{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.backup#ARN": { "type": "string" }, "com.amazonaws.backup#AccessPointArn": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:aws[a-z-]*:backup:[a-z-\\d]+:\\d{12}:accesspoint/)[\\da-z]{1}[\\da-z-]{1,48}[\\da-z]{1}(?Specifies an object containing resource type and backup options. The only supported\n resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service\n (VSS). For a CloudFormation example, see the sample\n CloudFormation template to enable Windows VSS in the Backup User Guide.

\n

Valid values: EC2.

" } }, "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is available for\n Windows VSS backup jobs and S3 backups.

\n

Valid values:

\n

Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup\n option and create a Windows VSS backup.

\n

Set to \"WindowsVSS\":\"disabled\" to create a regular backup. The\n WindowsVSS option is not enabled by default.

\n

For S3 backups, set to \"BackupACLs\":\"disabled\" to exclude ACLs from the backup, \n or \"BackupObjectTags\":\"disabled\" to exclude object tags from the backup. \n By default, both ACLs and object tags are included in S3 backups.

\n

If you specify an invalid option, you get an InvalidParameterValueException\n exception.

\n

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows\n Backup.

" } } }, "traits": { "smithy.api#documentation": "

The backup options for each resource type.

" } }, "com.amazonaws.backup#AdvancedBackupSettings": { "type": "list", "member": { "target": "com.amazonaws.backup#AdvancedBackupSetting" } }, "com.amazonaws.backup#AggregatedScanResult": { "type": "structure", "members": { "FailedScan": { "target": "com.amazonaws.backup#Boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether any of the aggregated scans failed.

" } }, "Findings": { "target": "com.amazonaws.backup#ScanFindings", "traits": { "smithy.api#documentation": "

An array of findings discovered across all aggregated scans.

" } }, "LastComputed": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the aggregated scan result was last computed, in Unix format and Coordinated Universal Time (UTC).

" } } }, "traits": { "smithy.api#documentation": "

Contains aggregated scan results across multiple scan operations, providing a summary of scan status and findings.

" } }, "com.amazonaws.backup#AggregationPeriod": { "type": "enum", "members": { "ONE_DAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ONE_DAY" } }, "SEVEN_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEVEN_DAYS" } }, "FOURTEEN_DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FOURTEEN_DAYS" } } } }, "com.amazonaws.backup#AlreadyExistsException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Arn": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

The required resource already exists.

", "smithy.api#error": "client" } }, "com.amazonaws.backup#AssociateBackupVaultMpaApprovalTeam": { "type": "operation", "input": { "target": "com.amazonaws.backup#AssociateBackupVaultMpaApprovalTeamInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Associates an MPA approval team with a backup vault.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}/mpaApprovalTeam", "code": 204 } } }, "com.amazonaws.backup#AssociateBackupVaultMpaApprovalTeamInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault to associate with the MPA approval team.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MpaApprovalTeamArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.

", "smithy.api#required": {} } }, "RequesterComment": { "target": "com.amazonaws.backup#RequesterComment", "traits": { "smithy.api#documentation": "

A comment provided by the requester explaining the association request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#BackupAccessPoints": { "type": "list", "member": { "target": "com.amazonaws.backup#ListAccessPointsMember" } }, "com.amazonaws.backup#BackupJob": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID that owns the backup job.

" } }, "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "VaultType": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The type of backup vault where the recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.

" } }, "VaultLockState": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "RecoveryPointLifecycle": { "target": "com.amazonaws.backup#Lifecycle" }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.

" } }, "IsEncrypted": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.

" } }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup job is created, in Unix format and Coordinated Universal Time\n (UTC). The value of CreationDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a job to create a backup job is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "State": { "target": "com.amazonaws.backup#BackupJobState", "traits": { "smithy.api#documentation": "

The current state of a backup job.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A detailed message explaining the status of the job to back up a resource.

" } }, "PercentDone": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" } }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of a backup (recovery point).

\n

This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the \n value returned may show a value of 0, which may differ from the \n anticipated value.

\n

The expected behavior for values by resource type are described as follows:

\n " } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point. IAM roles other\n than the default role must include either AWSBackup or AwsBackup\n in the role name. For example,\n arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those\n strings lack permissions to perform backup jobs.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#RecoveryPointCreator", "traits": { "smithy.api#documentation": "

Contains identifying information about the creation of a backup job, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan used to create it.

" } }, "ExpectedCompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a job to back up resources is expected to be completed, in Unix format\n and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is\n accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January\n 26, 2018 12:11:30.087 AM.

" } }, "StartBy": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job\n must be started before it is canceled. The value is calculated by adding the start window\n to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2\n hours, the StartBy time would be 8:00 PM on the date specified. The value of\n StartBy is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only\n supported resource type is Amazon EC2.

" } }, "BytesTransferred": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size in bytes transferred to a backup vault at the time that the job status was\n queried.

" } }, "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows Volume Shadow Copy Service (VSS) backup jobs.

\n

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the\n WindowsVSS backup option and create a Windows VSS backup. Set to\n \"WindowsVSS\":\"disabled\" to create a regular backup. If you specify an\n invalid option, you get an InvalidParameterValueException exception.

" } }, "BackupType": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Represents the type of backup for a backup job.

" } }, "ParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This uniquely identifies a request to Backup \n to back up a resource. The return will be the \n parent (composite) job ID.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) backup job.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that \n belongs to the specified backup.

" } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date on which the backup \n job was initiated.

" } }, "MessageCategory": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n INVALIDPARAMETERS. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a backup job.

" } }, "com.amazonaws.backup#BackupJobChildJobsInState": { "type": "map", "key": { "target": "com.amazonaws.backup#BackupJobState" }, "value": { "target": "com.amazonaws.backup#Long" } }, "com.amazonaws.backup#BackupJobState": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "ABORTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTING" } }, "ABORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "PARTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL" } } } }, "com.amazonaws.backup#BackupJobStatus": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "ABORTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTING" } }, "ABORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "PARTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL" } }, "AGGREGATE_ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGGREGATE_ALL" } }, "ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY" } } } }, "com.amazonaws.backup#BackupJobSummary": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.backup#Region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" } }, "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" } }, "State": { "target": "com.amazonaws.backup#BackupJobStatus", "traits": { "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types.

" } }, "MessageCategory": { "target": "com.amazonaws.backup#MessageCategory", "traits": { "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" } }, "Count": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" } }, "StartTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "EndTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } } }, "traits": { "smithy.api#documentation": "

This is a summary of jobs created \n or running within the most recent 14 days.

\n

The returned summary may contain the following: \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" } }, "com.amazonaws.backup#BackupJobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupJobSummary" } }, "com.amazonaws.backup#BackupJobsList": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupJob" } }, "com.amazonaws.backup#BackupOptionKey": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" } }, "com.amazonaws.backup#BackupOptionValue": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" } }, "com.amazonaws.backup#BackupOptions": { "type": "map", "key": { "target": "com.amazonaws.backup#BackupOptionKey" }, "value": { "target": "com.amazonaws.backup#BackupOptionValue" } }, "com.amazonaws.backup#BackupPlan": { "type": "structure", "members": { "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { "smithy.api#documentation": "

The display name of a backup plan. Must contain only alphanumeric or '-_.'\n special characters.

\n

If this is set in the console, it can contain 1 to 50 characters; if this \n is set through CLI or API, it can contain 1 to 200 characters.

", "smithy.api#required": {} } }, "Rules": { "target": "com.amazonaws.backup#BackupRules", "traits": { "smithy.api#documentation": "

An array of BackupRule objects, each of which specifies a scheduled task\n that is used to back up a selection of resources.

", "smithy.api#required": {} } }, "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { "smithy.api#documentation": "

Contains a list of BackupOptions for each resource type.

" } }, "ScanSettings": { "target": "com.amazonaws.backup#ScanSettings", "traits": { "smithy.api#documentation": "

Contains your scanning configuration for the backup plan and includes the Malware scanner, your selected resources, and scanner role.

" } } }, "traits": { "smithy.api#documentation": "

Contains an optional backup plan display name and an array of BackupRule\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task and can back up a different selection of Amazon Web Services\n resources.

" } }, "com.amazonaws.backup#BackupPlanInput": { "type": "structure", "members": { "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { "smithy.api#documentation": "

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'\n characters.

", "smithy.api#required": {} } }, "Rules": { "target": "com.amazonaws.backup#BackupRulesInput", "traits": { "smithy.api#documentation": "

An array of BackupRule objects, each of which specifies a scheduled task\n that is used to back up a selection of resources.

", "smithy.api#required": {} } }, "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { "smithy.api#documentation": "

Specifies a list of BackupOptions for each resource type. These settings\n are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

" } }, "ScanSettings": { "target": "com.amazonaws.backup#ScanSettings", "traits": { "smithy.api#documentation": "

Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.

" } } }, "traits": { "smithy.api#documentation": "

Contains an optional backup plan display name and an array of BackupRule\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task.

" } }, "com.amazonaws.backup#BackupPlanName": { "type": "string" }, "com.amazonaws.backup#BackupPlanTemplatesList": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupPlanTemplatesListMember" } }, "com.amazonaws.backup#BackupPlanTemplatesListMember": { "type": "structure", "members": { "BackupPlanTemplateId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a stored backup plan template.

" } }, "BackupPlanTemplateName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The optional display name of a backup plan template.

" } } }, "traits": { "smithy.api#documentation": "

An object specifying metadata associated with a backup plan template.

" } }, "com.amazonaws.backup#BackupPlanVersionsList": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupPlansListMember" } }, "com.amazonaws.backup#BackupPlansList": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupPlansListMember" } }, "com.amazonaws.backup#BackupPlansListMember": { "type": "structure", "members": { "BackupPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a resource backup plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "DeletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup plan is deleted, in Unix format and Coordinated Universal\n Time (UTC). The value of DeletionDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "VersionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

" } }, "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { "smithy.api#documentation": "

The display name of a saved backup plan.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } }, "LastExecutionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The last time this backup plan was run. A date and time, in\n Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { "smithy.api#documentation": "

Contains a list of BackupOptions for a resource type.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata about a backup plan.

" } }, "com.amazonaws.backup#BackupRule": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.backup#BackupRuleName", "traits": { "smithy.api#documentation": "

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'\n characters.

", "smithy.api#required": {} } }, "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#required": {} } }, "TargetLogicallyAirGappedBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of a logically air-gapped vault. ARN must be in the same account and Region.\n If provided, supported fully managed resources back up directly to logically air-gapped vault,\n while other supported resources create a temporary (billable) snapshot in backup vault,\n then copy it to logically air-gapped vault. Unsupported resources only back up to the specified\n backup vault.

" } }, "ScheduleExpression": { "target": "com.amazonaws.backup#CronExpression", "traits": { "smithy.api#documentation": "

A cron expression in UTC specifying when Backup initiates a backup job. \n When no CRON expression is provided, Backup will use the default \n expression cron(0 5 ? * * *).

\n

For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User\n Guide.

\n

Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take\n a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a\n backup every day at 12 noon UTC).

\n

For a table of examples, click the preceding link and scroll down the page.

" } }, "StartWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional. \n If this value is included, it must be at least 60 minutes to avoid errors.

\n

During the start window, the backup job status remains in CREATED status until it \n has successfully begun or until the start window time has run out. If within the start \n window time Backup receives an error that allows the job to be retried, \n Backup will automatically retry to begin the job at least every 10 minutes \n until the backup \n successfully begins (the job status changes to RUNNING) or until the job status \n changes to EXPIRED (which is expected to occur when the start window time is over).

" } }, "CompletionWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by Backup. This value is optional.

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold.

\n

Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

" } }, "RecoveryPointTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

The tags that are assigned to resources that are associated\n with this rule when restored from backup.

" } }, "RuleId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a rule that is used to schedule the backup of a selection of\n resources.

" } }, "CopyActions": { "target": "com.amazonaws.backup#CopyActions", "traits": { "smithy.api#documentation": "

An array of CopyAction objects, which contains the details of the copy\n operation.

" } }, "EnableContinuousBackup": { "target": "com.amazonaws.backup#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.

" } }, "ScheduleExpressionTimezone": { "target": "com.amazonaws.backup#Timezone", "traits": { "smithy.api#documentation": "

The timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" } }, "IndexActions": { "target": "com.amazonaws.backup#IndexActions", "traits": { "smithy.api#documentation": "

IndexActions is an array you use to specify how backup data should \n be indexed.

\n

eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up \n to one index associated with it.

\n

Within the array is ResourceType. Only one will be accepted for each BackupRule.

" } }, "ScanActions": { "target": "com.amazonaws.backup#ScanActions", "traits": { "smithy.api#documentation": "

Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.

" } } }, "traits": { "smithy.api#documentation": "

Specifies a scheduled task used to back up a selection of resources.

" } }, "com.amazonaws.backup#BackupRuleInput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.backup#BackupRuleName", "traits": { "smithy.api#documentation": "

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'\n characters.

", "smithy.api#required": {} } }, "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#required": {} } }, "TargetLogicallyAirGappedBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of a logically air-gapped vault. ARN must be in the same account and Region.\n If provided, supported fully managed resources back up directly to logically air-gapped vault,\n while other supported resources create a temporary (billable) snapshot in backup vault,\n then copy it to logically air-gapped vault. Unsupported resources only back up to the specified\n backup vault.

" } }, "ScheduleExpression": { "target": "com.amazonaws.backup#CronExpression", "traits": { "smithy.api#documentation": "

A CRON expression in UTC specifying when Backup initiates a backup\n job. When no CRON expression is provided, Backup will use the default \n expression cron(0 5 ? * * *).

" } }, "StartWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional. \n If this value is included, it must be at least 60 minutes to avoid errors.

\n

This parameter has a maximum value of 100 years (52,560,000 minutes).

\n

During the start window, the backup job status remains in CREATED status until it \n has successfully begun or until the start window time has run out. If within the start \n window time Backup receives an error that allows the job to be retried, \n Backup will automatically retry to begin the job at least every 10 minutes \n until the backup \n successfully begins (the job status changes to RUNNING) or until the job status \n changes to EXPIRED (which is expected to occur when the start window time is over).

" } }, "CompletionWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by Backup. This value is optional.

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold storage.

\n

Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

\n

This parameter has a maximum value of 100 years (36,500 days).

" } }, "RecoveryPointTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

The tags to assign to the resources.

" } }, "CopyActions": { "target": "com.amazonaws.backup#CopyActions", "traits": { "smithy.api#documentation": "

An array of CopyAction objects, which contains the details of the copy\n operation.

" } }, "EnableContinuousBackup": { "target": "com.amazonaws.backup#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.

" } }, "ScheduleExpressionTimezone": { "target": "com.amazonaws.backup#Timezone", "traits": { "smithy.api#documentation": "

The timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.

" } }, "IndexActions": { "target": "com.amazonaws.backup#IndexActions", "traits": { "smithy.api#documentation": "

There can up to one IndexAction in each BackupRule, as each backup \n can have 0 or 1 backup index associated with it.

\n

Within the array is ResourceTypes. Only 1 resource type will \n be accepted for each BackupRule. Valid values:

\n " } }, "ScanActions": { "target": "com.amazonaws.backup#ScanActions", "traits": { "smithy.api#documentation": "

Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.

" } } }, "traits": { "smithy.api#documentation": "

Specifies a scheduled task used to back up a selection of resources.

" } }, "com.amazonaws.backup#BackupRuleName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" } }, "com.amazonaws.backup#BackupRules": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupRule" } }, "com.amazonaws.backup#BackupRulesInput": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupRuleInput" } }, "com.amazonaws.backup#BackupSelection": { "type": "structure", "members": { "SelectionName": { "target": "com.amazonaws.backup#BackupSelectionName", "traits": { "smithy.api#documentation": "

The display name of a resource selection document. Must contain 1 to 50 alphanumeric or\n '-_.' characters.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that Backup uses to authenticate when backing up the\n target resource; for example, arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "Resources": { "target": "com.amazonaws.backup#ResourceArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the resources to assign to a backup plan. The maximum number of\n ARNs is 500 without wildcards, or 30 ARNs with wildcards.

\n

If you need to assign many resources to a backup plan, consider a different resource\n selection strategy, such as assigning all resources of a resource type or refining your\n resource selection using tags.

\n

If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).

\n \n

When using wildcards in ARN patterns for backup selections, the asterisk (*) must appear at the end of the ARN string (prefix pattern). For example, arn:aws:s3:::my-bucket-* is valid, but arn:aws:s3:::*-logs is not supported.

\n
" } }, "ListOfTags": { "target": "com.amazonaws.backup#ListOfTags", "traits": { "smithy.api#documentation": "

The conditions that you define to assign resources to your backup plans using tags. For example, \n \"StringEquals\": { \"ConditionKey\": \"backup\", \"ConditionValue\": \"daily\"}.

\n

\n ListOfTags supports only StringEquals. Condition operators are case sensitive.

\n

If you specify multiple conditions, the resources much match any of the conditions (OR logic).

" } }, "NotResources": { "target": "com.amazonaws.backup#ResourceArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the resources to exclude from a backup plan. The maximum number\n of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

\n

If you need to exclude many resources from a backup plan, consider a different resource\n selection strategy, such as assigning only one or a few resource types or refining your\n resource selection using tags.

" } }, "Conditions": { "target": "com.amazonaws.backup#Conditions", "traits": { "smithy.api#documentation": "

The conditions that you define to assign resources to your backup plans using tags. For example, \n \"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/backup\", \"ConditionValue\": \"daily\" }.

\n

\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike. Condition operators are case sensitive.

\n

If you specify multiple conditions, the resources much match all conditions (AND logic).

" } } }, "traits": { "smithy.api#documentation": "

Used to specify a set of resources to a backup plan.

\n

We recommend that you specify conditions, tags, or resources to include or exclude. \n Otherwise, Backup attempts to select all supported and opted-in storage resources, which \n could have unintended cost implications.

\n

For more information, see Assigning resources programmatically.

" } }, "com.amazonaws.backup#BackupSelectionName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" } }, "com.amazonaws.backup#BackupSelectionsList": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupSelectionsListMember" } }, "com.amazonaws.backup#BackupSelectionsListMember": { "type": "structure", "members": { "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to assign a set of resources to a backup plan.

" } }, "SelectionName": { "target": "com.amazonaws.backup#BackupSelectionName", "traits": { "smithy.api#documentation": "

The display name of a resource selection document.

" } }, "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup plan is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point;\n for example, arn:aws:iam::123456789012:role/S3Access.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata about a BackupSelection object.

" } }, "com.amazonaws.backup#BackupVaultArn": { "type": "string" }, "com.amazonaws.backup#BackupVaultEvent": { "type": "enum", "members": { "BACKUP_JOB_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_JOB_STARTED" } }, "BACKUP_JOB_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_JOB_COMPLETED" } }, "BACKUP_JOB_SUCCESSFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_JOB_SUCCESSFUL" } }, "BACKUP_JOB_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_JOB_FAILED" } }, "BACKUP_JOB_EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_JOB_EXPIRED" } }, "RESTORE_JOB_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORE_JOB_STARTED" } }, "RESTORE_JOB_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORE_JOB_COMPLETED" } }, "RESTORE_JOB_SUCCESSFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORE_JOB_SUCCESSFUL" } }, "RESTORE_JOB_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORE_JOB_FAILED" } }, "COPY_JOB_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPY_JOB_STARTED" } }, "COPY_JOB_SUCCESSFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPY_JOB_SUCCESSFUL" } }, "COPY_JOB_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPY_JOB_FAILED" } }, "RECOVERY_POINT_MODIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOVERY_POINT_MODIFIED" } }, "BACKUP_PLAN_CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_PLAN_CREATED" } }, "BACKUP_PLAN_MODIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_PLAN_MODIFIED" } }, "S3_BACKUP_OBJECT_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3_BACKUP_OBJECT_FAILED" } }, "S3_RESTORE_OBJECT_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3_RESTORE_OBJECT_FAILED" } }, "CONTINUOUS_BACKUP_INTERRUPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUOUS_BACKUP_INTERRUPTED" } }, "RECOVERY_POINT_INDEX_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOVERY_POINT_INDEX_COMPLETED" } }, "RECOVERY_POINT_INDEX_DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOVERY_POINT_INDEX_DELETED" } }, "RECOVERY_POINT_INDEXING_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOVERY_POINT_INDEXING_FAILED" } }, "EKS_RESTORE_OBJECT_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_RESTORE_OBJECT_FAILED" } }, "EKS_RESTORE_OBJECT_SKIPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_RESTORE_OBJECT_SKIPPED" } }, "EKS_BACKUP_OBJECT_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_BACKUP_OBJECT_FAILED" } }, "EKS_RESTORE_MODIFICATION_SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_RESTORE_MODIFICATION_SUCCESS" } }, "EKS_RESTORE_MODIFICATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_RESTORE_MODIFICATION_FAILED" } }, "ACCESS_POINT_AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_POINT_AVAILABLE" } }, "ACCESS_POINT_CREATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_POINT_CREATION_FAILED" } }, "ACCESS_POINT_DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_POINT_DELETED" } }, "ACCESS_POINT_DELETION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_POINT_DELETION_FAILED" } }, "ACCESS_POINT_EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_POINT_EXPIRED" } }, "ACCESS_POINT_DISASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_POINT_DISASSOCIATED" } } } }, "com.amazonaws.backup#BackupVaultEvents": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupVaultEvent" } }, "com.amazonaws.backup#BackupVaultList": { "type": "list", "member": { "target": "com.amazonaws.backup#BackupVaultListMember" } }, "com.amazonaws.backup#BackupVaultListMember": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { "smithy.api#documentation": "

The type of vault in which the described recovery point is stored.

" } }, "VaultState": { "target": "com.amazonaws.backup#VaultState", "traits": { "smithy.api#documentation": "

The current state of the vault.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a resource backup is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

A server-side encryption key you can specify to encrypt your backups from services\n that support full Backup management; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.\n If you specify a key, you must specify its ARN, not its alias. If you do not specify a key,\n Backup creates a KMS key for you by default.

\n

To learn which Backup services support full Backup management\n and how Backup handles encryption for backups from services that do not yet support\n full Backup, see \n Encryption for backups in Backup\n

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } }, "NumberOfRecoveryPoints": { "target": "com.amazonaws.backup#Long2", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of recovery points that are stored in a backup vault. Recovery point count\n value displayed in the console can be an approximation.

" } }, "Locked": { "target": "com.amazonaws.backup#Boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether Backup Vault Lock applies to the\n selected backup vault. If true, Vault Lock prevents delete and update\n operations on the recovery points in the selected vault.

" } }, "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The Backup Vault Lock setting that specifies the minimum retention period\n that the vault retains its recovery points. If this parameter is not specified, Vault Lock\n does not enforce a minimum retention period.

\n

If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or longer than the minimum retention period. If the job's\n retention period is shorter than that minimum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.

" } }, "MaxRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The Backup Vault Lock setting that specifies the maximum retention period\n that the vault retains its recovery points. If this parameter is not specified, Vault Lock\n does not enforce a maximum retention period on the recovery points in the vault (allowing\n indefinite storage).

\n

If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or shorter than the maximum retention period. If the job's\n retention period is longer than that maximum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.

" } }, "LockDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when Backup Vault Lock configuration becomes immutable,\n meaning it cannot be changed or deleted.

\n

If you applied Vault Lock to your vault without specifying a lock date, you can change\n your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

\n

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "EncryptionKeyType": { "target": "com.amazonaws.backup#EncryptionKeyType", "traits": { "smithy.api#documentation": "

The type of encryption key used for the backup vault. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata about a backup vault.

" } }, "com.amazonaws.backup#BackupVaultName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]{2,50}$" } }, "com.amazonaws.backup#BackupVaultNameOrWildcard": { "type": "string", "traits": { "smithy.api#pattern": "^(\\*|[a-zA-Z0-9\\-\\_]{2,50})$" } }, "com.amazonaws.backup#Boolean": { "type": "boolean" }, "com.amazonaws.backup#Boolean2": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.backup#CalculatedLifecycle": { "type": "structure", "members": { "MoveToColdStorageAt": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

A timestamp that specifies when to transition a recovery point to cold storage.

" } }, "DeleteAt": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

A timestamp that specifies when to delete a recovery point.

" } } }, "traits": { "smithy.api#documentation": "

Contains DeleteAt and MoveToColdStorageAt timestamps, which\n are used to specify a lifecycle for a recovery point.

\n

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold.

\n

Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

" } }, "com.amazonaws.backup#CancelLegalHold": { "type": "operation", "input": { "target": "com.amazonaws.backup#CancelLegalHoldInput" }, "output": { "target": "com.amazonaws.backup#CancelLegalHoldOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidResourceStateException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Removes the specified legal hold on a recovery point. This action can only be performed\n by a user with sufficient permissions.

", "smithy.api#http": { "method": "DELETE", "uri": "/legal-holds/{LegalHoldId}", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CancelLegalHoldInput": { "type": "structure", "members": { "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the legal hold.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CancelDescription": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A string the describes the reason for removing the legal hold.

", "smithy.api#httpQuery": "cancelDescription", "smithy.api#required": {} } }, "RetainRecordInDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The integer amount, in days, after which to remove legal hold.

", "smithy.api#httpQuery": "retainRecordInDays" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CancelLegalHoldOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ComplianceResourceIdList": { "type": "list", "member": { "target": "com.amazonaws.backup#string" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.backup#Condition": { "type": "structure", "members": { "ConditionType": { "target": "com.amazonaws.backup#ConditionType", "traits": { "smithy.api#documentation": "

An operation applied to a key-value pair used to assign resources to your backup plan.\n Condition only supports StringEquals. For more flexible assignment options,\n including StringLike and the ability to exclude resources from your backup\n plan, use Conditions (with an \"s\" on the end) for your \n BackupSelection\n .

", "smithy.api#required": {} } }, "ConditionKey": { "target": "com.amazonaws.backup#ConditionKey", "traits": { "smithy.api#documentation": "

The key in a key-value pair. For example, in the tag Department:\n Accounting, Department is the key.

", "smithy.api#required": {} } }, "ConditionValue": { "target": "com.amazonaws.backup#ConditionValue", "traits": { "smithy.api#documentation": "

The value in a key-value pair. For example, in the tag Department:\n Accounting, Accounting is the value.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains an array of triplets made up of a condition type (such as\n StringEquals), a key, and a value. Used to filter resources using their\n tags and assign them to a backup plan. Case sensitive.

" } }, "com.amazonaws.backup#ConditionKey": { "type": "string" }, "com.amazonaws.backup#ConditionParameter": { "type": "structure", "members": { "ConditionKey": { "target": "com.amazonaws.backup#ConditionKey", "traits": { "smithy.api#documentation": "

The key in a key-value pair. For example, in the tag Department:\n Accounting, Department is the key.

" } }, "ConditionValue": { "target": "com.amazonaws.backup#ConditionValue", "traits": { "smithy.api#documentation": "

The value in a key-value pair. For example, in the tag Department:\n Accounting, Accounting is the value.

" } } }, "traits": { "smithy.api#documentation": "

Includes information about tags you define to assign tagged resources to a backup\n plan.

\n

Include the prefix aws:ResourceTag in your tags. \n For example, \"aws:ResourceTag/TagKey1\": \"Value1\".

" } }, "com.amazonaws.backup#ConditionParameters": { "type": "list", "member": { "target": "com.amazonaws.backup#ConditionParameter" } }, "com.amazonaws.backup#ConditionType": { "type": "enum", "members": { "STRINGEQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRINGEQUALS" } } } }, "com.amazonaws.backup#ConditionValue": { "type": "string" }, "com.amazonaws.backup#Conditions": { "type": "structure", "members": { "StringEquals": { "target": "com.amazonaws.backup#ConditionParameters", "traits": { "smithy.api#documentation": "

Filters the values of your tagged resources for only those resources that you tagged\n with the same value. Also called \"exact matching.\"

" } }, "StringNotEquals": { "target": "com.amazonaws.backup#ConditionParameters", "traits": { "smithy.api#documentation": "

Filters the values of your tagged resources for only those resources that you tagged\n that do not have the same value. Also called \"negated matching.\"

" } }, "StringLike": { "target": "com.amazonaws.backup#ConditionParameters", "traits": { "smithy.api#documentation": "

Filters the values of your tagged resources for matching tag values with the use of a\n wildcard character (*) anywhere in the string. For example, \"prod*\" or \"*rod*\" matches the\n tag value \"production\".

" } }, "StringNotLike": { "target": "com.amazonaws.backup#ConditionParameters", "traits": { "smithy.api#documentation": "

Filters the values of your tagged resources for non-matching tag values with the use of\n a wildcard character (*) anywhere in the string.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about which resources to include or exclude from a backup plan\n using their tags. Conditions are case sensitive.

" } }, "com.amazonaws.backup#ConflictException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ConflictException", "httpResponseCode": 409 }, "smithy.api#documentation": "

Backup can't perform the action that you requested until it finishes\n performing a previous action. Try again later.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.backup#ControlInputParameter": { "type": "structure", "members": { "ParameterName": { "target": "com.amazonaws.backup#ParameterName", "traits": { "smithy.api#documentation": "

The name of a parameter, for example, BackupPlanFrequency.

" } }, "ParameterValue": { "target": "com.amazonaws.backup#ParameterValue", "traits": { "smithy.api#documentation": "

The value of parameter, for example, hourly.

" } } }, "traits": { "smithy.api#documentation": "

The parameters for a control. A control can have zero, one, or more than one\n parameter. An example of a control with two parameters is: \"backup plan frequency is at\n least daily and the retention period is at least 1 year\". The\n first parameter is daily. The second parameter is 1 year.

" } }, "com.amazonaws.backup#ControlInputParameters": { "type": "list", "member": { "target": "com.amazonaws.backup#ControlInputParameter" } }, "com.amazonaws.backup#ControlName": { "type": "string" }, "com.amazonaws.backup#ControlScope": { "type": "structure", "members": { "ComplianceResourceIds": { "target": "com.amazonaws.backup#ComplianceResourceIdList", "traits": { "smithy.api#documentation": "

The ID of the only Amazon Web Services resource that you want your control scope to\n contain.

" } }, "ComplianceResourceTypes": { "target": "com.amazonaws.backup#ResourceTypeList", "traits": { "smithy.api#documentation": "

Describes whether the control scope includes one or more types of resources, such as\n EFS or RDS.

" } }, "Tags": { "target": "com.amazonaws.backup#stringMap", "traits": { "smithy.api#documentation": "

The tag key-value pair applied to those Amazon Web Services resources that you want to\n trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag\n value is optional, but it cannot be an empty string if you are creating or editing a \n framework from the console (though the value can be an empty string when included \n in a CloudFormation template).

\n

The structure to assign a tag is:\n [{\"Key\":\"string\",\"Value\":\"string\"}].

" } } }, "traits": { "smithy.api#documentation": "

A framework consists of one or more controls. Each control has its own control scope.\n The control scope can include one or more resource types, a combination of a tag key and\n value, or a combination of one resource type and one resource ID. If no scope is specified,\n evaluations for the rule are triggered when any resource in your recording group changes in\n configuration.

\n \n

To set a control scope that includes all of a particular resource, leave the\n ControlScope empty or do not pass it when calling\n CreateFramework.

\n
" } }, "com.amazonaws.backup#CopyAction": { "type": "structure", "members": { "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle" }, "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for\n the copied backup. For example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The details of the copy operation.

" } }, "com.amazonaws.backup#CopyActions": { "type": "list", "member": { "target": "com.amazonaws.backup#CopyAction" } }, "com.amazonaws.backup#CopyJob": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID that owns the copy job.

" } }, "CopyJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a copy job.

" } }, "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "SourceRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a source recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for\n example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "DestinationVaultType": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The type of destination backup vault where the copied recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.

" } }, "DestinationVaultLockState": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The lock state of the destination backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.

" } }, "DestinationRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a destination recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "DestinationEncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault. This can be a customer-managed key or an Amazon Web Services managed key.

" } }, "DestinationRecoveryPointLifecycle": { "target": "com.amazonaws.backup#Lifecycle" }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)\n database.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a copy job is created, in Unix format and Coordinated Universal Time\n (UTC). The value of CreationDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a copy job is completed, in Unix format and Coordinated Universal Time\n (UTC). The value of CompletionDate is accurate to milliseconds. For example,\n the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "State": { "target": "com.amazonaws.backup#CopyJobState", "traits": { "smithy.api#documentation": "

The current state of a copy job.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A detailed message explaining the status of the job to copy a resource.

" } }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of a copy job.

" } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to copy the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#RecoveryPointCreator" }, "CreatedByBackupJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The backup job ID that initiated this copy job. Only applicable to scheduled copy\n jobs and automatic copy jobs to logically air-gapped vault.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" } }, "ParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This uniquely identifies a request to Backup \n to copy a resource. The return will be the \n parent (composite) job ID.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) copy job.

" } }, "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

" } }, "NumberOfChildJobs": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The number of child (nested) copy jobs.

" } }, "ChildJobsInState": { "target": "com.amazonaws.backup#CopyJobChildJobsInState", "traits": { "smithy.api#documentation": "

This returns the statistics of the included \n child (nested) copy jobs.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that \n belongs to the specified backup.

" } }, "MessageCategory": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a copy job.

" } }, "com.amazonaws.backup#CopyJobChildJobsInState": { "type": "map", "key": { "target": "com.amazonaws.backup#CopyJobState" }, "value": { "target": "com.amazonaws.backup#Long" } }, "com.amazonaws.backup#CopyJobState": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "PARTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL" } } } }, "com.amazonaws.backup#CopyJobStatus": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "ABORTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTING" } }, "ABORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTED" } }, "COMPLETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "PARTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL" } }, "AGGREGATE_ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGGREGATE_ALL" } }, "ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY" } } } }, "com.amazonaws.backup#CopyJobSummary": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.backup#Region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" } }, "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" } }, "State": { "target": "com.amazonaws.backup#CopyJobStatus", "traits": { "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types

" } }, "MessageCategory": { "target": "com.amazonaws.backup#MessageCategory", "traits": { "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" } }, "Count": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" } }, "StartTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "EndTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } } }, "traits": { "smithy.api#documentation": "

This is a summary of copy jobs created \n or running within the most recent 14 days.

\n

The returned summary may contain the following: \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" } }, "com.amazonaws.backup#CopyJobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.backup#CopyJobSummary" } }, "com.amazonaws.backup#CopyJobsList": { "type": "list", "member": { "target": "com.amazonaws.backup#CopyJob" } }, "com.amazonaws.backup#CreateBackupAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateBackupAccessPointRequest" }, "output": { "target": "com.amazonaws.backup#CreateBackupAccessPointResponse" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a backup access point for an Amazon S3 recovery point. A backup access point provides\n on-demand, read-only access to the backup data in a recovery point through an Amazon S3 access point,\n without initiating a restore.

\n

While a backup access point is active for a recovery point, Backup pauses lifecycle transitions\n and blocks deletion of that recovery point.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-access-point/create", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateBackupAccessPointRequest": { "type": "structure", "members": { "AccessPointMetadata": { "target": "com.amazonaws.backup#AccessPointMetadataMap", "traits": { "smithy.api#documentation": "

Metadata for the backup access point. For continuous (point-in-time) recovery points, you must include an\n AccessPointInTime timestamp (in format 2021-11-27T03:30:27Z). The access point\n provides access to the content present in the backup at that specific time. You can specify any time\n within the continuous backup's retention period, up to the latest restorable time. For snapshot recovery\n points, do not include AccessPointInTime.

" } }, "AccessPointPolicy": { "target": "com.amazonaws.backup#AccessPointPolicy", "traits": { "smithy.api#documentation": "

An optional resource-based policy, in JSON format, to apply to the underlying Amazon S3 access\n point. The policy controls how backup data can be accessed through the access point. If you do not specify\n a policy, access is governed by the caller's IAM permissions. For more information, see Configuring IAM policies\n for using access points in the Amazon S3 User Guide.

" } }, "Name": { "target": "com.amazonaws.backup#AccessPointName", "traits": { "smithy.api#documentation": "

The name of the backup access point. This name is shared with the Amazon S3 access point namespace.\n It must be unique within your account and Region and cannot conflict with an existing Amazon S3 access\n point. For more information about access point naming, see Access points naming rules, restrictions, and limitations in the Amazon S3 User\n Guide.

", "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#RecoveryPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point for which to create the backup access point. The\n recovery point must be an Amazon S3 recovery point in the AVAILABLE, STOPPED,\n or COMPLETED state.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.backup#TagMap", "traits": { "smithy.api#documentation": "

The tags to assign to the backup access point.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateBackupAccessPointResponse": { "type": "structure", "members": { "AccessPointArn": { "target": "com.amazonaws.backup#AccessPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the created backup access point.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.backup#AccessPointStatus", "traits": { "smithy.api#documentation": "

The current status of the backup access point. A newly created backup access point begins in the\n CREATING state and becomes usable when it reaches AVAILABLE.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateBackupPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateBackupPlanInput" }, "output": { "target": "com.amazonaws.backup#CreateBackupPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a backup plan using a backup plan name and backup rules. A backup plan is a\n document that contains information that Backup uses to schedule tasks that\n create recovery points for resources.

\n

If you call CreateBackupPlan with a plan that already exists, you receive\n an AlreadyExistsException exception.

", "smithy.api#http": { "method": "PUT", "uri": "/backup/plans", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateBackupPlanInput": { "type": "structure", "members": { "BackupPlan": { "target": "com.amazonaws.backup#BackupPlanInput", "traits": { "smithy.api#documentation": "

The body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

", "smithy.api#required": {} } }, "BackupPlanTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

The tags to assign to the backup plan.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Identifies the request and allows failed requests to be retried without the risk of\n running the operation twice. If the request includes a CreatorRequestId that\n matches an existing backup plan, that plan is returned. This parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateBackupPlanOutput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the backup plan.

" } }, "BackupPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "VersionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. They cannot be edited.

" } }, "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { "smithy.api#documentation": "

The settings for a resource type. This option is only\n available for Windows Volume Shadow Copy Service (VSS) backup jobs.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateBackupSelection": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateBackupSelectionInput" }, "output": { "target": "com.amazonaws.backup#CreateBackupSelectionOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a JSON document that specifies a set of resources to assign to a backup plan.\n For examples, see Assigning resources programmatically.

", "smithy.api#http": { "method": "PUT", "uri": "/backup/plans/{BackupPlanId}/selections", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateBackupSelectionInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupSelection": { "target": "com.amazonaws.backup#BackupSelection", "traits": { "smithy.api#documentation": "

The body of a request to assign a set of resources to a backup plan.

", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateBackupSelectionOutput": { "type": "structure", "members": { "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

" } }, "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the backup plan.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup selection is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateBackupVaultInput" }, "output": { "target": "com.amazonaws.backup#CreateBackupVaultOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a logical container where backups are stored. A CreateBackupVault\n request includes a name, optionally one or more resource tags, an encryption key, and a\n request ID.

\n \n

Do not include sensitive data, such as passport numbers, in the name of a backup\n vault.

\n
", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateBackupVaultInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of letters, numbers, and hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupVaultTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

The tags to assign to the backup vault.

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateBackupVaultOutput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup vault is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateFramework": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateFrameworkInput" }, "output": { "target": "com.amazonaws.backup#CreateFrameworkOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a framework with one or more controls. A framework is a collection of controls\n that you can use to evaluate your backup practices. By using pre-built customizable\n controls to define your policies, you can evaluate whether your backup practices comply\n with your policies and which resources are not yet in compliance.

", "smithy.api#http": { "method": "POST", "uri": "/audit/frameworks", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateFrameworkInput": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of the framework. The name must be between 1 and 256 characters,\n starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and\n underscores (_).

", "smithy.api#required": {} } }, "FrameworkDescription": { "target": "com.amazonaws.backup#FrameworkDescription", "traits": { "smithy.api#documentation": "

An optional description of the framework with a maximum of 1,024 characters.

" } }, "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { "smithy.api#documentation": "

The controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to CreateFrameworkInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } }, "FrameworkTags": { "target": "com.amazonaws.backup#stringMap", "traits": { "smithy.api#documentation": "

The tags to assign to the framework.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateFrameworkOutput": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of the framework. The name must be between 1 and 256 characters,\n starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and\n underscores (_).

" } }, "FrameworkArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateLegalHold": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateLegalHoldInput" }, "output": { "target": "com.amazonaws.backup#CreateLegalHoldOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a legal hold on a recovery point (backup). A legal hold is a restraint on\n altering or deleting a backup until an authorized user cancels the legal hold. Any actions\n to delete or disassociate a recovery point will fail with an error if one or more active\n legal holds are on the recovery point.

", "smithy.api#http": { "method": "POST", "uri": "/legal-holds", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateLegalHoldInput": { "type": "structure", "members": { "Title": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The title of the legal hold.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The description of the legal hold.

", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is a user-chosen string used to distinguish between otherwise identical \n calls. Retrying a successful request with the \n same idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } }, "RecoveryPointSelection": { "target": "com.amazonaws.backup#RecoveryPointSelection", "traits": { "smithy.api#documentation": "

The criteria to assign a set of resources, such as resource types or backup vaults.

" } }, "Tags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

Optional tags to include. A tag is a key-value pair you can use to manage, \n filter, and search for your resources. Allowed characters include UTF-8 letters, \n numbers, spaces, and the following characters: + - = . _ : /.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateLegalHoldOutput": { "type": "structure", "members": { "Title": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The title of the legal hold.

" } }, "Status": { "target": "com.amazonaws.backup#LegalHoldStatus", "traits": { "smithy.api#documentation": "

The status of the legal hold.

" } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The description of the legal hold.

" } }, "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the legal hold.

" } }, "LegalHoldArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the legal hold.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The time when the legal hold was created.

" } }, "RecoveryPointSelection": { "target": "com.amazonaws.backup#RecoveryPointSelection", "traits": { "smithy.api#documentation": "

The criteria to assign to a set of resources, such as resource types or backup vaults.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateLogicallyAirGappedBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultInput" }, "output": { "target": "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a logical container to where backups may be copied.

\n

This request includes a name, the Region, the maximum number of retention days, the \n minimum number of retention days, and optionally can include tags and a creator request \n ID.

\n \n

Do not include sensitive data, such as passport numbers, in the name of a backup\n vault.

\n
", "smithy.api#http": { "method": "PUT", "uri": "/logically-air-gapped-backup-vaults/{BackupVaultName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Logically air-gapped \n backup vaults are identified by names that are unique to the account used to create \n them and the Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupVaultTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

The tags to assign to the vault.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the creation request.

\n

This parameter is optional. If used, this parameter must contain \n 1 to 50 alphanumeric or '-_.' characters.

", "smithy.api#idempotencyToken": {} } }, "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

This setting specifies the minimum retention period\n that the vault retains its recovery points.

\n

The minimum value accepted is 7 days.

", "smithy.api#required": {} } }, "MaxRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The maximum retention period that the vault retains its recovery points.

", "smithy.api#required": {} } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the customer-managed KMS key to use for encrypting the logically air-gapped backup vault. If not specified, the vault will be encrypted with an Amazon Web Services-owned key managed by Amazon Web Services Backup.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultOutput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Logically air-gapped \n backup vaults are identified by names that are unique to the account used to create \n them and the Region where they are created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the vault.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the vault was created.

\n

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "VaultState": { "target": "com.amazonaws.backup#VaultState", "traits": { "smithy.api#documentation": "

The current state of the vault.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateReportPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateReportPlanInput" }, "output": { "target": "com.amazonaws.backup#CreateReportPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a report plan. A report plan is a document that contains information about the\n contents of the report and where Backup will deliver it.

\n

If you call CreateReportPlan with a plan that already exists, you receive\n an AlreadyExistsException exception.

", "smithy.api#http": { "method": "POST", "uri": "/audit/report-plans", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateReportPlanInput": { "type": "structure", "members": { "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of the report plan. The name must be between 1 and 256 characters,\n starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and\n underscores (_).

", "smithy.api#required": {} } }, "ReportPlanDescription": { "target": "com.amazonaws.backup#ReportPlanDescription", "traits": { "smithy.api#documentation": "

An optional description of the report plan with a maximum of 1,024 characters.

" } }, "ReportDeliveryChannel": { "target": "com.amazonaws.backup#ReportDeliveryChannel", "traits": { "smithy.api#documentation": "

A structure that contains information about where and how to deliver your reports,\n specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your\n reports.

", "smithy.api#required": {} } }, "ReportSetting": { "target": "com.amazonaws.backup#ReportSetting", "traits": { "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT \n

\n

If the report template is RESOURCE_COMPLIANCE_REPORT or\n CONTROL_COMPLIANCE_REPORT, this API resource also describes the report\n coverage by Amazon Web Services Regions and frameworks.

", "smithy.api#required": {} } }, "ReportPlanTags": { "target": "com.amazonaws.backup#stringMap", "traits": { "smithy.api#documentation": "

The tags to assign to the report plan.

" } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to CreateReportPlanInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateReportPlanOutput": { "type": "structure", "members": { "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of the report plan.

" } }, "ReportPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup vault is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateRestoreAccessBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateRestoreAccessBackupVaultInput" }, "output": { "target": "com.amazonaws.backup#CreateRestoreAccessBackupVaultOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.

", "smithy.api#http": { "method": "PUT", "uri": "/restore-access-backup-vaults", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateRestoreAccessBackupVaultInput": { "type": "structure", "members": { "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the source backup vault containing the recovery points to which temporary access is requested.

", "smithy.api#required": {} } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault to associate with an MPA approval team.

" } }, "BackupVaultTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

Optional tags to assign to the restore access backup vault.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

", "smithy.api#idempotencyToken": {} } }, "RequesterComment": { "target": "com.amazonaws.backup#RequesterComment", "traits": { "smithy.api#documentation": "

A comment explaining the reason for requesting restore access to the backup vault.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateRestoreAccessBackupVaultOutput": { "type": "structure", "members": { "RestoreAccessBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN that uniquely identifies the created restore access backup vault.

" } }, "VaultState": { "target": "com.amazonaws.backup#VaultState", "traits": { "smithy.api#documentation": "

The current state of the restore access backup vault.

" } }, "RestoreAccessBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the created restore access backup vault.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

>The date and time when the restore access backup vault was created, in Unix format and Coordinated Universal Time

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateRestoreTestingPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateRestoreTestingPlanInput" }, "output": { "target": "com.amazonaws.backup#CreateRestoreTestingPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a restore testing plan.

\n

The first of two steps to create a restore testing \n plan. After this request is successful, finish the procedure using \n CreateRestoreTestingSelection.

", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateRestoreTestingPlanInput": { "type": "structure", "members": { "CreatorRequestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

This is a unique string that identifies the request and \n allows failed requests to be retriedwithout the risk of running \n the operation twice. This parameter is optional. If used, this \n parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } }, "RestoreTestingPlan": { "target": "com.amazonaws.backup#RestoreTestingPlanForCreate", "traits": { "smithy.api#documentation": "

A restore testing plan must contain a unique RestoreTestingPlanName string\n you create and must contain a ScheduleExpression cron. You may optionally\n include a StartWindowHours integer and a CreatorRequestId\n string.

\n

The RestoreTestingPlanName is a unique string that is the name of the\n restore testing plan. This cannot be changed after creation, and it must consist of only\n alphanumeric characters and underscores.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { "smithy.api#documentation": "

The tags to assign to the restore testing plan.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateRestoreTestingPlanOutput": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time a restore testing plan was created, in Unix format \n and Coordinated Universal Time (UTC). The value of CreationTime \n is accurate to milliseconds. For example, the value 1516925490.087 represents \n Friday, January 26, 2018 12:11:30.087AM.

", "smithy.api#required": {} } }, "RestoreTestingPlanArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the created \n restore testing plan.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

This unique string is the name of the restore testing plan.

\n

The name cannot be changed after creation. The name consists of only \n alphanumeric characters and underscores. Maximum length is 50.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateRestoreTestingSelection": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateRestoreTestingSelectionInput" }, "output": { "target": "com.amazonaws.backup#CreateRestoreTestingSelectionOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request can be sent after CreateRestoreTestingPlan request \n returns successfully. This is the second part of creating a resource testing \n plan, and it must be completed sequentially.

\n

This consists of RestoreTestingSelectionName,\n ProtectedResourceType, and one of the following:

\n \n

Each protected resource type can have one single value.

\n

A restore testing selection can include a wildcard value (\"*\") for\n ProtectedResourceArns along with ProtectedResourceConditions.\n Alternatively, you can include up to 30 specific protected resource ARNs in\n ProtectedResourceArns.

\n

Cannot select by both protected resource types AND specific ARNs. \n Request will fail if both are included.

", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateRestoreTestingSelectionInput": { "type": "structure", "members": { "CreatorRequestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

This is an optional unique string that identifies the request and allows \n failed requests to be retried without the risk of running the operation \n twice. If used, this parameter must contain \n 1 to 50 alphanumeric or '-_.' characters.

" } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Input the restore testing plan name that was returned from the \n related CreateRestoreTestingPlan request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RestoreTestingSelection": { "target": "com.amazonaws.backup#RestoreTestingSelectionForCreate", "traits": { "smithy.api#documentation": "

This consists of RestoreTestingSelectionName,\n ProtectedResourceType, and one of the following:

\n \n

Each protected resource type can have one single value.

\n

A restore testing selection can include a wildcard value (\"*\") for\n ProtectedResourceArns along with ProtectedResourceConditions.\n Alternatively, you can include up to 30 specific protected resource ARNs in\n ProtectedResourceArns.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateRestoreTestingSelectionOutput": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time that the resource testing selection was created.

", "smithy.api#required": {} } }, "RestoreTestingPlanArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the restore testing plan with which the restore \n testing selection is associated.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the restore testing plan.

\n

The name cannot be changed after creation. The name consists of only \n alphanumeric characters and underscores. Maximum length is 50.

", "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the restore testing selection for the related restore testing plan.

\n

The name cannot be changed after creation. The name consists of only \n alphanumeric characters and underscores. Maximum length is 50.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreateTieringConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.backup#CreateTieringConfigurationInput" }, "output": { "target": "com.amazonaws.backup#CreateTieringConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a tiering configuration.

\n

A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault.

\n

Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.

", "smithy.api#http": { "method": "PUT", "uri": "/tiering-configurations", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#CreateTieringConfigurationInput": { "type": "structure", "members": { "TieringConfiguration": { "target": "com.amazonaws.backup#TieringConfigurationInputForCreate", "traits": { "smithy.api#documentation": "

A tiering configuration must contain a unique TieringConfigurationName string\n you create and must contain a BackupVaultName and ResourceSelection.\n You may optionally include a CreatorRequestId string.

\n

The TieringConfigurationName is a unique string that is the name of the\n tiering configuration. This cannot be changed after creation, and it must consist of only\n alphanumeric characters and underscores.

", "smithy.api#required": {} } }, "TieringConfigurationTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

The tags to assign to the tiering configuration.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#CreatorRequestId", "traits": { "smithy.api#documentation": "

This is a unique string that identifies the request and\n allows failed requests to be retried without the risk of running\n the operation twice. This parameter is optional. If used, this\n parameter must contain 1 to 50 alphanumeric or '-_.' characters.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#CreateTieringConfigurationOutput": { "type": "structure", "members": { "TieringConfigurationArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the created\n tiering configuration.

" } }, "TieringConfigurationName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This unique string is the name of the tiering configuration.

\n

The name cannot be changed after creation. The name consists of only\n alphanumeric characters and underscores. Maximum length is 200.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a tiering configuration was created, in Unix format\n and Coordinated Universal Time (UTC). The value of CreationTime\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087AM.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#CreatorRequestId": { "type": "string" }, "com.amazonaws.backup#CronExpression": { "type": "string" }, "com.amazonaws.backup#CryoControllerUserManager": { "type": "service", "version": "2018-11-15", "operations": [ { "target": "com.amazonaws.backup#AssociateBackupVaultMpaApprovalTeam" }, { "target": "com.amazonaws.backup#CancelLegalHold" }, { "target": "com.amazonaws.backup#CreateBackupAccessPoint" }, { "target": "com.amazonaws.backup#CreateBackupPlan" }, { "target": "com.amazonaws.backup#CreateBackupSelection" }, { "target": "com.amazonaws.backup#CreateBackupVault" }, { "target": "com.amazonaws.backup#CreateFramework" }, { "target": "com.amazonaws.backup#CreateLegalHold" }, { "target": "com.amazonaws.backup#CreateLogicallyAirGappedBackupVault" }, { "target": "com.amazonaws.backup#CreateReportPlan" }, { "target": "com.amazonaws.backup#CreateRestoreAccessBackupVault" }, { "target": "com.amazonaws.backup#CreateRestoreTestingPlan" }, { "target": "com.amazonaws.backup#CreateRestoreTestingSelection" }, { "target": "com.amazonaws.backup#CreateTieringConfiguration" }, { "target": "com.amazonaws.backup#DeleteBackupAccessPoint" }, { "target": "com.amazonaws.backup#DeleteBackupPlan" }, { "target": "com.amazonaws.backup#DeleteBackupSelection" }, { "target": "com.amazonaws.backup#DeleteBackupVault" }, { "target": "com.amazonaws.backup#DeleteBackupVaultAccessPolicy" }, { "target": "com.amazonaws.backup#DeleteBackupVaultLockConfiguration" }, { "target": "com.amazonaws.backup#DeleteBackupVaultNotifications" }, { "target": "com.amazonaws.backup#DeleteFramework" }, { "target": "com.amazonaws.backup#DeleteRecoveryPoint" }, { "target": "com.amazonaws.backup#DeleteReportPlan" }, { "target": "com.amazonaws.backup#DeleteRestoreTestingPlan" }, { "target": "com.amazonaws.backup#DeleteRestoreTestingSelection" }, { "target": "com.amazonaws.backup#DeleteTieringConfiguration" }, { "target": "com.amazonaws.backup#DescribeBackupAccessPoint" }, { "target": "com.amazonaws.backup#DescribeBackupJob" }, { "target": "com.amazonaws.backup#DescribeBackupVault" }, { "target": "com.amazonaws.backup#DescribeCopyJob" }, { "target": "com.amazonaws.backup#DescribeFramework" }, { "target": "com.amazonaws.backup#DescribeGlobalSettings" }, { "target": "com.amazonaws.backup#DescribeProtectedResource" }, { "target": "com.amazonaws.backup#DescribeRecoveryPoint" }, { "target": "com.amazonaws.backup#DescribeRegionSettings" }, { "target": "com.amazonaws.backup#DescribeReportJob" }, { "target": "com.amazonaws.backup#DescribeReportPlan" }, { "target": "com.amazonaws.backup#DescribeRestoreJob" }, { "target": "com.amazonaws.backup#DescribeScanJob" }, { "target": "com.amazonaws.backup#DisassociateBackupVaultMpaApprovalTeam" }, { "target": "com.amazonaws.backup#DisassociateRecoveryPoint" }, { "target": "com.amazonaws.backup#DisassociateRecoveryPointFromParent" }, { "target": "com.amazonaws.backup#ExportBackupPlanTemplate" }, { "target": "com.amazonaws.backup#GetBackupPlan" }, { "target": "com.amazonaws.backup#GetBackupPlanFromJSON" }, { "target": "com.amazonaws.backup#GetBackupPlanFromTemplate" }, { "target": "com.amazonaws.backup#GetBackupSelection" }, { "target": "com.amazonaws.backup#GetBackupVaultAccessPolicy" }, { "target": "com.amazonaws.backup#GetBackupVaultNotifications" }, { "target": "com.amazonaws.backup#GetLegalHold" }, { "target": "com.amazonaws.backup#GetPITRMalwareScanResults" }, { "target": "com.amazonaws.backup#GetRecoveryPointIndexDetails" }, { "target": "com.amazonaws.backup#GetRecoveryPointRestoreMetadata" }, { "target": "com.amazonaws.backup#GetRestoreJobMetadata" }, { "target": "com.amazonaws.backup#GetRestoreTestingInferredMetadata" }, { "target": "com.amazonaws.backup#GetRestoreTestingPlan" }, { "target": "com.amazonaws.backup#GetRestoreTestingSelection" }, { "target": "com.amazonaws.backup#GetSupportedResourceTypes" }, { "target": "com.amazonaws.backup#GetTieringConfiguration" }, { "target": "com.amazonaws.backup#ListBackupAccessPoints" }, { "target": "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPoint" }, { "target": "com.amazonaws.backup#ListBackupAccessPointsByResource" }, { "target": "com.amazonaws.backup#ListBackupJobs" }, { "target": "com.amazonaws.backup#ListBackupJobSummaries" }, { "target": "com.amazonaws.backup#ListBackupPlans" }, { "target": "com.amazonaws.backup#ListBackupPlanTemplates" }, { "target": "com.amazonaws.backup#ListBackupPlanVersions" }, { "target": "com.amazonaws.backup#ListBackupSelections" }, { "target": "com.amazonaws.backup#ListBackupVaults" }, { "target": "com.amazonaws.backup#ListCopyJobs" }, { "target": "com.amazonaws.backup#ListCopyJobSummaries" }, { "target": "com.amazonaws.backup#ListFrameworks" }, { "target": "com.amazonaws.backup#ListIndexedRecoveryPoints" }, { "target": "com.amazonaws.backup#ListLegalHolds" }, { "target": "com.amazonaws.backup#ListProtectedResources" }, { "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVault" }, { "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVault" }, { "target": "com.amazonaws.backup#ListRecoveryPointsByLegalHold" }, { "target": "com.amazonaws.backup#ListRecoveryPointsByResource" }, { "target": "com.amazonaws.backup#ListReportJobs" }, { "target": "com.amazonaws.backup#ListReportPlans" }, { "target": "com.amazonaws.backup#ListRestoreAccessBackupVaults" }, { "target": "com.amazonaws.backup#ListRestoreJobs" }, { "target": "com.amazonaws.backup#ListRestoreJobsByProtectedResource" }, { "target": "com.amazonaws.backup#ListRestoreJobSummaries" }, { "target": "com.amazonaws.backup#ListRestoreTestingPlans" }, { "target": "com.amazonaws.backup#ListRestoreTestingSelections" }, { "target": "com.amazonaws.backup#ListScanJobs" }, { "target": "com.amazonaws.backup#ListScanJobSummaries" }, { "target": "com.amazonaws.backup#ListTags" }, { "target": "com.amazonaws.backup#ListTieringConfigurations" }, { "target": "com.amazonaws.backup#PutBackupVaultAccessPolicy" }, { "target": "com.amazonaws.backup#PutBackupVaultLockConfiguration" }, { "target": "com.amazonaws.backup#PutBackupVaultNotifications" }, { "target": "com.amazonaws.backup#PutRestoreValidationResult" }, { "target": "com.amazonaws.backup#RevokeRestoreAccessBackupVault" }, { "target": "com.amazonaws.backup#StartBackupJob" }, { "target": "com.amazonaws.backup#StartCopyJob" }, { "target": "com.amazonaws.backup#StartReportJob" }, { "target": "com.amazonaws.backup#StartRestoreJob" }, { "target": "com.amazonaws.backup#StartScanJob" }, { "target": "com.amazonaws.backup#StopBackupJob" }, { "target": "com.amazonaws.backup#TagResource" }, { "target": "com.amazonaws.backup#UntagResource" }, { "target": "com.amazonaws.backup#UpdateBackupPlan" }, { "target": "com.amazonaws.backup#UpdateFramework" }, { "target": "com.amazonaws.backup#UpdateGlobalSettings" }, { "target": "com.amazonaws.backup#UpdateRecoveryPointIndexSettings" }, { "target": "com.amazonaws.backup#UpdateRecoveryPointLifecycle" }, { "target": "com.amazonaws.backup#UpdateRegionSettings" }, { "target": "com.amazonaws.backup#UpdateReportPlan" }, { "target": "com.amazonaws.backup#UpdateRestoreTestingPlan" }, { "target": "com.amazonaws.backup#UpdateRestoreTestingSelection" }, { "target": "com.amazonaws.backup#UpdateTieringConfiguration" } ], "traits": { "aws.api#service": { "sdkId": "Backup", "arnNamespace": "backup", "cloudFormationName": "Backup", "cloudTrailEventSource": "backup.amazonaws.com", "endpointPrefix": "backup" }, "aws.auth#sigv4": { "name": "backup" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Backup\n

Backup is a unified backup service designed to protect Amazon Web Services\n services and their associated data. Backup simplifies the creation, migration,\n restoration, and deletion of backups, while also providing reporting and\n auditing.

", "smithy.api#title": "AWS Backup", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://backup-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://backup-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://backup.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://backup.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://backup-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://backup-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://backup.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://backup.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://backup-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://backup.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://backup-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://backup.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://backup-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://backup.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://backup.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.backup#DateRange": { "type": "structure", "members": { "FromDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

This value is the beginning date, inclusive.

\n

The date and time are in Unix format and Coordinated \n Universal Time (UTC), and it is accurate to milliseconds \n (milliseconds are optional).

", "smithy.api#required": {} } }, "ToDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

This value is the end date, inclusive.

\n

The date and time are in Unix format and Coordinated \n Universal Time (UTC), and it is accurate to milliseconds \n (milliseconds are optional).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

This is a resource filter containing FromDate: DateTime \n and ToDate: DateTime. Both values are required. Future DateTime \n values are not permitted.

\n

The date and time are in Unix format and Coordinated \n Universal Time (UTC), and it is accurate to milliseconds \n ((milliseconds are optional). \n For example, the value 1516925490.087 represents Friday, January \n 26, 2018 12:11:30.087 AM.

" } }, "com.amazonaws.backup#DeleteBackupAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteBackupAccessPointInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes a backup access point. This deletes the underlying Amazon S3 access point and, if no other\n backup access points remain for the recovery point, resumes lifecycle transitions for that recovery point.

\n

Always delete backup access points using this operation rather than deleting the underlying Amazon S3\n access point directly.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup-access-point/delete/{AccessPointArn}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteBackupAccessPointInput": { "type": "structure", "members": { "AccessPointArn": { "target": "com.amazonaws.backup#AccessPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup access point to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteBackupPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteBackupPlanInput" }, "output": { "target": "com.amazonaws.backup#DeleteBackupPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes a backup plan. A backup plan can only be deleted after all associated selections\n of resources have been deleted. Deleting a backup plan deletes the current version of a\n backup plan. Previous versions, if any, will still exist.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup/plans/{BackupPlanId}", "code": 200 } } }, "com.amazonaws.backup#DeleteBackupPlanInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteBackupPlanOutput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "BackupPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "DeletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup plan is deleted, in Unix format and Coordinated Universal\n Time (UTC). The value of DeletionDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "VersionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DeleteBackupSelection": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteBackupSelectionInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the resource selection associated with a backup plan that is specified by the\n SelectionId.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup/plans/{BackupPlanId}/selections/{SelectionId}", "code": 200 } } }, "com.amazonaws.backup#DeleteBackupSelectionInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteBackupVaultInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the backup vault identified by its name. A vault can be deleted only if it is\n empty.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup-vaults/{BackupVaultName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteBackupVaultAccessPolicy": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteBackupVaultAccessPolicyInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the policy document that manages permissions on a backup vault.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup-vaults/{BackupVaultName}/access-policy", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteBackupVaultAccessPolicyInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteBackupVaultInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteBackupVaultLockConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteBackupVaultLockConfigurationInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes Backup Vault Lock from a backup vault specified by a backup vault\n name.

\n

If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using\n API operations, and you will receive an InvalidRequestException if you attempt\n to do so. For more information, see Vault Lock in the\n Backup Developer Guide.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup-vaults/{BackupVaultName}/vault-lock", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteBackupVaultLockConfigurationInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault from which to delete Backup Vault Lock.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteBackupVaultNotifications": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteBackupVaultNotificationsInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes event notifications for the specified backup vault.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup-vaults/{BackupVaultName}/notification-configuration", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteBackupVaultNotificationsInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteFramework": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteFrameworkInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the framework specified by a framework name.

", "smithy.api#http": { "method": "DELETE", "uri": "/audit/frameworks/{FrameworkName}", "code": 200 } } }, "com.amazonaws.backup#DeleteFrameworkInput": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of a framework.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteRecoveryPointInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#InvalidResourceStateException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the recovery point specified by a recovery point ID.

\n

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes\n the existing continuous backup and stops future continuous backup.

\n

When an IAM role's permissions are insufficient to call this API, the service sends back\n an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted.\n Instead, it enters an EXPIRED state.

\n

\n EXPIRED recovery points can be deleted with this API once the IAM role\n has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see \n \n Troubleshooting manual deletions.

\n

If the user or role is deleted or the permission within the role is removed, \n the deletion will not be successful and will enter an EXPIRED state.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteRecoveryPointInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteReportPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteReportPlanInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the report plan specified by a report plan name.

", "smithy.api#http": { "method": "DELETE", "uri": "/audit/report-plans/{ReportPlanName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteReportPlanInput": { "type": "structure", "members": { "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of a report plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteRestoreTestingPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteRestoreTestingPlanInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request deletes the specified restore testing plan.

\n

Deletion can only successfully occur if all associated \n restore testing selections are deleted first.

", "smithy.api#http": { "method": "DELETE", "uri": "/restore-testing/plans/{RestoreTestingPlanName}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteRestoreTestingPlanInput": { "type": "structure", "members": { "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Required unique name of the restore testing plan you wish \n to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteRestoreTestingSelection": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteRestoreTestingSelectionInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Input the Restore Testing Plan name and Restore Testing Selection \n name.

\n

All testing selections associated with a restore testing plan must \n be deleted before the restore testing plan can be deleted.

", "smithy.api#http": { "method": "DELETE", "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteRestoreTestingSelectionInput": { "type": "structure", "members": { "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Required unique name of the restore testing plan that contains the \n restore testing selection you wish to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Required unique name of the restore testing selection you \n wish to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteTieringConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.backup#DeleteTieringConfigurationInput" }, "output": { "target": "com.amazonaws.backup#DeleteTieringConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the tiering configuration specified by a tiering configuration name.

", "smithy.api#http": { "method": "DELETE", "uri": "/tiering-configurations/{TieringConfigurationName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DeleteTieringConfigurationInput": { "type": "structure", "members": { "TieringConfigurationName": { "target": "com.amazonaws.backup#TieringConfigurationName", "traits": { "smithy.api#documentation": "

The unique name of a tiering configuration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DeleteTieringConfigurationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DependencyFailureException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

", "smithy.api#error": "server" } }, "com.amazonaws.backup#DescribeBackupAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeBackupAccessPointInput" }, "output": { "target": "com.amazonaws.backup#DescribeBackupAccessPointResponse" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns metadata about a backup access point, including its status and the details of the underlying\n Amazon S3 access point.

\n

After a backup access point reaches the AVAILABLE status, use this operation to retrieve the\n Amazon S3 access point ARN and alias that you need to read the backup data.

", "smithy.api#http": { "method": "GET", "uri": "/backup-access-point/{AccessPointArn}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.backup#DescribeBackupAccessPointInput": { "type": "structure", "members": { "AccessPointArn": { "target": "com.amazonaws.backup#AccessPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup access point to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeBackupAccessPointResponse": { "type": "structure", "members": { "AccessPointArn": { "target": "com.amazonaws.backup#AccessPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the backup access point.

", "smithy.api#required": {} } }, "AccessPointMetadata": { "target": "com.amazonaws.backup#AccessPointMetadataMap", "traits": { "smithy.api#documentation": "

Metadata for the backup access point. After the backup access point reaches the AVAILABLE\n status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with\n standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also\n contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point\n provides access to the content present in the backup at that specific time.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#BackupVaultArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault that contains the recovery point.

", "smithy.api#required": {} } }, "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the backup access point was created, in Unix format and Coordinated Universal Time\n (UTC). The value of CreationTime is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.backup#AccessPointName", "traits": { "smithy.api#documentation": "

The name of the backup access point.

", "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#RecoveryPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.

", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.backup#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.

", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource associated with the recovery point. For example, S3 for\n Amazon Simple Storage Service.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.backup#AccessPointStatus", "traits": { "smithy.api#documentation": "

The current status of the backup access point.

", "smithy.api#required": {} } }, "StatusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A message that provides additional detail about the status of the backup access point, such as the reason a\n creation or deletion attempt failed.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeBackupJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeBackupJobInput" }, "output": { "target": "com.amazonaws.backup#DescribeBackupJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#DependencyFailureException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns backup job details for the specified BackupJobId.

", "smithy.api#http": { "method": "GET", "uri": "/backup-jobs/{BackupJobId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DescribeBackupJobInput": { "type": "structure", "members": { "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeBackupJobOutput": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

Returns the account ID that owns the backup job.

" } }, "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

" } }, "RecoveryPointLifecycle": { "target": "com.amazonaws.backup#Lifecycle" }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "VaultType": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The type of backup vault where the recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.

" } }, "VaultLockState": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.

" } }, "IsEncrypted": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.

" } }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the\n resource type.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a job to create a backup job is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "State": { "target": "com.amazonaws.backup#BackupJobState", "traits": { "smithy.api#documentation": "

The current state of a backup job.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A detailed message explaining the status of the job to back up a resource.

" } }, "PercentDone": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Contains an estimated percentage that is complete of a job at the time the job status\n was queried.

" } }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of a backup (recovery point).

\n

This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the \n value returned may show a value of 0, which may differ from the \n anticipated value.

\n

The expected behavior for values by resource type are described as follows:

\n " } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#RecoveryPointCreator", "traits": { "smithy.api#documentation": "

Contains identifying information about the creation of a backup job, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan that is used to create it.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" } }, "BytesTransferred": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size in bytes transferred to a backup vault at the time that the job status was\n queried.

" } }, "ExpectedCompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a job to back up resources is expected to be completed, in Unix\n format and Coordinated Universal Time (UTC). The value of\n ExpectedCompletionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "StartBy": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job\n must be started before it is canceled. The value is calculated by adding the start window\n to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2\n hours, the StartBy time would be 8:00 PM on the date specified. The value of\n StartBy is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { "smithy.api#documentation": "

Represents the options specified as part of backup plan or on-demand backup job.

" } }, "BackupType": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Represents the actual backup type selected for a backup job. For example, if a\n successful Windows Volume Shadow Copy Service (VSS) backup was taken,\n BackupType returns \"WindowsVSS\". If BackupType is\n empty, then the backup type was a regular backup.

" } }, "ParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This returns the parent (composite) resource backup job ID.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This returns the boolean value that a backup job is a parent (composite) job.

" } }, "NumberOfChildJobs": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

This returns the number of child (nested) backup jobs.

" } }, "ChildJobsInState": { "target": "com.amazonaws.backup#BackupJobChildJobsInState", "traits": { "smithy.api#documentation": "

This returns the statistics of the included child (nested) backup jobs.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that \n belongs to the specified backup.

" } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date a backup job was initiated.

" } }, "MessageCategory": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The job count for the specified \n message category.

\n

Example strings may include AccessDenied, SUCCESS,\n AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring\n for a list of accepted MessageCategory strings.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeBackupVaultInput" }, "output": { "target": "com.amazonaws.backup#DescribeBackupVaultOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns metadata about a backup vault specified by its name.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DescribeBackupVaultInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupVaultAccountId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "backupVaultAccountId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeBackupVaultOutput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { "smithy.api#documentation": "

The type of vault described.

" } }, "VaultState": { "target": "com.amazonaws.backup#VaultState", "traits": { "smithy.api#documentation": "

The current state of the vault.->

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup vault is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional. If used, this\n parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } }, "NumberOfRecoveryPoints": { "target": "com.amazonaws.backup#Long2", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of recovery points that are stored in a backup vault.

\n

Recovery point count value displayed in the console can be an approximation. Use \n ListRecoveryPointsByBackupVault\n API to obtain the exact\n count.

" } }, "Locked": { "target": "com.amazonaws.backup#Boolean", "traits": { "smithy.api#documentation": "

A Boolean that indicates whether Backup Vault Lock is currently protecting\n the backup vault. True means that Vault Lock causes delete or update\n operations on the recovery points stored in the vault to fail.

" } }, "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The Backup Vault Lock setting that specifies the minimum retention period\n that the vault retains its recovery points. If this\n parameter is not specified, Vault Lock will not enforce a minimum retention period.

\n

If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or longer than the minimum retention period. If the job's\n retention period is shorter than that minimum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.

" } }, "MaxRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The Backup Vault Lock setting that specifies the maximum retention period\n that the vault retains its recovery points. If this parameter is not specified, Vault Lock\n does not enforce a maximum retention period on the recovery points in the vault (allowing\n indefinite storage).

\n

If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or shorter than the maximum retention period. If the job's\n retention period is longer than that maximum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.

" } }, "LockDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when Backup Vault Lock configuration cannot be changed or\n deleted.

\n

If you applied Vault Lock to your vault without specifying a lock date, you can change\n any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any\n time.

\n

This value is in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the source backup vault from which this restore access backup vault was created.

" } }, "MpaApprovalTeamArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the MPA approval team associated with this backup vault.

" } }, "MpaSessionArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the MPA session associated with this backup vault.

" } }, "LatestMpaApprovalTeamUpdate": { "target": "com.amazonaws.backup#LatestMpaApprovalTeamUpdate", "traits": { "smithy.api#documentation": "

Information about the latest update to the MPA approval team association for this backup vault.

" } }, "EncryptionKeyType": { "target": "com.amazonaws.backup#EncryptionKeyType", "traits": { "smithy.api#documentation": "

The type of encryption key used for the backup vault. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeCopyJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeCopyJobInput" }, "output": { "target": "com.amazonaws.backup#DescribeCopyJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns metadata associated with creating a copy of a resource.

", "smithy.api#http": { "method": "GET", "uri": "/copy-jobs/{CopyJobId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DescribeCopyJobInput": { "type": "structure", "members": { "CopyJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a copy job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeCopyJobOutput": { "type": "structure", "members": { "CopyJob": { "target": "com.amazonaws.backup#CopyJob", "traits": { "smithy.api#documentation": "

Contains detailed information about a copy job.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeFramework": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeFrameworkInput" }, "output": { "target": "com.amazonaws.backup#DescribeFrameworkOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the framework details for the specified FrameworkName.

", "smithy.api#http": { "method": "GET", "uri": "/audit/frameworks/{FrameworkName}", "code": 200 } } }, "com.amazonaws.backup#DescribeFrameworkInput": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of a framework.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeFrameworkOutput": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of a framework.

" } }, "FrameworkArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "FrameworkDescription": { "target": "com.amazonaws.backup#FrameworkDescription", "traits": { "smithy.api#documentation": "

An optional description of the framework.

" } }, "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { "smithy.api#documentation": "

The controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example,\n 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind\n UTC.

" } }, "DeploymentStatus": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The deployment status of a framework. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED |\n FAILED\n

" } }, "FrameworkStatus": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A framework consists of one or more controls. Each control governs a resource, such as\n backup plans, backup selections, backup vaults, or recovery points. You can also turn\n Config recording on or off for each resource. The statuses are:

\n " } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to DescribeFrameworkOutput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeGlobalSettings": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeGlobalSettingsInput" }, "output": { "target": "com.amazonaws.backup#DescribeGlobalSettingsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Describes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2\n

", "smithy.api#http": { "method": "GET", "uri": "/global-settings", "code": 200 } } }, "com.amazonaws.backup#DescribeGlobalSettingsInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeGlobalSettingsOutput": { "type": "structure", "members": { "GlobalSettings": { "target": "com.amazonaws.backup#GlobalSettings", "traits": { "smithy.api#documentation": "

The status of the flags isCrossAccountBackupEnabled, isMpaEnabled ('Mpa' refers to multi-party approval), and isDelegatedAdministratorEnabled.

\n " } }, "LastUpdateTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that the supported flags were last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeProtectedResource": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeProtectedResourceInput" }, "output": { "target": "com.amazonaws.backup#DescribeProtectedResourceOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns information about a saved resource, including the last time it was backed up,\n its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved\n resource.

", "smithy.api#http": { "method": "GET", "uri": "/resources/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DescribeProtectedResourceInput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeProtectedResourceOutput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an\n Amazon EBS volume or an Amazon RDS database.

" } }, "LastBackupTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a resource was last backed up, in Unix format and Coordinated\n Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The name of the resource that belongs to the specified backup.

" } }, "LastBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

" } }, "LastRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the most recent \n recovery point.

" } }, "LatestRestoreExecutionTimeMinutes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The time, in minutes, that the most recent restore job took to complete.

" } }, "LatestRestoreJobCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The creation date of the most recent restore job.

" } }, "LatestRestoreRecoveryPointCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date the most recent recovery point was created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeRecoveryPointInput" }, "output": { "target": "com.amazonaws.backup#DescribeRecoveryPointOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns metadata associated with a recovery point, including ID, status, encryption, and\n lifecycle.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DescribeRecoveryPointInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "backupVaultAccountId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeRecoveryPointOutput": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the\n resource was originally backed up in; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. If the recovery is\n restored to the same Amazon Web Services account or Region, this value will be\n null.

" } }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the\n resource type.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource to save as a recovery point; for example, an\n Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#RecoveryPointCreator", "traits": { "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan used to create it.

" } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, "Status": { "target": "com.amazonaws.backup#RecoveryPointStatus", "traits": { "smithy.api#documentation": "

A status code specifying the state of the recovery point. For more information, see \n \n Recovery point status in the Backup Developer \n Guide.

\n " } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A status message explaining the status of the recovery point.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a recovery point is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the backup job that created this recovery point was initiated, in\n Unix format and Coordinated Universal Time (UTC).

" } }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a job to create a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of a backup.

" } }, "CalculatedLifecycle": { "target": "com.amazonaws.backup#CalculatedLifecycle", "traits": { "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the\n \u201ctransition to cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot\n be changed after a backup has been transitioned to cold.

\n

Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for other resource types.

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The server-side encryption key used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, "IsEncrypted": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is\n encrypted, or FALSE if the recovery point is not encrypted.

" } }, "StorageClass": { "target": "com.amazonaws.backup#StorageClass", "traits": { "smithy.api#documentation": "

Specifies the storage class of the recovery point. Valid values are WARM or\n COLD.

" } }, "LastRestoreTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a recovery point was last restored, in Unix format and\n Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "ParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

This is an ARN that uniquely identifies a parent (composite) recovery point; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from the \n logical ID within a stack.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This returns the boolean value that a recovery point is a parent (composite) job.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The name of the resource that belongs to the specified backup.

" } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { "smithy.api#documentation": "

The type of vault in which the described recovery point is stored.

" } }, "IndexStatus": { "target": "com.amazonaws.backup#IndexStatus", "traits": { "smithy.api#documentation": "

This is the current status for the backup index associated with the specified recovery\n point.

\n

Statuses are: PENDING | ACTIVE | FAILED |\n DELETING\n

\n

A recovery point with an index that has the status of ACTIVE can be\n included in a search.

" } }, "IndexStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A string in the form of a detailed message explaining the status of a backup index\n associated with the recovery point.

" } }, "EncryptionKeyType": { "target": "com.amazonaws.backup#EncryptionKeyType", "traits": { "smithy.api#documentation": "

The type of encryption key used for the recovery point. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.

" } }, "ScanResults": { "target": "com.amazonaws.backup#ScanResults", "traits": { "smithy.api#documentation": "

Contains the latest scanning results against the recovery point and currently include MalwareScanner, ScanJobState, Findings, and LastScanTimestamp\n

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeRegionSettings": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeRegionSettingsInput" }, "output": { "target": "com.amazonaws.backup#DescribeRegionSettingsOutput" }, "errors": [ { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the current service opt-in settings for the Region. If service opt-in is enabled\n for a service, Backup tries to protect that service's resources in this Region,\n when the resource is included in an on-demand backup or scheduled backup plan. Otherwise,\n Backup does not try to protect that service's resources in this\n Region.

", "smithy.api#http": { "method": "GET", "uri": "/account-settings", "code": 200 } } }, "com.amazonaws.backup#DescribeRegionSettingsInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeRegionSettingsOutput": { "type": "structure", "members": { "ResourceTypeOptInPreference": { "target": "com.amazonaws.backup#ResourceTypeOptInPreference", "traits": { "smithy.api#documentation": "

The services along with the opt-in preferences in the Region.

" } }, "ResourceTypeManagementPreference": { "target": "com.amazonaws.backup#ResourceTypeManagementPreference", "traits": { "smithy.api#documentation": "

Returns whether Backup fully manages the backups for a resource type.

\n

For the benefits of full Backup management, see Full Backup \n management.

\n

For a list of resource types and whether each supports full Backup management, \n see the Feature availability by resource table.

\n

If \"DynamoDB\":false, you can enable full Backup management for\n DynamoDB backup by enabling \n Backup's advanced DynamoDB backup features.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeReportJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeReportJobInput" }, "output": { "target": "com.amazonaws.backup#DescribeReportJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the details associated with creating a report as specified by its\n ReportJobId.

", "smithy.api#http": { "method": "GET", "uri": "/audit/report-jobs/{ReportJobId}", "code": 200 } } }, "com.amazonaws.backup#DescribeReportJobInput": { "type": "structure", "members": { "ReportJobId": { "target": "com.amazonaws.backup#ReportJobId", "traits": { "smithy.api#documentation": "

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. The report job ID cannot be edited.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeReportJobOutput": { "type": "structure", "members": { "ReportJob": { "target": "com.amazonaws.backup#ReportJob", "traits": { "smithy.api#documentation": "

The information about a report job, including its completion and creation times,\n report destination, unique report job ID, Amazon Resource Name (ARN), report template,\n status, and status message.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeReportPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeReportPlanInput" }, "output": { "target": "com.amazonaws.backup#DescribeReportPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

", "smithy.api#http": { "method": "GET", "uri": "/audit/report-plans/{ReportPlanName}", "code": 200 } } }, "com.amazonaws.backup#DescribeReportPlanInput": { "type": "structure", "members": { "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of a report plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeReportPlanOutput": { "type": "structure", "members": { "ReportPlan": { "target": "com.amazonaws.backup#ReportPlan", "traits": { "smithy.api#documentation": "

Returns details about the report plan that is specified by its name. These details\n include the report plan's Amazon Resource Name (ARN), description, settings, delivery\n channel, deployment status, creation time, and last attempted and successful run\n times.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeRestoreJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeRestoreJobInput" }, "output": { "target": "com.amazonaws.backup#DescribeRestoreJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#DependencyFailureException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns metadata associated with a restore job that is specified by a job ID.

", "smithy.api#http": { "method": "GET", "uri": "/restore-jobs/{RestoreJobId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DescribeRestoreJobInput": { "type": "structure", "members": { "RestoreJobId": { "target": "com.amazonaws.backup#RestoreJobId", "traits": { "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeRestoreJobOutput": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

Returns the account ID that owns the restore job.

" } }, "RestoreJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "SourceResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a restore job is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a job to restore a recovery point is completed, in Unix format\n and Coordinated Universal Time (UTC). The value of CompletionDate is accurate\n to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "Status": { "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { "smithy.api#documentation": "

Status code specifying the state of the job that is initiated by Backup to\n restore a recovery point.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A message showing the status of a job to restore a recovery point.

" } }, "PercentDone": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Contains an estimated percentage that is complete of a job at the time the job status\n was queried.

" } }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, "ExpectedCompletionTimeMinutes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to\n take.

" } }, "CreatedResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that \n was created by the restore job.

\n

The format of the ARN depends on the resource type of the backed-up\n resource.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns metadata associated with a restore job listed by resource type.

" } }, "RecoveryPointCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The creation date of the recovery point made by the specifed restore job.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#RestoreJobCreator", "traits": { "smithy.api#documentation": "

Contains identifying information about the creation of a restore job.

" } }, "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { "smithy.api#documentation": "

The status of validation run on the indicated \n restore job.

" } }, "ValidationStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The status message.

" } }, "DeletionStatus": { "target": "com.amazonaws.backup#RestoreDeletionStatus", "traits": { "smithy.api#documentation": "

The status of the data generated by the restore test.

" } }, "DeletionStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This describes the restore job deletion status.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a boolean value indicating whether the restore job is a parent (composite) restore job.

" } }, "ParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is the unique identifier of the parent restore job for the selected restore job.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DescribeScanJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#DescribeScanJobInput" }, "output": { "target": "com.amazonaws.backup#DescribeScanJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns scan job details for the specified ScanJobID.

", "smithy.api#http": { "method": "GET", "uri": "/scan/jobs/{ScanJobId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#DescribeScanJobInput": { "type": "structure", "members": { "ScanJobId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to scan a resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DescribeScanJobOutput": { "type": "structure", "members": { "AccountId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Returns the account ID that owns the scan job.

\n

Pattern: ^[0-9]{12}$\n

", "smithy.api#required": {} } }, "BackupVaultArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault\n

", "smithy.api#required": {} } }, "BackupVaultName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are \n unique to the account used to create them and the Amazon Web Services Region where they are created.

\n

Pattern: ^[a-zA-Z0-9\\-\\_\\.]{2,50}$\n

", "smithy.api#required": {} } }, "CompletionDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup index finished creation, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "ContinuousScanEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The point in time the scan job scanned up to for a continuous backup.

" } }, "ContinuousScanStartTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The point in time the scan job started scan from for a continuous backup.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#ScanJobCreator", "traits": { "smithy.api#required": {} } }, "CreationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup index finished creation, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

The scanning engine used for the corresponding scan job. Currently only GUARDUTY is supported.

", "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the target recovery point for scanning.; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#required": {} } }, "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the source resource of the corresponding recovery point ARN.

", "smithy.api#required": {} } }, "ResourceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that belongs to the specified backup.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.backup#ScanResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

\n

Pattern: ^[a-zA-Z0-9\\-\\_\\.]{1,50}$\n

", "smithy.api#required": {} } }, "ScanBaseRecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the base recovery point for scanning. This field will only be populated when an incremental scan job has taken place.

" } }, "ScanId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

" } }, "ScanJobId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The scan job ID that uniquely identified the request to Backup.

", "smithy.api#required": {} } }, "ScanMode": { "target": "com.amazonaws.backup#ScanMode", "traits": { "smithy.api#documentation": "

Specifies the scan type used for the scan job.

", "smithy.api#required": {} } }, "ScanResult": { "target": "com.amazonaws.backup#ScanResultInfo", "traits": { "smithy.api#documentation": "

\n Contains the ScanResultsStatus for the scanning job and returns THREATS_FOUND or NO_THREATS_FOUND for completed jobs.

" } }, "ScannerRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Specifies the scanner IAM role ARN used to for the scan job.

", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.backup#ScanState", "traits": { "smithy.api#documentation": "

The current state of a scan job.

", "smithy.api#required": {} } }, "StatusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A detailed message explaining the status of the job to back up a resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#DisassociateBackupVaultMpaApprovalTeam": { "type": "operation", "input": { "target": "com.amazonaws.backup#DisassociateBackupVaultMpaApprovalTeamInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.

", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/mpaApprovalTeam?delete", "code": 204 } } }, "com.amazonaws.backup#DisassociateBackupVaultMpaApprovalTeamInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault from which to disassociate the MPA approval team.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RequesterComment": { "target": "com.amazonaws.backup#RequesterComment", "traits": { "smithy.api#documentation": "

An optional comment explaining the reason for disassociating the MPA approval team from the backup vault.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DisassociateRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.backup#DisassociateRecoveryPointInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#InvalidResourceStateException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified continuous backup recovery point from Backup and\n releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the\n lifecycle that you specified in your original backup plan.

\n

Does not support snapshot backup recovery points.

", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/disassociate", "code": 200 } } }, "com.amazonaws.backup#DisassociateRecoveryPointFromParent": { "type": "operation", "input": { "target": "com.amazonaws.backup#DisassociateRecoveryPointFromParentInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This action to a specific child (nested) recovery point removes the relationship \n between the specified recovery point and its parent (composite) recovery point.

", "smithy.api#http": { "method": "DELETE", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/parentAssociation", "code": 204 } } }, "com.amazonaws.backup#DisassociateRecoveryPointFromParentInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where the child (nested) recovery point\n is stored. Backup vaults are identified by names that are unique to the account used \n to create them and the Amazon Web Services Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the child \n (nested) recovery point; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#DisassociateRecoveryPointInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The unique name of an Backup vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery\n point.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#EncryptionKeyType": { "type": "enum", "members": { "AWS_OWNED_KMS_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_OWNED_KMS_KEY" } }, "CUSTOMER_MANAGED_KMS_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED_KMS_KEY" } } } }, "com.amazonaws.backup#ExportBackupPlanTemplate": { "type": "operation", "input": { "target": "com.amazonaws.backup#ExportBackupPlanTemplateInput" }, "output": { "target": "com.amazonaws.backup#ExportBackupPlanTemplateOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the backup plan that is specified by the plan ID as a backup template.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans/{BackupPlanId}/toTemplate", "code": 200 } } }, "com.amazonaws.backup#ExportBackupPlanTemplateInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ExportBackupPlanTemplateOutput": { "type": "structure", "members": { "BackupPlanTemplateJson": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The body of a backup plan template in JSON format.

\n \n

This is a signed JSON document that cannot be modified before being passed to\n GetBackupPlanFromJSON.\n

\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#FormatList": { "type": "list", "member": { "target": "com.amazonaws.backup#string" } }, "com.amazonaws.backup#Framework": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with\n a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" } }, "FrameworkArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "FrameworkDescription": { "target": "com.amazonaws.backup#FrameworkDescription", "traits": { "smithy.api#documentation": "

An optional description of the framework with a maximum 1,024 characters.

" } }, "NumberOfControls": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of controls contained by the framework.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a framework is created, in ISO 8601 representation. \n The value of CreationTime is accurate to milliseconds. For example,\n 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind\n UTC.

" } }, "DeploymentStatus": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The deployment status of a framework. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED |\n FAILED\n

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a framework. Frameworks contain controls, which\n evaluate and report on your backup events and resources. Frameworks generate daily\n compliance results.

" } }, "com.amazonaws.backup#FrameworkControl": { "type": "structure", "members": { "ControlName": { "target": "com.amazonaws.backup#ControlName", "traits": { "smithy.api#documentation": "

The name of a control. This name is between 1 and 256 characters.

", "smithy.api#required": {} } }, "ControlInputParameters": { "target": "com.amazonaws.backup#ControlInputParameters", "traits": { "smithy.api#documentation": "

The name/value pairs.

" } }, "ControlScope": { "target": "com.amazonaws.backup#ControlScope", "traits": { "smithy.api#documentation": "

The scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans.

\n

For more information, see \n ControlScope.\n

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about all of the controls of a framework. Each framework\n must contain at least one control.

" } }, "com.amazonaws.backup#FrameworkControls": { "type": "list", "member": { "target": "com.amazonaws.backup#FrameworkControl" } }, "com.amazonaws.backup#FrameworkDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.backup#FrameworkList": { "type": "list", "member": { "target": "com.amazonaws.backup#Framework" } }, "com.amazonaws.backup#FrameworkName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z][_a-zA-Z0-9]*$" } }, "com.amazonaws.backup#GetBackupPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetBackupPlanInput" }, "output": { "target": "com.amazonaws.backup#GetBackupPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns BackupPlan details for the specified BackupPlanId. The\n details are the body of a backup plan in JSON format, in addition to plan metadata.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans/{BackupPlanId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetBackupPlanFromJSON": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetBackupPlanFromJSONInput" }, "output": { "target": "com.amazonaws.backup#GetBackupPlanFromJSONOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a valid JSON document specifying a backup plan or an error.

", "smithy.api#http": { "method": "POST", "uri": "/backup/template/json/toPlan", "code": 200 } } }, "com.amazonaws.backup#GetBackupPlanFromJSONInput": { "type": "structure", "members": { "BackupPlanTemplateJson": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-supplied backup plan document in JSON format.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetBackupPlanFromJSONOutput": { "type": "structure", "members": { "BackupPlan": { "target": "com.amazonaws.backup#BackupPlan", "traits": { "smithy.api#documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetBackupPlanFromTemplate": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetBackupPlanFromTemplateInput" }, "output": { "target": "com.amazonaws.backup#GetBackupPlanFromTemplateOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the template specified by its templateId as a backup plan.

", "smithy.api#http": { "method": "GET", "uri": "/backup/template/plans/{BackupPlanTemplateId}/toPlan", "code": 200 } } }, "com.amazonaws.backup#GetBackupPlanFromTemplateInput": { "type": "structure", "members": { "BackupPlanTemplateId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a stored backup plan template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetBackupPlanFromTemplateOutput": { "type": "structure", "members": { "BackupPlanDocument": { "target": "com.amazonaws.backup#BackupPlan", "traits": { "smithy.api#documentation": "

Returns the body of a backup plan based on the target template, including the name,\n rules, and backup vault of the plan.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetBackupPlanInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

", "smithy.api#httpQuery": "versionId" } }, "MaxScheduledRunsPreview": { "target": "com.amazonaws.backup#MaxScheduledRunsPreview", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

Number of future scheduled backup runs to preview. When set to 0 (default), no scheduled runs preview is included in the response. Valid range is 0-10.

", "smithy.api#httpQuery": "MaxScheduledRunsPreview" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetBackupPlanOutput": { "type": "structure", "members": { "BackupPlan": { "target": "com.amazonaws.backup#BackupPlan", "traits": { "smithy.api#documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

" } }, "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "BackupPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "VersionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "DeletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup plan is deleted, in Unix format and Coordinated\n Universal Time (UTC). The value of DeletionDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "LastExecutionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The last time this backup plan was run. A date and time,\n in Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { "smithy.api#documentation": "

Contains a list of BackupOptions for each resource type. The list is\n populated only if the advanced option is set for the backup plan.

" } }, "ScheduledRunsPreview": { "target": "com.amazonaws.backup#ScheduledRunsPreview", "traits": { "smithy.api#documentation": "

List of upcoming scheduled backup runs. Only included when MaxScheduledRunsPreview parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetBackupSelection": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetBackupSelectionInput" }, "output": { "target": "com.amazonaws.backup#GetBackupSelectionOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns selection metadata and a document in JSON format that specifies a list of\n resources that are associated with a backup plan.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans/{BackupPlanId}/selections/{SelectionId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetBackupSelectionInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetBackupSelectionOutput": { "type": "structure", "members": { "BackupSelection": { "target": "com.amazonaws.backup#BackupSelection", "traits": { "smithy.api#documentation": "

Specifies the body of a request to assign a set of resources to a backup plan.

" } }, "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

" } }, "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup selection is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetBackupVaultAccessPolicy": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetBackupVaultAccessPolicyInput" }, "output": { "target": "com.amazonaws.backup#GetBackupVaultAccessPolicyOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the access policy document that is associated with the named backup\n vault.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}/access-policy", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetBackupVaultAccessPolicyInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetBackupVaultAccessPolicyOutput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "Policy": { "target": "com.amazonaws.backup#IAMPolicy", "traits": { "smithy.api#documentation": "

The backup vault access policy document in JSON format.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetBackupVaultNotifications": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetBackupVaultNotificationsInput" }, "output": { "target": "com.amazonaws.backup#GetBackupVaultNotificationsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns event notifications for the specified backup vault.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}/notification-configuration", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetBackupVaultNotificationsInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetBackupVaultNotificationsOutput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "SNSTopicArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS)\n topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

" } }, "BackupVaultEvents": { "target": "com.amazonaws.backup#BackupVaultEvents", "traits": { "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup\n vault.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetLegalHold": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetLegalHoldInput" }, "output": { "target": "com.amazonaws.backup#GetLegalHoldOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This action returns details for a specified legal hold. The details are the \n body of a legal hold in JSON format, in addition to metadata.

", "smithy.api#http": { "method": "GET", "uri": "/legal-holds/{LegalHoldId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetLegalHoldInput": { "type": "structure", "members": { "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the legal hold.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetLegalHoldOutput": { "type": "structure", "members": { "Title": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The title of the legal hold.

" } }, "Status": { "target": "com.amazonaws.backup#LegalHoldStatus", "traits": { "smithy.api#documentation": "

The status of the legal hold.

" } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The description of the legal hold.

" } }, "CancelDescription": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The reason for removing the legal hold.

" } }, "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the legal hold.

" } }, "LegalHoldArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The framework ARN for the specified legal hold. The format \n of the ARN depends on the resource type.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The time when the legal hold was created.

" } }, "CancellationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The time when the legal hold was cancelled.

" } }, "RetainRecordUntil": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time until which the legal hold record is retained.

" } }, "RecoveryPointSelection": { "target": "com.amazonaws.backup#RecoveryPointSelection", "traits": { "smithy.api#documentation": "

The criteria to assign a set of resources, such as resource types or backup vaults.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetPITRMalwareScanResults": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetPITRMalwareScanResultsInput" }, "output": { "target": "com.amazonaws.backup#GetPITRMalwareScanResultsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the malware scan results for a specified point in time within a continuous (point-in-time recovery) backup.

", "smithy.api#http": { "method": "GET", "uri": "/scan/pitr-malware-scan-results", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetPITRMalwareScanResultsInput": { "type": "structure", "members": { "RecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the target recovery point for scanning; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#httpQuery": "RecoveryPointArn", "smithy.api#required": {} } }, "BackupVaultName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpQuery": "BackupVaultName", "smithy.api#required": {} } }, "ScanEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The point in time within the continuous backup to examine for malware scan results.

", "smithy.api#httpQuery": "ScanEndTime", "smithy.api#required": {} } }, "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

The scanning engine used for the corresponding scan job. Currently only GUARDDUTY is supported.

", "smithy.api#httpQuery": "MalwareScanner", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetPITRMalwareScanResultsOutput": { "type": "structure", "members": { "ScanEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The point in time that was queried. This echoes back the time specified in the request.

", "smithy.api#required": {} } }, "ScanResult": { "target": "com.amazonaws.backup#ScanResultInfo", "traits": { "smithy.api#documentation": "

Contains the ScanResultStatus for the scan and returns THREATS_FOUND, NO_THREATS_FOUND, or UNKNOWN.

", "smithy.api#required": {} } }, "LastScanJobTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The completion time of the most recent scan job that covered the specified point in time.

" } }, "ScanId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

" } }, "ScanMode": { "target": "com.amazonaws.backup#ScanMode", "traits": { "smithy.api#documentation": "

Specifies the scan type used for the scan job.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetRecoveryPointIndexDetails": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetRecoveryPointIndexDetailsInput" }, "output": { "target": "com.amazonaws.backup#GetRecoveryPointIndexDetailsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This operation returns the metadata and details specific to \n the backup index associated with the specified recovery point.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/index", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetRecoveryPointIndexDetailsInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

\n

Accepted characters include lowercase letters, numbers, and hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetRecoveryPointIndexDetailsOutput": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the backup vault where the recovery \n point index is stored.

\n

For example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "SourceResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

A string of the Amazon Resource Name (ARN) that uniquely identifies \n the source resource.

" } }, "IndexCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup index was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "IndexDeletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup index was deleted, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "IndexCompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup index finished creation, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "IndexStatus": { "target": "com.amazonaws.backup#IndexStatus", "traits": { "smithy.api#documentation": "

This is the current status for the backup index associated \n with the specified recovery point.

\n

Statuses are: PENDING | ACTIVE | FAILED | DELETING\n

\n

A recovery point with an index that has the status of ACTIVE \n can be included in a search.

" } }, "IndexStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A detailed message explaining the status of a backup index associated \n with the recovery point.

" } }, "TotalItemsIndexed": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

Count of items within the backup index associated with the \n recovery point.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetRecoveryPointRestoreMetadata": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetRecoveryPointRestoreMetadataInput" }, "output": { "target": "com.amazonaws.backup#GetRecoveryPointRestoreMetadataOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a set of metadata key-value pairs that were used to create the backup.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/restore-metadata", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetRecoveryPointRestoreMetadataInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "backupVaultAccountId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetRecoveryPointRestoreMetadataOutput": { "type": "structure", "members": { "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "RestoreMetadata": { "target": "com.amazonaws.backup#Metadata", "traits": { "smithy.api#documentation": "

The set of metadata key-value pairs that describe the original configuration of the\n backed-up resource. These values vary depending on the service that is being\n restored.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The resource type of the recovery point.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetRestoreJobMetadata": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetRestoreJobMetadataInput" }, "output": { "target": "com.amazonaws.backup#GetRestoreJobMetadataOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request returns the metadata for the specified restore job.

", "smithy.api#http": { "method": "GET", "uri": "/restore-jobs/{RestoreJobId}/metadata", "code": 200 } } }, "com.amazonaws.backup#GetRestoreJobMetadataInput": { "type": "structure", "members": { "RestoreJobId": { "target": "com.amazonaws.backup#RestoreJobId", "traits": { "smithy.api#documentation": "

This is a unique identifier of a restore job within Backup.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetRestoreJobMetadataOutput": { "type": "structure", "members": { "RestoreJobId": { "target": "com.amazonaws.backup#RestoreJobId", "traits": { "smithy.api#documentation": "

This is a unique identifier of a restore job within Backup.

" } }, "Metadata": { "target": "com.amazonaws.backup#Metadata", "traits": { "smithy.api#documentation": "

This contains the metadata of the specified backup job.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetRestoreTestingInferredMetadata": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetRestoreTestingInferredMetadataInput" }, "output": { "target": "com.amazonaws.backup#GetRestoreTestingInferredMetadataOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request returns the minimal required set of metadata needed to \n start a restore job with secure default settings. BackupVaultName \n and RecoveryPointArn are required parameters. \n BackupVaultAccountId is an optional parameter.

", "smithy.api#http": { "method": "GET", "uri": "/restore-testing/inferred-metadata", "code": 200 } } }, "com.amazonaws.backup#GetRestoreTestingInferredMetadataInput": { "type": "structure", "members": { "BackupVaultAccountId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "BackupVaultAccountId" } }, "BackupVaultName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup \n vaults are identified by names that are unique to the account used to \n create them and the Amazon Web ServicesRegion where they are created. \n They consist of letters, numbers, and hyphens.

", "smithy.api#httpQuery": "BackupVaultName", "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery \n point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.\n

", "smithy.api#httpQuery": "RecoveryPointArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetRestoreTestingInferredMetadataOutput": { "type": "structure", "members": { "InferredMetadata": { "target": "com.amazonaws.backup#stringMap", "traits": { "smithy.api#documentation": "

This is a string map of the metadata inferred from the request.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetRestoreTestingPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetRestoreTestingPlanInput" }, "output": { "target": "com.amazonaws.backup#GetRestoreTestingPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns RestoreTestingPlan details for the specified\n RestoreTestingPlanName. The details are the body of a restore testing plan\n in JSON format, in addition to plan metadata.

", "smithy.api#http": { "method": "GET", "uri": "/restore-testing/plans/{RestoreTestingPlanName}", "code": 200 } } }, "com.amazonaws.backup#GetRestoreTestingPlanInput": { "type": "structure", "members": { "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Required unique name of the restore testing plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetRestoreTestingPlanOutput": { "type": "structure", "members": { "RestoreTestingPlan": { "target": "com.amazonaws.backup#RestoreTestingPlanForGet", "traits": { "smithy.api#documentation": "

Specifies the body of a restore testing plan. Includes \n RestoreTestingPlanName.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetRestoreTestingSelection": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetRestoreTestingSelectionInput" }, "output": { "target": "com.amazonaws.backup#GetRestoreTestingSelectionOutput" }, "errors": [ { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns RestoreTestingSelection, which displays resources \n and elements of the restore testing plan.

", "smithy.api#http": { "method": "GET", "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", "code": 200 } } }, "com.amazonaws.backup#GetRestoreTestingSelectionInput": { "type": "structure", "members": { "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Required unique name of the restore testing plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Required unique name of the restore testing selection.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetRestoreTestingSelectionOutput": { "type": "structure", "members": { "RestoreTestingSelection": { "target": "com.amazonaws.backup#RestoreTestingSelectionForGet", "traits": { "smithy.api#documentation": "

Unique name of the restore testing selection.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetSupportedResourceTypes": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.backup#GetSupportedResourceTypesOutput" }, "errors": [ { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the Amazon Web Services resource types supported by Backup.

", "smithy.api#http": { "method": "GET", "uri": "/supported-resource-types", "code": 200 } } }, "com.amazonaws.backup#GetSupportedResourceTypesOutput": { "type": "structure", "members": { "ResourceTypes": { "target": "com.amazonaws.backup#ResourceTypes", "traits": { "smithy.api#documentation": "

Contains a string with the supported Amazon Web Services resource types:

\n " } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GetTieringConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.backup#GetTieringConfigurationInput" }, "output": { "target": "com.amazonaws.backup#GetTieringConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns TieringConfiguration details for the specified\n TieringConfigurationName. The details are the body of a tiering configuration\n in JSON format, in addition to configuration metadata.

", "smithy.api#http": { "method": "GET", "uri": "/tiering-configurations/{TieringConfigurationName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#GetTieringConfigurationInput": { "type": "structure", "members": { "TieringConfigurationName": { "target": "com.amazonaws.backup#TieringConfigurationName", "traits": { "smithy.api#documentation": "

The unique name of a tiering configuration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#GetTieringConfigurationOutput": { "type": "structure", "members": { "TieringConfiguration": { "target": "com.amazonaws.backup#TieringConfiguration", "traits": { "smithy.api#documentation": "

Specifies the body of a tiering configuration. Includes TieringConfigurationName.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#GlobalSettings": { "type": "map", "key": { "target": "com.amazonaws.backup#GlobalSettingsName" }, "value": { "target": "com.amazonaws.backup#GlobalSettingsValue" } }, "com.amazonaws.backup#GlobalSettingsName": { "type": "string" }, "com.amazonaws.backup#GlobalSettingsValue": { "type": "string" }, "com.amazonaws.backup#IAMPolicy": { "type": "string" }, "com.amazonaws.backup#IAMRoleArn": { "type": "string" }, "com.amazonaws.backup#Index": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.backup#IndexAction": { "type": "structure", "members": { "ResourceTypes": { "target": "com.amazonaws.backup#ResourceTypes", "traits": { "smithy.api#documentation": "

0 or 1 index action will be accepted for each BackupRule.

\n

Valid values:

\n " } } }, "traits": { "smithy.api#documentation": "

This is an optional array within a BackupRule.

\n

IndexAction consists of one ResourceTypes.

" } }, "com.amazonaws.backup#IndexActions": { "type": "list", "member": { "target": "com.amazonaws.backup#IndexAction" } }, "com.amazonaws.backup#IndexStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.backup#IndexedRecoveryPoint": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45\n

" } }, "SourceResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

A string of the Amazon Resource Name (ARN) that uniquely identifies \n the source resource.

" } }, "IamRoleArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

This specifies the IAM role ARN used for this operation.

\n

For example, arn:aws:iam::123456789012:role/S3Access

" } }, "BackupCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The resource type of the indexed recovery point.

\n " } }, "IndexCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup index was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "IndexStatus": { "target": "com.amazonaws.backup#IndexStatus", "traits": { "smithy.api#documentation": "

This is the current status for the backup index associated \n with the specified recovery point.

\n

Statuses are: PENDING | ACTIVE | FAILED | DELETING\n

\n

A recovery point with an index that has the status of ACTIVE \n can be included in a search.

" } }, "IndexStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A string in the form of a detailed message explaining the status of a backup index associated \n with the recovery point.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the backup vault where the recovery \n point index is stored.

\n

For example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } } }, "traits": { "smithy.api#documentation": "

This is a recovery point that has an associated backup index.

\n

Only recovery points with a backup index can be \n included in a search.

" } }, "com.amazonaws.backup#IndexedRecoveryPointList": { "type": "list", "member": { "target": "com.amazonaws.backup#IndexedRecoveryPoint" } }, "com.amazonaws.backup#InvalidParameterValueException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Indicates that something is wrong with a parameter's value. For example, the value is\n out of range.

", "smithy.api#error": "client" } }, "com.amazonaws.backup#InvalidRequestException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Indicates that something is wrong with the input to the request. For example, a\n parameter is of the wrong type.

", "smithy.api#error": "client" } }, "com.amazonaws.backup#InvalidResourceStateException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Backup is already performing an action on this recovery point. It can't\n perform the action you requested until the first action finishes. Try again later.

", "smithy.api#error": "client" } }, "com.amazonaws.backup#IsEnabled": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.backup#KeyValue": { "type": "structure", "members": { "Key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The tag key (String). The key can't start with \n aws:.

\n

Length Constraints: Minimum length of 1. Maximum \n length of 128.

\n

Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$\n

", "smithy.api#required": {} } }, "Value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The value of the key.

\n

Length Constraints: Maximum length of 256.

\n

Pattern: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$\n

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Pair of two related strings. Allowed characters \n are letters, white space, and numbers that can be \n represented in UTF-8 and the following characters: \n + - = . _ : /\n

" } }, "com.amazonaws.backup#KeyValueList": { "type": "list", "member": { "target": "com.amazonaws.backup#KeyValue" } }, "com.amazonaws.backup#LatestMpaApprovalTeamUpdate": { "type": "structure", "members": { "MpaSessionArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the MPA session associated with this update.

" } }, "Status": { "target": "com.amazonaws.backup#MpaSessionStatus", "traits": { "smithy.api#documentation": "

The current status of the MPA approval team update.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A message describing the current status of the MPA approval team update.

" } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the MPA approval team update was initiated.

" } }, "ExpiryDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the MPA approval team update will expire.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the latest update to an MPA approval team association.

" } }, "com.amazonaws.backup#LatestRevokeRequest": { "type": "structure", "members": { "MpaSessionArn": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ARN of the MPA session associated with this revoke request.

" } }, "Status": { "target": "com.amazonaws.backup#MpaRevokeSessionStatus", "traits": { "smithy.api#documentation": "

The current status of the revoke request.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A message describing the current status of the revoke request.

" } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the revoke request was initiated.

" } }, "ExpiryDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the revoke request will expire.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the latest request to revoke access to a backup vault.

" } }, "com.amazonaws.backup#LegalHold": { "type": "structure", "members": { "Title": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The title of a legal hold.

" } }, "Status": { "target": "com.amazonaws.backup#LegalHoldStatus", "traits": { "smithy.api#documentation": "

The status of the legal hold.

" } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The description of a legal hold.

" } }, "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the legal hold.

" } }, "LegalHoldArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the legal hold; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The time when the legal hold was created.

" } }, "CancellationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The time when the legal hold was cancelled.

" } } }, "traits": { "smithy.api#documentation": "

A legal hold is an administrative tool that helps prevent backups \n from being deleted while under a hold. While the hold is in place, \n backups under a hold cannot be deleted and lifecycle policies that \n would alter the backup status (such as transition to cold storage) are \n delayed until the legal hold is removed. A backup can have more than \n one legal hold. Legal holds are applied to one or more backups \n (also known as recovery points). These backups can be filtered by resource \n types and by resource IDs.

" } }, "com.amazonaws.backup#LegalHoldStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "CANCELING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELING" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } } } }, "com.amazonaws.backup#LegalHoldsList": { "type": "list", "member": { "target": "com.amazonaws.backup#LegalHold" } }, "com.amazonaws.backup#Lifecycle": { "type": "structure", "members": { "MoveToColdStorageAfterDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The number of days after creation that a recovery point is moved to cold\n storage.

" } }, "DeleteAfterDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The number of days after creation that a recovery point is deleted. This value must be\n at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

" } }, "OptInToArchiveForSupportedResources": { "target": "com.amazonaws.backup#Boolean", "traits": { "smithy.api#documentation": "

If the value is true, your backup plan transitions supported resources to \n archive (cold) storage tier in accordance with your lifecycle settings.

" } }, "DeleteAfterEvent": { "target": "com.amazonaws.backup#LifecycleDeleteAfterEvent", "traits": { "smithy.api#documentation": "

The event after which a recovery point is deleted. A recovery point with both\n DeleteAfterDays and DeleteAfterEvent will delete after\n whichever condition is satisfied first. Not valid as an input.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the time period, in days, before a recovery point transitions to cold storage \n or is deleted.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the retention setting must be 90 days greater than the\n transition to cold after days setting. The transition to cold after days setting can't\n be changed after a backup has been transitioned to cold.

\n

Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for\n other resource types.

\n

To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, \n specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

" } }, "com.amazonaws.backup#LifecycleDeleteAfterEvent": { "type": "enum", "members": { "DELETE_AFTER_COPY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_AFTER_COPY" } } } }, "com.amazonaws.backup#LimitExceededException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

A limit in the request has been exceeded; for example, a maximum number of items allowed\n in a request.

", "smithy.api#error": "client" } }, "com.amazonaws.backup#ListAccessPointsMember": { "type": "structure", "members": { "AccessPointArn": { "target": "com.amazonaws.backup#AccessPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the backup access point.

", "smithy.api#required": {} } }, "AccessPointMetadata": { "target": "com.amazonaws.backup#AccessPointMetadataMap", "traits": { "smithy.api#documentation": "

Metadata for the backup access point. After the backup access point reaches the AVAILABLE\n status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with\n standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also\n contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point\n provides access to the content present in the backup at that specific time.

", "smithy.api#required": {} } }, "BackupVaultArn": { "target": "com.amazonaws.backup#BackupVaultArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault that contains the recovery point.

", "smithy.api#required": {} } }, "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the backup access point was created, in Unix format and Coordinated Universal Time\n (UTC). The value of CreationTime is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.backup#AccessPointName", "traits": { "smithy.api#documentation": "

The name of the backup access point.

", "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#RecoveryPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.

", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.backup#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.

", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource associated with the recovery point. For example, S3 for\n Amazon Simple Storage Service.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.backup#AccessPointStatus", "traits": { "smithy.api#documentation": "

The current status of the backup access point.

", "smithy.api#required": {} } }, "StatusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A message that provides additional detail about the status of the backup access point, such as the reason a\n creation or deletion attempt failed.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata about a backup access point.

" } }, "com.amazonaws.backup#ListBackupAccessPoints": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupAccessPointsRequest" }, "output": { "target": "com.amazonaws.backup#ListBackupAccessPointsResponse" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of the backup access points in your account and Region.

", "smithy.api#http": { "method": "GET", "uri": "/backup-access-point", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupAccessPoints", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPointRequest" }, "output": { "target": "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPointResponse" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the backup access points associated with the specified recovery point.

\n

If you own the recovery point and have shared it with other accounts, the response includes backup access\n points created by those accounts.

", "smithy.api#http": { "method": "POST", "uri": "/backup-access-point/recovery-point/{RecoveryPointArn}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupAccessPoints", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPointRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPointRequestMaxResultsInteger", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to return\n MaxResults number of items, NextToken allows you to return more items in your list\n starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "NextToken" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#RecoveryPointArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point whose backup access points you want to list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPointRequestMaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.backup#ListBackupAccessPointsByRecoveryPointResponse": { "type": "structure", "members": { "BackupAccessPoints": { "target": "com.amazonaws.backup#BackupAccessPoints", "traits": { "smithy.api#documentation": "

A list of backup access points, each containing metadata such as its name, ARN, status, and associated\n recovery point.

", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to return\n MaxResults number of items, NextToken allows you to return more items in your list\n starting at the location pointed to by the next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupAccessPointsByResource": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupAccessPointsByResourceRequest" }, "output": { "target": "com.amazonaws.backup#ListBackupAccessPointsByResourceResponse" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the backup access points associated with the specified resource, such as an Amazon S3\n bucket.

", "smithy.api#http": { "method": "POST", "uri": "/backup-access-point/resource/{ResourceArn}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupAccessPoints", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.backup#ListBackupAccessPointsByResourceRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#ListBackupAccessPointsByResourceRequestMaxResultsInteger", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to return\n MaxResults number of items, NextToken allows you to return more items in your list\n starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "NextToken" } }, "ResourceArn": { "target": "com.amazonaws.backup#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose backup access points you want to list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupAccessPointsByResourceRequestMaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.backup#ListBackupAccessPointsByResourceResponse": { "type": "structure", "members": { "BackupAccessPoints": { "target": "com.amazonaws.backup#BackupAccessPoints", "traits": { "smithy.api#documentation": "

A list of backup access points, each containing metadata such as its name, ARN, status, and associated\n recovery point.

", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to return\n MaxResults number of items, NextToken allows you to return more items in your list\n starting at the location pointed to by the next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupAccessPointsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#ListBackupAccessPointsRequestMaxResultsInteger", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to return\n MaxResults number of items, NextToken allows you to return more items in your list\n starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupAccessPointsRequestMaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.backup#ListBackupAccessPointsResponse": { "type": "structure", "members": { "BackupAccessPoints": { "target": "com.amazonaws.backup#BackupAccessPoints", "traits": { "smithy.api#documentation": "

A list of backup access points, each containing metadata such as its name, ARN, status, and associated\n recovery point.

", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to return\n MaxResults number of items, NextToken allows you to return more items in your list\n starting at the location pointed to by the next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupJobSummaries": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupJobSummariesInput" }, "output": { "target": "com.amazonaws.backup#ListBackupJobSummariesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This is a request for a summary of backup jobs created \n or running within the most recent 14 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", "smithy.api#http": { "method": "GET", "uri": "/audit/backup-job-summaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListBackupJobSummariesInput": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", "smithy.api#httpQuery": "AccountId" } }, "State": { "target": "com.amazonaws.backup#BackupJobStatus", "traits": { "smithy.api#documentation": "

This parameter returns the job count for jobs with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts for all states and returns the\n sum.

\n

\n Completed with issues is a status found only in the Backup\n console. For API, this status refers to jobs with a state of COMPLETED and a\n MessageCategory with a value other than SUCCESS; that is, the\n status is completed but comes with a status message. To obtain the job count for\n Completed with issues, run two GET requests, and subtract the second,\n smaller number:

\n

GET\n /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

\n

GET\n /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

", "smithy.api#httpQuery": "State" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "smithy.api#httpQuery": "ResourceType" } }, "MessageCategory": { "target": "com.amazonaws.backup#MessageCategory", "traits": { "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", "smithy.api#httpQuery": "MessageCategory" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n ", "smithy.api#httpQuery": "AggregationPeriod" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupJobSummariesOutput": { "type": "structure", "members": { "BackupJobSummaries": { "target": "com.amazonaws.backup#BackupJobSummaryList", "traits": { "smithy.api#documentation": "

The summary information.

" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n " } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupJobs": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupJobsInput" }, "output": { "target": "com.amazonaws.backup#ListBackupJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of existing backup jobs for an authenticated account for the last 30\n days. For a longer period of time, consider using these monitoring tools.

", "smithy.api#http": { "method": "GET", "uri": "/backup-jobs", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupJobs", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListBackupJobsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is \n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } }, "ByResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

Returns only backup jobs that match the specified resource Amazon Resource Name\n (ARN).

", "smithy.api#httpQuery": "resourceArn" } }, "ByState": { "target": "com.amazonaws.backup#BackupJobState", "traits": { "smithy.api#documentation": "

Returns only backup jobs that are in the specified state.

\n

\n Completed with issues is a status found only in the Backup\n console. For API, this status refers to jobs with a state of COMPLETED and a\n MessageCategory with a value other than SUCCESS; that is, the\n status is completed but comes with a status message.

\n

To obtain the job count for\n Completed with issues, run two GET requests, and subtract the second,\n smaller number:

\n

GET /backup-jobs/?state=COMPLETED

\n

GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED

", "smithy.api#httpQuery": "state" } }, "ByBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n Amazon Web Services Region where they are created.

", "smithy.api#httpQuery": "backupVaultName" } }, "ByCreatedBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only backup jobs that were created before the specified date.

", "smithy.api#httpQuery": "createdBefore" } }, "ByCreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only backup jobs that were created after the specified date.

", "smithy.api#httpQuery": "createdAfter" } }, "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, "ByAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the\n specified account ID.

\n

If used from an Organizations management account, passing * returns\n all jobs across the organization.

", "smithy.api#httpQuery": "accountId" } }, "ByCompleteAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only backup jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", "smithy.api#httpQuery": "completeAfter" } }, "ByCompleteBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only backup jobs completed before a date expressed in Unix format and\n Coordinated Universal Time (UTC).

", "smithy.api#httpQuery": "completeBefore" } }, "ByParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", "smithy.api#httpQuery": "parentJobId" } }, "ByMessageCategory": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is an optional parameter that can be used to \n filter out jobs with a MessageCategory which matches the \n value you input.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n InvalidParameters.

\n

View Monitoring\n

\n

The wildcard () returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", "smithy.api#httpQuery": "messageCategory" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupJobsOutput": { "type": "structure", "members": { "BackupJobs": { "target": "com.amazonaws.backup#BackupJobsList", "traits": { "smithy.api#documentation": "

An array of structures containing metadata about your backup jobs returned in JSON\n format.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is \n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupPlanTemplates": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupPlanTemplatesInput" }, "output": { "target": "com.amazonaws.backup#ListBackupPlanTemplatesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists the backup plan templates.

", "smithy.api#http": { "method": "GET", "uri": "/backup/template/plans", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupPlanTemplatesList", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListBackupPlanTemplatesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupPlanTemplatesOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, "BackupPlanTemplatesList": { "target": "com.amazonaws.backup#BackupPlanTemplatesList", "traits": { "smithy.api#documentation": "

An array of template list items containing metadata about your saved templates.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupPlanVersions": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupPlanVersionsInput" }, "output": { "target": "com.amazonaws.backup#ListBackupPlanVersionsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs),\n backup plan IDs, creation and deletion dates, plan names, and version IDs.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans/{BackupPlanId}/versions", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupPlanVersionsList", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListBackupPlanVersionsInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupPlanVersionsOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, "BackupPlanVersionsList": { "target": "com.amazonaws.backup#BackupPlanVersionsList", "traits": { "smithy.api#documentation": "

An array of version list items containing metadata about your backup plans.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupPlans": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupPlansInput" }, "output": { "target": "com.amazonaws.backup#ListBackupPlansOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists the active backup plans for the account.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupPlansList", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListBackupPlansInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } }, "IncludeDeleted": { "target": "com.amazonaws.backup#Boolean", "traits": { "smithy.api#documentation": "

A Boolean value with a default value of FALSE that returns deleted backup\n plans when set to TRUE.

", "smithy.api#httpQuery": "includeDeleted" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupPlansOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, "BackupPlansList": { "target": "com.amazonaws.backup#BackupPlansList", "traits": { "smithy.api#documentation": "

Information about the backup plans.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupSelections": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupSelectionsInput" }, "output": { "target": "com.amazonaws.backup#ListBackupSelectionsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns an array containing metadata of the resources associated with the target backup\n plan.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans/{BackupPlanId}/selections", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupSelectionsList", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListBackupSelectionsInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupSelectionsOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, "BackupSelectionsList": { "target": "com.amazonaws.backup#BackupSelectionsList", "traits": { "smithy.api#documentation": "

An array of backup selection list items containing metadata about each resource in the\n list.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListBackupVaults": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListBackupVaultsInput" }, "output": { "target": "com.amazonaws.backup#ListBackupVaultsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of recovery point storage containers along with information about\n them.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "BackupVaultList", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListBackupVaultsInput": { "type": "structure", "members": { "ByVaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { "smithy.api#documentation": "

This parameter will sort the list of vaults by vault type.

", "smithy.api#httpQuery": "vaultType" } }, "ByShared": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This parameter will sort the list of vaults by shared vaults.

", "smithy.api#httpQuery": "shared" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListBackupVaultsOutput": { "type": "structure", "members": { "BackupVaultList": { "target": "com.amazonaws.backup#BackupVaultList", "traits": { "smithy.api#documentation": "

An array of backup vault list members containing vault metadata, including Amazon\n Resource Name (ARN), display name, creation date, number of saved recovery points, and\n encryption information if the resources saved in the backup vault are encrypted.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListCopyJobSummaries": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListCopyJobSummariesInput" }, "output": { "target": "com.amazonaws.backup#ListCopyJobSummariesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request obtains a list of copy jobs created \n or running within the the most recent 14 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", "smithy.api#http": { "method": "GET", "uri": "/audit/copy-job-summaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListCopyJobSummariesInput": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", "smithy.api#httpQuery": "AccountId" } }, "State": { "target": "com.amazonaws.backup#CopyJobStatus", "traits": { "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", "smithy.api#httpQuery": "State" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "smithy.api#httpQuery": "ResourceType" } }, "MessageCategory": { "target": "com.amazonaws.backup#MessageCategory", "traits": { "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", "smithy.api#httpQuery": "MessageCategory" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n ", "smithy.api#httpQuery": "AggregationPeriod" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListCopyJobSummariesOutput": { "type": "structure", "members": { "CopyJobSummaries": { "target": "com.amazonaws.backup#CopyJobSummaryList", "traits": { "smithy.api#documentation": "

This return shows a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n " } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListCopyJobs": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListCopyJobsInput" }, "output": { "target": "com.amazonaws.backup#ListCopyJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns metadata about your copy jobs.

", "smithy.api#http": { "method": "GET", "uri": "/copy-jobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "CopyJobs", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListCopyJobsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you to return more items in\n your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } }, "ByResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).\n

", "smithy.api#httpQuery": "resourceArn" } }, "ByState": { "target": "com.amazonaws.backup#CopyJobState", "traits": { "smithy.api#documentation": "

Returns only copy jobs that are in the specified state.

", "smithy.api#httpQuery": "state" } }, "ByCreatedBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only copy jobs that were created before the specified date.

", "smithy.api#httpQuery": "createdBefore" } }, "ByCreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only copy jobs that were created after the specified date.

", "smithy.api#httpQuery": "createdAfter" } }, "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, "ByDestinationVaultArn": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy\n from; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.\n

", "smithy.api#httpQuery": "destinationVaultArn" } }, "ByAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID to list the jobs from. Returns only copy jobs associated with the\n specified account ID.

", "smithy.api#httpQuery": "accountId" } }, "ByCompleteBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", "smithy.api#httpQuery": "completeBefore" } }, "ByCompleteAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", "smithy.api#httpQuery": "completeAfter" } }, "ByParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", "smithy.api#httpQuery": "parentJobId" } }, "ByMessageCategory": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is an optional parameter that can be used to \n filter out jobs with a MessageCategory which matches the \n value you input.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n INVALIDPARAMETERS.

\n

View \n Monitoring\n for a list of accepted strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", "smithy.api#httpQuery": "messageCategory" } }, "BySourceRecoveryPointArn": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Filters copy jobs by the specified source recovery point ARN.

", "smithy.api#httpQuery": "sourceRecoveryPointArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListCopyJobsOutput": { "type": "structure", "members": { "CopyJobs": { "target": "com.amazonaws.backup#CopyJobsList", "traits": { "smithy.api#documentation": "

An array of structures containing metadata about your copy jobs returned in JSON format.\n

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you to return more items in\n your list starting at the location pointed to by the next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListFrameworks": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListFrameworksInput" }, "output": { "target": "com.amazonaws.backup#ListFrameworksOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

", "smithy.api#http": { "method": "GET", "uri": "/audit/frameworks", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListFrameworksInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#MaxFrameworkInputs", "traits": { "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListFrameworksOutput": { "type": "structure", "members": { "Frameworks": { "target": "com.amazonaws.backup#FrameworkList", "traits": { "smithy.api#documentation": "

The frameworks with details for each framework, including the framework name,\n Amazon Resource Name (ARN), description, number of controls, creation time, and deployment\n status.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListIndexedRecoveryPoints": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListIndexedRecoveryPointsInput" }, "output": { "target": "com.amazonaws.backup#ListIndexedRecoveryPointsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This operation returns a list of recovery points that have an \n associated index, belonging to the specified account.

\n

Optional parameters you can include are: MaxResults; \n NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; \n and ResourceType.

", "smithy.api#http": { "method": "GET", "uri": "/indexes/recovery-point", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "IndexedRecoveryPoints", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListIndexedRecoveryPointsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned recovery points.

\n

For example, if a request\n is made to return MaxResults number of indexed recovery points, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of resource list items to be returned.

", "smithy.api#httpQuery": "maxResults" } }, "SourceResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

A string of the Amazon Resource Name (ARN) that uniquely identifies \n the source resource.

", "smithy.api#httpQuery": "sourceResourceArn" } }, "CreatedBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only indexed recovery points that were created before the \n specified date.

", "smithy.api#httpQuery": "createdBefore" } }, "CreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only indexed recovery points that were created after the \n specified date.

", "smithy.api#httpQuery": "createdAfter" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns a list of indexed recovery points for the specified \n resource type(s).

\n

Accepted values include:

\n ", "smithy.api#httpQuery": "resourceType" } }, "IndexStatus": { "target": "com.amazonaws.backup#IndexStatus", "traits": { "smithy.api#documentation": "

Include this parameter to filter the returned list by \n the indicated statuses.

\n

Accepted values: PENDING | ACTIVE | FAILED | DELETING\n

\n

A recovery point with an index that has the status of ACTIVE \n can be included in a search.

", "smithy.api#httpQuery": "indexStatus" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListIndexedRecoveryPointsOutput": { "type": "structure", "members": { "IndexedRecoveryPoints": { "target": "com.amazonaws.backup#IndexedRecoveryPointList", "traits": { "smithy.api#documentation": "

This is a list of recovery points that have an \n associated index, belonging to the specified account.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned recovery points.

\n

For example, if a request\n is made to return MaxResults number of indexed recovery points, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListLegalHolds": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListLegalHoldsInput" }, "output": { "target": "com.amazonaws.backup#ListLegalHoldsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This action returns metadata about active and previous legal holds.

", "smithy.api#http": { "method": "GET", "uri": "/legal-holds", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "LegalHolds", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListLegalHoldsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of resource list items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListLegalHoldsOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } }, "LegalHolds": { "target": "com.amazonaws.backup#LegalHoldsList", "traits": { "smithy.api#documentation": "

This is an array of returned legal holds, both active and previous.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListOfTags": { "type": "list", "member": { "target": "com.amazonaws.backup#Condition" } }, "com.amazonaws.backup#ListProtectedResources": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListProtectedResourcesInput" }, "output": { "target": "com.amazonaws.backup#ListProtectedResourcesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns an array of resources with recovery points created by Backup\n (regardless of the recovery point's status),\n including the time the resource was saved, an Amazon Resource Name (ARN) of the resource,\n and a resource type.

", "smithy.api#http": { "method": "GET", "uri": "/resources", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Results", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListProtectedResourcesByBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput" }, "output": { "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request lists the protected resources corresponding to each backup vault.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}/resources", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Results", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The list of protected resources by backup vault within the vault(s) you specify by name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The list of protected resources by backup vault within the vault(s) you specify by account ID.

", "smithy.api#httpQuery": "backupVaultAccountId" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.backup#ProtectedResourcesList", "traits": { "smithy.api#documentation": "

These are the results returned for the request ListProtectedResourcesByBackupVault.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListProtectedResourcesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListProtectedResourcesOutput": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.backup#ProtectedResourcesList", "traits": { "smithy.api#documentation": "

An array of resources successfully backed up by Backup including the time\n the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource\n type.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRecoveryPointsByBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput" }, "output": { "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVaultOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns detailed information about the recovery points stored in a backup vault.

", "smithy.api#http": { "method": "GET", "uri": "/backup-vaults/{BackupVaultName}/recovery-points", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RecoveryPoints", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

\n \n

Backup vault name might not be available when a supported service creates the\n backup.

\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

This parameter will sort the list of recovery points by account ID.

", "smithy.api#httpQuery": "backupVaultAccountId" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } }, "ByResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

Returns only recovery points that match the specified resource Amazon Resource Name\n (ARN).

", "smithy.api#httpQuery": "resourceArn" } }, "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns only recovery points that match the specified resource type(s):

\n ", "smithy.api#httpQuery": "resourceType" } }, "ByBackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Returns only recovery points that match the specified backup plan ID.

", "smithy.api#httpQuery": "backupPlanId" } }, "ByCreatedBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only recovery points that were created before the specified timestamp.

", "smithy.api#httpQuery": "createdBefore" } }, "ByCreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only recovery points that were created after the specified timestamp.

", "smithy.api#httpQuery": "createdAfter" } }, "ByParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

This returns only recovery points that match the specified parent (composite)\n recovery point Amazon Resource Name (ARN).

", "smithy.api#httpQuery": "parentRecoveryPointArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRecoveryPointsByBackupVaultOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, "RecoveryPoints": { "target": "com.amazonaws.backup#RecoveryPointByBackupVaultList", "traits": { "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points saved in a\n backup vault.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRecoveryPointsByLegalHold": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRecoveryPointsByLegalHoldInput" }, "output": { "target": "com.amazonaws.backup#ListRecoveryPointsByLegalHoldOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This action returns recovery point ARNs (Amazon Resource Names) of the \n specified legal hold.

", "smithy.api#http": { "method": "GET", "uri": "/legal-holds/{LegalHoldId}/recovery-points", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RecoveryPoints", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRecoveryPointsByLegalHoldInput": { "type": "structure", "members": { "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the legal hold.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of resource list items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRecoveryPointsByLegalHoldOutput": { "type": "structure", "members": { "RecoveryPoints": { "target": "com.amazonaws.backup#RecoveryPointsList", "traits": { "smithy.api#documentation": "

The recovery points.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRecoveryPointsByResource": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRecoveryPointsByResourceInput" }, "output": { "target": "com.amazonaws.backup#ListRecoveryPointsByResourceOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

The information about the recovery points of the type specified by a\n resource Amazon Resource Name (ARN).

\n \n

For Amazon EFS and Amazon EC2, this action only lists recovery points\n created by Backup.

\n
", "smithy.api#http": { "method": "GET", "uri": "/resources/{ResourceArn}/recovery-points", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RecoveryPoints", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRecoveryPointsByResourceInput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

\n \n

Amazon RDS requires a value of at least 20.

\n
", "smithy.api#httpQuery": "maxResults" } }, "ManagedByAWSBackupOnly": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This attribute filters recovery points based on ownership.

\n

If this is \n set to TRUE, the response will contain recovery points associated \n with the selected resources that are managed by Backup.

\n

If this is set to FALSE, the response will contain all \n recovery points associated with the selected resource, except for EBS\n snapshots copied within the same Region and account.

\n

Type: Boolean

", "smithy.api#httpQuery": "managedByAWSBackupOnly" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRecoveryPointsByResourceOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, "RecoveryPoints": { "target": "com.amazonaws.backup#RecoveryPointByResourceList", "traits": { "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points of the\n specified resource type.

\n \n

Only Amazon EFS and Amazon EC2 recovery points return\n BackupVaultName.

\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListReportJobs": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListReportJobsInput" }, "output": { "target": "com.amazonaws.backup#ListReportJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns details about your report jobs.

", "smithy.api#http": { "method": "GET", "uri": "/audit/report-jobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListReportJobsInput": { "type": "structure", "members": { "ByReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

Returns only report jobs with the specified report plan name.

", "smithy.api#httpQuery": "ReportPlanName" } }, "ByCreationBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only report jobs that were created before the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", "smithy.api#httpQuery": "CreationBefore" } }, "ByCreationAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only report jobs that were created after the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", "smithy.api#httpQuery": "CreationAfter" } }, "ByStatus": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Returns only report jobs that are in the specified status. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES\n

\n

Please note that only scanning jobs finish with state completed with issues. \n For backup jobs this is a console interpretation of a job that finishes in \n completed state and has a status message.

", "smithy.api#httpQuery": "Status" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListReportJobsOutput": { "type": "structure", "members": { "ReportJobs": { "target": "com.amazonaws.backup#ReportJobList", "traits": { "smithy.api#documentation": "

Details about your report jobs in JSON format.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListReportPlans": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListReportPlansInput" }, "output": { "target": "com.amazonaws.backup#ListReportPlansOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of your report plans. For detailed information about a single report\n plan, use DescribeReportPlan.

", "smithy.api#http": { "method": "GET", "uri": "/audit/report-plans", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListReportPlansInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListReportPlansOutput": { "type": "structure", "members": { "ReportPlans": { "target": "com.amazonaws.backup#ReportPlanList", "traits": { "smithy.api#documentation": "

The report plans with detailed information for each plan. This information\n includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery\n channel, deployment status, creation time, and last times the report plan attempted to and\n successfully ran.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRestoreAccessBackupVaults": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRestoreAccessBackupVaultsInput" }, "output": { "target": "com.amazonaws.backup#ListRestoreAccessBackupVaultsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of restore access backup vaults associated with a specified backup vault.

", "smithy.api#http": { "method": "GET", "uri": "/logically-air-gapped-backup-vaults/{BackupVaultName}/restore-access-backup-vaults", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RestoreAccessBackupVaults", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRestoreAccessBackupVaultsInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault for which to list associated restore access backup vaults.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The pagination token from a previous request to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRestoreAccessBackupVaultsOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The pagination token to use in a subsequent request to retrieve the next set of results.

" } }, "RestoreAccessBackupVaults": { "target": "com.amazonaws.backup#RestoreAccessBackupVaultList", "traits": { "smithy.api#documentation": "

A list of restore access backup vaults associated with the specified backup vault.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRestoreJobSummaries": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRestoreJobSummariesInput" }, "output": { "target": "com.amazonaws.backup#ListRestoreJobSummariesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request obtains a summary of restore jobs created \n or running within the the most recent 14 days. You can \n include parameters AccountID, State, ResourceType, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", "smithy.api#http": { "method": "GET", "uri": "/audit/restore-job-summaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRestoreJobSummariesInput": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", "smithy.api#httpQuery": "AccountId" } }, "State": { "target": "com.amazonaws.backup#RestoreJobState", "traits": { "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", "smithy.api#httpQuery": "State" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "smithy.api#httpQuery": "ResourceType" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n ", "smithy.api#httpQuery": "AggregationPeriod" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRestoreJobSummariesOutput": { "type": "structure", "members": { "RestoreJobSummaries": { "target": "com.amazonaws.backup#RestoreJobSummaryList", "traits": { "smithy.api#documentation": "

This return contains a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n " } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRestoreJobs": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRestoreJobsInput" }, "output": { "target": "com.amazonaws.backup#ListRestoreJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of jobs that Backup initiated to restore a saved resource,\n including details about the recovery process.

", "smithy.api#http": { "method": "GET", "uri": "/restore-jobs", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RestoreJobs", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRestoreJobsByProtectedResource": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRestoreJobsByProtectedResourceInput" }, "output": { "target": "com.amazonaws.backup#ListRestoreJobsByProtectedResourceOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This returns restore jobs that contain the specified protected resource.

\n

You must include ResourceArn. You can optionally include\n NextToken, ByStatus, MaxResults,\n ByRecoveryPointCreationDateAfter , and\n ByRecoveryPointCreationDateBefore.

", "smithy.api#http": { "method": "GET", "uri": "/resources/{ResourceArn}/restore-jobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RestoreJobs", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRestoreJobsByProtectedResourceInput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

Returns only restore jobs that match the specified resource \n Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ByStatus": { "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { "smithy.api#documentation": "

Returns only restore jobs associated with the specified job status.

", "smithy.api#httpQuery": "status" } }, "ByRecoveryPointCreationDateAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only restore jobs of recovery points that were created after the specified date.

", "smithy.api#httpQuery": "recoveryPointCreationDateAfter" } }, "ByRecoveryPointCreationDateBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only restore jobs of recovery points that were created before the specified date.

", "smithy.api#httpQuery": "recoveryPointCreationDateBefore" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, \n if a request ismade to return MaxResults number of items, \n NextToken allows you to return more items in your list \n starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRestoreJobsByProtectedResourceOutput": { "type": "structure", "members": { "RestoreJobs": { "target": "com.amazonaws.backup#RestoreJobsList", "traits": { "smithy.api#documentation": "

An array of objects that contain detailed information about \n jobs to restore saved resources.>

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, \n if a request is made to return MaxResults number of items, \n NextToken allows youto return more items in your list starting \n at the location pointed to by the next token

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRestoreJobsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } }, "ByAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID to list the jobs from. Returns only restore jobs associated with the\n specified account ID.

", "smithy.api#httpQuery": "accountId" } }, "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Include this parameter to return only restore jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, "ByCreatedBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only restore jobs that were created before the specified date.

", "smithy.api#httpQuery": "createdBefore" } }, "ByCreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only restore jobs that were created after the specified date.

", "smithy.api#httpQuery": "createdAfter" } }, "ByStatus": { "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { "smithy.api#documentation": "

Returns only restore jobs associated with the specified job status.

", "smithy.api#httpQuery": "status" } }, "ByCompleteBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", "smithy.api#httpQuery": "completeBefore" } }, "ByCompleteAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", "smithy.api#httpQuery": "completeAfter" } }, "ByRestoreTestingPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

This returns only restore testing jobs that match the \n specified resource Amazon Resource Name (ARN).

", "smithy.api#httpQuery": "restoreTestingPlanArn" } }, "ByParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is a filter to list child (nested) restore jobs based on parent restore job ID.

", "smithy.api#httpQuery": "parentJobId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRestoreJobsOutput": { "type": "structure", "members": { "RestoreJobs": { "target": "com.amazonaws.backup#RestoreJobsList", "traits": { "smithy.api#documentation": "

An array of objects that contain detailed information about jobs to restore saved\n resources.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRestoreTestingPlans": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRestoreTestingPlansInput" }, "output": { "target": "com.amazonaws.backup#ListRestoreTestingPlansOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of restore testing plans.

", "smithy.api#http": { "method": "GET", "uri": "/restore-testing/plans", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RestoreTestingPlans", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRestoreTestingPlansInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#ListRestoreTestingPlansInputMaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return MaxResults \n number of items, NextToken allows you to return more items \n in your list starting at the location pointed to by the nexttoken.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRestoreTestingPlansInputMaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.backup#ListRestoreTestingPlansOutput": { "type": "structure", "members": { "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return MaxResults \n number of items, NextToken allows you to return more items \n in your list starting at the location pointed to by the nexttoken.

" } }, "RestoreTestingPlans": { "target": "com.amazonaws.backup#RestoreTestingPlans", "traits": { "smithy.api#documentation": "

This is a returned list of restore testing plans.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListRestoreTestingSelections": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListRestoreTestingSelectionsInput" }, "output": { "target": "com.amazonaws.backup#ListRestoreTestingSelectionsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of restore testing selections. Can be filtered \n by MaxResults and RestoreTestingPlanName.

", "smithy.api#http": { "method": "GET", "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RestoreTestingSelections", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListRestoreTestingSelectionsInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#ListRestoreTestingSelectionsInputMaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return MaxResults \n number of items, NextToken allows you to return more items \n in your list starting at the location pointed to by the nexttoken.

", "smithy.api#httpQuery": "NextToken" } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Returns restore testing selections by the specified restore testing \n plan name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListRestoreTestingSelectionsInputMaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.backup#ListRestoreTestingSelectionsOutput": { "type": "structure", "members": { "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, \n if a request is made to return MaxResults number of items, \n NextToken allows you to return more items in your list \n starting at the location pointed to by the nexttoken.

" } }, "RestoreTestingSelections": { "target": "com.amazonaws.backup#RestoreTestingSelections", "traits": { "smithy.api#documentation": "

The returned restore testing selections associated with the \n restore testing plan.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListScanJobSummaries": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListScanJobSummariesInput" }, "output": { "target": "com.amazonaws.backup#ListScanJobSummariesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This is a request for a summary of scan jobs created or running within the most recent 14 days.

", "smithy.api#http": { "method": "GET", "uri": "/audit/scan-job-summaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ScanJobSummaries", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListScanJobSummariesInput": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

\n

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

\n

\n AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

", "smithy.api#httpQuery": "AccountId" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Returns the job count for the specified resource type. Use request \n GetSupportedResourceTypes to obtain strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

", "smithy.api#httpQuery": "ResourceType" } }, "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

Returns only the scan jobs for the specified malware scanner. \n Currently the only MalwareScanner is GUARDDUTY. But the field also supports ANY, and AGGREGATE_ALL.

", "smithy.api#httpQuery": "MalwareScanner" } }, "ScanResultStatus": { "target": "com.amazonaws.backup#ScanResultStatus", "traits": { "smithy.api#documentation": "

Returns only the scan jobs for the specified scan results.

", "smithy.api#httpQuery": "ScanResultStatus" } }, "State": { "target": "com.amazonaws.backup#ScanJobStatus", "traits": { "smithy.api#documentation": "

Returns only the scan jobs for the specified scanning job state.

", "smithy.api#httpQuery": "State" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n ", "smithy.api#httpQuery": "AggregationPeriod" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

\n

The value is an integer. Range of accepted values is from 1 to 500.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to \n return MaxResults number of items, NextToken allows you to return more items\n in your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListScanJobSummariesOutput": { "type": "structure", "members": { "ScanJobSummaries": { "target": "com.amazonaws.backup#ScanJobSummaryList", "traits": { "smithy.api#documentation": "

The summary information.

" } }, "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The period for the returned results.

\n \n

Valid Values: 'ONE_DAY' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS'\n

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to \n return MaxResults number of items, NextToken allows you to return more items\n in your list starting at the location pointed to by the next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListScanJobs": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListScanJobsInput" }, "output": { "target": "com.amazonaws.backup#ListScanJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of existing scan jobs for an authenticated account for the last 30 days.

", "smithy.api#http": { "method": "GET", "uri": "/scan/jobs", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ScanJobs", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListScanJobsInput": { "type": "structure", "members": { "ByAccountId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

\n

If used from an Amazon Web Services Organizations management account, passing * returns all jobs across the organization.

\n

Pattern: ^[0-9]{12}$\n

", "smithy.api#httpQuery": "ByAccountId" } }, "ByBackupVaultName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Returns only scan jobs that will be stored in the specified backup vault. \n Backup vaults are identified by names that are unique to the account \n used to create them and the Amazon Web Services Region where they are created.

\n

Pattern: ^[a-zA-Z0-9\\-\\_\\.]{2,50}$\n

", "smithy.api#httpQuery": "ByBackupVaultName" } }, "ByCompleteAfter": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Returns only scan jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

", "smithy.api#httpQuery": "ByCompleteAfter" } }, "ByCompleteBefore": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

", "smithy.api#httpQuery": "ByCompleteBefore" } }, "ByMalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

Returns only the scan jobs for the specified malware scanner. Currently only supports GUARDDUTY.

", "smithy.api#httpQuery": "ByMalwareScanner" } }, "ByRecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Returns only the scan jobs that are ran against the specified recovery point.

", "smithy.api#httpQuery": "ByRecoveryPointArn" } }, "ByResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Returns only scan jobs that match the specified resource Amazon Resource Name (ARN).

", "smithy.api#httpQuery": "ByResourceArn" } }, "ByResourceType": { "target": "com.amazonaws.backup#ScanResourceType", "traits": { "smithy.api#documentation": "

Returns restore testing selections by the specified restore testing \n plan name.

\n \n

Pattern: ^[a-zA-Z0-9\\-\\_\\.]{1,50}$\n

", "smithy.api#httpQuery": "ByResourceType" } }, "ByScanResultStatus": { "target": "com.amazonaws.backup#ScanResultStatus", "traits": { "smithy.api#documentation": "

Returns only the scan jobs for the specified scan results:

\n ", "smithy.api#httpQuery": "ByScanResultStatus" } }, "ByState": { "target": "com.amazonaws.backup#ScanState", "traits": { "smithy.api#documentation": "

Returns only the scan jobs for the specified scanning job state.

", "smithy.api#httpQuery": "ByState" } }, "MaxResults": { "target": "com.amazonaws.backup#ListScanJobsInputMaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

\n

Valid Range: Minimum value of 1. Maximum value of 1000.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to \n return MaxResults number of items, NextToken allows you to return more items\n in your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListScanJobsInputMaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.backup#ListScanJobsOutput": { "type": "structure", "members": { "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is made to \n return MaxResults number of items, NextToken allows you to return more items\n in your list starting at the location pointed to by the next token.

" } }, "ScanJobs": { "target": "com.amazonaws.backup#ScanJobs", "traits": { "smithy.api#documentation": "

An array of structures containing metadata about your scan jobs returned in JSON format.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListTags": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListTagsInput" }, "output": { "target": "com.amazonaws.backup#ListTagsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns the tags assigned to the resource, such as a target recovery point, backup plan,\n or backup vault.

\n

This operation returns results depending on the resource type used in the value for\n resourceArn. For example, recovery points of Amazon DynamoDB with\n Advanced Settings have an ARN (Amazon Resource Name) that begins with\n arn:aws:backup. Recovery points (backups) of DynamoDB without\n Advanced Settings enabled have an ARN that begins with\n arn:aws:dynamodb.

\n

When this operation is called and when you include values of resourceArn\n that have an ARN other than arn:aws:backup, it may return one of the\n exceptions listed below. To prevent this exception, include only values representing\n resource types that are fully managed by Backup. These have an ARN that begins\n arn:aws:backup and they are noted in the Feature availability by resource table.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListTagsInput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the type of resource. Valid targets for ListTags are recovery\n points, backup plans, and backup vaults.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListTagsOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, "Tags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

Information about the tags.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#ListTieringConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.backup#ListTieringConfigurationsInput" }, "output": { "target": "com.amazonaws.backup#ListTieringConfigurationsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Returns a list of tiering configurations.

", "smithy.api#http": { "method": "GET", "uri": "/tiering-configurations", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "TieringConfigurations", "pageSize": "MaxResults" } } }, "com.amazonaws.backup#ListTieringConfigurationsInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request\n is made to return MaxResults number of items, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#ListTieringConfigurationsOutput": { "type": "structure", "members": { "TieringConfigurations": { "target": "com.amazonaws.backup#TieringConfigurationsList", "traits": { "smithy.api#documentation": "

An array of tiering configurations returned by the ListTieringConfigurations call.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request\n is made to return MaxResults number of items, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#Long": { "type": "long" }, "com.amazonaws.backup#Long2": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.backup#MalwareScanner": { "type": "enum", "members": { "GUARDDUTY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GUARDDUTY" } } } }, "com.amazonaws.backup#MaxFrameworkInputs": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.backup#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.backup#MaxScheduledRunsPreview": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 10 } } }, "com.amazonaws.backup#MessageCategory": { "type": "string" }, "com.amazonaws.backup#Metadata": { "type": "map", "key": { "target": "com.amazonaws.backup#MetadataKey" }, "value": { "target": "com.amazonaws.backup#MetadataValue" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.backup#MetadataKey": { "type": "string" }, "com.amazonaws.backup#MetadataValue": { "type": "string" }, "com.amazonaws.backup#MissingParameterValueException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Indicates that a required parameter is missing.

", "smithy.api#error": "client" } }, "com.amazonaws.backup#MpaRevokeSessionStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.backup#MpaSessionStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.backup#ParameterName": { "type": "string" }, "com.amazonaws.backup#ParameterValue": { "type": "string" }, "com.amazonaws.backup#ProtectedResource": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For\n Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" } }, "LastBackupTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a resource was last backed up, in Unix format and Coordinated\n Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that \n belongs to the specified backup.

" } }, "LastBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

" } }, "LastRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the most \n recent recovery point.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains information about a backed-up resource.

" } }, "com.amazonaws.backup#ProtectedResourceConditions": { "type": "structure", "members": { "StringEquals": { "target": "com.amazonaws.backup#KeyValueList", "traits": { "smithy.api#documentation": "

Filters the values of your tagged resources for only \n those resources that you tagged with the same value. \n Also called \"exact matching.\"

" } }, "StringNotEquals": { "target": "com.amazonaws.backup#KeyValueList", "traits": { "smithy.api#documentation": "

Filters the values of your tagged resources for only \n those resources that you tagged that do not have the same value. \n Also called \"negated matching.\"

" } } }, "traits": { "smithy.api#documentation": "

The conditions that you define for resources in \n your restore testing plan using tags.

" } }, "com.amazonaws.backup#ProtectedResourcesList": { "type": "list", "member": { "target": "com.amazonaws.backup#ProtectedResource" } }, "com.amazonaws.backup#PutBackupVaultAccessPolicy": { "type": "operation", "input": { "target": "com.amazonaws.backup#PutBackupVaultAccessPolicyInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Sets a resource-based policy that is used to manage access permissions on the target\n backup vault. Requires a backup vault name and an access policy document in JSON\n format.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}/access-policy", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#PutBackupVaultAccessPolicyInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.backup#IAMPolicy", "traits": { "smithy.api#documentation": "

The backup vault access policy document in JSON format.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#PutBackupVaultLockConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.backup#PutBackupVaultLockConfigurationInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Applies Backup Vault Lock to a backup vault, preventing attempts to delete\n any recovery point stored in or created in a backup vault. Vault Lock also prevents\n attempts to update the lifecycle policy that controls the retention period of any recovery\n point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and\n maximum retention period for future backup and copy jobs that target a backup vault.

\n \n

Backup Vault Lock has been assessed by Cohasset Associates for use in environments \n that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about \n how Backup Vault Lock relates to these regulations, see the \n Cohasset Associates \n Compliance Assessment.\n

\n
\n

For more information, see Backup Vault Lock.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}/vault-lock", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#PutBackupVaultLockConfigurationInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the name of the backup\n vault it protects.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the minimum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to retain certain data for at least seven\n years (2555 days).

\n

This parameter is required when a vault lock is created through CloudFormation;\n otherwise, this parameter is optional. If this parameter is not specified, Vault Lock will\n not enforce a minimum retention period.

\n

If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or longer than the minimum retention\n period. If the job's retention period is shorter than that minimum retention period, then\n the vault fails that backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The shortest minimum retention period\n you can specify is 1 day. Recovery points already saved in the vault prior to\n Vault Lock are not affected.

" } }, "MaxRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the maximum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to destroy certain data after retaining\n it for four years (1460 days).

\n

If this parameter is not included, Vault Lock does not enforce a maximum retention\n period on the recovery points in the vault. If this parameter is included without a value,\n Vault Lock will not enforce a maximum retention period.

\n

If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or shorter than the maximum retention\n period. If the job's retention period is longer than that maximum retention period, then\n the vault fails the backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The longest maximum retention period\n you can specify is 36500 days (approximately 100 years).\n Recovery points already saved in the vault prior to\n Vault Lock are not affected.

" } }, "ChangeableForDays": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the number of days before\n the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at\n 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

\n

Backup enforces a 72-hour cooling-off period before Vault Lock takes effect\n and becomes immutable. Therefore, you must set ChangeableForDays to 3 or\n greater.

\n

The maximum value you can specify is 36,500 days (approximately 100 years).

\n

Before the lock date, you can delete Vault Lock from the vault using\n DeleteBackupVaultLockConfiguration or change the Vault Lock configuration\n using PutBackupVaultLockConfiguration. On and after the lock date, the Vault\n Lock becomes immutable and cannot be changed or deleted.

\n

If this parameter is not specified, you can delete Vault Lock from the vault using\n DeleteBackupVaultLockConfiguration or change the Vault Lock configuration\n using PutBackupVaultLockConfiguration at any time.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#PutBackupVaultNotifications": { "type": "operation", "input": { "target": "com.amazonaws.backup#PutBackupVaultNotificationsInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Turns on notifications on a backup vault for the specified topic and events.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}/notification-configuration", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#PutBackupVaultNotificationsInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SNSTopicArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that specifies the topic for a backup vault\u2019s events; for\n example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

", "smithy.api#required": {} } }, "BackupVaultEvents": { "target": "com.amazonaws.backup#BackupVaultEvents", "traits": { "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup\n vault. For the list of supported events, common use cases, and code samples, see Notification options\n with Backup.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#PutRestoreValidationResult": { "type": "operation", "input": { "target": "com.amazonaws.backup#PutRestoreValidationResultInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request allows you to send your independent self-run \n restore test validation results. \n RestoreJobId and ValidationStatus \n are required. Optionally, you can input a \n ValidationStatusMessage.

", "smithy.api#http": { "method": "PUT", "uri": "/restore-jobs/{RestoreJobId}/validations", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#PutRestoreValidationResultInput": { "type": "structure", "members": { "RestoreJobId": { "target": "com.amazonaws.backup#RestoreJobId", "traits": { "smithy.api#documentation": "

This is a unique identifier of a restore job within Backup.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { "smithy.api#documentation": "

The status of your restore validation.

", "smithy.api#required": {} } }, "ValidationStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is an optional message string you can input to \n describe the validation status for the restore test validation.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#RecoveryPointArn": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:aws[a-z-]*:[a-z-\\d]+:[a-z-\\d]+:).+$" } }, "com.amazonaws.backup#RecoveryPointByBackupVault": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The backup vault where the recovery point was originally copied from. If the recovery\n point is restored to the same account this value will be null.

" } }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an\n Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only\n supported resource type is Amazon EC2.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#RecoveryPointCreator", "traits": { "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan that is used to create it.

" } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, "Status": { "target": "com.amazonaws.backup#RecoveryPointStatus", "traits": { "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A message explaining the current status of the recovery point.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the backup job that created this recovery point was initiated, in\n Unix format and Coordinated Universal Time (UTC).

" } }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of a backup.

" } }, "CalculatedLifecycle": { "target": "com.amazonaws.backup#CalculatedLifecycle", "traits": { "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold.

\n

Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for\n other resource types.

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, "IsEncrypted": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is\n encrypted, or FALSE if the recovery point is not encrypted.

" } }, "LastRestoreTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a recovery point was last restored, in Unix format and Coordinated\n Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "ParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" } }, "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) recovery point.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that \n belongs to the specified backup.

" } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { "smithy.api#documentation": "

The type of vault in which the described recovery point is stored.

" } }, "IndexStatus": { "target": "com.amazonaws.backup#IndexStatus", "traits": { "smithy.api#documentation": "

This is the current status for the backup index associated \n with the specified recovery point.

\n

Statuses are: PENDING | ACTIVE | FAILED |\n DELETING\n

\n

A recovery point with an index that has the status of ACTIVE \n can be included in a search.

" } }, "IndexStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A string in the form of a detailed message explaining the status of a backup index associated \n with the recovery point.

" } }, "EncryptionKeyType": { "target": "com.amazonaws.backup#EncryptionKeyType", "traits": { "smithy.api#documentation": "

The type of encryption key used for the recovery point. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.

" } }, "AggregatedScanResult": { "target": "com.amazonaws.backup#AggregatedScanResult", "traits": { "smithy.api#documentation": "

Contains the latest scanning results against the recovery point and currently include \n FailedScan, Findings, LastComputed.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about the recovery points stored in a backup vault.

" } }, "com.amazonaws.backup#RecoveryPointByBackupVaultList": { "type": "list", "member": { "target": "com.amazonaws.backup#RecoveryPointByBackupVault" } }, "com.amazonaws.backup#RecoveryPointByResource": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "Status": { "target": "com.amazonaws.backup#RecoveryPointStatus", "traits": { "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A message explaining the current status of the recovery point.

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, "BackupSizeBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of a backup.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) recovery point.

" } }, "ParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that \n belongs to the specified backup.

" } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { "smithy.api#documentation": "

The type of vault in which the described recovery point is \n stored.

" } }, "IndexStatus": { "target": "com.amazonaws.backup#IndexStatus", "traits": { "smithy.api#documentation": "

This is the current status for the backup index associated \n with the specified recovery point.

\n

Statuses are: PENDING | ACTIVE | FAILED | DELETING\n

\n

A recovery point with an index that has the status of ACTIVE \n can be included in a search.

" } }, "IndexStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A string in the form of a detailed message explaining the status of a backup index\n associated with the recovery point.

" } }, "EncryptionKeyType": { "target": "com.amazonaws.backup#EncryptionKeyType", "traits": { "smithy.api#documentation": "

The type of encryption key used for the recovery point. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.

" } }, "AggregatedScanResult": { "target": "com.amazonaws.backup#AggregatedScanResult", "traits": { "smithy.api#documentation": "

Contains the latest scanning results against the recovery point and currently include \n FailedScan, Findings, LastComputed.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a saved recovery point.

" } }, "com.amazonaws.backup#RecoveryPointByResourceList": { "type": "list", "member": { "target": "com.amazonaws.backup#RecoveryPointByResource" } }, "com.amazonaws.backup#RecoveryPointCreator": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "BackupPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "BackupPlanName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.

" } }, "BackupPlanVersion": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at\n most 1,024 bytes long. They cannot be edited.

" } }, "BackupRuleId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of\n resources.

" } }, "BackupRuleName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.

" } }, "BackupRuleCron": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.

" } }, "BackupRuleTimezone": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the backup plan and rule that Backup used to\n initiate the recovery point backup.

" } }, "com.amazonaws.backup#RecoveryPointMember": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" } }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies \n a saved resource.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The Amazon Web Services resource type that is saved as \n a recovery point.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the backup vault \n (the logical container in which backups are stored).

" } } }, "traits": { "smithy.api#documentation": "

This is a recovery point which is a child (nested) recovery point \n of a parent (composite) recovery point. These recovery points \n can be disassociated from their parent (composite) recovery \n point, in which case they will no longer be a member.

" } }, "com.amazonaws.backup#RecoveryPointSelection": { "type": "structure", "members": { "VaultNames": { "target": "com.amazonaws.backup#VaultNames", "traits": { "smithy.api#documentation": "

These are the names of the vaults in which the selected \n recovery points are contained.

" } }, "ResourceIdentifiers": { "target": "com.amazonaws.backup#ResourceIdentifiers", "traits": { "smithy.api#documentation": "

These are the resources included in the resource selection \n (including type of resources and vaults).

" } }, "DateRange": { "target": "com.amazonaws.backup#DateRange" } }, "traits": { "smithy.api#documentation": "

This specifies criteria to assign \n a set of resources, such as resource types or backup vaults.

" } }, "com.amazonaws.backup#RecoveryPointStatus": { "type": "enum", "members": { "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "PARTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } } } }, "com.amazonaws.backup#RecoveryPointsList": { "type": "list", "member": { "target": "com.amazonaws.backup#RecoveryPointMember" } }, "com.amazonaws.backup#Region": { "type": "string" }, "com.amazonaws.backup#ReportDeliveryChannel": { "type": "structure", "members": { "S3BucketName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The unique name of the S3 bucket that receives your reports.

", "smithy.api#required": {} } }, "S3KeyPrefix": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path:\n s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.\n If not specified, there is no prefix.

" } }, "Formats": { "target": "com.amazonaws.backup#FormatList", "traits": { "smithy.api#documentation": "

The format of your reports: CSV, JSON, or both. If\n not specified, the default format is CSV.

" } } }, "traits": { "smithy.api#documentation": "

Contains information from your report plan about where to deliver your reports,\n specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your\n reports.

" } }, "com.amazonaws.backup#ReportDestination": { "type": "structure", "members": { "S3BucketName": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The unique name of the Amazon S3 bucket that receives your reports.

" } }, "S3Keys": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

The object key that uniquely identifies your reports in your S3 bucket.

" } } }, "traits": { "smithy.api#documentation": "

Contains information from your report job about your report destination.

" } }, "com.amazonaws.backup#ReportJob": { "type": "structure", "members": { "ReportJobId": { "target": "com.amazonaws.backup#ReportJobId", "traits": { "smithy.api#documentation": "

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. Report job IDs cannot be edited.

" } }, "ReportPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "ReportTemplate": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a report job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CompletionTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a report job is completed, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "Status": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The status of a report job. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED\n

\n

\n COMPLETED means that the report is available for your review at your\n designated destination. If the status is FAILED, review the\n StatusMessage for the reason.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A message explaining the status of the report job.

" } }, "ReportDestination": { "target": "com.amazonaws.backup#ReportDestination", "traits": { "smithy.api#documentation": "

The S3 bucket name and S3 keys for the destination where the report job publishes the\n report.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a report job. A report job compiles a report based\n on a report plan and publishes it to Amazon S3.

" } }, "com.amazonaws.backup#ReportJobId": { "type": "string" }, "com.amazonaws.backup#ReportJobList": { "type": "list", "member": { "target": "com.amazonaws.backup#ReportJob" } }, "com.amazonaws.backup#ReportPlan": { "type": "structure", "members": { "ReportPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of the report plan. This name is between 1 and 256 characters starting\n with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores\n (_).

" } }, "ReportPlanDescription": { "target": "com.amazonaws.backup#ReportPlanDescription", "traits": { "smithy.api#documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" } }, "ReportSetting": { "target": "com.amazonaws.backup#ReportSetting", "traits": { "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

\n

If the report template is RESOURCE_COMPLIANCE_REPORT or\n CONTROL_COMPLIANCE_REPORT, this API resource also describes the report\n coverage by Amazon Web Services Regions and frameworks.

" } }, "ReportDeliveryChannel": { "target": "com.amazonaws.backup#ReportDeliveryChannel", "traits": { "smithy.api#documentation": "

Contains information about where and how to deliver your reports, specifically your\n Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" } }, "DeploymentStatus": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The deployment status of a report plan. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS |\n COMPLETED\n

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a report plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "LastAttemptedExecutionTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a report job associated with this report plan last attempted to\n run, in Unix format and Coordinated Universal Time (UTC). The value of\n LastAttemptedExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "LastSuccessfulExecutionTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a report job associated with this report plan last successfully\n ran, in Unix format and Coordinated Universal Time (UTC). The value of\n LastSuccessfulExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a report plan.

" } }, "com.amazonaws.backup#ReportPlanDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "\\S" } }, "com.amazonaws.backup#ReportPlanList": { "type": "list", "member": { "target": "com.amazonaws.backup#ReportPlan" } }, "com.amazonaws.backup#ReportPlanName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z][_a-zA-Z0-9]*$" } }, "com.amazonaws.backup#ReportSetting": { "type": "structure", "members": { "ReportTemplate": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT\n

", "smithy.api#required": {} } }, "FrameworkArns": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the frameworks a report covers.

" } }, "NumberOfFrameworks": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of frameworks a report covers.

" } }, "Accounts": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

These are the accounts to be included in the report.

\n

Use string value of ROOT to include all organizational units.

" } }, "OrganizationUnits": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

These are the Organizational Units to be included in the report.

" } }, "Regions": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

These are the Regions to be included in the report.

\n

Use the wildcard as the string value to include all Regions.

" } } }, "traits": { "smithy.api#documentation": "

Contains detailed information about a report setting.

" } }, "com.amazonaws.backup#RequesterComment": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.backup#ResourceArn": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:aws[a-z-]*:[a-z-\\d]+:).+$" } }, "com.amazonaws.backup#ResourceArns": { "type": "list", "member": { "target": "com.amazonaws.backup#ARN" } }, "com.amazonaws.backup#ResourceIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.backup#string" } }, "com.amazonaws.backup#ResourceNotFoundException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

A resource that is required for the action doesn't exist.

", "smithy.api#error": "client" } }, "com.amazonaws.backup#ResourceSelection": { "type": "structure", "members": { "Resources": { "target": "com.amazonaws.backup#ResourceArns", "traits": { "smithy.api#documentation": "

An array of strings that either contains ARNs of the associated resources\n or contains a wildcard * to specify all resources.\n You can specify up to 100 specific resources per tiering configuration.

", "smithy.api#required": {} } }, "TieringDownSettingsInDays": { "target": "com.amazonaws.backup#TieringDownSettingsInDays", "traits": { "smithy.api#documentation": "

The number of days after creation within a backup vault that an object can transition to the low cost warm storage tier.\n Must be a positive integer between 60 and 36500 days.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource; for example, S3 for Amazon S3.\n For tiering configurations, this is currently limited to S3.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

This contains metadata about resource selection for tiering configurations.

\n

You can specify up to 5 different resource selections per tiering configuration.\n Data moved to lower-cost tier remains there until deletion (one-way transition).

" } }, "com.amazonaws.backup#ResourceSelections": { "type": "list", "member": { "target": "com.amazonaws.backup#ResourceSelection" } }, "com.amazonaws.backup#ResourceType": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" } }, "com.amazonaws.backup#ResourceTypeList": { "type": "list", "member": { "target": "com.amazonaws.backup#ARN" } }, "com.amazonaws.backup#ResourceTypeManagementPreference": { "type": "map", "key": { "target": "com.amazonaws.backup#ResourceType" }, "value": { "target": "com.amazonaws.backup#IsEnabled" } }, "com.amazonaws.backup#ResourceTypeOptInPreference": { "type": "map", "key": { "target": "com.amazonaws.backup#ResourceType" }, "value": { "target": "com.amazonaws.backup#IsEnabled" } }, "com.amazonaws.backup#ResourceTypes": { "type": "list", "member": { "target": "com.amazonaws.backup#ResourceType" } }, "com.amazonaws.backup#RestoreAccessBackupVaultList": { "type": "list", "member": { "target": "com.amazonaws.backup#RestoreAccessBackupVaultListMember" } }, "com.amazonaws.backup#RestoreAccessBackupVaultListMember": { "type": "structure", "members": { "RestoreAccessBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the restore access backup vault.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the restore access backup vault was created.

" } }, "ApprovalDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time when the restore access backup vault was approved.

" } }, "VaultState": { "target": "com.amazonaws.backup#VaultState", "traits": { "smithy.api#documentation": "

The current state of the restore access backup vault.

" } }, "LatestRevokeRequest": { "target": "com.amazonaws.backup#LatestRevokeRequest", "traits": { "smithy.api#documentation": "

Information about the latest request to revoke access to this backup vault.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a restore access backup vault.

" } }, "com.amazonaws.backup#RestoreDeletionStatus": { "type": "enum", "members": { "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "SUCCESSFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESSFUL" } } } }, "com.amazonaws.backup#RestoreJobCreator": { "type": "structure", "members": { "RestoreTestingPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies \n a restore testing plan.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the restore testing plan that \n Backup used to initiate the restore job.

" } }, "com.amazonaws.backup#RestoreJobId": { "type": "string" }, "com.amazonaws.backup#RestoreJobState": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "ABORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "AGGREGATE_ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGGREGATE_ALL" } }, "ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY" } } } }, "com.amazonaws.backup#RestoreJobStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "ABORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ABORTED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.backup#RestoreJobSummary": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.backup#Region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" } }, "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" } }, "State": { "target": "com.amazonaws.backup#RestoreJobState", "traits": { "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types.

" } }, "Count": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" } }, "StartTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "EndTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } } }, "traits": { "smithy.api#documentation": "

This is a summary of restore jobs created \n or running within the most recent 14 days.

\n

The returned summary may contain the following: \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" } }, "com.amazonaws.backup#RestoreJobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.backup#RestoreJobSummary" } }, "com.amazonaws.backup#RestoreJobsList": { "type": "list", "member": { "target": "com.amazonaws.backup#RestoreJobsListMember" } }, "com.amazonaws.backup#RestoreJobsListMember": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID that owns the restore job.

" } }, "RestoreJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "SourceResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.

" } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a restore job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "Status": { "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { "smithy.api#documentation": "

A status code specifying the state of the job initiated by Backup to restore\n a recovery point.

" } }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A detailed message explaining the status of the job to restore a recovery point.

" } }, "PercentDone": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" } }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

The IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, "ExpectedCompletionTimeMinutes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to\n take.

" } }, "CreatedResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.\n For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" } }, "RecoveryPointCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date on which a recovery point was created.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a boolean value indicating whether the restore job is a parent (composite) restore job.

" } }, "ParentJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This is the unique identifier of the parent restore job for the selected restore job.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#RestoreJobCreator", "traits": { "smithy.api#documentation": "

Contains identifying information about the creation \n of a restore job.

" } }, "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { "smithy.api#documentation": "

The status of validation run on the indicated \n restore job.

" } }, "ValidationStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This describes the status of validation run on the \n indicated restore job.

" } }, "DeletionStatus": { "target": "com.amazonaws.backup#RestoreDeletionStatus", "traits": { "smithy.api#documentation": "

This notes the status of the data generated by the restore \n test. The status may be Deleting, Failed, \n or Successful.

" } }, "DeletionStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

This describes the restore job deletion status.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata about a restore job.

" } }, "com.amazonaws.backup#RestoreTestingPlanForCreate": { "type": "structure", "members": { "RecoveryPointSelection": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", "traits": { "smithy.api#documentation": "

\n RecoveryPointSelection has five parameters (three required and two\n optional). The values you specify determine which recovery point is included in the restore\n test. You must indicate with Algorithm if you want the latest recovery point\n within your SelectionWindowDays or if you want a random recovery point, and\n you must indicate through IncludeVaults from which vaults the recovery points\n can be chosen.

\n

\n Algorithm (required) Valid values:\n \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\".

\n

\n Recovery point types (required) Valid values:\n \"SNAPSHOT\" and/or \"CONTINUOUS\". Include SNAPSHOT\n to restore only snapshot recovery points; include CONTINUOUS to restore\n continuous recovery points (point in time restore / PITR); use both to restore either a\n snapshot or a continuous recovery point. The recovery point will be determined by the value\n for Algorithm.

\n

\n IncludeVaults (required). You must include one or more\n backup vaults. Use the wildcard [\"*\"] or specific ARNs.

\n

\n SelectionWindowDays (optional) Value must be an\n integer (in days) from 1 to 365. If not included, the value defaults to\n 30.

\n

\n ExcludeVaults (optional). You can choose to input one\n or more specific backup vault ARNs to exclude those vaults' contents from restore\n eligibility. Or, you can include a list of selectors. If this parameter and its value are\n not included, it defaults to empty list.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The RestoreTestingPlanName is a unique string that is the name \n of the restore testing plan. This cannot be changed after creation, \n and it must consist of only alphanumeric characters and underscores.

", "smithy.api#required": {} } }, "ScheduleExpression": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A CRON expression in specified timezone when a restore \n testing plan is executed. When no CRON expression is provided, Backup will use the default \n expression cron(0 5 ? * * *).

", "smithy.api#required": {} } }, "ScheduleExpressionTimezone": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" } }, "StartWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a \n restore test is scheduled before a job will be canceled if it \n doesn't start successfully. This value is optional. If this value \n is included, this parameter has a maximum value of 168 hours \n (one week).

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, "com.amazonaws.backup#RestoreTestingPlanForGet": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a restore testing plan was created, \n in Unix format and Coordinated Universal Time (UTC). The value of \n CreationTime is accurate to milliseconds. For example, \n the value 1516925490.087 represents Friday, January 26, 2018 \n 12:11:30.087 AM.

", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

This identifies the request and allows failed requests to \n be retried without the risk of running the operation twice. \n If the request includes a CreatorRequestId that \n matches an existing backup plan, that plan is returned. This \n parameter is optional.

\n

If used, this parameter must \n contain 1 to 50 alphanumeric or '-_.' characters.

" } }, "LastExecutionTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The last time a restore test was run with the specified \n restore testing plan. A date and time, in Unix format and \n Coordinated Universal Time (UTC). The value of \n LastExecutionDate is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26, 2018 12:11:30.087 AM.

" } }, "LastUpdateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the restore testing plan was updated. \n This update is in Unix format and Coordinated Universal Time (UTC). \n The value of LastUpdateTime is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26, 2018 12:11:30.087 AM.

" } }, "RecoveryPointSelection": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", "traits": { "smithy.api#documentation": "

The specified criteria to assign a set of resources, such as \n recovery point types or backup vaults.

", "smithy.api#required": {} } }, "RestoreTestingPlanArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies \n a restore testing plan.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The restore testing plan name.

", "smithy.api#required": {} } }, "ScheduleExpression": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A CRON expression in specified timezone when a restore \n testing plan is executed. When no CRON expression is provided, Backup will use the default \n expression cron(0 5 ? * * *).

", "smithy.api#required": {} } }, "ScheduleExpressionTimezone": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" } }, "StartWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a \n restore test is scheduled before a job will be canceled if it \n doesn't start successfully. This value is optional. If this value \n is included, this parameter has a maximum value of 168 hours \n (one week).

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, "com.amazonaws.backup#RestoreTestingPlanForList": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a restore testing plan was created, \n in Unix format and Coordinated Universal Time (UTC). The value \n of CreationTime is accurate to milliseconds. For \n example, the value 1516925490.087 represents Friday, January 26, \n 2018 12:11:30.087 AM.

", "smithy.api#required": {} } }, "LastExecutionTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The last time a restore test was run with the specified \n restore testing plan. A date and time, in Unix format and \n Coordinated Universal Time (UTC). The value of \n LastExecutionDate is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26, 2018 12:11:30.087 AM.

" } }, "LastUpdateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the restore testing plan was updated. \n This update is in Unix format and Coordinated Universal Time (UTC). \n The value of LastUpdateTime is accurate to \n milliseconds. For example, the value 1516925490.087 represents \n Friday, January 26, 2018 12:11:30.087 AM.

" } }, "RestoreTestingPlanArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifiesa \n restore testing plan.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The restore testing plan name.

", "smithy.api#required": {} } }, "ScheduleExpression": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A CRON expression in specified timezone when a restore testing plan is executed. When no\n CRON expression is provided, Backup will use the default expression\n cron(0 5 ? * * *).

", "smithy.api#required": {} } }, "ScheduleExpressionTimezone": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" } }, "StartWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a restore test is scheduled before \n a job will be canceled if it doesn't start successfully. This \n value is optional. If this value is included, this parameter \n has a maximum value of 168 hours (one week).

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, "com.amazonaws.backup#RestoreTestingPlanForUpdate": { "type": "structure", "members": { "RecoveryPointSelection": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", "traits": { "smithy.api#documentation": "

Required: Algorithm; RecoveryPointTypes; \n IncludeVaults (one or more).

\n

Optional: SelectionWindowDays ('30' if \n not specified); ExcludeVaults (defaults to empty \n list if not listed).

" } }, "ScheduleExpression": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A CRON expression in specified timezone when a restore testing plan is executed. When no\n CRON expression is provided, Backup will use the default expression\n cron(0 5 ? * * *).

" } }, "ScheduleExpressionTimezone": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" } }, "StartWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a restore test is scheduled before a \n job will be canceled if it doesn't start successfully. This value \n is optional. If this value is included, this parameter has a \n maximum value of 168 hours (one week).

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, "com.amazonaws.backup#RestoreTestingPlans": { "type": "list", "member": { "target": "com.amazonaws.backup#RestoreTestingPlanForList" } }, "com.amazonaws.backup#RestoreTestingRecoveryPointSelection": { "type": "structure", "members": { "Algorithm": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelectionAlgorithm", "traits": { "smithy.api#documentation": "

Acceptable values include \"LATEST_WITHIN_WINDOW\" or \n \"RANDOM_WITHIN_WINDOW\"

" } }, "ExcludeVaults": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

Accepted values include specific ARNs or list of selectors. \n Defaults to empty list if not listed.

" } }, "IncludeVaults": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

Accepted values include wildcard [\"*\"] or by specific ARNs or \n ARN wilcard replacement \n [\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...] \n [\"arn:aws:backup:*:*:backup-vault:asdf-*\", ...]

" } }, "RecoveryPointTypes": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointTypeList", "traits": { "smithy.api#documentation": "

These are the types of recovery points.

\n

Include SNAPSHOT\n to restore only snapshot recovery points; include CONTINUOUS to restore\n continuous recovery points (point in time restore / PITR); use both to restore either a\n snapshot or a continuous recovery point. The recovery point will be determined by the value\n for Algorithm.

" } }, "SelectionWindowDays": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

Accepted values are integers from 1 to 365. If not included, the value defaults to 30.\n The selection window is calculated from the actual job execution time, not the plan's\n scheduled start time.

" } } }, "traits": { "smithy.api#documentation": "

\n RecoveryPointSelection has five parameters (three required and two\n optional). The values you specify determine which recovery point is included in the restore\n test. You must indicate with Algorithm if you want the latest recovery point\n within your SelectionWindowDays or if you want a random recovery point, and\n you must indicate through IncludeVaults from which vaults the recovery points\n can be chosen.

\n

\n Algorithm (required) Valid values:\n \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\".

\n

\n Recovery point types (required) Valid values:\n \"SNAPSHOT\" and/or \"CONTINUOUS\". Include SNAPSHOT\n to restore only snapshot recovery points; include CONTINUOUS to restore\n continuous recovery points (point in time restore / PITR); use both to restore either a\n snapshot or a continuous recovery point. The recovery point will be determined by the value\n for Algorithm.

\n

\n IncludeVaults (required). You must include one or more\n backup vaults. Use the wildcard [\"*\"] or specific ARNs.

\n

\n SelectionWindowDays (optional) Value must be an\n integer (in days) from 1 to 365. If not included, the value defaults to\n 30.

\n

\n ExcludeVaults (optional). You can choose to input one\n or more specific backup vault ARNs to exclude those vaults' contents from restore\n eligibility. Or, you can include a list of selectors. If this parameter and its value are\n not included, it defaults to empty list.

" } }, "com.amazonaws.backup#RestoreTestingRecoveryPointSelectionAlgorithm": { "type": "enum", "members": { "LATEST_WITHIN_WINDOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LATEST_WITHIN_WINDOW" } }, "RANDOM_WITHIN_WINDOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RANDOM_WITHIN_WINDOW" } } } }, "com.amazonaws.backup#RestoreTestingRecoveryPointType": { "type": "enum", "members": { "CONTINUOUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUOUS" } }, "SNAPSHOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNAPSHOT" } } } }, "com.amazonaws.backup#RestoreTestingRecoveryPointTypeList": { "type": "list", "member": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointType" } }, "com.amazonaws.backup#RestoreTestingSelectionForCreate": { "type": "structure", "members": { "IamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; \n for example: arn:aws:iam::123456789012:role/S3Access.\n

", "smithy.api#required": {} } }, "ProtectedResourceArns": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

Each protected resource can be filtered by its specific ARNs, such as \n ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] \n or by a wildcard: ProtectedResourceArns: [\"*\"], \n but not both.

" } }, "ProtectedResourceConditions": { "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { "smithy.api#documentation": "

If you have included the wildcard in ProtectedResourceArns, \n you can include resource conditions, such as \n ProtectedResourceConditions: { StringEquals: [{ key: \"XXXX\", \n value: \"YYYY\" }].

" } }, "ProtectedResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource included in a restore \n testing selection; for example, an Amazon EBS volume or \n an Amazon RDS database.

\n

Supported resource types accepted include:

\n ", "smithy.api#required": {} } }, "RestoreMetadataOverrides": { "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { "smithy.api#documentation": "

You can override certain restore metadata keys by including the parameter\n RestoreMetadataOverrides in the body of\n RestoreTestingSelection. Key values are not case sensitive.

\n

See the complete list of restore testing\n inferred metadata.

" } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique name of the restore testing selection \n that belongs to the related restore testing plan.

\n

The name consists of only alphanumeric characters and underscores. \n Maximum length is 50.

", "smithy.api#required": {} } }, "ValidationWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

This is amount of hours (0 to 168) available to run a validation script on the data. The\n data will be deleted upon the completion of the validation script or the end of the\n specified retention period, whichever comes first.

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a specific restore testing selection.

\n

ProtectedResourceType is required, such as Amazon EBS or \n Amazon EC2.

\n

This consists of RestoreTestingSelectionName,\n ProtectedResourceType, and one of the following:

\n \n

Each protected resource type can have one single value.

\n

A restore testing selection can include a wildcard value (\"*\") for\n ProtectedResourceArns along with ProtectedResourceConditions.\n Alternatively, you can include up to 30 specific protected resource ARNs in\n ProtectedResourceArns.

\n

\n ProtectedResourceConditions examples include as StringEquals \n and StringNotEquals.

" } }, "com.amazonaws.backup#RestoreTestingSelectionForGet": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a restore testing selection was created, \n in Unix format and Coordinated Universal Time (UTC). The value of \n CreationTime is accurate to milliseconds. For example, \n the value 1516925490.087 represents Friday, January 26, \n 201812:11:30.087 AM.

", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

This identifies the request and allows failed requests to \n be retried without the risk of running the operation twice. \n If the request includes a CreatorRequestId that \n matches an existing backup plan, that plan is returned. This \n parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric \n or '-_.' characters.

" } }, "IamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; for \n example:arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "ProtectedResourceArns": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

You can include specific ARNs, such as \n ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] \n or you can include a wildcard: ProtectedResourceArns: [\"*\"], \n but not both.

" } }, "ProtectedResourceConditions": { "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { "smithy.api#documentation": "

In a resource testing selection, this parameter filters by \n specific conditions such as StringEquals or \n StringNotEquals.

" } }, "ProtectedResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource included in a resource \n testing selection; \n for example, an Amazon EBS volume \n or an Amazon RDS database.

", "smithy.api#required": {} } }, "RestoreMetadataOverrides": { "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { "smithy.api#documentation": "

You can override certain restore metadata keys by including the parameter\n RestoreMetadataOverrides in the body of\n RestoreTestingSelection. Key values are not case sensitive.

\n

See the complete list of restore testing\n inferred metadata.

" } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The RestoreTestingPlanName is a unique string that is the name \n of the restore testing plan.

", "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique name of the restore testing selection that \n belongs to the related restore testing plan.

\n

The name consists of only alphanumeric characters and underscores. \n Maximum length is 50.

", "smithy.api#required": {} } }, "ValidationWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

This is amount of hours (1 to 168) available to run a validation script on the data. The\n data will be deleted upon the completion of the validation script or the end of the\n specified retention period, whichever comes first.

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a restore testing selection.

" } }, "com.amazonaws.backup#RestoreTestingSelectionForList": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a restore testing selection \n was created, in Unix format and Coordinated Universal Time (UTC). \n The value of CreationTime is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26,2018 12:11:30.087 AM.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; for example: \n arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "ProtectedResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource included in a restore \n testing selection; for example, an \n Amazon EBS volume or an\n Amazon RDS database.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Unique string that is the name of the restore testing plan.

\n

The name cannot be changed after creation. The name must \n consist of only alphanumeric characters and underscores. \n Maximum length is 50.

", "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Unique name of a restore testing selection.

\n

The name consists of only alphanumeric characters and underscores. \n Maximum length is 50.

", "smithy.api#required": {} } }, "ValidationWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

This value represents the time, in hours, data is retained after \n a restore test so that optional validation can be completed.

\n

Accepted value is an integer between \n 0 and 168 (the hourly equivalent of seven days).

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a restore testing selection.

" } }, "com.amazonaws.backup#RestoreTestingSelectionForUpdate": { "type": "structure", "members": { "IamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; for example: \n arn:aws:iam::123456789012:role/S3Access.

" } }, "ProtectedResourceArns": { "target": "com.amazonaws.backup#stringList", "traits": { "smithy.api#documentation": "

You can include a list of specific ARNs, such as \n ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] \n or you can include a wildcard: ProtectedResourceArns: [\"*\"], \n but not both.

" } }, "ProtectedResourceConditions": { "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { "smithy.api#documentation": "

The conditions that you define for resources in \n your restore testing plan using tags.

" } }, "RestoreMetadataOverrides": { "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { "smithy.api#documentation": "

You can override certain restore metadata keys by including the parameter\n RestoreMetadataOverrides in the body of\n RestoreTestingSelection. Key values are not case sensitive.

\n

See the complete list of restore testing\n inferred metadata.

" } }, "ValidationWindowHours": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

This value represents the time, in hours, data is retained after \n a restore test so that optional validation can be completed.

\n

Accepted value is an integer between \n 0 and 168 (the hourly equivalent of seven days).

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a restore testing selection.

" } }, "com.amazonaws.backup#RestoreTestingSelections": { "type": "list", "member": { "target": "com.amazonaws.backup#RestoreTestingSelectionForList" } }, "com.amazonaws.backup#RestoreValidationStatus": { "type": "enum", "members": { "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "SUCCESSFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESSFUL" } }, "TIMED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMED_OUT" } }, "VALIDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATING" } } } }, "com.amazonaws.backup#RevokeRestoreAccessBackupVault": { "type": "operation", "input": { "target": "com.amazonaws.backup#RevokeRestoreAccessBackupVaultInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.

", "smithy.api#http": { "method": "DELETE", "uri": "/logically-air-gapped-backup-vaults/{BackupVaultName}/restore-access-backup-vaults/{RestoreAccessBackupVaultArn}", "code": 200 } } }, "com.amazonaws.backup#RevokeRestoreAccessBackupVaultInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of the source backup vault associated with the restore access backup vault to be revoked.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RestoreAccessBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of the restore access backup vault to revoke.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RequesterComment": { "target": "com.amazonaws.backup#RequesterComment", "traits": { "smithy.api#documentation": "

A comment explaining the reason for revoking access to the restore access backup vault.

", "smithy.api#httpQuery": "requesterComment" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#RuleExecutionType": { "type": "enum", "members": { "CONTINUOUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUOUS" } }, "SNAPSHOTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNAPSHOTS" } }, "CONTINUOUS_AND_SNAPSHOTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUOUS_AND_SNAPSHOTS" } } } }, "com.amazonaws.backup#ScanAction": { "type": "structure", "members": { "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

The malware scanner to use for the scan action. Currently only GUARDDUTY is supported.

" } }, "ScanMode": { "target": "com.amazonaws.backup#ScanMode", "traits": { "smithy.api#documentation": "

The scanning mode to use for the scan action.

\n

Valid values: FULL_SCAN | INCREMENTAL_SCAN.

" } } }, "traits": { "smithy.api#documentation": "

Defines a scanning action that specifies the malware scanner and scan mode to use.

" } }, "com.amazonaws.backup#ScanActions": { "type": "list", "member": { "target": "com.amazonaws.backup#ScanAction" } }, "com.amazonaws.backup#ScanFinding": { "type": "enum", "members": { "MALWARE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MALWARE" } } } }, "com.amazonaws.backup#ScanFindings": { "type": "list", "member": { "target": "com.amazonaws.backup#ScanFinding" } }, "com.amazonaws.backup#ScanJob": { "type": "structure", "members": { "AccountId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The account ID that owns the scan job.

", "smithy.api#required": {} } }, "BackupVaultArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

", "smithy.api#required": {} } }, "BackupVaultName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#required": {} } }, "CompletionDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a scan job is completed, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "ContinuousScanEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The point in time the scan job scanned up to for a continuous backup.

" } }, "ContinuousScanStartTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The point in time the scan job started scan from for a continuous backup.

" } }, "CreatedBy": { "target": "com.amazonaws.backup#ScanJobCreator", "traits": { "smithy.api#documentation": "

Contains identifying information about the creation of a scan job.

", "smithy.api#required": {} } }, "CreationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a scan job is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the scan job; for example,\n arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

", "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the recovery point being scanned; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#required": {} } }, "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the source resource of the recovery point being scanned.

", "smithy.api#required": {} } }, "ResourceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The non-unique name of the resource that belongs to the specified backup.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.backup#ScanResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "smithy.api#required": {} } }, "ScanBaseRecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the base recovery point for scanning. This field is populated\n when an incremental scan job has taken place.

" } }, "ScanId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The scan ID generated by the malware scanner for the corresponding scan job.

" } }, "ScanJobId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier that identifies the scan job request to Backup.

", "smithy.api#required": {} } }, "ScanMode": { "target": "com.amazonaws.backup#ScanMode", "traits": { "smithy.api#documentation": "

Specifies the scan type use for the scan job.

\n

Includes:

\n

\n FULL_SCAN will scan the entire data lineage within the backup.

\n

\n INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

", "smithy.api#required": {} } }, "ScanResult": { "target": "com.amazonaws.backup#ScanResultInfo", "traits": { "smithy.api#documentation": "

Contains the scan results information, including the status of threats found during scanning.

" } }, "ScannerRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Specifies the scanner IAM role ARN used for the scan job.

", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.backup#ScanState", "traits": { "smithy.api#documentation": "

The current state of the scan job.

\n

Valid values: CREATED | RUNNING | COMPLETED | \n COMPLETED_WITH_ISSUES | FAILED | CANCELED.

" } }, "StatusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A detailed message explaining the status of the scan job.

" } } }, "traits": { "smithy.api#documentation": "

Contains metadata about a scan job, including information about the scanning process, results, and associated resources.

" } }, "com.amazonaws.backup#ScanJobCreator": { "type": "structure", "members": { "BackupPlanArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

", "smithy.api#required": {} } }, "BackupPlanId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the backup plan.

", "smithy.api#required": {} } }, "BackupPlanVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

", "smithy.api#required": {} } }, "BackupRuleId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Uniquely identifies the backup rule that initiated the scan job.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.

" } }, "com.amazonaws.backup#ScanJobState": { "type": "enum", "members": { "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "COMPLETED_WITH_ISSUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED_WITH_ISSUES" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } } } }, "com.amazonaws.backup#ScanJobStatus": { "type": "enum", "members": { "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "COMPLETED_WITH_ISSUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED_WITH_ISSUES" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "AGGREGATE_ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGGREGATE_ALL" } }, "ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY" } } } }, "com.amazonaws.backup#ScanJobSummary": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.backup#Region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region where the scan jobs were executed.

" } }, "AccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { "smithy.api#documentation": "

The account ID that owns the scan jobs included in this summary.

" } }, "State": { "target": "com.amazonaws.backup#ScanJobStatus", "traits": { "smithy.api#documentation": "

The state of the scan jobs included in this summary.

\n

Valid values: CREATED | RUNNING | COMPLETED | \n COMPLETED_WITH_ISSUES | FAILED | CANCELED.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

The type of Amazon Web Services resource for the scan jobs included in this summary.

" } }, "Count": { "target": "com.amazonaws.backup#integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of scan jobs that match the specified criteria.

" } }, "StartTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "EndTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

" } }, "ScanResultStatus": { "target": "com.amazonaws.backup#ScanResultStatus", "traits": { "smithy.api#documentation": "

The scan result status for the scan jobs included in this summary.

\n

Valid values: THREATS_FOUND | NO_THREATS_FOUND.

" } } }, "traits": { "smithy.api#documentation": "

Contains summary information about scan jobs, including counts and metadata for a specific time period and criteria.

" } }, "com.amazonaws.backup#ScanJobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.backup#ScanJobSummary" } }, "com.amazonaws.backup#ScanJobs": { "type": "list", "member": { "target": "com.amazonaws.backup#ScanJob" } }, "com.amazonaws.backup#ScanMode": { "type": "enum", "members": { "FULL_SCAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULL_SCAN" } }, "INCREMENTAL_SCAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCREMENTAL_SCAN" } } } }, "com.amazonaws.backup#ScanResourceType": { "type": "enum", "members": { "EBS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EBS" } }, "EC2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EC2" } }, "S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3" } } } }, "com.amazonaws.backup#ScanResult": { "type": "structure", "members": { "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

The malware scanner used to perform the scan. Currently only GUARDDUTY is supported.

" } }, "ScanJobState": { "target": "com.amazonaws.backup#ScanJobState", "traits": { "smithy.api#documentation": "

The final state of the scan job.

\n

Valid values: COMPLETED | FAILED | CANCELED.

" } }, "LastScanTimestamp": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The timestamp of when the last scan was performed, in Unix format and Coordinated Universal Time (UTC).

" } }, "Findings": { "target": "com.amazonaws.backup#ScanFindings", "traits": { "smithy.api#documentation": "

An array of findings discovered during the scan.

" } } }, "traits": { "smithy.api#documentation": "

Contains the results of a security scan, including scanner information, scan state, and any findings discovered.

" } }, "com.amazonaws.backup#ScanResultInfo": { "type": "structure", "members": { "ScanResultStatus": { "target": "com.amazonaws.backup#ScanResultStatus", "traits": { "smithy.api#documentation": "

The status of the scan results.

\n

Valid values: THREATS_FOUND | NO_THREATS_FOUND | UNKNOWN.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about the results of a scan job.

" } }, "com.amazonaws.backup#ScanResultStatus": { "type": "enum", "members": { "NO_THREATS_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_THREATS_FOUND" } }, "THREATS_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THREATS_FOUND" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } } } }, "com.amazonaws.backup#ScanResults": { "type": "list", "member": { "target": "com.amazonaws.backup#ScanResult" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.backup#ScanSetting": { "type": "structure", "members": { "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

The malware scanner to use for scanning. Currently only GUARDDUTY is supported.

" } }, "ResourceTypes": { "target": "com.amazonaws.backup#ResourceTypes", "traits": { "smithy.api#documentation": "

An array of resource types to be scanned for malware.

" } }, "ScannerRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the scanner uses to access resources; for example,\n arn:aws:iam::123456789012:role/ScannerRole.

" } } }, "traits": { "smithy.api#documentation": "

Contains configuration settings for malware scanning, including the scanner type, target resource types, and scanner role.

" } }, "com.amazonaws.backup#ScanSettings": { "type": "list", "member": { "target": "com.amazonaws.backup#ScanSetting" } }, "com.amazonaws.backup#ScanState": { "type": "enum", "members": { "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "COMPLETED_WITH_ISSUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED_WITH_ISSUES" } }, "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } } } }, "com.amazonaws.backup#ScheduledPlanExecutionMember": { "type": "structure", "members": { "ExecutionTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the backup is scheduled to run, in Unix format and Coordinated Universal Time (UTC). The value is accurate to milliseconds.

" } }, "RuleId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The unique identifier of the backup rule that will execute at the scheduled time.

" } }, "RuleExecutionType": { "target": "com.amazonaws.backup#RuleExecutionType", "traits": { "smithy.api#documentation": "

The type of backup rule execution. Valid values are CONTINUOUS (point-in-time recovery), SNAPSHOTS (snapshot backups), or CONTINUOUS_AND_SNAPSHOTS (both types combined).

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a scheduled backup plan execution, including the execution time, rule type, and associated rule identifier.

" } }, "com.amazonaws.backup#ScheduledRunsPreview": { "type": "list", "member": { "target": "com.amazonaws.backup#ScheduledPlanExecutionMember" } }, "com.amazonaws.backup#SensitiveStringMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.backup#ServiceUnavailableException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.backup#string" }, "Message": { "target": "com.amazonaws.backup#string" }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

The request failed due to a temporary failure of the server.

", "smithy.api#error": "server" } }, "com.amazonaws.backup#StartBackupJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#StartBackupJobInput" }, "output": { "target": "com.amazonaws.backup#StartBackupJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Starts an on-demand backup job for the specified resource.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-jobs", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#StartBackupJobInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#required": {} } }, "LogicallyAirGappedBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN of a logically air-gapped vault. ARN must be in the same account and Region.\n If provided, supported fully managed resources back up directly to logically air-gapped vault,\n while other supported resources create a temporary (billable) snapshot in backup vault,\n then copy it to logically air-gapped vault. Unsupported resources only back up to the specified\n backup vault.

" } }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartBackupJob. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } }, "StartWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional, and the default is 8 hours. \n If this value is included, it must be at least 60 minutes to avoid errors.

\n

This parameter has a maximum value of 100 years (52,560,000 minutes).

\n

During the start window, the backup job status remains in CREATED status until it \n has successfully begun or until the start window time has run out. If within the start \n window time Backup receives an error that allows the job to be retried, \n Backup will automatically retry to begin the job at least every 10 minutes \n until the backup \n successfully begins (the job status changes to RUNNING) or until the job status \n changes to EXPIRED (which is expected to occur when the start window time is over).

" } }, "CompleteWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { "smithy.api#documentation": "

A value in minutes during which a successfully started backup must complete, or else\n Backup will cancel the job. This value is optional. This value begins\n counting down from when the backup was scheduled. It does not add additional time for\n StartWindowMinutes, or if the backup started later than scheduled.

\n

Like StartWindowMinutes, this parameter has a maximum value of \n 100 years (52,560,000 minutes).

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold.

\n

Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for\n other resource types.

\n

This parameter has a maximum value of 100 years (36,500 days).

" } }, "RecoveryPointTags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

The tags to assign to the resources.

" } }, "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { "smithy.api#documentation": "

The backup option for a selected resource. This option is only available for\n Windows Volume Shadow Copy Service (VSS) backup jobs.

\n

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the\n WindowsVSS backup option and create a Windows VSS backup. Set to\n \"WindowsVSS\"\"disabled\" to create a regular backup. The\n WindowsVSS option is not enabled by default.

" } }, "Index": { "target": "com.amazonaws.backup#Index", "traits": { "smithy.api#documentation": "

Include this parameter to enable index creation if your backup \n job has a resource type that supports backup indexes.

\n

Resource types that support backup indexes include:

\n \n

Index can have 1 of 2 possible values, either ENABLED or \n DISABLED.

\n

To create a backup index for an eligible ACTIVE recovery point \n that does not yet have a backup index, set value to ENABLED.

\n

To delete a backup index, set value to DISABLED.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#StartBackupJobOutput": { "type": "structure", "members": { "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

\n Note: This field is only returned for Amazon EFS and Advanced DynamoDB \n resources.\n

\n

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a returned boolean value indicating this is a parent (composite) \n backup job.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#StartCopyJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#StartCopyJobInput" }, "output": { "target": "com.amazonaws.backup#StartCopyJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Starts a job to create a one-time copy of the specified resource.

\n

Does not support continuous backups.

\n

See Copy \n job retry for information on how Backup retries copy job \n operations.

", "smithy.api#http": { "method": "PUT", "uri": "/copy-jobs", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#StartCopyJobInput": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point to use for the copy job; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.\n

", "smithy.api#required": {} } }, "SourceBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical source container where backups are stored. Backup vaults are\n identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

", "smithy.api#required": {} } }, "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to\n copy to; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to copy the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartCopyJob. Retrying a successful request with the same idempotency\n token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#StartCopyJobOutput": { "type": "structure", "members": { "CopyJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a copy job.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a copy job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "IsParent": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is a returned boolean value indicating this is a parent (composite) \n copy job.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#StartReportJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#StartReportJobInput" }, "output": { "target": "com.amazonaws.backup#StartReportJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Starts an on-demand report job for the specified report plan.

", "smithy.api#http": { "method": "POST", "uri": "/audit/report-jobs/{ReportPlanName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#StartReportJobInput": { "type": "structure", "members": { "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of a report plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartReportJobInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#StartReportJobOutput": { "type": "structure", "members": { "ReportJobId": { "target": "com.amazonaws.backup#ReportJobId", "traits": { "smithy.api#documentation": "

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. The report job ID cannot be edited.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#StartRestoreJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#StartRestoreJobInput" }, "output": { "target": "com.amazonaws.backup#StartRestoreJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Recovers the saved resource identified by an Amazon Resource Name (ARN).

", "smithy.api#http": { "method": "PUT", "uri": "/restore-jobs", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#StartRestoreJobInput": { "type": "structure", "members": { "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.backup#Metadata", "traits": { "smithy.api#documentation": "

A set of metadata key-value pairs.

\n

You can get configuration metadata about a resource at the time it was backed up by\n calling GetRecoveryPointRestoreMetadata. However, values in addition to those\n provided by GetRecoveryPointRestoreMetadata might be required to restore a\n resource. For example, you might need to provide a new resource name if the original\n already exists.

\n

For more information about the metadata for each resource, see the following:

\n ", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create\n the target resource; for example:\n arn:aws:iam::123456789012:role/S3Access.

" } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartRestoreJob. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { "smithy.api#documentation": "

Starts a job to restore a recovery point for one of the following resources:

\n " } }, "CopySourceTagsToRestoredResource": { "target": "com.amazonaws.backup#Boolean2", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

This is an optional parameter. If this equals True, tags included in the backup\n will be copied to the restored resource.

\n

This can only be applied to backups created through Backup.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#StartRestoreJobOutput": { "type": "structure", "members": { "RestoreJobId": { "target": "com.amazonaws.backup#RestoreJobId", "traits": { "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#StartScanJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#StartScanJobInput" }, "output": { "target": "com.amazonaws.backup#StartScanJobOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Starts scanning jobs for specific resources.

", "smithy.api#http": { "method": "PUT", "uri": "/scan/job", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#StartScanJobInput": { "type": "structure", "members": { "BackupVaultName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified by names that \n are unique to the account used to create them and the Amazon Web Services Region where they are created.

\n

Pattern: ^[a-zA-Z0-9\\-\\_]{2,50}$\n

", "smithy.api#required": {} } }, "ContinuousScanEndTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The point in time the scan job will scan up to for a continuous backup.

" } }, "IamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartScanJob. Retrying a successful request with the same idempotency\n token results in a success message with no action taken.

" } }, "MalwareScanner": { "target": "com.amazonaws.backup#MalwareScanner", "traits": { "smithy.api#documentation": "

Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

", "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. \n If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.

", "smithy.api#required": {} } }, "ScanBaseRecoveryPointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies the base recovery point to be used for incremental scanning.

" } }, "ScanMode": { "target": "com.amazonaws.backup#ScanMode", "traits": { "smithy.api#documentation": "

Specifies the scan type use for the scan job.

\n

Includes:

\n ", "smithy.api#required": {} } }, "ScannerRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Specified the IAM scanner role ARN.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#StartScanJobOutput": { "type": "structure", "members": { "CreationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

", "smithy.api#required": {} } }, "ScanJobId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#StopBackupJob": { "type": "operation", "input": { "target": "com.amazonaws.backup#StopBackupJobInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Attempts to cancel a job to create a one-time backup of a resource.

\n

This action is not supported for the following services:

\n ", "smithy.api#http": { "method": "POST", "uri": "/backup-jobs/{BackupJobId}", "code": 200 } } }, "com.amazonaws.backup#StopBackupJobInput": { "type": "structure", "members": { "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#StorageClass": { "type": "enum", "members": { "WARM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WARM" } }, "COLD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COLD" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.backup#TagKey": { "type": "string" }, "com.amazonaws.backup#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.backup#string" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.backup#TagMap": { "type": "map", "key": { "target": "com.amazonaws.backup#TagMapKeyString" }, "value": { "target": "com.amazonaws.backup#TagMapValueString" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 }, "smithy.api#sensitive": {} } }, "com.amazonaws.backup#TagMapKeyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.backup#TagMapValueString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.backup#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.backup#TagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Assigns a set of key-value pairs to a resource.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#TagResourceInput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The ARN that uniquely identifies the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.backup#Tags", "traits": { "smithy.api#documentation": "

Key-value pairs that are used to help organize your resources. You can assign your own\n metadata to the resources you create. For clarity, this is the structure to assign tags:\n [{\"Key\":\"string\",\"Value\":\"string\"}].

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#TagValue": { "type": "string" }, "com.amazonaws.backup#Tags": { "type": "map", "key": { "target": "com.amazonaws.backup#TagKey" }, "value": { "target": "com.amazonaws.backup#TagValue" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.backup#TieringConfiguration": { "type": "structure", "members": { "TieringConfigurationName": { "target": "com.amazonaws.backup#TieringConfigurationName", "traits": { "smithy.api#documentation": "

The unique name of the tiering configuration. This cannot be changed\n after creation, and it must consist of only alphanumeric characters and underscores.

", "smithy.api#required": {} } }, "TieringConfigurationArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the\n tiering configuration.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultNameOrWildcard", "traits": { "smithy.api#documentation": "

The name of the backup vault where the tiering configuration applies.\n Use * to apply to all backup vaults.

", "smithy.api#required": {} } }, "ResourceSelection": { "target": "com.amazonaws.backup#ResourceSelections", "traits": { "smithy.api#documentation": "

An array of resource selection objects that specify which resources\n are included in the tiering configuration and their tiering settings.

", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.backup#CreatorRequestId", "traits": { "smithy.api#documentation": "

This is a unique string that identifies the request and\n allows failed requests to be retried without the risk of running\n the operation twice.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a tiering configuration was created, in Unix format\n and Coordinated Universal Time (UTC). The value of CreationTime\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087AM.

" } }, "LastUpdatedTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a tiering configuration was updated, in Unix format\n and Coordinated Universal Time (UTC). The value of LastUpdatedTime\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087AM.

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a tiering configuration.

" } }, "com.amazonaws.backup#TieringConfigurationInputForCreate": { "type": "structure", "members": { "TieringConfigurationName": { "target": "com.amazonaws.backup#TieringConfigurationName", "traits": { "smithy.api#documentation": "

The unique name of the tiering configuration. This cannot be changed\n after creation, and it must consist of only alphanumeric characters and underscores.

", "smithy.api#required": {} } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultNameOrWildcard", "traits": { "smithy.api#documentation": "

The name of the backup vault where the tiering configuration applies.\n Use * to apply to all backup vaults.

", "smithy.api#required": {} } }, "ResourceSelection": { "target": "com.amazonaws.backup#ResourceSelections", "traits": { "smithy.api#documentation": "

An array of resource selection objects that specify which resources\n are included in the tiering configuration and their tiering settings.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a tiering configuration for create operations.

" } }, "com.amazonaws.backup#TieringConfigurationInputForUpdate": { "type": "structure", "members": { "ResourceSelection": { "target": "com.amazonaws.backup#ResourceSelections", "traits": { "smithy.api#documentation": "

An array of resource selection objects that specify which resources\n are included in the tiering configuration and their tiering settings.

", "smithy.api#required": {} } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultNameOrWildcard", "traits": { "smithy.api#documentation": "

The name of the backup vault where the tiering configuration applies.\n Use * to apply to all backup vaults.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a tiering configuration for update operations.

" } }, "com.amazonaws.backup#TieringConfigurationName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9_]{1,200}$" } }, "com.amazonaws.backup#TieringConfigurationsList": { "type": "list", "member": { "target": "com.amazonaws.backup#TieringConfigurationsListMember" }, "traits": { "smithy.api#documentation": "

A list of tiering configurations.

" } }, "com.amazonaws.backup#TieringConfigurationsListMember": { "type": "structure", "members": { "TieringConfigurationArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the\n tiering configuration.

" } }, "TieringConfigurationName": { "target": "com.amazonaws.backup#TieringConfigurationName", "traits": { "smithy.api#documentation": "

The unique name of the tiering configuration.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultNameOrWildcard", "traits": { "smithy.api#documentation": "

The name of the backup vault where the tiering configuration applies.\n Use * to apply to all backup vaults.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a tiering configuration was created, in Unix format\n and Coordinated Universal Time (UTC). The value of CreationTime\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087AM.

" } }, "LastUpdatedTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a tiering configuration was updated, in Unix format\n and Coordinated Universal Time (UTC). The value of LastUpdatedTime\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087AM.

" } } }, "traits": { "smithy.api#documentation": "

This contains metadata about a tiering configuration returned in a list.

" } }, "com.amazonaws.backup#TieringDownSettingsInDays": { "type": "integer", "traits": { "smithy.api#range": { "min": 60, "max": 36500 } } }, "com.amazonaws.backup#Timezone": { "type": "string" }, "com.amazonaws.backup#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.backup#UntagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault\n identified by an Amazon Resource Name (ARN)

\n

This API is not supported for recovery points for resource types \n including Aurora, Amazon DocumentDB. Amazon EBS, \n Amazon FSx, Neptune, and Amazon RDS.

", "smithy.api#http": { "method": "POST", "uri": "/untag/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UntagResourceInput": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of\n the tagged resource.

\n

ARNs that do not include backup are incompatible with tagging. \n TagResource and UntagResource with invalid ARNs will \n result in an error. Acceptable ARN content can include \n arn:aws:backup:us-east. Invalid ARN content may look like \n arn:aws:ec2:us-east.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeyList": { "target": "com.amazonaws.backup#TagKeyList", "traits": { "smithy.api#documentation": "

The keys to identify which key-value tags to remove from a resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateBackupPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateBackupPlanInput" }, "output": { "target": "com.amazonaws.backup#UpdateBackupPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates the specified backup plan. The new version is uniquely identified by its ID.

", "smithy.api#http": { "method": "POST", "uri": "/backup/plans/{BackupPlanId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateBackupPlanInput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The ID of the backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackupPlan": { "target": "com.amazonaws.backup#BackupPlanInput", "traits": { "smithy.api#documentation": "

The body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateBackupPlanOutput": { "type": "structure", "members": { "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "BackupPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a backup plan is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "VersionId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version Ids cannot be edited.

" } }, "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { "smithy.api#documentation": "

Contains a list of BackupOptions for each resource type.

" } }, "ScanSettings": { "target": "com.amazonaws.backup#ScanSettings", "traits": { "smithy.api#documentation": "

Contains your scanning configuration for the backup plan and includes the Malware scanner, your selected resources, and scanner role.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#UpdateFramework": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateFrameworkInput" }, "output": { "target": "com.amazonaws.backup#UpdateFrameworkOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates the specified framework.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/frameworks/{FrameworkName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateFrameworkInput": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with\n a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "FrameworkDescription": { "target": "com.amazonaws.backup#FrameworkDescription", "traits": { "smithy.api#documentation": "

An optional description of the framework with a maximum 1,024 characters.

" } }, "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { "smithy.api#documentation": "

The controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

" } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to UpdateFrameworkInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateFrameworkOutput": { "type": "structure", "members": { "FrameworkName": { "target": "com.amazonaws.backup#FrameworkName", "traits": { "smithy.api#documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with\n a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" } }, "FrameworkArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example,\n 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind\n UTC.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#UpdateGlobalSettings": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateGlobalSettingsInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

", "smithy.api#http": { "method": "PUT", "uri": "/global-settings", "code": 200 } } }, "com.amazonaws.backup#UpdateGlobalSettingsInput": { "type": "structure", "members": { "GlobalSettings": { "target": "com.amazonaws.backup#GlobalSettings", "traits": { "smithy.api#documentation": "

Inputs can include:

\n

A value for isCrossAccountBackupEnabled. Values can be true or false. Example:\n update-global-settings --global-settings isCrossAccountBackupEnabled=false.

\n

A value for Multi-party approval, styled as isMpaEnabled. Values can\n be true or false. Example:\n update-global-settings --global-settings isMpaEnabled=false.

\n

A value for Backup Service-Linked Role creation, styled as isDelegatedAdministratorEnabled.\n Values can be true or false. Example:\n update-global-settings --global-settings isDelegatedAdministratorEnabled=false.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateRecoveryPointIndexSettings": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateRecoveryPointIndexSettingsInput" }, "output": { "target": "com.amazonaws.backup#UpdateRecoveryPointIndexSettingsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This operation updates the settings of a recovery point index.

\n

Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn

", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/index", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateRecoveryPointIndexSettingsInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

\n

Accepted characters include lowercase letters, numbers, and hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

This specifies the IAM role ARN used for this operation.

\n

For example, arn:aws:iam::123456789012:role/S3Access

" } }, "Index": { "target": "com.amazonaws.backup#Index", "traits": { "smithy.api#documentation": "

Index can have 1 of 2 possible values, either ENABLED or \n DISABLED.

\n

To create a backup index for an eligible ACTIVE recovery point \n that does not yet have a backup index, set value to ENABLED.

\n

To delete a backup index, set value to DISABLED.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateRecoveryPointIndexSettingsOutput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "IndexStatus": { "target": "com.amazonaws.backup#IndexStatus", "traits": { "smithy.api#documentation": "

This is the current status for the backup index associated \n with the specified recovery point.

\n

Statuses are: PENDING | ACTIVE | FAILED | DELETING\n

\n

A recovery point with an index that has the status of ACTIVE \n can be included in a search.

" } }, "Index": { "target": "com.amazonaws.backup#Index", "traits": { "smithy.api#documentation": "

Index can have 1 of 2 possible values, either ENABLED or\n DISABLED.

\n

A value of ENABLED means a backup index for an eligible ACTIVE\n recovery point has been created.

\n

A value of DISABLED means a backup index was deleted.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#UpdateRecoveryPointLifecycle": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateRecoveryPointLifecycleInput" }, "output": { "target": "com.amazonaws.backup#UpdateRecoveryPointLifecycleOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Sets the transition lifecycle of a recovery point.

\n

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for\n other resource types.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold.

\n \n

If your lifecycle currently uses the parameters DeleteAfterDays and \n MoveToColdStorageAfterDays, include these parameters and their values when you call \n this operation. Not including them may result in your plan updating with null values.

\n
\n

This operation does not support continuous backups.

", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateRecoveryPointLifecycleInput": { "type": "structure", "members": { "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateRecoveryPointLifecycleOutput": { "type": "structure", "members": { "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

" } }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the \u201cretention\u201d setting must be 90 days greater than the \u201ctransition to\n cold after days\u201d setting. The \u201ctransition to cold after days\u201d setting cannot be changed\n after a backup has been transitioned to cold.

\n

Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

" } }, "CalculatedLifecycle": { "target": "com.amazonaws.backup#CalculatedLifecycle", "traits": { "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#UpdateRegionSettings": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateRegionSettingsInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates the current service opt-in settings for the Region.

\n

Use\n the DescribeRegionSettings API to determine the resource types that are\n supported.

", "smithy.api#http": { "method": "PUT", "uri": "/account-settings", "code": 200 } } }, "com.amazonaws.backup#UpdateRegionSettingsInput": { "type": "structure", "members": { "ResourceTypeOptInPreference": { "target": "com.amazonaws.backup#ResourceTypeOptInPreference", "traits": { "smithy.api#documentation": "

Updates the list of services along with the opt-in preferences for the Region.

\n

If resource assignments are only based on tags, then service opt-in settings are applied. \n If a resource type is explicitly assigned to a backup plan, such as Amazon S3, \n Amazon EC2, or Amazon RDS, it will be included in the \n backup even if the opt-in is not enabled for that particular service. \n If both a resource type and tags are specified in a resource assignment, \n the resource type specified in the backup plan takes priority over the \n tag condition. Service opt-in settings are disregarded in this situation.

" } }, "ResourceTypeManagementPreference": { "target": "com.amazonaws.backup#ResourceTypeManagementPreference", "traits": { "smithy.api#documentation": "

Enables or disables full Backup management of backups for a resource type.\n To enable full Backup management for DynamoDB along with \n Backup's advanced DynamoDB backup features, follow the\n procedure to enable advanced DynamoDB backup programmatically.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateReportPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateReportPlanInput" }, "output": { "target": "com.amazonaws.backup#UpdateReportPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates the specified report plan.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/report-plans/{ReportPlanName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateReportPlanInput": { "type": "structure", "members": { "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of the report plan. This name is between 1 and 256 characters, starting\n with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores\n (_).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ReportPlanDescription": { "target": "com.amazonaws.backup#ReportPlanDescription", "traits": { "smithy.api#documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" } }, "ReportDeliveryChannel": { "target": "com.amazonaws.backup#ReportDeliveryChannel", "traits": { "smithy.api#documentation": "

The information about where to deliver your reports, specifically\n your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" } }, "ReportSetting": { "target": "com.amazonaws.backup#ReportSetting", "traits": { "smithy.api#documentation": "

The report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

\n

If the report template is RESOURCE_COMPLIANCE_REPORT or\n CONTROL_COMPLIANCE_REPORT, this API resource also describes the report\n coverage by Amazon Web Services Regions and frameworks.

" } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to UpdateReportPlanInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateReportPlanOutput": { "type": "structure", "members": { "ReportPlanName": { "target": "com.amazonaws.backup#ReportPlanName", "traits": { "smithy.api#documentation": "

The unique name of the report plan.

" } }, "ReportPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a report plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#UpdateRestoreTestingPlan": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateRestoreTestingPlanInput" }, "output": { "target": "com.amazonaws.backup#UpdateRestoreTestingPlanOutput" }, "errors": [ { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request will send changes to your specified restore testing \n plan. RestoreTestingPlanName \n cannot be updated after it is created.

\n

\n RecoveryPointSelection can contain:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans/{RestoreTestingPlanName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateRestoreTestingPlanInput": { "type": "structure", "members": { "RestoreTestingPlan": { "target": "com.amazonaws.backup#RestoreTestingPlanForUpdate", "traits": { "smithy.api#documentation": "

Specifies the body of a restore testing plan.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the restore testing plan name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateRestoreTestingPlanOutput": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time the resource testing plan was \n created.

", "smithy.api#required": {} } }, "RestoreTestingPlanArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Unique ARN (Amazon Resource Name) of the restore testing plan.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name cannot be changed after creation. The name consists of \n only alphanumeric characters and underscores. Maximum length is 50.

", "smithy.api#required": {} } }, "UpdateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time the update completed for the restore \n testing plan.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#UpdateRestoreTestingSelection": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateRestoreTestingSelectionInput" }, "output": { "target": "com.amazonaws.backup#UpdateRestoreTestingSelectionOutput" }, "errors": [ { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Updates the specified restore testing selection.

\n

Most elements except the RestoreTestingSelectionName \n can be updated with this request.

\n

You can use either protected resource ARNs or conditions, but not both.

", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateRestoreTestingSelectionInput": { "type": "structure", "members": { "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The restore testing plan name is required to update the \n indicated testing plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RestoreTestingSelection": { "target": "com.amazonaws.backup#RestoreTestingSelectionForUpdate", "traits": { "smithy.api#documentation": "

To update your restore testing selection, you can use either \n protected resource ARNs or conditions, but not both. That is, if your \n selection has ProtectedResourceArns, requesting an update \n with the parameter ProtectedResourceConditions will be \n unsuccessful.

", "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The required restore testing selection name of the restore \n testing selection you wish to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateRestoreTestingSelectionOutput": { "type": "structure", "members": { "CreationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time the resource testing selection was \n updated successfully.

", "smithy.api#required": {} } }, "RestoreTestingPlanArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Unique string that is the name of the restore testing plan.

", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The restore testing plan with which the updated restore \n testing selection is associated.

", "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The returned restore testing selection name.

", "smithy.api#required": {} } }, "UpdateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The time the update completed for the restore \n testing selection.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#UpdateTieringConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.backup#UpdateTieringConfigurationInput" }, "output": { "target": "com.amazonaws.backup#UpdateTieringConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.backup#AlreadyExistsException" }, { "target": "com.amazonaws.backup#ConflictException" }, { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#LimitExceededException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

This request will send changes to your specified tiering\n configuration. TieringConfigurationName\n cannot be updated after it is created.

\n

\n ResourceSelection can contain:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/tiering-configurations/{TieringConfigurationName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.backup#UpdateTieringConfigurationInput": { "type": "structure", "members": { "TieringConfigurationName": { "target": "com.amazonaws.backup#TieringConfigurationName", "traits": { "smithy.api#documentation": "

The name of a tiering configuration to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TieringConfiguration": { "target": "com.amazonaws.backup#TieringConfigurationInputForUpdate", "traits": { "smithy.api#documentation": "

Specifies the body of a tiering configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.backup#UpdateTieringConfigurationOutput": { "type": "structure", "members": { "TieringConfigurationArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the updated\n tiering configuration.

" } }, "TieringConfigurationName": { "target": "com.amazonaws.backup#TieringConfigurationName", "traits": { "smithy.api#documentation": "

This unique string is the name of the tiering configuration.

" } }, "CreationTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a tiering configuration was created, in Unix format\n and Coordinated Universal Time (UTC). The value of CreationTime\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087AM.

" } }, "LastUpdatedTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a tiering configuration was updated, in Unix format\n and Coordinated Universal Time (UTC). The value of LastUpdatedTime\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087AM.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.backup#VaultNames": { "type": "list", "member": { "target": "com.amazonaws.backup#string" } }, "com.amazonaws.backup#VaultState": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.backup#VaultType": { "type": "enum", "members": { "BACKUP_VAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_VAULT" } }, "LOGICALLY_AIR_GAPPED_BACKUP_VAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOGICALLY_AIR_GAPPED_BACKUP_VAULT" } }, "RESTORE_ACCESS_BACKUP_VAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORE_ACCESS_BACKUP_VAULT" } } } }, "com.amazonaws.backup#WindowMinutes": { "type": "long" }, "com.amazonaws.backup#integer": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.backup#string": { "type": "string" }, "com.amazonaws.backup#stringList": { "type": "list", "member": { "target": "com.amazonaws.backup#string" } }, "com.amazonaws.backup#stringMap": { "type": "map", "key": { "target": "com.amazonaws.backup#string" }, "value": { "target": "com.amazonaws.backup#string" } }, "com.amazonaws.backup#timestamp": { "type": "timestamp" } } }