From aeb19a7eef55ef705b0117744fac6fa452cbc3f5 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 26 Jan 2021 19:06:16 +0000 Subject: [PATCH] Updates SDK documentation --- apis/backup-2018-11-15.normal.json | 52 +++++++++++++++--------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/apis/backup-2018-11-15.normal.json b/apis/backup-2018-11-15.normal.json index 9be96e4bd1..5a0ef58c4c 100644 --- a/apis/backup-2018-11-15.normal.json +++ b/apis/backup-2018-11-15.normal.json @@ -379,7 +379,7 @@ "shape": "ServiceUnavailableException" } ], - "documentation": "

The current feature settings for the AWS Account.

" + "documentation": "

Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.

" }, "DescribeProtectedResource": { "name": "DescribeProtectedResource", @@ -1349,7 +1349,7 @@ "shape": "InvalidRequestException" } ], - "documentation": "

Updates the current global settings for the AWS Account. Use the DescribeGlobalSettings API to determine the current settings.

" + "documentation": "

Updates the current global settings for the AWS account. Use the DescribeGlobalSettings API to determine the current settings.

" }, "UpdateRecoveryPointLifecycle": { "name": "UpdateRecoveryPointLifecycle", @@ -1377,7 +1377,7 @@ "shape": "ServiceUnavailableException" } ], - "documentation": "

Sets the transition lifecycle of a recovery point.

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

", + "documentation": "

Sets the transition lifecycle of a recovery point.

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

", "idempotent": true }, "UpdateRegionSettings": { @@ -1416,7 +1416,7 @@ "members": { "ResourceType": { "shape": "ResourceType", - "documentation": "

The type of AWS resource to be backed up. For VSS Windows backups, the only supported resource type is Amazon EC2.

Valid values: EC2.

" + "documentation": "

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows VSS. For an CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the AWS Backup User Guide.

Valid values: EC2.

" }, "BackupOptions": { "shape": "BackupOptions", @@ -1484,7 +1484,7 @@ }, "IamRoleArn": { "shape": "IAMRoleArn", - "documentation": "

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

" + "documentation": "

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

" }, "CreatedBy": { "shape": "RecoveryPointCreator", @@ -1703,7 +1703,7 @@ }, "Lifecycle": { "shape": "Lifecycle", - "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "RecoveryPointTags": { "shape": "Tags", @@ -1749,7 +1749,7 @@ }, "Lifecycle": { "shape": "Lifecycle", - "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "RecoveryPointTags": { "shape": "Tags", @@ -1799,7 +1799,7 @@ }, "ListOfTags": { "shape": "ListOfTags", - "documentation": "

An array of conditions used to specify a set of resources to assign to a backup plan; for example, \"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\".

" + "documentation": "

An array of conditions used to specify a set of resources to assign to a backup plan; for example, \"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\". Assigns the backup plan to every resource with at least one matching tag.

" } }, "documentation": "

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

" @@ -1925,7 +1925,7 @@ "documentation": "

A timestamp that specifies when to delete a recovery point.

" } }, - "documentation": "

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

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

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

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "Condition": { "type": "structure", @@ -2157,7 +2157,7 @@ "members": { "BackupVaultName": { "shape": "BackupVaultName", - "documentation": "

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

", + "documentation": "

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

", "location": "uri", "locationName": "backupVaultName" }, @@ -2492,7 +2492,7 @@ }, "LastUpdateTime": { "shape": "timestamp", - "documentation": "

The date and time that the global settings was 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.

" + "documentation": "

The date and time that the global settings 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.

" } } }, @@ -2605,7 +2605,7 @@ }, "Lifecycle": { "shape": "Lifecycle", - "documentation": "

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

Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

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

Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "EncryptionKeyArn": { "shape": "ARN", @@ -2992,7 +2992,7 @@ "members": { "ResourceTypes": { "shape": "ResourceTypes", - "documentation": "

Contains a string with the supported AWS resource types:

" + "documentation": "

Contains a string with the supported AWS resource types:

" } } }, @@ -3032,7 +3032,7 @@ "documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

" } }, - "documentation": "

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "ListBackupJobsInput": { "type": "structure", @@ -3081,13 +3081,13 @@ }, "ByResourceType": { "shape": "ResourceType", - "documentation": "

Returns only backup jobs for the specified resources:

", + "documentation": "

Returns only backup jobs for the specified resources:

", "location": "querystring", "locationName": "resourceType" }, "ByAccountId": { "shape": "AccountId", - "documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

", + "documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an AWS Organizations management account, passing * returns all jobs across the organization.

", "location": "querystring", "locationName": "accountId" } @@ -3321,7 +3321,7 @@ }, "ByResourceType": { "shape": "ResourceType", - "documentation": "

Returns only backup jobs for the specified resources:

", + "documentation": "

Returns only backup jobs for the specified resources:

", "location": "querystring", "locationName": "resourceType" }, @@ -3736,7 +3736,7 @@ }, "Lifecycle": { "shape": "Lifecycle", - "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "EncryptionKeyArn": { "shape": "ARN", @@ -3954,15 +3954,15 @@ }, "StartWindowMinutes": { "shape": "WindowMinutes", - "documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

" + "documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.

" }, "CompleteWindowMinutes": { "shape": "WindowMinutes", - "documentation": "

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

" + "documentation": "

A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

" }, "Lifecycle": { "shape": "Lifecycle", - "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "RecoveryPointTags": { "shape": "Tags", @@ -3987,7 +3987,7 @@ }, "CreationDate": { "shape": "timestamp", - "documentation": "

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

" + "documentation": "

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

" } } }, @@ -4034,7 +4034,7 @@ }, "CreationDate": { "shape": "timestamp", - "documentation": "

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

" + "documentation": "

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

" } } }, @@ -4052,7 +4052,7 @@ }, "Metadata": { "shape": "Metadata", - "documentation": "

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

" + "documentation": "

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

" }, "IamRoleArn": { "shape": "IAMRoleArn", @@ -4064,7 +4064,7 @@ }, "ResourceType": { "shape": "ResourceType", - "documentation": "

Starts a job to restore a recovery point for one of the following resources:

" + "documentation": "

Starts a job to restore a recovery point for one of the following resources:

" } } }, @@ -4251,7 +4251,7 @@ }, "Lifecycle": { "shape": "Lifecycle", - "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + "documentation": "

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

" }, "CalculatedLifecycle": { "shape": "CalculatedLifecycle",