diff --git a/apis/backup/2018-11-15/api-2.json b/apis/backup/2018-11-15/api-2.json index 30519748265..ea82850c2a1 100644 --- a/apis/backup/2018-11-15/api-2.json +++ b/apis/backup/2018-11-15/api-2.json @@ -1741,6 +1741,8 @@ "members":{ "BackupVaultName":{"shape":"BackupVaultName"}, "BackupVaultArn":{"shape":"ARN"}, + "VaultType":{"shape":"VaultType"}, + "VaultState":{"shape":"VaultState"}, "CreationDate":{"shape":"timestamp"}, "EncryptionKeyArn":{"shape":"ARN"}, "CreatorRequestId":{"shape":"string"}, @@ -2423,6 +2425,7 @@ "BackupVaultName":{"shape":"string"}, "BackupVaultArn":{"shape":"ARN"}, "VaultType":{"shape":"VaultType"}, + "VaultState":{"shape":"VaultState"}, "EncryptionKeyArn":{"shape":"ARN"}, "CreationDate":{"shape":"timestamp"}, "CreatorRequestId":{"shape":"string"}, diff --git a/apis/backup/2018-11-15/docs-2.json b/apis/backup/2018-11-15/docs-2.json index f8fb3e37e64..e16589c374a 100644 --- a/apis/backup/2018-11-15/docs-2.json +++ b/apis/backup/2018-11-15/docs-2.json @@ -2,15 +2,15 @@ "version": "2.0", "service": "Backup

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

", "operations": { - "CancelLegalHold": "

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

", + "CancelLegalHold": "

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

", "CreateBackupPlan": "

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

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

", "CreateBackupSelection": "

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

", "CreateBackupVault": "

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

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

", "CreateFramework": "

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

", - "CreateLegalHold": "

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

", - "CreateLogicallyAirGappedBackupVault": "

This request creates a logical container to where backups may be copied.

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

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

", + "CreateLegalHold": "

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

", + "CreateLogicallyAirGappedBackupVault": "

Creates a logical container to where backups may be copied.

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

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

", "CreateReportPlan": "

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

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

", - "CreateRestoreTestingPlan": "

This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.

You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.

", + "CreateRestoreTestingPlan": "

Creates a restore testing plan.

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

", "CreateRestoreTestingSelection": "

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

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

Each protected resource type can have one single value.

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

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

", "DeleteBackupPlan": "

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

", "DeleteBackupSelection": "

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

", @@ -52,9 +52,9 @@ "GetSupportedResourceTypes": "

Returns the Amazon Web Services resource types supported by Backup.

", "ListBackupJobSummaries": "

This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

", "ListBackupJobs": "

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

", - "ListBackupPlanTemplates": "

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

", + "ListBackupPlanTemplates": "

Lists the backup plan templates.

", "ListBackupPlanVersions": "

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

", - "ListBackupPlans": "

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

", + "ListBackupPlans": "

Lists the active backup plans for the account.

", "ListBackupSelections": "

Returns an array containing metadata of the resources associated with the target backup plan.

", "ListBackupVaults": "

Returns a list of recovery point storage containers along with information about them.

", "ListCopyJobSummaries": "

This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

", @@ -65,7 +65,7 @@ "ListProtectedResourcesByBackupVault": "

This request lists the protected resources corresponding to each backup vault.

", "ListRecoveryPointsByBackupVault": "

Returns detailed information about the recovery points stored in a backup vault.

", "ListRecoveryPointsByLegalHold": "

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

", - "ListRecoveryPointsByResource": "

Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

", + "ListRecoveryPointsByResource": "

The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).

For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

", "ListReportJobs": "

Returns details about your report jobs.

", "ListReportPlans": "

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

", "ListRestoreJobSummaries": "

This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

", @@ -73,83 +73,83 @@ "ListRestoreJobsByProtectedResource": "

This returns restore jobs that contain the specified protected resource.

You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.

", "ListRestoreTestingPlans": "

Returns a list of restore testing plans.

", "ListRestoreTestingSelections": "

Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.

", - "ListTags": "

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the \"Full Backup management\" section of the Feature availability by resource table.

", + "ListTags": "

Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.

", "PutBackupVaultAccessPolicy": "

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

", - "PutBackupVaultLockConfiguration": "

Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.

Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.

", + "PutBackupVaultLockConfiguration": "

Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.

Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.

For more information, see Backup Vault Lock.

", "PutBackupVaultNotifications": "

Turns on notifications on a backup vault for the specified topic and events.

", "PutRestoreValidationResult": "

This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.

", "StartBackupJob": "

Starts an on-demand backup job for the specified resource.

", "StartCopyJob": "

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

", "StartReportJob": "

Starts an on-demand report job for the specified report plan.

", "StartRestoreJob": "

Recovers the saved resource identified by an Amazon Resource Name (ARN).

", - "StopBackupJob": "

Attempts to cancel a job to create a one-time backup of a resource.

This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

", - "TagResource": "

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

", - "UntagResource": "

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

", - "UpdateBackupPlan": "

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

", - "UpdateFramework": "

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

", + "StopBackupJob": "

Attempts to cancel a job to create a one-time backup of a resource.

This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

", + "TagResource": "

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.

", + "UntagResource": "

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.

", + "UpdateBackupPlan": "

Updates the specified backup plan. The new version is uniquely identified by its ID.

", + "UpdateFramework": "

Updates the specified framework.

", "UpdateGlobalSettings": "

Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

", - "UpdateRecoveryPointLifecycle": "

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

This operation does not support continuous backups.

", + "UpdateRecoveryPointLifecycle": "

Sets the transition lifecycle of a recovery point.

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

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

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” 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.

If your lifecycle currently uses the parameters DeleteAfterDays and MoveToColdStorageAfterDays, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values.

This operation does not support continuous backups.

", "UpdateRegionSettings": "

Updates the current service opt-in settings for the Region.

Use the DescribeRegionSettings API to determine the resource types that are supported.

", - "UpdateReportPlan": "

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

", + "UpdateReportPlan": "

Updates the specified report plan.

", "UpdateRestoreTestingPlan": "

This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.

RecoveryPointSelection can contain:

", - "UpdateRestoreTestingSelection": "

Most elements except the RestoreTestingSelectionName can be updated with this request.

RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

" + "UpdateRestoreTestingSelection": "

Updates the specified restore testing selection.

Most elements except the RestoreTestingSelectionName can be updated with this request.

You can use either protected resource ARNs or conditions, but not both.

" }, "shapes": { "ARN": { "base": null, "refs": { - "BackupJob$BackupVaultArn": "

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

", + "BackupJob$BackupVaultArn": "

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

", "BackupJob$RecoveryPointArn": "

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

", "BackupJob$ResourceArn": "

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

", "BackupPlansListMember$BackupPlanArn": "

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

", - "BackupVaultListMember$BackupVaultArn": "

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

", + "BackupVaultListMember$BackupVaultArn": "

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

", "BackupVaultListMember$EncryptionKeyArn": "

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

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

", - "CopyAction$DestinationBackupVaultArn": "

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

", - "CopyJob$SourceBackupVaultArn": "

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

", + "CopyAction$DestinationBackupVaultArn": "

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

", + "CopyJob$SourceBackupVaultArn": "

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

", "CopyJob$SourceRecoveryPointArn": "

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

", - "CopyJob$DestinationBackupVaultArn": "

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

", + "CopyJob$DestinationBackupVaultArn": "

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

", "CopyJob$DestinationRecoveryPointArn": "

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

", "CopyJob$ResourceArn": "

The 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.

", "CreateBackupPlanOutput$BackupPlanArn": "

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

", "CreateBackupVaultInput$EncryptionKeyArn": "

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

", - "CreateBackupVaultOutput$BackupVaultArn": "

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

", + "CreateBackupVaultOutput$BackupVaultArn": "

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

", "CreateFrameworkOutput$FrameworkArn": "

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

", - "CreateLegalHoldOutput$LegalHoldArn": "

This is the ARN (Amazon Resource Number) of the created legal hold.

", - "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultArn": "

This is the ARN (Amazon Resource Name) of the vault being created.

", + "CreateLegalHoldOutput$LegalHoldArn": "

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

", + "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultArn": "

The ARN (Amazon Resource Name) of the vault.

", "CreateReportPlanOutput$ReportPlanArn": "

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

", "DeleteBackupPlanOutput$BackupPlanArn": "

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

", "DeleteRecoveryPointInput$RecoveryPointArn": "

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

", - "DescribeBackupJobOutput$BackupVaultArn": "

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

", + "DescribeBackupJobOutput$BackupVaultArn": "

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

", "DescribeBackupJobOutput$RecoveryPointArn": "

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

", "DescribeBackupJobOutput$ResourceArn": "

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

", - "DescribeBackupVaultOutput$BackupVaultArn": "

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

", + "DescribeBackupVaultOutput$BackupVaultArn": "

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

", "DescribeBackupVaultOutput$EncryptionKeyArn": "

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

", "DescribeFrameworkOutput$FrameworkArn": "

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

", "DescribeProtectedResourceInput$ResourceArn": "

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

", "DescribeProtectedResourceOutput$ResourceArn": "

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

", - "DescribeProtectedResourceOutput$LastBackupVaultArn": "

This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

", - "DescribeProtectedResourceOutput$LastRecoveryPointArn": "

This is the ARN (Amazon Resource Name) of the most recent recovery point.

", + "DescribeProtectedResourceOutput$LastBackupVaultArn": "

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

", + "DescribeProtectedResourceOutput$LastRecoveryPointArn": "

The ARN (Amazon Resource Name) of the most recent recovery point.

", "DescribeRecoveryPointInput$RecoveryPointArn": "

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

", "DescribeRecoveryPointOutput$RecoveryPointArn": "

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

", - "DescribeRecoveryPointOutput$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", - "DescribeRecoveryPointOutput$SourceBackupVaultArn": "

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.

", + "DescribeRecoveryPointOutput$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

", + "DescribeRecoveryPointOutput$SourceBackupVaultArn": "

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.

", "DescribeRecoveryPointOutput$ResourceArn": "

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

", "DescribeRecoveryPointOutput$EncryptionKeyArn": "

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

", "DescribeRecoveryPointOutput$ParentRecoveryPointArn": "

This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "DescribeRestoreJobOutput$RecoveryPointArn": "

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

", - "DescribeRestoreJobOutput$CreatedResourceArn": "

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

", - "DisassociateRecoveryPointFromParentInput$RecoveryPointArn": "

This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", + "DescribeRestoreJobOutput$CreatedResourceArn": "

The Amazon Resource Name (ARN) of the resource that was created by the restore job.

The format of the ARN depends on the resource type of the backed-up resource.

", + "DisassociateRecoveryPointFromParentInput$RecoveryPointArn": "

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

", "DisassociateRecoveryPointInput$RecoveryPointArn": "

An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.

", "Framework$FrameworkArn": "

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

", "GetBackupPlanOutput$BackupPlanArn": "

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

", - "GetBackupVaultAccessPolicyOutput$BackupVaultArn": "

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

", - "GetBackupVaultNotificationsOutput$BackupVaultArn": "

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

", + "GetBackupVaultAccessPolicyOutput$BackupVaultArn": "

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

", + "GetBackupVaultNotificationsOutput$BackupVaultArn": "

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

", "GetBackupVaultNotificationsOutput$SNSTopicArn": "

An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

", - "GetLegalHoldOutput$LegalHoldArn": "

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

", + "GetLegalHoldOutput$LegalHoldArn": "

The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.

", "GetRecoveryPointRestoreMetadataInput$RecoveryPointArn": "

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

", - "GetRecoveryPointRestoreMetadataOutput$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", + "GetRecoveryPointRestoreMetadataOutput$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

", "GetRecoveryPointRestoreMetadataOutput$RecoveryPointArn": "

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

", - "LegalHold$LegalHoldArn": "

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", + "LegalHold$LegalHoldArn": "

The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "ListBackupJobsInput$ByResourceArn": "

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

", "ListCopyJobsInput$ByResourceArn": "

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

", "ListRecoveryPointsByBackupVaultInput$ByResourceArn": "

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

", @@ -159,21 +159,21 @@ "ListRestoreJobsInput$ByRestoreTestingPlanArn": "

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

", "ListTagsInput$ResourceArn": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

", "ProtectedResource$ResourceArn": "

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

", - "ProtectedResource$LastBackupVaultArn": "

This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

", - "ProtectedResource$LastRecoveryPointArn": "

This is the ARN (Amazon Resource Name) of the most recent recovery point.

", + "ProtectedResource$LastBackupVaultArn": "

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

", + "ProtectedResource$LastRecoveryPointArn": "

The ARN (Amazon Resource Name) of the most recent recovery point.

", "PutBackupVaultNotificationsInput$SNSTopicArn": "

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

", "RecoveryPointByBackupVault$RecoveryPointArn": "

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

", - "RecoveryPointByBackupVault$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", + "RecoveryPointByBackupVault$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

", "RecoveryPointByBackupVault$SourceBackupVaultArn": "

The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

", "RecoveryPointByBackupVault$ResourceArn": "

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

", "RecoveryPointByBackupVault$EncryptionKeyArn": "

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

", - "RecoveryPointByBackupVault$ParentRecoveryPointArn": "

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

", + "RecoveryPointByBackupVault$ParentRecoveryPointArn": "

The Amazon Resource Name (ARN) of the parent (composite) recovery point.

", "RecoveryPointByResource$RecoveryPointArn": "

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

", "RecoveryPointByResource$EncryptionKeyArn": "

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

", - "RecoveryPointByResource$ParentRecoveryPointArn": "

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

", + "RecoveryPointByResource$ParentRecoveryPointArn": "

The Amazon Resource Name (ARN) of the parent (composite) recovery point.

", "RecoveryPointCreator$BackupPlanArn": "

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

", - "RecoveryPointMember$RecoveryPointArn": "

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

", - "RecoveryPointMember$ResourceArn": "

This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.

", + "RecoveryPointMember$RecoveryPointArn": "

The Amazon Resource Name (ARN) of the parent (composite) recovery point.

", + "RecoveryPointMember$ResourceArn": "

The Amazon Resource Name (ARN) that uniquely identifies a saved resource.

", "ReportJob$ReportPlanArn": "

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

", "ReportPlan$ReportPlanArn": "

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

", "ResourceArns$member": null, @@ -184,14 +184,14 @@ "StartBackupJobInput$ResourceArn": "

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

", "StartBackupJobOutput$RecoveryPointArn": "

Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.

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

", "StartCopyJobInput$RecoveryPointArn": "

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

", - "StartCopyJobInput$DestinationBackupVaultArn": "

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

", + "StartCopyJobInput$DestinationBackupVaultArn": "

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

", "StartRestoreJobInput$RecoveryPointArn": "

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

", - "TagResourceInput$ResourceArn": "

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

", - "UntagResourceInput$ResourceArn": "

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

", + "TagResourceInput$ResourceArn": "

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

ARNs that do not include backup are incompatible with tagging. TagResource and UntagResource with invalid ARNs will result in an error. Acceptable ARN content can include arn:aws:backup:us-east. Invalid ARN content may look like arn:aws:ec2:us-east.

", + "UntagResourceInput$ResourceArn": "

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

ARNs that do not include backup are incompatible with tagging. TagResource and UntagResource with invalid ARNs will result in an error. Acceptable ARN content can include arn:aws:backup:us-east. Invalid ARN content may look like arn:aws:ec2:us-east.

", "UpdateBackupPlanOutput$BackupPlanArn": "

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

", "UpdateFrameworkOutput$FrameworkArn": "

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

", "UpdateRecoveryPointLifecycleInput$RecoveryPointArn": "

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

", - "UpdateRecoveryPointLifecycleOutput$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", + "UpdateRecoveryPointLifecycleOutput$BackupVaultArn": "

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

", "UpdateRecoveryPointLifecycleOutput$RecoveryPointArn": "

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

", "UpdateReportPlanOutput$ReportPlanArn": "

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

" } @@ -204,14 +204,14 @@ "CopyJob$AccountId": "

The account ID that owns the copy job.

", "CopyJobSummary$AccountId": "

The account ID that owns the jobs within the summary.

", "DescribeBackupJobOutput$AccountId": "

Returns the account ID that owns the backup job.

", - "DescribeRecoveryPointInput$BackupVaultAccountId": "

This is the account ID of the specified backup vault.

", + "DescribeRecoveryPointInput$BackupVaultAccountId": "

The account ID of the specified backup vault.

", "DescribeRestoreJobOutput$AccountId": "

Returns the account ID that owns the restore job.

", - "GetRecoveryPointRestoreMetadataInput$BackupVaultAccountId": "

This is the account ID of the specified backup vault.

", + "GetRecoveryPointRestoreMetadataInput$BackupVaultAccountId": "

The account ID of the specified backup vault.

", "ListBackupJobSummariesInput$AccountId": "

Returns the job count for the specified account.

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.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

", "ListBackupJobsInput$ByAccountId": "

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

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

", "ListCopyJobSummariesInput$AccountId": "

Returns the job count for the specified account.

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.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

", "ListCopyJobsInput$ByAccountId": "

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

", - "ListProtectedResourcesByBackupVaultInput$BackupVaultAccountId": "

This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

", + "ListProtectedResourcesByBackupVaultInput$BackupVaultAccountId": "

The list of protected resources by backup vault within the vault(s) you specify by account ID.

", "ListRecoveryPointsByBackupVaultInput$BackupVaultAccountId": "

This parameter will sort the list of recovery points by account ID.

", "ListRestoreJobSummariesInput$AccountId": "

Returns the job count for the specified account.

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.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

", "ListRestoreJobsInput$ByAccountId": "

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

", @@ -220,7 +220,7 @@ } }, "AdvancedBackupSetting": { - "base": "

A list of backup options for each resource type.

", + "base": "

The backup options for each resource type.

", "refs": { "AdvancedBackupSettings$member": null } @@ -231,7 +231,7 @@ "BackupPlan$AdvancedBackupSettings": "

Contains a list of BackupOptions for each resource type.

", "BackupPlanInput$AdvancedBackupSettings": "

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

", "BackupPlansListMember$AdvancedBackupSettings": "

Contains a list of BackupOptions for a resource type.

", - "CreateBackupPlanOutput$AdvancedBackupSettings": "

A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

", + "CreateBackupPlanOutput$AdvancedBackupSettings": "

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

", "GetBackupPlanOutput$AdvancedBackupSettings": "

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

", "UpdateBackupPlanOutput$AdvancedBackupSettings": "

Contains a list of BackupOptions for each resource type.

" } @@ -239,9 +239,9 @@ "AggregationPeriod": { "base": null, "refs": { - "ListBackupJobSummariesInput$AggregationPeriod": "

This is the period that sets the boundaries for returned results.

Acceptable values include

", - "ListCopyJobSummariesInput$AggregationPeriod": "

This is the period that sets the boundaries for returned results.

", - "ListRestoreJobSummariesInput$AggregationPeriod": "

This is the period that sets the boundaries for returned results.

Acceptable values include

" + "ListBackupJobSummariesInput$AggregationPeriod": "

The period for the returned results.

", + "ListCopyJobSummariesInput$AggregationPeriod": "

The period for the returned results.

", + "ListRestoreJobSummariesInput$AggregationPeriod": "

The period for the returned results.

" } }, "AlreadyExistsException": { @@ -286,7 +286,7 @@ "BackupJobSummaryList": { "base": null, "refs": { - "ListBackupJobSummariesOutput$BackupJobSummaries": "

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

" + "ListBackupJobSummariesOutput$BackupJobSummaries": "

The summary information.

" } }, "BackupJobsList": { @@ -313,7 +313,7 @@ "AdvancedBackupSetting$BackupOptions": "

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values:

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

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

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

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

", "BackupJob$BackupOptions": "

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

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

", "DescribeBackupJobOutput$BackupOptions": "

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

", - "StartBackupJobInput$BackupOptions": "

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

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\"\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.

" + "StartBackupJobInput$BackupOptions": "

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

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\"\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.

" } }, "BackupPlan": { @@ -327,14 +327,14 @@ "BackupPlanInput": { "base": "

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

", "refs": { - "CreateBackupPlanInput$BackupPlan": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

", - "UpdateBackupPlanInput$BackupPlan": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" + "CreateBackupPlanInput$BackupPlan": "

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

", + "UpdateBackupPlanInput$BackupPlan": "

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

" } }, "BackupPlanName": { "base": null, "refs": { - "BackupPlan$BackupPlanName": "

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

", + "BackupPlan$BackupPlanName": "

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

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

", "BackupPlanInput$BackupPlanName": "

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

", "BackupPlansListMember$BackupPlanName": "

The display name of a saved backup plan.

" } @@ -360,7 +360,7 @@ "BackupPlansList": { "base": null, "refs": { - "ListBackupPlansOutput$BackupPlansList": "

An array of backup plan list items containing metadata about your saved backup plans.

" + "ListBackupPlansOutput$BackupPlansList": "

Information about the backup plans.

" } }, "BackupPlansListMember": { @@ -402,9 +402,9 @@ } }, "BackupSelection": { - "base": "

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

Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.

", + "base": "

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

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

For more information, see Assigning resources programmatically.

", "refs": { - "CreateBackupSelectionInput$BackupSelection": "

Specifies the body of a request to assign a set of resources to a backup plan.

", + "CreateBackupSelectionInput$BackupSelection": "

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

", "GetBackupSelectionOutput$BackupSelection": "

Specifies the body of a request to assign a set of resources to a backup plan.

" } }, @@ -437,7 +437,7 @@ "base": null, "refs": { "GetBackupVaultNotificationsOutput$BackupVaultEvents": "

An array of events that indicate the status of jobs to back up resources to the backup vault.

", - "PutBackupVaultNotificationsInput$BackupVaultEvents": "

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

" + "PutBackupVaultNotificationsInput$BackupVaultEvents": "

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

The following events are supported:

The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.

" } }, "BackupVaultList": { @@ -455,40 +455,40 @@ "BackupVaultName": { "base": null, "refs": { - "BackupJob$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "BackupRule$TargetBackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "BackupRuleInput$TargetBackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "BackupVaultListMember$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "BackupJob$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "BackupRule$TargetBackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "BackupRuleInput$TargetBackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "BackupVaultListMember$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", "CreateBackupVaultInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

", "CreateBackupVaultOutput$BackupVaultName": "

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "CreateLogicallyAirGappedBackupVaultInput$BackupVaultName": "

This is the name of the vault that is being created.

", - "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultName": "

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

", + "CreateLogicallyAirGappedBackupVaultInput$BackupVaultName": "

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

", + "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultName": "

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

", "DeleteBackupVaultAccessPolicyInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", "DeleteBackupVaultLockConfigurationInput$BackupVaultName": "

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

", - "DeleteBackupVaultNotificationsInput$BackupVaultName": "

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "DeleteRecoveryPointInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "DescribeBackupJobOutput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "DescribeRecoveryPointInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "DescribeRecoveryPointOutput$BackupVaultName": "

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "DisassociateRecoveryPointFromParentInput$BackupVaultName": "

This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "DeleteBackupVaultNotificationsInput$BackupVaultName": "

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 Region where they are created.

", + "DeleteRecoveryPointInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "DescribeBackupJobOutput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "DescribeRecoveryPointInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "DescribeRecoveryPointOutput$BackupVaultName": "

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 Region where they are created.

", + "DisassociateRecoveryPointFromParentInput$BackupVaultName": "

The name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

", "DisassociateRecoveryPointInput$BackupVaultName": "

The unique name of an Backup vault.

", - "GetBackupVaultAccessPolicyInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "GetBackupVaultAccessPolicyOutput$BackupVaultName": "

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "GetBackupVaultNotificationsInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "GetBackupVaultNotificationsOutput$BackupVaultName": "

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "GetRecoveryPointRestoreMetadataInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "ListBackupJobsInput$ByBackupVaultName": "

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "ListProtectedResourcesByBackupVaultInput$BackupVaultName": "

This is the list of protected resources by backup vault within the vault(s) you specify by name.

", - "ListRecoveryPointsByBackupVaultInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Backup vault name might not be available when a supported service creates the backup.

", - "PutBackupVaultAccessPolicyInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "GetBackupVaultAccessPolicyInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "GetBackupVaultAccessPolicyOutput$BackupVaultName": "

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 Region where they are created.

", + "GetBackupVaultNotificationsInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "GetBackupVaultNotificationsOutput$BackupVaultName": "

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 Region where they are created.

", + "GetRecoveryPointRestoreMetadataInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "ListBackupJobsInput$ByBackupVaultName": "

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

", + "ListProtectedResourcesByBackupVaultInput$BackupVaultName": "

The list of protected resources by backup vault within the vault(s) you specify by name.

", + "ListRecoveryPointsByBackupVaultInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

Backup vault name might not be available when a supported service creates the backup.

", + "PutBackupVaultAccessPolicyInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", "PutBackupVaultLockConfigurationInput$BackupVaultName": "

The Backup Vault Lock configuration that specifies the name of the backup vault it protects.

", - "PutBackupVaultNotificationsInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "RecoveryPointByBackupVault$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "RecoveryPointByResource$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "RecoveryPointMember$BackupVaultName": "

This is the name of the backup vault (the logical container in which backups are stored).

", - "StartBackupJobInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "StartCopyJobInput$SourceBackupVaultName": "

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

", - "UpdateRecoveryPointLifecycleInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + "PutBackupVaultNotificationsInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "RecoveryPointByBackupVault$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "RecoveryPointByResource$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "RecoveryPointMember$BackupVaultName": "

The name of the backup vault (the logical container in which backups are stored).

", + "StartBackupJobInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "StartCopyJobInput$SourceBackupVaultName": "

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

", + "UpdateRecoveryPointLifecycleInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

" } }, "Boolean": { @@ -498,12 +498,12 @@ "BackupRuleInput$EnableContinuousBackup": "

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

", "BackupVaultListMember$Locked": "

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

", "DescribeBackupVaultOutput$Locked": "

A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.

", - "Lifecycle$OptInToArchiveForSupportedResources": "

Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

", + "Lifecycle$OptInToArchiveForSupportedResources": "

If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

", "ListBackupPlansInput$IncludeDeleted": "

A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

" } }, "CalculatedLifecycle": { - "base": "

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. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

", + "base": "

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. 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 “retention” 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.

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

", "refs": { "DescribeRecoveryPointOutput$CalculatedLifecycle": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

", "RecoveryPointByBackupVault$CalculatedLifecycle": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

", @@ -540,7 +540,7 @@ } }, "ConditionParameter": { - "base": "

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

", + "base": "

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

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

", "refs": { "ConditionParameters$member": null } @@ -570,7 +570,7 @@ "Conditions": { "base": "

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

", "refs": { - "BackupSelection$Conditions": "

A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

Conditions differs from ListOfTags as follows:

" + "BackupSelection$Conditions": "

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

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

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

" } }, "ConflictException": { @@ -579,7 +579,7 @@ } }, "ControlInputParameter": { - "base": "

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

", + "base": "

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

", "refs": { "ControlInputParameters$member": null } @@ -587,7 +587,7 @@ "ControlInputParameters": { "base": null, "refs": { - "FrameworkControl$ControlInputParameters": "

A list of ParameterName and ParameterValue pairs.

" + "FrameworkControl$ControlInputParameters": "

The name/value pairs.

" } }, "ControlName": { @@ -962,7 +962,7 @@ "FormatList": { "base": null, "refs": { - "ReportDeliveryChannel$Formats": "

A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

" + "ReportDeliveryChannel$Formats": "

The format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

" } }, "Framework": { @@ -980,9 +980,9 @@ "FrameworkControls": { "base": null, "refs": { - "CreateFrameworkInput$FrameworkControls": "

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

", - "DescribeFrameworkOutput$FrameworkControls": "

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

", - "UpdateFrameworkInput$FrameworkControls": "

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

" + "CreateFrameworkInput$FrameworkControls": "

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

", + "DescribeFrameworkOutput$FrameworkControls": "

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

", + "UpdateFrameworkInput$FrameworkControls": "

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

" } }, "FrameworkDescription": { @@ -997,7 +997,7 @@ "FrameworkList": { "base": null, "refs": { - "ListFrameworksOutput$Frameworks": "

A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.

" + "ListFrameworksOutput$Frameworks": "

The frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.

" } }, "FrameworkName": { @@ -1175,7 +1175,7 @@ "DescribeRecoveryPointOutput$IamRoleArn": "

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

", "DescribeRestoreJobOutput$IamRoleArn": "

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

", "RecoveryPointByBackupVault$IamRoleArn": "

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

", - "RestoreJobsListMember$IamRoleArn": "

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

", + "RestoreJobsListMember$IamRoleArn": "

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

", "StartBackupJobInput$IamRoleArn": "

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

", "StartCopyJobInput$IamRoleArn": "

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

", "StartRestoreJobInput$IamRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

" @@ -1225,9 +1225,9 @@ "LegalHoldStatus": { "base": null, "refs": { - "CreateLegalHoldOutput$Status": "

This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.

", - "GetLegalHoldOutput$Status": "

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

", - "LegalHold$Status": "

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

" + "CreateLegalHoldOutput$Status": "

The status of the legal hold.

", + "GetLegalHoldOutput$Status": "

The status of the legal hold.

", + "LegalHold$Status": "

The status of the legal hold.

" } }, "LegalHoldsList": { @@ -1237,17 +1237,17 @@ } }, "Lifecycle": { - "base": "

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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

", + "base": "

Specifies the time period, 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 retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.

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

To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

", "refs": { - "BackupRule$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

", - "BackupRuleInput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

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

", + "BackupRule$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

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

", + "BackupRuleInput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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 storage.

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

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

", "CopyAction$Lifecycle": null, - "DescribeRecoveryPointOutput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

", - "RecoveryPointByBackupVault$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

", - "StartBackupJobInput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

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

", + "DescribeRecoveryPointOutput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

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

", + "RecoveryPointByBackupVault$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

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

", + "StartBackupJobInput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

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

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

", "StartCopyJobInput$Lifecycle": null, "UpdateRecoveryPointLifecycleInput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

", - "UpdateRecoveryPointLifecycleOutput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

" + "UpdateRecoveryPointLifecycleOutput$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “retention” 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.

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

" } }, "LimitExceededException": { @@ -1368,7 +1368,7 @@ "ListOfTags": { "base": null, "refs": { - "BackupSelection$ListOfTags": "

A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

ListOfTags differs from Conditions as follows:

" + "BackupSelection$ListOfTags": "

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

ListOfTags supports only StringEquals. Condition operators are case sensitive.

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

" } }, "ListProtectedResourcesByBackupVaultInput": { @@ -1521,24 +1521,24 @@ "BackupJobChildJobsInState$value": null, "BackupVaultListMember$MinRetentionDays": "

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

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

", "BackupVaultListMember$MaxRetentionDays": "

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

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

", - "CancelLegalHoldInput$RetainRecordInDays": "

The integer amount in days specifying amount of days after this API operation to remove legal hold.

", + "CancelLegalHoldInput$RetainRecordInDays": "

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

", "CopyJob$BackupSizeInBytes": "

The size, in bytes, of a copy job.

", - "CopyJob$NumberOfChildJobs": "

This is the number of child (nested) copy jobs.

", + "CopyJob$NumberOfChildJobs": "

The number of child (nested) copy jobs.

", "CopyJobChildJobsInState$value": null, - "CreateLogicallyAirGappedBackupVaultInput$MinRetentionDays": "

This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

", - "CreateLogicallyAirGappedBackupVaultInput$MaxRetentionDays": "

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

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

", + "CreateLogicallyAirGappedBackupVaultInput$MinRetentionDays": "

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

The minimum value accepted is 7 days.

", + "CreateLogicallyAirGappedBackupVaultInput$MaxRetentionDays": "

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

", "DescribeBackupJobOutput$BackupSizeInBytes": "

The size, in bytes, of a backup.

", "DescribeBackupJobOutput$BytesTransferred": "

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

", "DescribeBackupJobOutput$NumberOfChildJobs": "

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

", - "DescribeBackupVaultOutput$MinRetentionDays": "

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

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

", + "DescribeBackupVaultOutput$MinRetentionDays": "

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

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

", "DescribeBackupVaultOutput$MaxRetentionDays": "

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

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

", - "DescribeProtectedResourceOutput$LatestRestoreExecutionTimeMinutes": "

This is the time in minutes the most recent restore job took to complete.

", + "DescribeProtectedResourceOutput$LatestRestoreExecutionTimeMinutes": "

The time, in minutes, that the most recent restore job took to complete.

", "DescribeRecoveryPointOutput$BackupSizeInBytes": "

The size, in bytes, of a backup.

", "DescribeRestoreJobOutput$BackupSizeInBytes": "

The size, in bytes, of the restored resource.

", "DescribeRestoreJobOutput$ExpectedCompletionTimeMinutes": "

The amount of time in minutes that a job restoring a recovery point is expected to take.

", - "Lifecycle$MoveToColdStorageAfterDays": "

Specifies the number of days after creation that a recovery point is moved to cold storage.

", - "Lifecycle$DeleteAfterDays": "

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

", - "PutBackupVaultLockConfigurationInput$MinRetentionDays": "

The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).

If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

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

", + "Lifecycle$MoveToColdStorageAfterDays": "

The number of days after creation that a recovery point is moved to cold storage.

", + "Lifecycle$DeleteAfterDays": "

The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

", + "PutBackupVaultLockConfigurationInput$MinRetentionDays": "

The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).

This parameter is required when a vault lock is created through CloudFormation; otherwise, this parameter is optional. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

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

", "PutBackupVaultLockConfigurationInput$MaxRetentionDays": "

The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).

If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.

If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.

", "PutBackupVaultLockConfigurationInput$ChangeableForDays": "

The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.

Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.

If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.

", "RecoveryPointByBackupVault$BackupSizeInBytes": "

The size, in bytes, of a backup.

", @@ -1556,9 +1556,9 @@ "MaxResults": { "base": null, "refs": { - "ListBackupJobSummariesInput$MaxResults": "

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

", + "ListBackupJobSummariesInput$MaxResults": "

The maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

", "ListBackupJobsInput$MaxResults": "

The maximum number of items to be returned.

", - "ListBackupPlanTemplatesInput$MaxResults": "

The maximum number of items to be returned.

", + "ListBackupPlanTemplatesInput$MaxResults": "

The maximum number of items to return.

", "ListBackupPlanVersionsInput$MaxResults": "

The maximum number of items to be returned.

", "ListBackupPlansInput$MaxResults": "

The maximum number of items to be returned.

", "ListBackupSelectionsInput$MaxResults": "

The maximum number of items to be returned.

", @@ -1569,7 +1569,7 @@ "ListProtectedResourcesByBackupVaultInput$MaxResults": "

The maximum number of items to be returned.

", "ListProtectedResourcesInput$MaxResults": "

The maximum number of items to be returned.

", "ListRecoveryPointsByBackupVaultInput$MaxResults": "

The maximum number of items to be returned.

", - "ListRecoveryPointsByLegalHoldInput$MaxResults": "

This is the maximum number of resource list items to be returned.

", + "ListRecoveryPointsByLegalHoldInput$MaxResults": "

The maximum number of resource list items to be returned.

", "ListRecoveryPointsByResourceInput$MaxResults": "

The maximum number of items to be returned.

Amazon RDS requires a value of at least 20.

", "ListReportJobsInput$MaxResults": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

", "ListReportPlansInput$MaxResults": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

", @@ -1593,7 +1593,7 @@ "refs": { "GetRecoveryPointRestoreMetadataOutput$RestoreMetadata": "

The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

", "GetRestoreJobMetadataOutput$Metadata": "

This contains the metadata of the specified backup job.

", - "StartRestoreJobInput$Metadata": "

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:

" + "StartRestoreJobInput$Metadata": "

A set of metadata key-value pairs.

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.

For more information about the metadata for each resource, see the following:

" } }, "MetadataKey": { @@ -1632,11 +1632,11 @@ } }, "ProtectedResourceConditions": { - "base": "

A list of conditions that you define for resources in your restore testing plan using tags.

For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

", + "base": "

The conditions that you define for resources in your restore testing plan using tags.

", "refs": { "RestoreTestingSelectionForCreate$ProtectedResourceConditions": "

If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: \"XXXX\", value: \"YYYY\" }].

", "RestoreTestingSelectionForGet$ProtectedResourceConditions": "

In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals.

", - "RestoreTestingSelectionForUpdate$ProtectedResourceConditions": "

A list of conditions that you define for resources in your restore testing plan using tags.

For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.

" + "RestoreTestingSelectionForUpdate$ProtectedResourceConditions": "

The conditions that you define for resources in your restore testing plan using tags.

" } }, "ProtectedResourcesList": { @@ -1709,15 +1709,15 @@ "RecoveryPointSelection": { "base": "

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

", "refs": { - "CreateLegalHoldInput$RecoveryPointSelection": "

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

", - "CreateLegalHoldOutput$RecoveryPointSelection": "

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

", - "GetLegalHoldOutput$RecoveryPointSelection": "

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

" + "CreateLegalHoldInput$RecoveryPointSelection": "

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

", + "CreateLegalHoldOutput$RecoveryPointSelection": "

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

", + "GetLegalHoldOutput$RecoveryPointSelection": "

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

" } }, "RecoveryPointStatus": { "base": null, "refs": { - "DescribeRecoveryPointOutput$Status": "

A status code specifying the state of the recovery point.

PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.

To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.

For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.

", + "DescribeRecoveryPointOutput$Status": "

A status code specifying the state of the recovery point.

PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.

To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.

For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.

", "RecoveryPointByBackupVault$Status": "

A status code specifying the state of the recovery point.

", "RecoveryPointByResource$Status": "

A status code specifying the state of the recovery point.

" } @@ -1725,14 +1725,14 @@ "RecoveryPointsList": { "base": null, "refs": { - "ListRecoveryPointsByLegalHoldOutput$RecoveryPoints": "

This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.

" + "ListRecoveryPointsByLegalHoldOutput$RecoveryPoints": "

The recovery points.

" } }, "Region": { "base": null, "refs": { "BackupJobSummary$Region": "

The Amazon Web Services Regions within the job summary.

", - "CopyJobSummary$Region": "

This is the Amazon Web Services Regions within the job summary.

", + "CopyJobSummary$Region": "

The Amazon Web Services Regions within the job summary.

", "RestoreJobSummary$Region": "

The Amazon Web Services Regions within the job summary.

" } }, @@ -1741,7 +1741,7 @@ "refs": { "CreateReportPlanInput$ReportDeliveryChannel": "

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

", "ReportPlan$ReportDeliveryChannel": "

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

", - "UpdateReportPlanInput$ReportDeliveryChannel": "

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

" + "UpdateReportPlanInput$ReportDeliveryChannel": "

The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" } }, "ReportDestination": { @@ -1753,7 +1753,7 @@ "ReportJob": { "base": "

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

", "refs": { - "DescribeReportJobOutput$ReportJob": "

A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

", + "DescribeReportJobOutput$ReportJob": "

The information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

", "ReportJobList$member": null } }, @@ -1789,7 +1789,7 @@ "ReportPlanList": { "base": null, "refs": { - "ListReportPlansOutput$ReportPlans": "

A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

" + "ListReportPlansOutput$ReportPlans": "

The report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

" } }, "ReportPlanName": { @@ -1811,14 +1811,14 @@ "refs": { "CreateReportPlanInput$ReportSetting": "

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

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

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

", "ReportPlan$ReportSetting": "

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

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

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

", - "UpdateReportPlanInput$ReportSetting": "

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

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

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

" + "UpdateReportPlanInput$ReportSetting": "

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

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

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

" } }, "ResourceArns": { "base": null, "refs": { - "BackupSelection$Resources": "

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

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

", - "BackupSelection$NotResources": "

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

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

" + "BackupSelection$Resources": "

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

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

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

", + "BackupSelection$NotResources": "

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

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

" } }, "ResourceIdentifiers": { @@ -1844,23 +1844,23 @@ "DescribeProtectedResourceOutput$ResourceType": "

The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.

", "DescribeRecoveryPointOutput$ResourceType": "

The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", "DescribeRestoreJobOutput$ResourceType": "

Returns metadata associated with a restore job listed by resource type.

", - "GetRecoveryPointRestoreMetadataOutput$ResourceType": "

This is the resource type associated with the recovery point.

", + "GetRecoveryPointRestoreMetadataOutput$ResourceType": "

The resource type of the recovery point.

", "ListBackupJobSummariesInput$ResourceType": "

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

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.

", - "ListBackupJobsInput$ByResourceType": "

Returns only backup jobs for the specified resources:

", + "ListBackupJobsInput$ByResourceType": "

Returns only backup jobs for the specified resources:

", "ListCopyJobSummariesInput$ResourceType": "

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

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.

", - "ListCopyJobsInput$ByResourceType": "

Returns only backup jobs for the specified resources:

", - "ListRecoveryPointsByBackupVaultInput$ByResourceType": "

Returns only recovery points that match the specified resource type(s):

", + "ListCopyJobsInput$ByResourceType": "

Returns only backup jobs for the specified resources:

", + "ListRecoveryPointsByBackupVaultInput$ByResourceType": "

Returns only recovery points that match the specified resource type(s):

", "ListRestoreJobSummariesInput$ResourceType": "

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

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.

", - "ListRestoreJobsInput$ByResourceType": "

Include this parameter to return only restore jobs for the specified resources:

", + "ListRestoreJobsInput$ByResourceType": "

Include this parameter to return only restore jobs for the specified resources:

", "ProtectedResource$ResourceType": "

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 Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

", "RecoveryPointByBackupVault$ResourceType": "

The type of Amazon Web Services resource saved as a recovery point; 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 supported resource type is Amazon EC2.

", - "RecoveryPointMember$ResourceType": "

This is the Amazon Web Services resource type that is saved as a recovery point.

", + "RecoveryPointMember$ResourceType": "

The Amazon Web Services resource type that is saved as a recovery point.

", "ResourceTypeManagementPreference$key": null, "ResourceTypeOptInPreference$key": null, "ResourceTypes$member": null, "RestoreJobSummary$ResourceType": "

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

", "RestoreJobsListMember$ResourceType": "

The resource type of the listed restore jobs; 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 supported resource type is Amazon EC2.

", - "StartRestoreJobInput$ResourceType": "

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

" + "StartRestoreJobInput$ResourceType": "

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

" } }, "ResourceTypeList": { @@ -1872,27 +1872,27 @@ "ResourceTypeManagementPreference": { "base": null, "refs": { - "DescribeRegionSettingsOutput$ResourceTypeManagementPreference": "

Returns whether Backup fully manages the backups for a resource type.

For the benefits of full Backup management, see Full Backup management.

For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.

If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.

", + "DescribeRegionSettingsOutput$ResourceTypeManagementPreference": "

Returns whether Backup fully manages the backups for a resource type.

For the benefits of full Backup management, see Full Backup management.

For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.

If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.

", "UpdateRegionSettingsInput$ResourceTypeManagementPreference": "

Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with Backup's advanced DynamoDB backup features, follow the procedure to enable advanced DynamoDB backup programmatically.

" } }, "ResourceTypeOptInPreference": { "base": null, "refs": { - "DescribeRegionSettingsOutput$ResourceTypeOptInPreference": "

Returns a list of all services along with the opt-in preferences in the Region.

", + "DescribeRegionSettingsOutput$ResourceTypeOptInPreference": "

The services along with the opt-in preferences in the Region.

", "UpdateRegionSettingsInput$ResourceTypeOptInPreference": "

Updates the list of services along with the opt-in preferences for the Region.

If resource assignments are only based on tags, then service opt-in settings are applied. If a resource type is explicitly assigned to a backup plan, such as Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if the opt-in is not enabled for that particular service. If both a resource type and tags are specified in a resource assignment, the resource type specified in the backup plan takes priority over the tag condition. Service opt-in settings are disregarded in this situation.

" } }, "ResourceTypes": { "base": null, "refs": { - "GetSupportedResourceTypesOutput$ResourceTypes": "

Contains a string with the supported Amazon Web Services resource types:

" + "GetSupportedResourceTypesOutput$ResourceTypes": "

Contains a string with the supported Amazon Web Services resource types:

" } }, "RestoreDeletionStatus": { "base": null, "refs": { - "DescribeRestoreJobOutput$DeletionStatus": "

This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.

", + "DescribeRestoreJobOutput$DeletionStatus": "

The status of the data generated by the restore test.

", "RestoreJobsListMember$DeletionStatus": "

This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.

" } }, @@ -1985,9 +1985,9 @@ } }, "RestoreTestingRecoveryPointSelection": { - "base": "

Required: Algorithm; Required: Recovery point types; IncludeVaults(one or more). Optional: SelectionWindowDays ('30' if not specified);ExcludeVaults (list of selectors), defaults to empty list if not listed.

", + "base": "

RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

Algorithm (required) Valid values: \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\".

Recovery point types (required) Valid values: \"SNAPSHOT\" and/or \"CONTINUOUS\". Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

IncludeVaults (required). You must include one or more backup vaults. Use the wildcard [\"*\"] or specific ARNs.

SelectionWindowDays (optional) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to 30.

ExcludeVaults (optional). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.

", "refs": { - "RestoreTestingPlanForCreate$RecoveryPointSelection": "

Required: Algorithm; Required: Recovery point types; IncludeVaults (one or more). Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (list of selectors), defaults to empty list if not listed.

", + "RestoreTestingPlanForCreate$RecoveryPointSelection": "

RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

Algorithm (required) Valid values: \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\".

Recovery point types (required) Valid values: \"SNAPSHOT\" and/or \"CONTINUOUS\". Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

IncludeVaults (required). You must include one or more backup vaults. Use the wildcard [\"*\"] or specific ARNs.

SelectionWindowDays (optional) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to 30.

ExcludeVaults (optional). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.

", "RestoreTestingPlanForGet$RecoveryPointSelection": "

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

", "RestoreTestingPlanForUpdate$RecoveryPointSelection": "

Required: Algorithm; RecoveryPointTypes; IncludeVaults (one or more).

Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (defaults to empty list if not listed).

" } @@ -2007,7 +2007,7 @@ "RestoreTestingRecoveryPointTypeList": { "base": null, "refs": { - "RestoreTestingRecoveryPointSelection$RecoveryPointTypes": "

These are the types of recovery points.

" + "RestoreTestingRecoveryPointSelection$RecoveryPointTypes": "

These are the types of recovery points.

Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

" } }, "RestoreTestingSelectionForCreate": { @@ -2043,15 +2043,15 @@ "RestoreValidationStatus": { "base": null, "refs": { - "DescribeRestoreJobOutput$ValidationStatus": "

This is the status of validation run on the indicated restore job.

", - "PutRestoreValidationResultInput$ValidationStatus": "

This is the status of your restore validation.

", - "RestoreJobsListMember$ValidationStatus": "

This is the status of validation run on the indicated restore job.

" + "DescribeRestoreJobOutput$ValidationStatus": "

The status of validation run on the indicated restore job.

", + "PutRestoreValidationResultInput$ValidationStatus": "

The status of your restore validation.

", + "RestoreJobsListMember$ValidationStatus": "

The status of validation run on the indicated restore job.

" } }, "SensitiveStringMap": { "base": null, "refs": { - "CreateRestoreTestingPlanInput$Tags": "

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

", + "CreateRestoreTestingPlanInput$Tags": "

The tags to assign to the restore testing plan.

", "RestoreTestingSelectionForCreate$RestoreMetadataOverrides": "

You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

See the complete list of restore testing inferred metadata.

", "RestoreTestingSelectionForGet$RestoreMetadataOverrides": "

You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

See the complete list of restore testing inferred metadata.

", "RestoreTestingSelectionForUpdate$RestoreMetadataOverrides": "

You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

See the complete list of restore testing inferred metadata.

" @@ -2121,13 +2121,13 @@ "CreateRestoreTestingPlanOutput$RestoreTestingPlanName": "

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

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

", "CreateRestoreTestingSelectionInput$CreatorRequestId": "

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

", "CreateRestoreTestingSelectionInput$RestoreTestingPlanName": "

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

", - "CreateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "

This is the ARN of the restore testing plan with which the restore testing selection is associated.

", - "CreateRestoreTestingSelectionOutput$RestoreTestingPlanName": "

Unique string that is the name of the restore testing plan.

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

", - "CreateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "

This is the unique name of the restore testing selection that belongs to the related restore testing plan.

", + "CreateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "

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

", + "CreateRestoreTestingSelectionOutput$RestoreTestingPlanName": "

The name of the restore testing plan.

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

", + "CreateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "

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

", "DeleteRestoreTestingPlanInput$RestoreTestingPlanName": "

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

", "DeleteRestoreTestingSelectionInput$RestoreTestingPlanName": "

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

", "DeleteRestoreTestingSelectionInput$RestoreTestingSelectionName": "

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

", - "GetRestoreTestingInferredMetadataInput$BackupVaultAccountId": "

This is the account ID of the specified backup vault.

", + "GetRestoreTestingInferredMetadataInput$BackupVaultAccountId": "

The account ID of the specified backup vault.

", "GetRestoreTestingInferredMetadataInput$BackupVaultName": "

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 Amazon Web ServicesRegion where they are created. They consist of letters, numbers, and hyphens.

", "GetRestoreTestingInferredMetadataInput$RecoveryPointArn": "

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

", "GetRestoreTestingPlanInput$RestoreTestingPlanName": "

Required unique name of the restore testing plan.

", @@ -2145,23 +2145,23 @@ "RestoreTestingPlanForCreate$ScheduleExpressionTimezone": "

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

", "RestoreTestingPlanForGet$CreatorRequestId": "

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

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

", "RestoreTestingPlanForGet$RestoreTestingPlanArn": "

An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

", - "RestoreTestingPlanForGet$RestoreTestingPlanName": "

This is the restore testing plan name.

", + "RestoreTestingPlanForGet$RestoreTestingPlanName": "

The restore testing plan name.

", "RestoreTestingPlanForGet$ScheduleExpression": "

A CRON expression in specified timezone when a restore testing plan is executed.

", "RestoreTestingPlanForGet$ScheduleExpressionTimezone": "

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

", "RestoreTestingPlanForList$RestoreTestingPlanArn": "

An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.

", - "RestoreTestingPlanForList$RestoreTestingPlanName": "

This is the restore testing plan name.

", + "RestoreTestingPlanForList$RestoreTestingPlanName": "

The restore testing plan name.

", "RestoreTestingPlanForList$ScheduleExpression": "

A CRON expression in specified timezone when a restore testing plan is executed.

", "RestoreTestingPlanForList$ScheduleExpressionTimezone": "

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

", "RestoreTestingPlanForUpdate$ScheduleExpression": "

A CRON expression in specified timezone when a restore testing plan is executed.

", "RestoreTestingPlanForUpdate$ScheduleExpressionTimezone": "

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

", "RestoreTestingSelectionForCreate$IamRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

", "RestoreTestingSelectionForCreate$ProtectedResourceType": "

The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

Supported resource types accepted include:

", - "RestoreTestingSelectionForCreate$RestoreTestingSelectionName": "

This is the unique name of the restore testing selection that belongs to the related restore testing plan.

", + "RestoreTestingSelectionForCreate$RestoreTestingSelectionName": "

The unique name of the restore testing selection that belongs to the related restore testing plan.

", "RestoreTestingSelectionForGet$CreatorRequestId": "

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

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

", "RestoreTestingSelectionForGet$IamRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example:arn:aws:iam::123456789012:role/S3Access.

", "RestoreTestingSelectionForGet$ProtectedResourceType": "

The type of Amazon Web Services resource included in a resource testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

", "RestoreTestingSelectionForGet$RestoreTestingPlanName": "

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

", - "RestoreTestingSelectionForGet$RestoreTestingSelectionName": "

This is the unique name of the restore testing selection that belongs to the related restore testing plan.

", + "RestoreTestingSelectionForGet$RestoreTestingSelectionName": "

The unique name of the restore testing selection that belongs to the related restore testing plan.

", "RestoreTestingSelectionForList$IamRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

", "RestoreTestingSelectionForList$ProtectedResourceType": "

The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

", "RestoreTestingSelectionForList$RestoreTestingPlanName": "

Unique string that is the name of the restore testing plan.

The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.

", @@ -2169,14 +2169,14 @@ "RestoreTestingSelectionForUpdate$IamRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

", "SensitiveStringMap$key": null, "SensitiveStringMap$value": null, - "UpdateRestoreTestingPlanInput$RestoreTestingPlanName": "

This is the restore testing plan name you wish to update.

", + "UpdateRestoreTestingPlanInput$RestoreTestingPlanName": "

The name of the restore testing plan name.

", "UpdateRestoreTestingPlanOutput$RestoreTestingPlanArn": "

Unique ARN (Amazon Resource Name) of the restore testing plan.

", "UpdateRestoreTestingPlanOutput$RestoreTestingPlanName": "

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

", "UpdateRestoreTestingSelectionInput$RestoreTestingPlanName": "

The restore testing plan name is required to update the indicated testing plan.

", - "UpdateRestoreTestingSelectionInput$RestoreTestingSelectionName": "

This is the required restore testing selection name of the restore testing selection you wish to update.

", + "UpdateRestoreTestingSelectionInput$RestoreTestingSelectionName": "

The required restore testing selection name of the restore testing selection you wish to update.

", "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "

Unique string that is the name of the restore testing plan.

", - "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanName": "

This is the restore testing plan with which the updated restore testing selection is associated.

", - "UpdateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "

This is the returned restore testing selection name.

" + "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanName": "

The restore testing plan with which the updated restore testing selection is associated.

", + "UpdateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "

The returned restore testing selection name.

" } }, "TagKey": { @@ -2188,7 +2188,7 @@ "TagKeyList": { "base": null, "refs": { - "UntagResourceInput$TagKeyList": "

A list of keys to identify which key-value tags to remove from a resource.

" + "UntagResourceInput$TagKeyList": "

The keys to identify which key-value tags to remove from a resource.

" } }, "TagResourceInput": { @@ -2205,14 +2205,14 @@ "Tags": { "base": null, "refs": { - "BackupRule$RecoveryPointTags": "

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

", - "BackupRuleInput$RecoveryPointTags": "

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

", - "CreateBackupPlanInput$BackupPlanTags": "

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

", - "CreateBackupVaultInput$BackupVaultTags": "

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

", + "BackupRule$RecoveryPointTags": "

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

", + "BackupRuleInput$RecoveryPointTags": "

The tags to assign to the resources.

", + "CreateBackupPlanInput$BackupPlanTags": "

The tags to assign to the backup plan.

", + "CreateBackupVaultInput$BackupVaultTags": "

The tags to assign to the backup vault.

", "CreateLegalHoldInput$Tags": "

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

", - "CreateLogicallyAirGappedBackupVaultInput$BackupVaultTags": "

These are the tags that will be included in the newly-created vault.

", - "ListTagsOutput$Tags": "

To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

", - "StartBackupJobInput$RecoveryPointTags": "

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

", + "CreateLogicallyAirGappedBackupVaultInput$BackupVaultTags": "

The tags to assign to the vault.

", + "ListTagsOutput$Tags": "

Information about the tags.

", + "StartBackupJobInput$RecoveryPointTags": "

The tags to assign to the resources.

", "TagResourceInput$Tags": "

Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{\"Key\":\"string\",\"Value\":\"string\"}].

" } }, @@ -2220,7 +2220,7 @@ "base": null, "refs": { "CreateRestoreTestingPlanOutput$CreationTime": "

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

", - "CreateRestoreTestingSelectionOutput$CreationTime": "

This is the time the resource testing selection was created successfully.

", + "CreateRestoreTestingSelectionOutput$CreationTime": "

The time that the resource testing selection was created.

", "RestoreTestingPlanForGet$CreationTime": "

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

", "RestoreTestingPlanForGet$LastExecutionTime": "

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

", "RestoreTestingPlanForGet$LastUpdateTime": "

The date and time that the restore testing plan was 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.

", @@ -2228,18 +2228,18 @@ "RestoreTestingPlanForList$LastExecutionTime": "

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

", "RestoreTestingPlanForList$LastUpdateTime": "

The date and time that the restore testing plan was 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.

", "RestoreTestingSelectionForGet$CreationTime": "

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

", - "RestoreTestingSelectionForList$CreationTime": "

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

", - "UpdateRestoreTestingPlanOutput$CreationTime": "

This is the time the resource testing plan was created.

", - "UpdateRestoreTestingPlanOutput$UpdateTime": "

This is the time the update completed for the restore testing plan.

", - "UpdateRestoreTestingSelectionOutput$CreationTime": "

This is the time the resource testing selection was updated successfully.

", - "UpdateRestoreTestingSelectionOutput$UpdateTime": "

This is the time the update completed for the restore testing selection.

" + "RestoreTestingSelectionForList$CreationTime": "

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

", + "UpdateRestoreTestingPlanOutput$CreationTime": "

The time the resource testing plan was created.

", + "UpdateRestoreTestingPlanOutput$UpdateTime": "

The time the update completed for the restore testing plan.

", + "UpdateRestoreTestingSelectionOutput$CreationTime": "

The time the resource testing selection was updated successfully.

", + "UpdateRestoreTestingSelectionOutput$UpdateTime": "

The time the update completed for the restore testing selection.

" } }, "Timezone": { "base": null, "refs": { - "BackupRule$ScheduleExpressionTimezone": "

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

", - "BackupRuleInput$ScheduleExpressionTimezone": "

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

" + "BackupRule$ScheduleExpressionTimezone": "

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

", + "BackupRuleInput$ScheduleExpressionTimezone": "

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

" } }, "UntagResourceInput": { @@ -2326,17 +2326,20 @@ "VaultState": { "base": null, "refs": { - "CreateLogicallyAirGappedBackupVaultOutput$VaultState": "

This is the current state of the vault.

" + "BackupVaultListMember$VaultState": "

The current state of the vault.

", + "CreateLogicallyAirGappedBackupVaultOutput$VaultState": "

The current state of the vault.

", + "DescribeBackupVaultOutput$VaultState": "

The current state of the vault.->

" } }, "VaultType": { "base": null, "refs": { - "DescribeBackupVaultOutput$VaultType": "

This is the type of vault described.

", - "DescribeRecoveryPointOutput$VaultType": "

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

", + "BackupVaultListMember$VaultType": "

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

", + "DescribeBackupVaultOutput$VaultType": "

The type of vault described.

", + "DescribeRecoveryPointOutput$VaultType": "

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

", "ListBackupVaultsInput$ByVaultType": "

This parameter will sort the list of vaults by vault type.

", - "RecoveryPointByBackupVault$VaultType": "

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

", - "RecoveryPointByResource$VaultType": "

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

" + "RecoveryPointByBackupVault$VaultType": "

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

", + "RecoveryPointByResource$VaultType": "

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

" } }, "WindowMinutes": { @@ -2408,7 +2411,7 @@ "BackupJob$PercentDone": "

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

", "BackupJob$BackupType": "

Represents the type of backup for a backup job.

", "BackupJob$ParentJobId": "

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

", - "BackupJob$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", + "BackupJob$ResourceName": "

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

", "BackupJob$MessageCategory": "

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

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

The the value ANY returns count of all message categories.

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

", "BackupPlanTemplatesListMember$BackupPlanTemplateId": "

Uniquely identifies a stored backup plan template.

", "BackupPlanTemplatesListMember$BackupPlanTemplateName": "

The optional display name of a backup plan template.

", @@ -2420,8 +2423,8 @@ "BackupSelectionsListMember$BackupPlanId": "

Uniquely identifies a backup plan.

", "BackupSelectionsListMember$CreatorRequestId": "

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

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

", "BackupVaultListMember$CreatorRequestId": "

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

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

", - "CancelLegalHoldInput$LegalHoldId": "

Legal hold ID required to remove the specified legal hold on a recovery point.

", - "CancelLegalHoldInput$CancelDescription": "

String describing the reason for removing the legal hold.

", + "CancelLegalHoldInput$LegalHoldId": "

The ID of the legal hold.

", + "CancelLegalHoldInput$CancelDescription": "

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

", "ComplianceResourceIdList$member": null, "ConflictException$Code": null, "ConflictException$Message": null, @@ -2430,32 +2433,32 @@ "CopyJob$CopyJobId": "

Uniquely identifies a copy job.

", "CopyJob$StatusMessage": "

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

", "CopyJob$ParentJobId": "

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

", - "CopyJob$CompositeMemberIdentifier": "

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

", - "CopyJob$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", + "CopyJob$CompositeMemberIdentifier": "

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

", + "CopyJob$ResourceName": "

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

", "CopyJob$MessageCategory": "

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

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

The the value ANY returns count of all message categories.

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

", "CreateBackupPlanInput$CreatorRequestId": "

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

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

", - "CreateBackupPlanOutput$BackupPlanId": "

Uniquely identifies a backup plan.

", + "CreateBackupPlanOutput$BackupPlanId": "

The ID of the backup plan.

", "CreateBackupPlanOutput$VersionId": "

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

", - "CreateBackupSelectionInput$BackupPlanId": "

Uniquely identifies the backup plan to be associated with the selection of resources.

", + "CreateBackupSelectionInput$BackupPlanId": "

The ID of the backup plan.

", "CreateBackupSelectionInput$CreatorRequestId": "

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

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

", "CreateBackupSelectionOutput$SelectionId": "

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

", - "CreateBackupSelectionOutput$BackupPlanId": "

Uniquely identifies a backup plan.

", + "CreateBackupSelectionOutput$BackupPlanId": "

The ID of the backup plan.

", "CreateBackupVaultInput$CreatorRequestId": "

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

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

", "CreateFrameworkInput$IdempotencyToken": "

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

", - "CreateLegalHoldInput$Title": "

This is the string title of the legal hold.

", - "CreateLegalHoldInput$Description": "

This is the string description of the legal hold.

", + "CreateLegalHoldInput$Title": "

The title of the legal hold.

", + "CreateLegalHoldInput$Description": "

The description of the legal hold.

", "CreateLegalHoldInput$IdempotencyToken": "

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

", - "CreateLegalHoldOutput$Title": "

This is the string title of the legal hold returned after creating the legal hold.

", - "CreateLegalHoldOutput$Description": "

This is the returned string description of the legal hold.

", - "CreateLegalHoldOutput$LegalHoldId": "

Legal hold ID returned for the specified legal hold on a recovery point.

", - "CreateLogicallyAirGappedBackupVaultInput$CreatorRequestId": "

This is the ID of the creation request.

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

", + "CreateLegalHoldOutput$Title": "

The title of the legal hold.

", + "CreateLegalHoldOutput$Description": "

The description of the legal hold.

", + "CreateLegalHoldOutput$LegalHoldId": "

The ID of the legal hold.

", + "CreateLogicallyAirGappedBackupVaultInput$CreatorRequestId": "

The ID of the creation request.

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

", "CreateReportPlanInput$IdempotencyToken": "

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

", "DeleteBackupPlanInput$BackupPlanId": "

Uniquely identifies a backup plan.

", "DeleteBackupPlanOutput$BackupPlanId": "

Uniquely identifies a backup plan.

", "DeleteBackupPlanOutput$VersionId": "

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

", "DeleteBackupSelectionInput$BackupPlanId": "

Uniquely identifies a backup plan.

", "DeleteBackupSelectionInput$SelectionId": "

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

", - "DeleteBackupVaultInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "DeleteBackupVaultInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", "DependencyFailureException$Code": null, "DependencyFailureException$Message": null, "DependencyFailureException$Type": "

", @@ -2466,24 +2469,24 @@ "DescribeBackupJobOutput$PercentDone": "

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

", "DescribeBackupJobOutput$BackupType": "

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

", "DescribeBackupJobOutput$ParentJobId": "

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

", - "DescribeBackupJobOutput$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", - "DescribeBackupJobOutput$MessageCategory": "

This is the job count for the specified message category.

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

", - "DescribeBackupVaultInput$BackupVaultName": "

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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", - "DescribeBackupVaultInput$BackupVaultAccountId": "

This is the account ID of the specified backup vault.

", - "DescribeBackupVaultOutput$BackupVaultName": "

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "DescribeBackupJobOutput$ResourceName": "

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

", + "DescribeBackupJobOutput$MessageCategory": "

The job count for the specified message category.

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

", + "DescribeBackupVaultInput$BackupVaultName": "

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 Amazon Web Services Region where they are created.

", + "DescribeBackupVaultInput$BackupVaultAccountId": "

The account ID of the specified backup vault.

", + "DescribeBackupVaultOutput$BackupVaultName": "

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 Region where they are created.

", "DescribeBackupVaultOutput$CreatorRequestId": "

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

", "DescribeCopyJobInput$CopyJobId": "

Uniquely identifies a copy job.

", "DescribeFrameworkOutput$DeploymentStatus": "

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

", "DescribeFrameworkOutput$FrameworkStatus": "

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

", "DescribeFrameworkOutput$IdempotencyToken": "

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

", - "DescribeProtectedResourceOutput$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", + "DescribeProtectedResourceOutput$ResourceName": "

The name of the resource that belongs to the specified backup.

", "DescribeRecoveryPointOutput$StatusMessage": "

A status message explaining the status of the recovery point.

", - "DescribeRecoveryPointOutput$CompositeMemberIdentifier": "

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

", - "DescribeRecoveryPointOutput$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", + "DescribeRecoveryPointOutput$CompositeMemberIdentifier": "

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

", + "DescribeRecoveryPointOutput$ResourceName": "

The name of the resource that belongs to the specified backup.

", "DescribeRestoreJobOutput$RestoreJobId": "

Uniquely identifies the job that restores a recovery point.

", "DescribeRestoreJobOutput$StatusMessage": "

A message showing the status of a job to restore a recovery point.

", "DescribeRestoreJobOutput$PercentDone": "

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

", - "DescribeRestoreJobOutput$ValidationStatusMessage": "

This describes the status of validation run on the indicated restore job.

", + "DescribeRestoreJobOutput$ValidationStatusMessage": "

The status message.

", "DescribeRestoreJobOutput$DeletionStatusMessage": "

This describes the restore job deletion status.

", "ExportBackupPlanTemplateInput$BackupPlanId": "

Uniquely identifies a backup plan.

", "ExportBackupPlanTemplateOutput$BackupPlanTemplateJson": "

The body of a backup plan template in JSON format.

This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

", @@ -2501,11 +2504,11 @@ "GetBackupSelectionOutput$SelectionId": "

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

", "GetBackupSelectionOutput$BackupPlanId": "

Uniquely identifies a backup plan.

", "GetBackupSelectionOutput$CreatorRequestId": "

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

", - "GetLegalHoldInput$LegalHoldId": "

This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.

", - "GetLegalHoldOutput$Title": "

This is the string title of the legal hold.

", - "GetLegalHoldOutput$Description": "

This is the returned string description of the legal hold.

", - "GetLegalHoldOutput$CancelDescription": "

String describing the reason for removing the legal hold.

", - "GetLegalHoldOutput$LegalHoldId": "

This is the returned ID associated with a specified legal hold.

", + "GetLegalHoldInput$LegalHoldId": "

The ID of the legal hold.

", + "GetLegalHoldOutput$Title": "

The title of the legal hold.

", + "GetLegalHoldOutput$Description": "

The description of the legal hold.

", + "GetLegalHoldOutput$CancelDescription": "

The reason for removing the legal hold.

", + "GetLegalHoldOutput$LegalHoldId": "

The ID of the legal hold.

", "InvalidParameterValueException$Code": null, "InvalidParameterValueException$Message": null, "InvalidParameterValueException$Type": "

", @@ -2518,15 +2521,15 @@ "InvalidResourceStateException$Message": null, "InvalidResourceStateException$Type": "

", "InvalidResourceStateException$Context": "

", - "LegalHold$Title": "

This is the title of a legal hold.

", - "LegalHold$Description": "

This is the description of a legal hold.

", - "LegalHold$LegalHoldId": "

ID of specific legal hold on one or more recovery points.

", + "LegalHold$Title": "

The title of a legal hold.

", + "LegalHold$Description": "

The description of a legal hold.

", + "LegalHold$LegalHoldId": "

The ID of the legal hold.

", "LimitExceededException$Code": null, "LimitExceededException$Message": null, "LimitExceededException$Type": "

", "LimitExceededException$Context": "

", "ListBackupJobSummariesInput$NextToken": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", - "ListBackupJobSummariesOutput$AggregationPeriod": "

This is the period that sets the boundaries for returned results.

", + "ListBackupJobSummariesOutput$AggregationPeriod": "

The period for the returned results.

", "ListBackupJobSummariesOutput$NextToken": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListBackupJobsInput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListBackupJobsInput$ByParentJobId": "

This is a filter to list child (nested) jobs based on parent job ID.

", @@ -2545,10 +2548,10 @@ "ListBackupVaultsInput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListBackupVaultsOutput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListCopyJobSummariesInput$NextToken": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", - "ListCopyJobSummariesOutput$AggregationPeriod": "

This is the period that sets the boundaries for returned results.

", + "ListCopyJobSummariesOutput$AggregationPeriod": "

The period for the returned results.

", "ListCopyJobSummariesOutput$NextToken": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListCopyJobsInput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", - "ListCopyJobsInput$ByDestinationVaultArn": "

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

", + "ListCopyJobsInput$ByDestinationVaultArn": "

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

", "ListCopyJobsInput$ByParentJobId": "

This is a filter to list child (nested) jobs based on parent job ID.

", "ListCopyJobsInput$ByMessageCategory": "

This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.

View Monitoring for a list of accepted strings.

The the value ANY returns count of all message categories.

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

", "ListCopyJobsOutput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", @@ -2563,9 +2566,9 @@ "ListRecoveryPointsByBackupVaultInput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListRecoveryPointsByBackupVaultInput$ByBackupPlanId": "

Returns only recovery points that match the specified backup plan ID.

", "ListRecoveryPointsByBackupVaultOutput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", - "ListRecoveryPointsByLegalHoldInput$LegalHoldId": "

This is the ID of the legal hold.

", - "ListRecoveryPointsByLegalHoldInput$NextToken": "

This is the next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", - "ListRecoveryPointsByLegalHoldOutput$NextToken": "

This return is the next item following a partial list of returned resources.

", + "ListRecoveryPointsByLegalHoldInput$LegalHoldId": "

The ID of the legal hold.

", + "ListRecoveryPointsByLegalHoldInput$NextToken": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "ListRecoveryPointsByLegalHoldOutput$NextToken": "

The next item following a partial list of returned resources.

", "ListRecoveryPointsByResourceInput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListRecoveryPointsByResourceOutput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListReportJobsInput$ByStatus": "

Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

", @@ -2574,7 +2577,7 @@ "ListReportPlansInput$NextToken": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", "ListReportPlansOutput$NextToken": "

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", "ListRestoreJobSummariesInput$NextToken": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", - "ListRestoreJobSummariesOutput$AggregationPeriod": "

This is the period that sets the boundaries for returned results.

", + "ListRestoreJobSummariesOutput$AggregationPeriod": "

The period for the returned results.

", "ListRestoreJobSummariesOutput$NextToken": "

The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListRestoreJobsByProtectedResourceInput$NextToken": "

The next item following a partial list of returned items. For example, if a request ismade to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "ListRestoreJobsByProtectedResourceOutput$NextToken": "

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows youto return more items in your list starting at the location pointed to by the next token

", @@ -2586,13 +2589,13 @@ "MissingParameterValueException$Message": null, "MissingParameterValueException$Type": "

", "MissingParameterValueException$Context": "

", - "ProtectedResource$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", + "ProtectedResource$ResourceName": "

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

", "PutRestoreValidationResultInput$ValidationStatusMessage": "

This is an optional message string you can input to describe the validation status for the restore test validation.

", - "RecoveryPointByBackupVault$StatusMessage": "

A message explaining the reason of the recovery point deletion failure.

", - "RecoveryPointByBackupVault$CompositeMemberIdentifier": "

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

", - "RecoveryPointByBackupVault$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", - "RecoveryPointByResource$StatusMessage": "

A message explaining the reason of the recovery point deletion failure.

", - "RecoveryPointByResource$ResourceName": "

This is the non-unique name of the resource that belongs to the specified backup.

", + "RecoveryPointByBackupVault$StatusMessage": "

A message explaining the current status of the recovery point.

", + "RecoveryPointByBackupVault$CompositeMemberIdentifier": "

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

", + "RecoveryPointByBackupVault$ResourceName": "

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

", + "RecoveryPointByResource$StatusMessage": "

A message explaining the current status of the recovery point.

", + "RecoveryPointByResource$ResourceName": "

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

", "RecoveryPointCreator$BackupPlanId": "

Uniquely identifies a backup plan.

", "RecoveryPointCreator$BackupPlanVersion": "

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

", "RecoveryPointCreator$BackupRuleId": "

Uniquely identifies a rule used to schedule the backup of a selection of resources.

", @@ -2626,7 +2629,7 @@ "StartRestoreJobInput$IdempotencyToken": "

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

", "StopBackupJobInput$BackupJobId": "

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

", "TagKeyList$member": null, - "UpdateBackupPlanInput$BackupPlanId": "

Uniquely identifies a backup plan.

", + "UpdateBackupPlanInput$BackupPlanId": "

The ID of the backup plan.

", "UpdateBackupPlanOutput$BackupPlanId": "

Uniquely identifies a backup plan.

", "UpdateBackupPlanOutput$VersionId": "

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

", "UpdateFrameworkInput$IdempotencyToken": "

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

", @@ -2642,9 +2645,9 @@ "refs": { "ReportDestination$S3Keys": "

The object key that uniquely identifies your reports in your S3 bucket.

", "ReportSetting$FrameworkArns": "

The Amazon Resource Names (ARNs) of the frameworks a report covers.

", - "ReportSetting$Accounts": "

These are the accounts to be included in the report.

", + "ReportSetting$Accounts": "

These are the accounts to be included in the report.

Use string value of ROOT to include all organizational units.

", "ReportSetting$OrganizationUnits": "

These are the Organizational Units to be included in the report.

", - "ReportSetting$Regions": "

These are the Regions to be included in the report.

", + "ReportSetting$Regions": "

These are the Regions to be included in the report.

Use the wildcard as the string value to include all Regions.

", "RestoreTestingRecoveryPointSelection$ExcludeVaults": "

Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.

", "RestoreTestingRecoveryPointSelection$IncludeVaults": "

Accepted values include wildcard [\"*\"] or by specific ARNs or ARN wilcard replacement [\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...] [\"arn:aws:backup:*:*:backup-vault:asdf-*\", ...]

", "RestoreTestingSelectionForCreate$ProtectedResourceArns": "

Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or by a wildcard: ProtectedResourceArns: [\"*\"], but not both.

", @@ -2655,9 +2658,9 @@ "stringMap": { "base": null, "refs": { - "ControlScope$Tags": "

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{\"Key\":\"string\",\"Value\":\"string\"}].

", - "CreateFrameworkInput$FrameworkTags": "

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

", - "CreateReportPlanInput$ReportPlanTags": "

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

", + "ControlScope$Tags": "

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

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

", + "CreateFrameworkInput$FrameworkTags": "

The tags to assign to the framework.

", + "CreateReportPlanInput$ReportPlanTags": "

The tags to assign to the report plan.

", "GetRestoreTestingInferredMetadataOutput$InferredMetadata": "

This is a string map of the metadata inferred from the request.

" } }, @@ -2668,12 +2671,12 @@ "BackupJob$CompletionDate": "

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

", "BackupJob$ExpectedCompletionDate": "

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

", "BackupJob$StartBy": "

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

", - "BackupJob$InitiationDate": "

This is the date on which the backup job was initiated.

", + "BackupJob$InitiationDate": "

The date on which the backup job was initiated.

", "BackupJobSummary$StartTime": "

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

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

", "BackupJobSummary$EndTime": "

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

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

", "BackupPlansListMember$CreationDate": "

The date and time a resource backup plan 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.

", "BackupPlansListMember$DeletionDate": "

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

", - "BackupPlansListMember$LastExecutionDate": "

The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", + "BackupPlansListMember$LastExecutionDate": "

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

", "BackupSelectionsListMember$CreationDate": "

The date and time a backup plan 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.

", "BackupVaultListMember$CreationDate": "

The date and time a resource backup 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.

", "BackupVaultListMember$LockDate": "

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

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

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

", @@ -2686,7 +2689,7 @@ "CreateBackupPlanOutput$CreationDate": "

The date and time that a backup plan 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.

", "CreateBackupSelectionOutput$CreationDate": "

The date and time a backup selection 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.

", "CreateBackupVaultOutput$CreationDate": "

The date and time a backup vault 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.

", - "CreateLegalHoldOutput$CreationDate": "

Time in number format when legal hold was created.

", + "CreateLegalHoldOutput$CreationDate": "

The time when the legal hold was created.

", "CreateLogicallyAirGappedBackupVaultOutput$CreationDate": "

The date and time when the vault was created.

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

", "CreateReportPlanOutput$CreationTime": "

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

", "DateRange$FromDate": "

This value is the beginning date, inclusive.

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

", @@ -2696,30 +2699,30 @@ "DescribeBackupJobOutput$CompletionDate": "

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

", "DescribeBackupJobOutput$ExpectedCompletionDate": "

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

", "DescribeBackupJobOutput$StartBy": "

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

", - "DescribeBackupJobOutput$InitiationDate": "

This is the date a backup job was initiated.

", + "DescribeBackupJobOutput$InitiationDate": "

The date a backup job was initiated.

", "DescribeBackupVaultOutput$CreationDate": "

The date and time that a backup vault 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.

", "DescribeBackupVaultOutput$LockDate": "

The date and time when Backup Vault Lock configuration cannot be changed or deleted.

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

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

", "DescribeFrameworkOutput$CreationTime": "

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

", "DescribeGlobalSettingsOutput$LastUpdateTime": "

The date and time that the flag isCrossAccountBackupEnabled 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.

", "DescribeProtectedResourceOutput$LastBackupTime": "

The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", - "DescribeProtectedResourceOutput$LatestRestoreJobCreationDate": "

This is the creation date of the most recent restore job.

", - "DescribeProtectedResourceOutput$LatestRestoreRecoveryPointCreationDate": "

This is the date the most recent recovery point was created.

", + "DescribeProtectedResourceOutput$LatestRestoreJobCreationDate": "

The creation date of the most recent restore job.

", + "DescribeProtectedResourceOutput$LatestRestoreRecoveryPointCreationDate": "

The date the most recent recovery point was created.

", "DescribeRecoveryPointOutput$CreationDate": "

The date and time that a recovery point 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.

", "DescribeRecoveryPointOutput$CompletionDate": "

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

", "DescribeRecoveryPointOutput$LastRestoreTime": "

The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", "DescribeRestoreJobOutput$CreationDate": "

The date and time that a restore 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.

", "DescribeRestoreJobOutput$CompletionDate": "

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

", - "DescribeRestoreJobOutput$RecoveryPointCreationDate": "

This is the creation date of the recovery point made by the specifed restore job.

", + "DescribeRestoreJobOutput$RecoveryPointCreationDate": "

The creation date of the recovery point made by the specifed restore job.

", "Framework$CreationTime": "

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

", "GetBackupPlanOutput$CreationDate": "

The date and time that a backup plan 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.

", "GetBackupPlanOutput$DeletionDate": "

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

", - "GetBackupPlanOutput$LastExecutionDate": "

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

", + "GetBackupPlanOutput$LastExecutionDate": "

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

", "GetBackupSelectionOutput$CreationDate": "

The date and time a backup selection 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.

", - "GetLegalHoldOutput$CreationDate": "

Time in number format when legal hold was created.

", - "GetLegalHoldOutput$CancellationDate": "

Time in number when legal hold was cancelled.

", - "GetLegalHoldOutput$RetainRecordUntil": "

This is the date and time until which the legal hold record will be retained.

", - "LegalHold$CreationDate": "

This is the time in number format when legal hold was created.

", - "LegalHold$CancellationDate": "

This is the time in number format when legal hold was cancelled.

", + "GetLegalHoldOutput$CreationDate": "

The time when the legal hold was created.

", + "GetLegalHoldOutput$CancellationDate": "

The time when the legal hold was cancelled.

", + "GetLegalHoldOutput$RetainRecordUntil": "

The date and time until which the legal hold record is retained.

", + "LegalHold$CreationDate": "

The time when the legal hold was created.

", + "LegalHold$CancellationDate": "

The time when the legal hold was cancelled.

", "ListBackupJobsInput$ByCreatedBefore": "

Returns only backup jobs that were created before the specified date.

", "ListBackupJobsInput$ByCreatedAfter": "

Returns only backup jobs that were created after the specified date.

", "ListBackupJobsInput$ByCompleteAfter": "

Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

", diff --git a/apis/datazone/2018-05-10/api-2.json b/apis/datazone/2018-05-10/api-2.json index 5921d0cd7a9..ec03784d353 100644 --- a/apis/datazone/2018-05-10/api-2.json +++ b/apis/datazone/2018-05-10/api-2.json @@ -52,6 +52,47 @@ ], "idempotent":true }, + "AddEntityOwner":{ + "name":"AddEntityOwner", + "http":{ + "method":"POST", + "requestUri":"/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/addOwner", + "responseCode":201 + }, + "input":{"shape":"AddEntityOwnerInput"}, + "output":{"shape":"AddEntityOwnerOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "idempotent":true + }, + "AddPolicyGrant":{ + "name":"AddPolicyGrant", + "http":{ + "method":"POST", + "requestUri":"/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/addGrant", + "responseCode":201 + }, + "input":{"shape":"AddPolicyGrantInput"}, + "output":{"shape":"AddPolicyGrantOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "idempotent":true + }, "AssociateEnvironmentRole":{ "name":"AssociateEnvironmentRole", "http":{ @@ -274,6 +315,26 @@ ], "idempotent":true }, + "CreateDomainUnit":{ + "name":"CreateDomainUnit", + "http":{ + "method":"POST", + "requestUri":"/v2/domains/{domainIdentifier}/domain-units", + "responseCode":201 + }, + "input":{"shape":"CreateDomainUnitInput"}, + "output":{"shape":"CreateDomainUnitOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "idempotent":true + }, "CreateEnvironment":{ "name":"CreateEnvironment", "http":{ @@ -664,6 +725,26 @@ ], "idempotent":true }, + "DeleteDomainUnit":{ + "name":"DeleteDomainUnit", + "http":{ + "method":"DELETE", + "requestUri":"/v2/domains/{domainIdentifier}/domain-units/{identifier}", + "responseCode":204 + }, + "input":{"shape":"DeleteDomainUnitInput"}, + "output":{"shape":"DeleteDomainUnitOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "idempotent":true + }, "DeleteEnvironment":{ "name":"DeleteEnvironment", "http":{ @@ -1079,6 +1160,24 @@ {"shape":"UnauthorizedException"} ] }, + "GetDomainUnit":{ + "name":"GetDomainUnit", + "http":{ + "method":"GET", + "requestUri":"/v2/domains/{domainIdentifier}/domain-units/{identifier}", + "responseCode":200 + }, + "input":{"shape":"GetDomainUnitInput"}, + "output":{"shape":"GetDomainUnitOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ] + }, "GetEnvironment":{ "name":"GetEnvironment", "http":{ @@ -1572,6 +1671,23 @@ {"shape":"UnauthorizedException"} ] }, + "ListDomainUnitsForParent":{ + "name":"ListDomainUnitsForParent", + "http":{ + "method":"GET", + "requestUri":"/v2/domains/{domainIdentifier}/domain-units", + "responseCode":200 + }, + "input":{"shape":"ListDomainUnitsForParentInput"}, + "output":{"shape":"ListDomainUnitsForParentOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ] + }, "ListDomains":{ "name":"ListDomains", "http":{ @@ -1592,6 +1708,23 @@ {"shape":"UnauthorizedException"} ] }, + "ListEntityOwners":{ + "name":"ListEntityOwners", + "http":{ + "method":"GET", + "requestUri":"/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/owners", + "responseCode":200 + }, + "input":{"shape":"ListEntityOwnersInput"}, + "output":{"shape":"ListEntityOwnersOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ] + }, "ListEnvironmentActions":{ "name":"ListEnvironmentActions", "http":{ @@ -1733,6 +1866,23 @@ {"shape":"UnauthorizedException"} ] }, + "ListPolicyGrants":{ + "name":"ListPolicyGrants", + "http":{ + "method":"GET", + "requestUri":"/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/grants", + "responseCode":200 + }, + "input":{"shape":"ListPolicyGrantsInput"}, + "output":{"shape":"ListPolicyGrantsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ] + }, "ListProjectMemberships":{ "name":"ListProjectMemberships", "http":{ @@ -1978,6 +2128,43 @@ ], "idempotent":true }, + "RemoveEntityOwner":{ + "name":"RemoveEntityOwner", + "http":{ + "method":"POST", + "requestUri":"/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/removeOwner", + "responseCode":204 + }, + "input":{"shape":"RemoveEntityOwnerInput"}, + "output":{"shape":"RemoveEntityOwnerOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "idempotent":true + }, + "RemovePolicyGrant":{ + "name":"RemovePolicyGrant", + "http":{ + "method":"POST", + "requestUri":"/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/removeGrant", + "responseCode":204 + }, + "input":{"shape":"RemovePolicyGrantInput"}, + "output":{"shape":"RemovePolicyGrantOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "idempotent":true + }, "RevokeSubscription":{ "name":"RevokeSubscription", "http":{ @@ -2225,6 +2412,26 @@ ], "idempotent":true }, + "UpdateDomainUnit":{ + "name":"UpdateDomainUnit", + "http":{ + "method":"PUT", + "requestUri":"/v2/domains/{domainIdentifier}/domain-units/{identifier}", + "responseCode":200 + }, + "input":{"shape":"UpdateDomainUnitInput"}, + "output":{"shape":"UpdateDomainUnitOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"UnauthorizedException"} + ], + "idempotent":true + }, "UpdateEnvironment":{ "name":"UpdateEnvironment", "http":{ @@ -2595,6 +2802,98 @@ }, "union":true }, + "AddEntityOwnerInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "entityIdentifier", + "entityType", + "owner" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "entityIdentifier":{ + "shape":"String", + "location":"uri", + "locationName":"entityIdentifier" + }, + "entityType":{ + "shape":"DataZoneEntityType", + "location":"uri", + "locationName":"entityType" + }, + "owner":{"shape":"OwnerProperties"} + } + }, + "AddEntityOwnerOutput":{ + "type":"structure", + "members":{ + } + }, + "AddPolicyGrantInput":{ + "type":"structure", + "required":[ + "detail", + "domainIdentifier", + "entityIdentifier", + "entityType", + "policyType", + "principal" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "detail":{"shape":"PolicyGrantDetail"}, + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "entityIdentifier":{ + "shape":"String", + "location":"uri", + "locationName":"entityIdentifier" + }, + "entityType":{ + "shape":"TargetEntityType", + "location":"uri", + "locationName":"entityType" + }, + "policyType":{"shape":"ManagedPolicyType"}, + "principal":{"shape":"PolicyGrantPrincipal"} + } + }, + "AddPolicyGrantOutput":{ + "type":"structure", + "members":{ + } + }, + "AddToProjectMemberPoolPolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, + "AllDomainUnitsGrantFilter":{ + "type":"structure", + "members":{ + } + }, + "AllUsersGrantFilter":{ + "type":"structure", + "members":{ + } + }, "ApplicableAssetTypes":{ "type":"list", "member":{"shape":"TypeName"} @@ -3239,6 +3538,12 @@ "updatedBy":{"shape":"UpdatedBy"} } }, + "CreateAssetTypePolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, "CreateDataProductInput":{ "type":"structure", "required":[ @@ -3441,11 +3746,61 @@ "kmsKeyIdentifier":{"shape":"KmsKeyArn"}, "name":{"shape":"String"}, "portalUrl":{"shape":"String"}, + "rootDomainUnitId":{"shape":"DomainUnitId"}, "singleSignOn":{"shape":"SingleSignOn"}, "status":{"shape":"DomainStatus"}, "tags":{"shape":"Tags"} } }, + "CreateDomainUnitInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "name", + "parentDomainUnitIdentifier" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "description":{"shape":"DomainUnitDescription"}, + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "name":{"shape":"DomainUnitName"}, + "parentDomainUnitIdentifier":{"shape":"DomainUnitId"} + } + }, + "CreateDomainUnitOutput":{ + "type":"structure", + "required":[ + "ancestorDomainUnitIds", + "domainId", + "id", + "name", + "owners" + ], + "members":{ + "ancestorDomainUnitIds":{"shape":"DomainUnitIds"}, + "createdAt":{"shape":"CreatedAt"}, + "createdBy":{"shape":"CreatedBy"}, + "description":{"shape":"DomainUnitDescription"}, + "domainId":{"shape":"DomainId"}, + "id":{"shape":"DomainUnitId"}, + "name":{"shape":"DomainUnitName"}, + "owners":{"shape":"DomainUnitOwners"}, + "parentDomainUnitId":{"shape":"DomainUnitId"} + } + }, + "CreateDomainUnitPolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, "CreateEnvironmentActionInput":{ "type":"structure", "required":[ @@ -3593,6 +3948,12 @@ "userParameters":{"shape":"CustomParameterList"} } }, + "CreateEnvironmentProfilePolicyGrantDetail":{ + "type":"structure", + "members":{ + "domainUnitId":{"shape":"DomainUnitId"} + } + }, "CreateFormTypeInput":{ "type":"structure", "required":[ @@ -3631,6 +3992,12 @@ "revision":{"shape":"Revision"} } }, + "CreateFormTypePolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, "CreateGlossaryInput":{ "type":"structure", "required":[ @@ -3671,6 +4038,12 @@ "status":{"shape":"GlossaryStatus"} } }, + "CreateGlossaryPolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, "CreateGlossaryTermInput":{ "type":"structure", "required":[ @@ -3794,6 +4167,7 @@ "location":"uri", "locationName":"domainIdentifier" }, + "domainUnitId":{"shape":"DomainUnitId"}, "glossaryTerms":{"shape":"GlossaryTerms"}, "name":{"shape":"ProjectName"} } @@ -3839,6 +4213,7 @@ "createdBy":{"shape":"CreatedBy"}, "description":{"shape":"Description"}, "domainId":{"shape":"DomainId"}, + "domainUnitId":{"shape":"DomainUnitId"}, "failureReasons":{"shape":"FailureReasons"}, "glossaryTerms":{"shape":"GlossaryTerms"}, "id":{"shape":"ProjectId"}, @@ -3847,6 +4222,12 @@ "projectStatus":{"shape":"ProjectStatus"} } }, + "CreateProjectPolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, "CreateSubscriptionGrantInput":{ "type":"structure", "required":[ @@ -4397,6 +4778,10 @@ "max":256, "min":1 }, + "DataZoneEntityType":{ + "type":"string", + "enum":["DOMAIN_UNIT"] + }, "DateTime":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -4596,6 +4981,30 @@ "status":{"shape":"DomainStatus"} } }, + "DeleteDomainUnitInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "identifier" + ], + "members":{ + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "identifier":{ + "shape":"DomainUnitId", + "location":"uri", + "locationName":"identifier" + } + } + }, + "DeleteDomainUnitOutput":{ + "type":"structure", + "members":{ + } + }, "DeleteEnvironmentActionInput":{ "type":"structure", "required":[ @@ -5117,6 +5526,101 @@ "status":{"shape":"DomainStatus"} } }, + "DomainUnitDescription":{ + "type":"string", + "max":2048, + "min":0, + "sensitive":true + }, + "DomainUnitDesignation":{ + "type":"string", + "enum":["OWNER"] + }, + "DomainUnitFilterForProject":{ + "type":"structure", + "required":["domainUnit"], + "members":{ + "domainUnit":{"shape":"DomainUnitId"}, + "includeChildDomainUnits":{ + "shape":"Boolean", + "box":true + } + } + }, + "DomainUnitGrantFilter":{ + "type":"structure", + "members":{ + "allDomainUnitsGrantFilter":{"shape":"AllDomainUnitsGrantFilter"} + }, + "union":true + }, + "DomainUnitGroupProperties":{ + "type":"structure", + "members":{ + "groupId":{"shape":"String"} + } + }, + "DomainUnitId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-z0-9_\\-]+$" + }, + "DomainUnitIds":{ + "type":"list", + "member":{"shape":"DomainUnitId"} + }, + "DomainUnitName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[\\w -]+$", + "sensitive":true + }, + "DomainUnitOwnerProperties":{ + "type":"structure", + "members":{ + "group":{"shape":"DomainUnitGroupProperties"}, + "user":{"shape":"DomainUnitUserProperties"} + }, + "union":true + }, + "DomainUnitOwners":{ + "type":"list", + "member":{"shape":"DomainUnitOwnerProperties"}, + "max":20, + "min":0 + }, + "DomainUnitPolicyGrantPrincipal":{ + "type":"structure", + "required":["domainUnitDesignation"], + "members":{ + "domainUnitDesignation":{"shape":"DomainUnitDesignation"}, + "domainUnitGrantFilter":{"shape":"DomainUnitGrantFilter"}, + "domainUnitIdentifier":{"shape":"DomainUnitId"} + } + }, + "DomainUnitSummaries":{ + "type":"list", + "member":{"shape":"DomainUnitSummary"} + }, + "DomainUnitSummary":{ + "type":"structure", + "required":[ + "id", + "name" + ], + "members":{ + "id":{"shape":"DomainUnitId"}, + "name":{"shape":"String"} + } + }, + "DomainUnitUserProperties":{ + "type":"structure", + "members":{ + "userId":{"shape":"String"} + } + }, "EdgeDirection":{ "type":"string", "enum":[ @@ -5150,6 +5654,10 @@ "type":"string", "pattern":"^[a-zA-Z0-9_-]{1,36}$" }, + "EntityOwners":{ + "type":"list", + "member":{"shape":"OwnerPropertiesOutput"} + }, "EntityType":{ "type":"string", "enum":[ @@ -5922,11 +6430,52 @@ "lastUpdatedAt":{"shape":"UpdatedAt"}, "name":{"shape":"String"}, "portalUrl":{"shape":"String"}, + "rootDomainUnitId":{"shape":"DomainUnitId"}, "singleSignOn":{"shape":"SingleSignOn"}, "status":{"shape":"DomainStatus"}, "tags":{"shape":"Tags"} } }, + "GetDomainUnitInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "identifier" + ], + "members":{ + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "identifier":{ + "shape":"DomainUnitId", + "location":"uri", + "locationName":"identifier" + } + } + }, + "GetDomainUnitOutput":{ + "type":"structure", + "required":[ + "domainId", + "id", + "name", + "owners" + ], + "members":{ + "createdAt":{"shape":"CreatedAt"}, + "createdBy":{"shape":"CreatedBy"}, + "description":{"shape":"DomainUnitDescription"}, + "domainId":{"shape":"DomainId"}, + "id":{"shape":"DomainUnitId"}, + "lastUpdatedAt":{"shape":"UpdatedAt"}, + "lastUpdatedBy":{"shape":"UpdatedBy"}, + "name":{"shape":"DomainUnitName"}, + "owners":{"shape":"DomainUnitOwners"}, + "parentDomainUnitId":{"shape":"DomainUnitId"} + } + }, "GetEnvironmentActionInput":{ "type":"structure", "required":[ @@ -6512,6 +7061,7 @@ "createdBy":{"shape":"CreatedBy"}, "description":{"shape":"Description"}, "domainId":{"shape":"DomainId"}, + "domainUnitId":{"shape":"DomainUnitId"}, "failureReasons":{"shape":"FailureReasons"}, "glossaryTerms":{"shape":"GlossaryTerms"}, "id":{"shape":"ProjectId"}, @@ -6998,11 +7548,18 @@ }, "GroupIdentifier":{ "type":"string", - "pattern":"(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)" + "pattern":"(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)" + }, + "GroupPolicyGrantPrincipal":{ + "type":"structure", + "members":{ + "groupIdentifier":{"shape":"GroupIdentifier"} + }, + "union":true }, "GroupProfileId":{ "type":"string", - "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + "pattern":"^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" }, "GroupProfileName":{ "type":"string", @@ -7497,7 +8054,44 @@ "type":"structure", "required":["items"], "members":{ - "items":{"shape":"DataSourceSummaries"}, + "items":{"shape":"DataSourceSummaries"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListDomainUnitsForParentInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "parentDomainUnitIdentifier" + ], + "members":{ + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "maxResults":{ + "shape":"MaxResultsForListDomains", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" + }, + "parentDomainUnitIdentifier":{ + "shape":"DomainUnitId", + "location":"querystring", + "locationName":"parentDomainUnitIdentifier" + } + } + }, + "ListDomainUnitsForParentOutput":{ + "type":"structure", + "required":["items"], + "members":{ + "items":{"shape":"DomainUnitSummaries"}, "nextToken":{"shape":"PaginationToken"} } }, @@ -7529,6 +8123,49 @@ "nextToken":{"shape":"PaginationToken"} } }, + "ListEntityOwnersInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "entityIdentifier", + "entityType" + ], + "members":{ + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "entityIdentifier":{ + "shape":"String", + "location":"uri", + "locationName":"entityIdentifier" + }, + "entityType":{ + "shape":"DataZoneEntityType", + "location":"uri", + "locationName":"entityType" + }, + "maxResults":{ + "shape":"MaxResultsForListDomains", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListEntityOwnersOutput":{ + "type":"structure", + "required":["owners"], + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "owners":{"shape":"EntityOwners"} + } + }, "ListEnvironmentActionSummaries":{ "type":"list", "member":{"shape":"EnvironmentActionSummary"} @@ -7912,6 +8549,55 @@ "notifications":{"shape":"NotificationsList"} } }, + "ListPolicyGrantsInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "entityIdentifier", + "entityType", + "policyType" + ], + "members":{ + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "entityIdentifier":{ + "shape":"String", + "location":"uri", + "locationName":"entityIdentifier" + }, + "entityType":{ + "shape":"TargetEntityType", + "location":"uri", + "locationName":"entityType" + }, + "maxResults":{ + "shape":"MaxResultsForListDomains", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" + }, + "policyType":{ + "shape":"ManagedPolicyType", + "location":"querystring", + "locationName":"policyType" + } + } + }, + "ListPolicyGrantsOutput":{ + "type":"structure", + "required":["grantList"], + "members":{ + "grantList":{"shape":"PolicyGrantList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, "ListProjectMembershipsInput":{ "type":"structure", "required":[ @@ -8388,6 +9074,22 @@ "min":0, "sensitive":true }, + "ManagedPolicyType":{ + "type":"string", + "enum":[ + "CREATE_DOMAIN_UNIT", + "OVERRIDE_DOMAIN_UNIT_OWNERS", + "ADD_TO_PROJECT_MEMBER_POOL", + "OVERRIDE_PROJECT_OWNERS", + "CREATE_GLOSSARY", + "CREATE_FORM_TYPE", + "CREATE_ASSET_TYPE", + "CREATE_PROJECT", + "CREATE_ENVIRONMENT_PROFILE", + "DELEGATE_CREATE_ENVIRONMENT_PROFILE", + "CREATE_ENVIRONMENT" + ] + }, "MaxResults":{ "type":"integer", "box":true, @@ -8598,11 +9300,105 @@ "type":"list", "member":{"shape":"NotificationOutput"} }, + "OverrideDomainUnitOwnersPolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, + "OverrideProjectOwnersPolicyGrantDetail":{ + "type":"structure", + "members":{ + "includeChildDomainUnits":{"shape":"Boolean"} + } + }, + "OwnerGroupProperties":{ + "type":"structure", + "required":["groupIdentifier"], + "members":{ + "groupIdentifier":{"shape":"GroupIdentifier"} + } + }, + "OwnerGroupPropertiesOutput":{ + "type":"structure", + "members":{ + "groupId":{"shape":"String"} + } + }, + "OwnerProperties":{ + "type":"structure", + "members":{ + "group":{"shape":"OwnerGroupProperties"}, + "user":{"shape":"OwnerUserProperties"} + }, + "union":true + }, + "OwnerPropertiesOutput":{ + "type":"structure", + "members":{ + "group":{"shape":"OwnerGroupPropertiesOutput"}, + "user":{"shape":"OwnerUserPropertiesOutput"} + }, + "union":true + }, + "OwnerUserProperties":{ + "type":"structure", + "required":["userIdentifier"], + "members":{ + "userIdentifier":{"shape":"UserIdentifier"} + } + }, + "OwnerUserPropertiesOutput":{ + "type":"structure", + "members":{ + "userId":{"shape":"String"} + } + }, "PaginationToken":{ "type":"string", "max":8192, "min":1 }, + "PolicyGrantDetail":{ + "type":"structure", + "members":{ + "addToProjectMemberPool":{"shape":"AddToProjectMemberPoolPolicyGrantDetail"}, + "createAssetType":{"shape":"CreateAssetTypePolicyGrantDetail"}, + "createDomainUnit":{"shape":"CreateDomainUnitPolicyGrantDetail"}, + "createEnvironment":{"shape":"Unit"}, + "createEnvironmentProfile":{"shape":"CreateEnvironmentProfilePolicyGrantDetail"}, + "createFormType":{"shape":"CreateFormTypePolicyGrantDetail"}, + "createGlossary":{"shape":"CreateGlossaryPolicyGrantDetail"}, + "createProject":{"shape":"CreateProjectPolicyGrantDetail"}, + "delegateCreateEnvironmentProfile":{"shape":"Unit"}, + "overrideDomainUnitOwners":{"shape":"OverrideDomainUnitOwnersPolicyGrantDetail"}, + "overrideProjectOwners":{"shape":"OverrideProjectOwnersPolicyGrantDetail"} + }, + "union":true + }, + "PolicyGrantList":{ + "type":"list", + "member":{"shape":"PolicyGrantMember"} + }, + "PolicyGrantMember":{ + "type":"structure", + "members":{ + "createdAt":{"shape":"CreatedAt"}, + "createdBy":{"shape":"CreatedBy"}, + "detail":{"shape":"PolicyGrantDetail"}, + "principal":{"shape":"PolicyGrantPrincipal"} + } + }, + "PolicyGrantPrincipal":{ + "type":"structure", + "members":{ + "domainUnit":{"shape":"DomainUnitPolicyGrantPrincipal"}, + "group":{"shape":"GroupPolicyGrantPrincipal"}, + "project":{"shape":"ProjectPolicyGrantPrincipal"}, + "user":{"shape":"UserPolicyGrantPrincipal"} + }, + "union":true + }, "PostLineageEventInput":{ "type":"structure", "required":[ @@ -8687,6 +9483,20 @@ "message":{"shape":"String"} } }, + "ProjectDesignation":{ + "type":"string", + "enum":[ + "OWNER", + "CONTRIBUTOR" + ] + }, + "ProjectGrantFilter":{ + "type":"structure", + "members":{ + "domainUnitFilter":{"shape":"DomainUnitFilterForProject"} + }, + "union":true + }, "ProjectId":{ "type":"string", "pattern":"^[a-zA-Z0-9_-]{1,36}$" @@ -8713,6 +9523,15 @@ "pattern":"^[\\w -]+$", "sensitive":true }, + "ProjectPolicyGrantPrincipal":{ + "type":"structure", + "required":["projectDesignation"], + "members":{ + "projectDesignation":{"shape":"ProjectDesignation"}, + "projectGrantFilter":{"shape":"ProjectGrantFilter"}, + "projectIdentifier":{"shape":"ProjectId"} + } + }, "ProjectStatus":{ "type":"string", "enum":[ @@ -8738,6 +9557,7 @@ "createdBy":{"shape":"CreatedBy"}, "description":{"shape":"Description"}, "domainId":{"shape":"DomainId"}, + "domainUnitId":{"shape":"DomainUnitId"}, "failureReasons":{"shape":"FailureReasons"}, "id":{"shape":"ProjectId"}, "name":{"shape":"ProjectName"}, @@ -9084,6 +9904,80 @@ "type":"list", "member":{"shape":"RelationalFilterConfiguration"} }, + "RemoveEntityOwnerInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "entityIdentifier", + "entityType", + "owner" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "entityIdentifier":{ + "shape":"String", + "location":"uri", + "locationName":"entityIdentifier" + }, + "entityType":{ + "shape":"DataZoneEntityType", + "location":"uri", + "locationName":"entityType" + }, + "owner":{"shape":"OwnerProperties"} + } + }, + "RemoveEntityOwnerOutput":{ + "type":"structure", + "members":{ + } + }, + "RemovePolicyGrantInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "entityIdentifier", + "entityType", + "policyType", + "principal" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "entityIdentifier":{ + "shape":"String", + "location":"uri", + "locationName":"entityIdentifier" + }, + "entityType":{ + "shape":"TargetEntityType", + "location":"uri", + "locationName":"entityType" + }, + "policyType":{"shape":"ManagedPolicyType"}, + "principal":{"shape":"PolicyGrantPrincipal"} + } + }, + "RemovePolicyGrantOutput":{ + "type":"structure", + "members":{ + } + }, "RequestReason":{ "type":"string", "max":4096, @@ -10040,6 +10934,14 @@ "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"} }, + "TargetEntityType":{ + "type":"string", + "enum":[ + "DOMAIN_UNIT", + "ENVIRONMENT_BLUEPRINT_CONFIGURATION", + "ENVIRONMENT_PROFILE" + ] + }, "TaskId":{ "type":"string", "pattern":"^[a-zA-Z0-9_-]{1,36}$" @@ -10288,6 +11190,11 @@ }, "exception":true }, + "Unit":{ + "type":"structure", + "members":{ + } + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -10455,9 +11362,52 @@ "id":{"shape":"DomainId"}, "lastUpdatedAt":{"shape":"UpdatedAt"}, "name":{"shape":"String"}, + "rootDomainUnitId":{"shape":"DomainUnitId"}, "singleSignOn":{"shape":"SingleSignOn"} } }, + "UpdateDomainUnitInput":{ + "type":"structure", + "required":[ + "domainIdentifier", + "identifier" + ], + "members":{ + "description":{"shape":"DomainUnitDescription"}, + "domainIdentifier":{ + "shape":"DomainId", + "location":"uri", + "locationName":"domainIdentifier" + }, + "identifier":{ + "shape":"DomainUnitId", + "location":"uri", + "locationName":"identifier" + }, + "name":{"shape":"DomainUnitName"} + } + }, + "UpdateDomainUnitOutput":{ + "type":"structure", + "required":[ + "domainId", + "id", + "name", + "owners" + ], + "members":{ + "createdAt":{"shape":"CreatedAt"}, + "createdBy":{"shape":"CreatedBy"}, + "description":{"shape":"DomainUnitDescription"}, + "domainId":{"shape":"DomainId"}, + "id":{"shape":"DomainUnitId"}, + "lastUpdatedAt":{"shape":"UpdatedAt"}, + "lastUpdatedBy":{"shape":"UpdatedBy"}, + "name":{"shape":"DomainUnitName"}, + "owners":{"shape":"DomainUnitOwners"}, + "parentDomainUnitId":{"shape":"DomainUnitId"} + } + }, "UpdateEnvironmentActionInput":{ "type":"structure", "required":[ @@ -10760,6 +11710,7 @@ "createdBy":{"shape":"CreatedBy"}, "description":{"shape":"Description"}, "domainId":{"shape":"DomainId"}, + "domainUnitId":{"shape":"DomainUnitId"}, "failureReasons":{"shape":"FailureReasons"}, "glossaryTerms":{"shape":"GlossaryTerms"}, "id":{"shape":"ProjectId"}, @@ -11011,7 +11962,15 @@ }, "UserIdentifier":{ "type":"string", - "pattern":"(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)" + "pattern":"(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)" + }, + "UserPolicyGrantPrincipal":{ + "type":"structure", + "members":{ + "allUsersGrantFilter":{"shape":"AllUsersGrantFilter"}, + "userIdentifier":{"shape":"UserIdentifier"} + }, + "union":true }, "UserProfileDetails":{ "type":"structure", @@ -11023,7 +11982,7 @@ }, "UserProfileId":{ "type":"string", - "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + "pattern":"^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" }, "UserProfileName":{ "type":"string", diff --git a/apis/datazone/2018-05-10/docs-2.json b/apis/datazone/2018-05-10/docs-2.json index f8d25d4d187..0e16b745cfc 100644 --- a/apis/datazone/2018-05-10/docs-2.json +++ b/apis/datazone/2018-05-10/docs-2.json @@ -4,6 +4,8 @@ "operations": { "AcceptPredictions": "

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

", "AcceptSubscriptionRequest": "

Accepts a subscription request to a specific asset.

", + "AddEntityOwner": "

Adds the owner of an entity (a domain unit).

", + "AddPolicyGrant": "

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

", "AssociateEnvironmentRole": "

Associates the environment role in Amazon DataZone.

", "CancelMetadataGenerationRun": "

Cancels the metadata generation run.

", "CancelSubscription": "

Cancels the subscription to the specified asset.

", @@ -15,6 +17,7 @@ "CreateDataProductRevision": "

Creates a data product revision.

", "CreateDataSource": "

Creates an Amazon DataZone data source.

", "CreateDomain": "

Creates an Amazon DataZone domain.

", + "CreateDomainUnit": "

Creates a domain unit in Amazon DataZone.

", "CreateEnvironment": "

Create an Amazon DataZone environment.

", "CreateEnvironmentAction": "

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

", "CreateEnvironmentProfile": "

Creates an Amazon DataZone environment profile.

", @@ -35,6 +38,7 @@ "DeleteDataProduct": "

Deletes a data product in Amazon DataZone.

", "DeleteDataSource": "

Deletes a data source in Amazon DataZone.

", "DeleteDomain": "

Deletes a Amazon DataZone domain.

", + "DeleteDomainUnit": "

Deletes a domain unit.

", "DeleteEnvironment": "

Deletes an environment in Amazon DataZone.

", "DeleteEnvironmentAction": "

Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

", "DeleteEnvironmentBlueprintConfiguration": "

Deletes the blueprint configuration in Amazon DataZone.

", @@ -57,6 +61,7 @@ "GetDataSource": "

Gets an Amazon DataZone data source.

", "GetDataSourceRun": "

Gets an Amazon DataZone data source run.

", "GetDomain": "

Gets an Amazon DataZone domain.

", + "GetDomainUnit": "

Gets the details of the specified domain unit.

", "GetEnvironment": "

Gets an Amazon DataZone environment.

", "GetEnvironmentAction": "

Gets the specified environment action.

", "GetEnvironmentBlueprint": "

Gets an Amazon DataZone blueprint.

", @@ -84,7 +89,9 @@ "ListDataSourceRunActivities": "

Lists data source run activities.

", "ListDataSourceRuns": "

Lists data source runs in Amazon DataZone.

", "ListDataSources": "

Lists data sources in Amazon DataZone.

", + "ListDomainUnitsForParent": "

Lists child domain units for the specified parent domain unit.

", "ListDomains": "

Lists Amazon DataZone domains.

", + "ListEntityOwners": "

Lists the entity (domain units) owners.

", "ListEnvironmentActions": "

Lists existing environment actions.

", "ListEnvironmentBlueprintConfigurations": "

Lists blueprint configurations for a Amazon DataZone environment.

", "ListEnvironmentBlueprints": "

Lists blueprints in an Amazon DataZone environment.

", @@ -93,6 +100,7 @@ "ListLineageNodeHistory": "

Lists the history of the specified data lineage node.

", "ListMetadataGenerationRuns": "

Lists all metadata generation runs.

", "ListNotifications": "

Lists all Amazon DataZone notifications.

", + "ListPolicyGrants": "

Lists policy grants.

", "ListProjectMemberships": "

Lists all members of the specified project.

", "ListProjects": "

Lists Amazon DataZone projects.

", "ListSubscriptionGrants": "

Lists subscription grants.

", @@ -106,6 +114,8 @@ "PutEnvironmentBlueprintConfiguration": "

Writes the configuration for the specified environment blueprint in Amazon DataZone.

", "RejectPredictions": "

Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

", "RejectSubscriptionRequest": "

Rejects the specified subscription request.

", + "RemoveEntityOwner": "

Removes an owner from an entity.

", + "RemovePolicyGrant": "

Removes a policy grant.

", "RevokeSubscription": "

Revokes a specified subscription in Amazon DataZone.

", "Search": "

Searches for assets in Amazon DataZone.

", "SearchGroupProfiles": "

Searches group profiles in Amazon DataZone.

", @@ -119,6 +129,7 @@ "UpdateAssetFilter": "

Updates an asset filter.

", "UpdateDataSource": "

Updates the specified data source in Amazon DataZone.

", "UpdateDomain": "

Updates a Amazon DataZone domain.

", + "UpdateDomainUnit": "

Updates the domain unit.

", "UpdateEnvironment": "

Updates the specified environment in Amazon DataZone.

", "UpdateEnvironmentAction": "

Updates an environment action.

", "UpdateEnvironmentProfile": "

Updates the specified environment profile in Amazon DataZone.

", @@ -210,6 +221,44 @@ "UpdateEnvironmentActionOutput$parameters": "

The parameters of the environment action.

" } }, + "AddEntityOwnerInput": { + "base": null, + "refs": { + } + }, + "AddEntityOwnerOutput": { + "base": null, + "refs": { + } + }, + "AddPolicyGrantInput": { + "base": null, + "refs": { + } + }, + "AddPolicyGrantOutput": { + "base": null, + "refs": { + } + }, + "AddToProjectMemberPoolPolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "PolicyGrantDetail$addToProjectMemberPool": "

Specifies that the policy grant is to be added to the members of the project.

" + } + }, + "AllDomainUnitsGrantFilter": { + "base": "

The grant filter for all domain units.

", + "refs": { + "DomainUnitGrantFilter$allDomainUnitsGrantFilter": "

Specifies a grant filter containing all domain units.

" + } + }, + "AllUsersGrantFilter": { + "base": "

The all users grant filter.

", + "refs": { + "UserPolicyGrantPrincipal$allUsersGrantFilter": "

The all users grant filter of the user policy grant principal.

" + } + }, "ApplicableAssetTypes": { "base": null, "refs": { @@ -470,10 +519,16 @@ "Boolean": { "base": null, "refs": { + "AddToProjectMemberPoolPolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy grant is applied to child domain units.

", "BusinessNameGenerationConfiguration$enabled": "

Specifies whether the business name generation is enabled.

", "CancelSubscriptionOutput$retainPermissions": "

Specifies whether the permissions to the asset are retained after the subscription is cancelled.

", + "CreateAssetTypePolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy grant is applied to child domain units.

", "CreateDataSourceInput$publishOnImport": "

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

", "CreateDataSourceOutput$publishOnImport": "

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

", + "CreateDomainUnitPolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy grant is applied to child domain units.

", + "CreateFormTypePolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy grant is applied to child domain units.

", + "CreateGlossaryPolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy grant is applied to child domain units.

", + "CreateProjectPolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy grant is applied to child domain units.

", "CustomParameter$isEditable": "

Specifies whether the parameter is editable.

", "CustomParameter$isOptional": "

Specifies whether the custom parameter is optional.

", "DeleteDataSourceInput$retainPermissionsOnRevokeFailure": "

Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

", @@ -482,6 +537,7 @@ "DeleteDomainInput$skipDeletionCheck": "

Specifies the optional flag to delete all child entities within the domain.

", "DeleteProjectInput$skipDeletionCheck": "

Specifies the optional flag to delete all child entities within the project.

", "Deployment$isDeploymentComplete": "

Specifies whether the last deployment of the environment is complete.

", + "DomainUnitFilterForProject$includeChildDomainUnits": "

Specifies whether to include child domain units.

", "FormEntryInput$required": "

Specifies whether a form entry is required.

", "FormEntryOutput$required": "

Specifies whether a form entry is required.

", "GetDataSourceOutput$publishOnImport": "

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

", @@ -489,6 +545,8 @@ "GlueRunConfigurationInput$autoImportDataQualityResult": "

Specifies whether to automatically import data quality metrics as part of the data source run.

", "GlueRunConfigurationOutput$autoImportDataQualityResult": "

Specifies whether to automatically import data quality metrics as part of the data source run.

", "ListEnvironmentBlueprintsInput$managed": "

Specifies whether the environment blueprint is managed by Amazon DataZone.

", + "OverrideDomainUnitOwnersPolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy is inherited by child domain units.

", + "OverrideProjectOwnersPolicyGrantDetail$includeChildDomainUnits": "

Specifies whether the policy is inherited by child domain units.

", "RecommendationConfiguration$enableBusinessNameGeneration": "

Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

", "RevokeSubscriptionInput$retainPermissions": "

Specifies whether permissions are retained when the subscription is revoked.

", "RevokeSubscriptionOutput$retainPermissions": "

Specifies whether permissions are retained when the subscription is revoked.

", @@ -537,10 +595,13 @@ "base": null, "refs": { "AcceptPredictionsInput$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

", + "AddEntityOwnerInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", + "AddPolicyGrantInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "CreateAssetInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "CreateAssetRevisionInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "CreateDataProductInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "CreateDataProductRevisionInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", + "CreateDomainUnitInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "CreateGlossaryInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "CreateGlossaryTermInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "CreateListingChangeSetInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", @@ -548,6 +609,8 @@ "PostLineageEventInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "PostTimeSeriesDataPointsInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "RejectPredictionsInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", + "RemoveEntityOwnerInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", + "RemovePolicyGrantInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "StartMetadataGenerationRunInput$clientToken": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

", "UpdateGlossaryInput$clientToken": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

" } @@ -643,6 +706,12 @@ "refs": { } }, + "CreateAssetTypePolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "PolicyGrantDetail$createAssetType": "

Specifies that this is a create asset type policy.

" + } + }, "CreateDataProductInput": { "base": null, "refs": { @@ -683,6 +752,22 @@ "refs": { } }, + "CreateDomainUnitInput": { + "base": null, + "refs": { + } + }, + "CreateDomainUnitOutput": { + "base": null, + "refs": { + } + }, + "CreateDomainUnitPolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "PolicyGrantDetail$createDomainUnit": "

Specifies that this is a create domain unit policy.

" + } + }, "CreateEnvironmentActionInput": { "base": null, "refs": { @@ -713,6 +798,12 @@ "refs": { } }, + "CreateEnvironmentProfilePolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "PolicyGrantDetail$createEnvironmentProfile": "

Specifies that this is a create environment profile policy.

" + } + }, "CreateFormTypeInput": { "base": null, "refs": { @@ -723,6 +814,12 @@ "refs": { } }, + "CreateFormTypePolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "PolicyGrantDetail$createFormType": "

Specifies that this is a create form type policy.

" + } + }, "CreateGlossaryInput": { "base": null, "refs": { @@ -733,6 +830,12 @@ "refs": { } }, + "CreateGlossaryPolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "PolicyGrantDetail$createGlossary": "

Specifies that this is a create glossary policy.

" + } + }, "CreateGlossaryTermInput": { "base": null, "refs": { @@ -783,6 +886,12 @@ "refs": { } }, + "CreateProjectPolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "PolicyGrantDetail$createProject": "

Specifies that this is a create project policy.

" + } + }, "CreateSubscriptionGrantInput": { "base": null, "refs": { @@ -857,6 +966,7 @@ "CreateDataProductOutput$firstRevisionCreatedAt": "

The timestamp at which the first revision of the data product was created.

", "CreateDataProductRevisionOutput$createdAt": "

The timestamp at which the data product revision is created.

", "CreateDataProductRevisionOutput$firstRevisionCreatedAt": "

The timestamp at which the first revision of the data product is created.

", + "CreateDomainUnitOutput$createdAt": "

The timestamp at which the domain unit was created.

", "CreateSubscriptionGrantOutput$createdAt": "

A timestamp of when the subscription grant is created.

", "CreateSubscriptionRequestOutput$createdAt": "

A timestamp of when the subscription request is created.

", "CreateSubscriptionTargetOutput$createdAt": "

The timestamp of when the subscription target was created.

", @@ -875,6 +985,7 @@ "GetDataProductOutput$createdAt": "

The timestamp at which the data product is created.

", "GetDataProductOutput$firstRevisionCreatedAt": "

The timestamp at which the first revision of the data product is created.

", "GetDomainOutput$createdAt": "

The timestamp of when the Amazon DataZone domain was created.

", + "GetDomainUnitOutput$createdAt": "

The time stamp at which the domain unit was created.

", "GetFormTypeOutput$createdAt": "

The timestamp of when this metadata form type was created.

", "GetGlossaryOutput$createdAt": "

The timestamp of when this business glossary was created.

", "GetGlossaryTermOutput$createdAt": "

The timestamp of when the business glossary term was created.

", @@ -890,6 +1001,7 @@ "LineageNodeSummary$createdAt": "

The timestamp at which the data lineage node was created.

", "LineageNodeTypeItem$createdAt": "

The timestamp at which the data lineage node type was created.

", "MetadataGenerationRunItem$createdAt": "

The timestamp at which the metadata generation run was created.

", + "PolicyGrantMember$createdAt": "

Specifies the timestamp at which policy grant member was created.

", "RejectSubscriptionRequestOutput$createdAt": "

The timestamp of when the subscription request was rejected.

", "RevokeSubscriptionOutput$createdAt": "

The timestamp of when the subscription was revoked.

", "StartMetadataGenerationRunOutput$createdAt": "

The timestamp at which the metadata generation run was started.

", @@ -898,6 +1010,7 @@ "SubscriptionSummary$createdAt": "

The timestamp of when the subscription was created.

", "SubscriptionTargetSummary$createdAt": "

The timestamp of when the subscription target was created.

", "UpdateAssetFilterOutput$createdAt": "

The timestamp at which the asset filter was created.

", + "UpdateDomainUnitOutput$createdAt": "

The time stamp at which the domain unit that you want to update was created.

", "UpdateSubscriptionGrantStatusOutput$createdAt": "

The timestamp of when the subscription grant status was created.

", "UpdateSubscriptionRequestOutput$createdAt": "

The timestamp of when the subscription request was created.

", "UpdateSubscriptionTargetOutput$createdAt": "

The timestamp of when a subscription target was created.

" @@ -922,6 +1035,7 @@ "CreateDataProductOutput$firstRevisionCreatedBy": "

The user who created the first revision of the data product.

", "CreateDataProductRevisionOutput$createdBy": "

The user who created the data product revision.

", "CreateDataProductRevisionOutput$firstRevisionCreatedBy": "

The user who created the first revision of the data product.

", + "CreateDomainUnitOutput$createdBy": "

The user who created the domain unit.

", "CreateProjectOutput$createdBy": "

The Amazon DataZone user who created the project.

", "CreateSubscriptionGrantOutput$createdBy": "

The Amazon DataZone user who created the subscription grant.

", "CreateSubscriptionRequestOutput$createdBy": "

The Amazon DataZone user who created the subscription request.

", @@ -937,6 +1051,7 @@ "GetAssetTypeOutput$createdBy": "

The Amazon DataZone user who created the asset type.

", "GetDataProductOutput$createdBy": "

The user who created the data product.

", "GetDataProductOutput$firstRevisionCreatedBy": "

The user who created the first revision of the data product.

", + "GetDomainUnitOutput$createdBy": "

The user who created the domain unit.

", "GetFormTypeOutput$createdBy": "

The Amazon DataZone user who created this metadata form type.

", "GetGlossaryOutput$createdBy": "

The Amazon DataZone user who created this business glossary.

", "GetGlossaryTermOutput$createdBy": "

The Amazon DataZone user who created the business glossary.

", @@ -953,6 +1068,7 @@ "LineageNodeSummary$createdBy": "

The user who created the data lineage node.

", "LineageNodeTypeItem$createdBy": "

The user who created the data lineage node type.

", "MetadataGenerationRunItem$createdBy": "

The user who created the metadata generation run.

", + "PolicyGrantMember$createdBy": "

Specifies the user who created the policy grant member.

", "ProjectSummary$createdBy": "

The Amazon DataZone user who created the project.

", "RejectSubscriptionRequestOutput$createdBy": "

The timestamp of when the subscription request was rejected.

", "RevokeSubscriptionOutput$createdBy": "

The identifier of the user who revoked the subscription.

", @@ -961,6 +1077,7 @@ "SubscriptionRequestSummary$createdBy": "

The Amazon DataZone user who created the subscription request.

", "SubscriptionSummary$createdBy": "

The Amazon DataZone user who created the subscription.

", "SubscriptionTargetSummary$createdBy": "

The Amazon DataZone user who created the subscription target.

", + "UpdateDomainUnitOutput$createdBy": "

The user who created the domain unit that you want to update.

", "UpdateProjectOutput$createdBy": "

The Amazon DataZone user who created the project.

", "UpdateSubscriptionGrantStatusOutput$createdBy": "

The Amazon DataZone domain user who created the subscription grant status.

", "UpdateSubscriptionRequestOutput$createdBy": "

The Amazon DataZone user who created the subscription request.

", @@ -1265,6 +1382,14 @@ "UpdateDataSourceOutput$type": "

The type to be updated as part of the UpdateDataSource action.

" } }, + "DataZoneEntityType": { + "base": null, + "refs": { + "AddEntityOwnerInput$entityType": "

The type of an entity.

", + "ListEntityOwnersInput$entityType": "

The type of the entity that you want to list.

", + "RemoveEntityOwnerInput$entityType": "

The type of the entity from which you want to remove an owner.

" + } + }, "DateTime": { "base": null, "refs": { @@ -1367,6 +1492,16 @@ "refs": { } }, + "DeleteDomainUnitInput": { + "base": null, + "refs": { + } + }, + "DeleteDomainUnitOutput": { + "base": null, + "refs": { + } + }, "DeleteEnvironmentActionInput": { "base": null, "refs": { @@ -1631,6 +1766,8 @@ "AcceptPredictionsOutput$domainId": "

The identifier of the Amazon DataZone domain.

", "AcceptSubscriptionRequestInput$domainIdentifier": "

The Amazon DataZone domain where the specified subscription request is being accepted.

", "AcceptSubscriptionRequestOutput$domainId": "

The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.

", + "AddEntityOwnerInput$domainIdentifier": "

The ID of the domain in which you want to add the entity owner.

", + "AddPolicyGrantInput$domainIdentifier": "

The ID of the domain where you want to add a policy grant.

", "AssetFilterSummary$domainId": "

The ID of the domain where the asset filter lives.

", "AssetItem$domainId": "

The identifier of the Amazon DataZone domain in which the inventory asset exists.

", "AssetRevision$domainId": "

The Amazon DataZone user who created the inventory asset.

", @@ -1656,6 +1793,8 @@ "CreateDataSourceInput$domainIdentifier": "

The ID of the Amazon DataZone domain where the data source is created.

", "CreateDataSourceOutput$domainId": "

The ID of the Amazon DataZone domain in which the data source is created.

", "CreateDomainOutput$id": "

The identifier of the Amazon DataZone domain.

", + "CreateDomainUnitInput$domainIdentifier": "

The ID of the domain where you want to crate a domain unit.

", + "CreateDomainUnitOutput$domainId": "

The ID of the domain where the domain unit was created.

", "CreateEnvironmentActionInput$domainIdentifier": "

The ID of the Amazon DataZone domain in which the environment action is created.

", "CreateEnvironmentActionOutput$domainId": "

The ID of the domain in which the environment action is created.

", "CreateEnvironmentInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which the environment is created.

", @@ -1693,6 +1832,7 @@ "DeleteDataSourceInput$domainIdentifier": "

The ID of the Amazon DataZone domain in which the data source is deleted.

", "DeleteDataSourceOutput$domainId": "

The ID of the Amazon DataZone domain in which the data source is deleted.

", "DeleteDomainInput$identifier": "

The identifier of the Amazon Web Services domain that is to be deleted.

", + "DeleteDomainUnitInput$domainIdentifier": "

The ID of the domain where you want to delete a domain unit.

", "DeleteEnvironmentActionInput$domainIdentifier": "

The ID of the Amazon DataZone domain in which an environment action is deleted.

", "DeleteEnvironmentBlueprintConfigurationInput$domainIdentifier": "

The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.

", "DeleteEnvironmentInput$domainIdentifier": "

The ID of the Amazon DataZone domain in which the environment is deleted.

", @@ -1731,6 +1871,8 @@ "GetDataSourceRunOutput$domainId": "

The ID of the domain in which this data source run was performed.

", "GetDomainInput$identifier": "

The identifier of the specified Amazon DataZone domain.

", "GetDomainOutput$id": "

The identifier of the specified Amazon DataZone domain.

", + "GetDomainUnitInput$domainIdentifier": "

The ID of the domain where you want to get a domain unit.

", + "GetDomainUnitOutput$domainId": "

The ID of the domain in which the domain unit lives.

", "GetEnvironmentActionInput$domainIdentifier": "

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is invoked.

", "GetEnvironmentActionOutput$domainId": "

The ID of the Amazon DataZone domain in which the environment action lives.

", "GetEnvironmentBlueprintConfigurationInput$domainIdentifier": "

The ID of the Amazon DataZone domain where this blueprint exists.

", @@ -1782,6 +1924,8 @@ "ListDataSourceRunActivitiesInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which to list data source run activities.

", "ListDataSourceRunsInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

", "ListDataSourcesInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which to list the data sources.

", + "ListDomainUnitsForParentInput$domainIdentifier": "

The ID of the domain in which you want to list domain units for a parent domain unit.

", + "ListEntityOwnersInput$domainIdentifier": "

The ID of the domain where you want to list entity owners.

", "ListEnvironmentActionsInput$domainIdentifier": "

The ID of the Amazon DataZone domain in which the environment actions are listed.

", "ListEnvironmentBlueprintConfigurationsInput$domainIdentifier": "

The identifier of the Amazon DataZone domain.

", "ListEnvironmentBlueprintsInput$domainIdentifier": "

The identifier of the Amazon DataZone domain.

", @@ -1790,6 +1934,7 @@ "ListLineageNodeHistoryInput$domainIdentifier": "

The ID of the domain where you want to list the history of the specified data lineage node.

", "ListMetadataGenerationRunsInput$domainIdentifier": "

The ID of the Amazon DataZone domain where you want to list metadata generation runs.

", "ListNotificationsInput$domainIdentifier": "

The identifier of the Amazon DataZone domain.

", + "ListPolicyGrantsInput$domainIdentifier": "

The ID of the domain where you want to list policy grants.

", "ListProjectMembershipsInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which you want to list project memberships.

", "ListProjectsInput$domainIdentifier": "

The identifier of the Amazon DataZone domain.

", "ListSubscriptionGrantsInput$domainIdentifier": "

The identifier of the Amazon DataZone domain.

", @@ -1809,6 +1954,8 @@ "RejectPredictionsOutput$domainId": "

The ID of the Amazon DataZone domain.

", "RejectSubscriptionRequestInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

", "RejectSubscriptionRequestOutput$domainId": "

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

", + "RemoveEntityOwnerInput$domainIdentifier": "

The ID of the domain where you want to remove an owner from an entity.

", + "RemovePolicyGrantInput$domainIdentifier": "

The ID of the domain where you want to remove a policy grant.

", "RevokeSubscriptionInput$domainIdentifier": "

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

", "RevokeSubscriptionOutput$domainId": "

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

", "SearchGroupProfilesInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which you want to search group profiles.

", @@ -1830,6 +1977,8 @@ "UpdateDataSourceOutput$domainId": "

The identifier of the Amazon DataZone domain in which a data source is to be updated.

", "UpdateDomainInput$identifier": "

The ID of the Amazon Web Services domain that is to be updated.

", "UpdateDomainOutput$id": "

The identifier of the Amazon DataZone domain.

", + "UpdateDomainUnitInput$domainIdentifier": "

The ID of the domain where you want to update a domain unit.

", + "UpdateDomainUnitOutput$domainId": "

The ID of the domain where you want to update the domain unit.

", "UpdateEnvironmentActionInput$domainIdentifier": "

The domain ID of the environment action.

", "UpdateEnvironmentActionOutput$domainId": "

The domain ID of the environment action.

", "UpdateEnvironmentInput$domainIdentifier": "

The identifier of the domain in which the environment is to be updated.

", @@ -1842,7 +1991,7 @@ "UpdateGlossaryTermOutput$domainId": "

The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

", "UpdateGroupProfileInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which a group profile is updated.

", "UpdateGroupProfileOutput$domainId": "

The identifier of the Amazon DataZone domain in which a group profile is updated.

", - "UpdateProjectInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which a project is to be updated.

", + "UpdateProjectInput$domainIdentifier": "

The ID of the Amazon DataZone domain where a project is being updated.

", "UpdateProjectOutput$domainId": "

The identifier of the Amazon DataZone domain in which a project is updated.

", "UpdateSubscriptionGrantStatusInput$domainIdentifier": "

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

", "UpdateSubscriptionGrantStatusOutput$domainId": "

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

", @@ -1883,6 +2032,123 @@ "DomainSummaries$member": null } }, + "DomainUnitDescription": { + "base": null, + "refs": { + "CreateDomainUnitInput$description": "

The description of the domain unit.

", + "CreateDomainUnitOutput$description": "

The description of the domain unit.

", + "GetDomainUnitOutput$description": "

The description of the domain unit.

", + "UpdateDomainUnitInput$description": "

The description of the domain unit that you want to update.

", + "UpdateDomainUnitOutput$description": "

The description of the domain unit that you want to update.

" + } + }, + "DomainUnitDesignation": { + "base": null, + "refs": { + "DomainUnitPolicyGrantPrincipal$domainUnitDesignation": "

Specifes the designation of the domain unit users.

" + } + }, + "DomainUnitFilterForProject": { + "base": "

The domain unit filter of the project grant filter.

", + "refs": { + "ProjectGrantFilter$domainUnitFilter": "

The domain unit filter of the project grant filter.

" + } + }, + "DomainUnitGrantFilter": { + "base": "

The grant filter for the domain unit. In the current release of Amazon DataZone, the only supported filter is the allDomainUnitsGrantFilter.

", + "refs": { + "DomainUnitPolicyGrantPrincipal$domainUnitGrantFilter": "

The grant filter for the domain unit.

" + } + }, + "DomainUnitGroupProperties": { + "base": "

The properties of a domain unit group.

", + "refs": { + "DomainUnitOwnerProperties$group": "

Indicates that the domain unit owner is a group.

" + } + }, + "DomainUnitId": { + "base": null, + "refs": { + "CreateDomainOutput$rootDomainUnitId": "

The ID of the root domain unit.

", + "CreateDomainUnitInput$parentDomainUnitIdentifier": "

The ID of the parent domain unit.

", + "CreateDomainUnitOutput$id": "

The ID of the domain unit.

", + "CreateDomainUnitOutput$parentDomainUnitId": "

The ID of the parent domain unit.

", + "CreateEnvironmentProfilePolicyGrantDetail$domainUnitId": "

The ID of the domain unit.

", + "CreateProjectInput$domainUnitId": "

The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

", + "CreateProjectOutput$domainUnitId": "

The ID of the domain unit.

", + "DeleteDomainUnitInput$identifier": "

The ID of the domain unit that you want to delete.

", + "DomainUnitFilterForProject$domainUnit": "

The domain unit ID to use in the filter.

", + "DomainUnitIds$member": null, + "DomainUnitPolicyGrantPrincipal$domainUnitIdentifier": "

The ID of the domain unit.

", + "DomainUnitSummary$id": "

The ID of the domain unit summary.

", + "GetDomainOutput$rootDomainUnitId": "

The ID of the root domain in Amazon Datazone.

", + "GetDomainUnitInput$identifier": "

The identifier of the domain unit that you want to get.

", + "GetDomainUnitOutput$id": "

The ID of the domain unit.

", + "GetDomainUnitOutput$parentDomainUnitId": "

The ID of the parent domain unit.

", + "GetProjectOutput$domainUnitId": "

The ID of the domain unit.

", + "ListDomainUnitsForParentInput$parentDomainUnitIdentifier": "

The ID of the parent domain unit.

", + "ProjectSummary$domainUnitId": "

The ID of the domain unit.

", + "UpdateDomainOutput$rootDomainUnitId": "

The ID of the root domain unit.

", + "UpdateDomainUnitInput$identifier": "

The ID of the domain unit that you want to update.

", + "UpdateDomainUnitOutput$id": "

The ID of the domain unit that you want to update.

", + "UpdateDomainUnitOutput$parentDomainUnitId": "

The ID of the parent domain unit.

", + "UpdateProjectOutput$domainUnitId": "

The ID of the domain unit.

" + } + }, + "DomainUnitIds": { + "base": null, + "refs": { + "CreateDomainUnitOutput$ancestorDomainUnitIds": "

The IDs of the ancestor domain units.

" + } + }, + "DomainUnitName": { + "base": null, + "refs": { + "CreateDomainUnitInput$name": "

The name of the domain unit.

", + "CreateDomainUnitOutput$name": "

The name of the domain unit.

", + "GetDomainUnitOutput$name": "

The name of the domain unit.

", + "UpdateDomainUnitInput$name": "

The name of the domain unit that you want to update.

", + "UpdateDomainUnitOutput$name": "

The name of the domain unit that you want to update.

" + } + }, + "DomainUnitOwnerProperties": { + "base": "

The properties of the domain unit owner.

", + "refs": { + "DomainUnitOwners$member": null + } + }, + "DomainUnitOwners": { + "base": null, + "refs": { + "CreateDomainUnitOutput$owners": "

The owners of the domain unit.

", + "GetDomainUnitOutput$owners": "

The owners of the domain unit.

", + "UpdateDomainUnitOutput$owners": "

The owners of the domain unit that you want to update.

" + } + }, + "DomainUnitPolicyGrantPrincipal": { + "base": "

The domain unit principal to whom the policy is granted.

", + "refs": { + "PolicyGrantPrincipal$domainUnit": "

The domain unit of the policy grant principal.

" + } + }, + "DomainUnitSummaries": { + "base": null, + "refs": { + "ListDomainUnitsForParentOutput$items": "

The results returned by this action.

" + } + }, + "DomainUnitSummary": { + "base": "

The summary of the domain unit.

", + "refs": { + "DomainUnitSummaries$member": null + } + }, + "DomainUnitUserProperties": { + "base": "

The properties of the domain unit user.

", + "refs": { + "DomainUnitOwnerProperties$user": "

Indicates that the domain unit owner is a user.

" + } + }, "EdgeDirection": { "base": null, "refs": { @@ -1934,6 +2200,12 @@ "PostTimeSeriesDataPointsInput$entityIdentifier": "

The ID of the asset for which you want to post time series data points.

" } }, + "EntityOwners": { + "base": null, + "refs": { + "ListEntityOwnersOutput$owners": "

The owners of the entity.

" + } + }, "EntityType": { "base": null, "refs": { @@ -2499,6 +2771,16 @@ "refs": { } }, + "GetDomainUnitInput": { + "base": null, + "refs": { + } + }, + "GetDomainUnitOutput": { + "base": null, + "refs": { + } + }, "GetEnvironmentActionInput": { "base": null, "refs": { @@ -2932,9 +3214,17 @@ "refs": { "CreateGroupProfileInput$groupIdentifier": "

The identifier of the group for which the group profile is created.

", "GetGroupProfileInput$groupIdentifier": "

The identifier of the group profile.

", + "GroupPolicyGrantPrincipal$groupIdentifier": "

The ID Of the group of the group principal.

", + "OwnerGroupProperties$groupIdentifier": "

The ID of the domain unit owners group.

", "UpdateGroupProfileInput$groupIdentifier": "

The identifier of the group profile that is updated.

" } }, + "GroupPolicyGrantPrincipal": { + "base": "

The group principal to whom the policy is granted.

", + "refs": { + "PolicyGrantPrincipal$group": "

The group of the policy grant principal.

" + } + }, "GroupProfileId": { "base": null, "refs": { @@ -3208,6 +3498,16 @@ "refs": { } }, + "ListDomainUnitsForParentInput": { + "base": null, + "refs": { + } + }, + "ListDomainUnitsForParentOutput": { + "base": null, + "refs": { + } + }, "ListDomainsInput": { "base": null, "refs": { @@ -3218,6 +3518,16 @@ "refs": { } }, + "ListEntityOwnersInput": { + "base": null, + "refs": { + } + }, + "ListEntityOwnersOutput": { + "base": null, + "refs": { + } + }, "ListEnvironmentActionSummaries": { "base": null, "refs": { @@ -3304,6 +3614,16 @@ "refs": { } }, + "ListPolicyGrantsInput": { + "base": null, + "refs": { + } + }, + "ListPolicyGrantsOutput": { + "base": null, + "refs": { + } + }, "ListProjectMembershipsInput": { "base": null, "refs": { @@ -3473,6 +3793,14 @@ "UpdateGlossaryTermOutput$longDescription": "

The long description to be updated as part of the UpdateGlossaryTerm action.

" } }, + "ManagedPolicyType": { + "base": null, + "refs": { + "AddPolicyGrantInput$policyType": "

The type of policy that you want to grant.

", + "ListPolicyGrantsInput$policyType": "

The type of policy that you want to list.

", + "RemovePolicyGrantInput$policyType": "

The type of the policy that you want to remove.

" + } + }, "MaxResults": { "base": null, "refs": { @@ -3507,7 +3835,10 @@ "MaxResultsForListDomains": { "base": null, "refs": { - "ListDomainsInput$maxResults": "

The maximum number of domains to return in a single call to ListDomains. When the number of domains to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomains to list the next set of domains.

" + "ListDomainUnitsForParentInput$maxResults": "

The maximum number of domain units to return in a single call to ListDomainUnitsForParent. When the number of domain units to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

", + "ListDomainsInput$maxResults": "

The maximum number of domains to return in a single call to ListDomains. When the number of domains to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomains to list the next set of domains.

", + "ListEntityOwnersInput$maxResults": "

The maximum number of entities to return in a single call to ListEntityOwners. When the number of entities to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEntityOwners to list the next set of entities.

", + "ListPolicyGrantsInput$maxResults": "

The maximum number of grants to return in a single call to ListPolicyGrants. When the number of grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListPolicyGrants to list the next set of grants.

" } }, "Member": { @@ -3674,6 +4005,55 @@ "ListNotificationsOutput$notifications": "

The results of the ListNotifications action.

" } }, + "OverrideDomainUnitOwnersPolicyGrantDetail": { + "base": "

The grant details of the override domain unit owners policy.

", + "refs": { + "PolicyGrantDetail$overrideDomainUnitOwners": "

Specifies whether to override domain unit owners.

" + } + }, + "OverrideProjectOwnersPolicyGrantDetail": { + "base": "

The details of the override project owners policy grant.

", + "refs": { + "PolicyGrantDetail$overrideProjectOwners": "

Specifies whether to override project owners.

" + } + }, + "OwnerGroupProperties": { + "base": "

The properties of the domain unit owners group.

", + "refs": { + "OwnerProperties$group": "

Specifies that the domain unit owner is a group.

" + } + }, + "OwnerGroupPropertiesOutput": { + "base": "

The properties of the domain unit owners group.

", + "refs": { + "OwnerPropertiesOutput$group": "

Specifies that the domain unit owner is a group.

" + } + }, + "OwnerProperties": { + "base": "

The properties of a domain unit's owner.

", + "refs": { + "AddEntityOwnerInput$owner": "

The owner that you want to add to the entity.

", + "RemoveEntityOwnerInput$owner": "

The owner that you want to remove from an entity.

" + } + }, + "OwnerPropertiesOutput": { + "base": "

The ID of the domain unit owners group.

", + "refs": { + "EntityOwners$member": null + } + }, + "OwnerUserProperties": { + "base": "

The properties of the owner user.

", + "refs": { + "OwnerProperties$user": "

Specifies that the domain unit owner is a user.

" + } + }, + "OwnerUserPropertiesOutput": { + "base": "

The properties of the owner user.

", + "refs": { + "OwnerPropertiesOutput$user": "

Specifies that the domain unit owner is a user.

" + } + }, "PaginationToken": { "base": null, "refs": { @@ -3689,8 +4069,12 @@ "ListDataSourceRunsOutput$nextToken": "

When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

", "ListDataSourcesInput$nextToken": "

When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

", "ListDataSourcesOutput$nextToken": "

When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

", + "ListDomainUnitsForParentInput$nextToken": "

When the number of domain units is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

", + "ListDomainUnitsForParentOutput$nextToken": "

When the number of domain units is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

", "ListDomainsInput$nextToken": "

When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

", "ListDomainsOutput$nextToken": "

When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

", + "ListEntityOwnersInput$nextToken": "

When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

", + "ListEntityOwnersOutput$nextToken": "

When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

", "ListEnvironmentActionsInput$nextToken": "

When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

", "ListEnvironmentActionsOutput$nextToken": "

When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

", "ListEnvironmentBlueprintConfigurationsInput$nextToken": "

When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

", @@ -3707,6 +4091,8 @@ "ListMetadataGenerationRunsOutput$nextToken": "

When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

", "ListNotificationsInput$nextToken": "

When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

", "ListNotificationsOutput$nextToken": "

When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

", + "ListPolicyGrantsInput$nextToken": "

When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

", + "ListPolicyGrantsOutput$nextToken": "

When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

", "ListProjectMembershipsInput$nextToken": "

When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

", "ListProjectMembershipsOutput$nextToken": "

When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

", "ListProjectsInput$nextToken": "

When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

", @@ -3733,6 +4119,33 @@ "SearchUserProfilesOutput$nextToken": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

" } }, + "PolicyGrantDetail": { + "base": "

The details of the policy grant.

", + "refs": { + "AddPolicyGrantInput$detail": "

The details of the policy grant.

", + "PolicyGrantMember$detail": "

The details of the policy grant member.

" + } + }, + "PolicyGrantList": { + "base": null, + "refs": { + "ListPolicyGrantsOutput$grantList": "

The results of this action - the listed grants.

" + } + }, + "PolicyGrantMember": { + "base": "

A member of the policy grant list.

", + "refs": { + "PolicyGrantList$member": null + } + }, + "PolicyGrantPrincipal": { + "base": "

The policy grant principal.

", + "refs": { + "AddPolicyGrantInput$principal": "

The principal to whom the permissions are granted.

", + "PolicyGrantMember$principal": "

The principal of the policy grant member.

", + "RemovePolicyGrantInput$principal": "

The principal from which you want to remove a policy grant.

" + } + }, "PostLineageEventInput": { "base": null, "refs": { @@ -3774,6 +4187,18 @@ "FailureReasons$member": null } }, + "ProjectDesignation": { + "base": null, + "refs": { + "ProjectPolicyGrantPrincipal$projectDesignation": "

The project designation of the project policy grant principal.

" + } + }, + "ProjectGrantFilter": { + "base": "

The project grant filter.

", + "refs": { + "ProjectPolicyGrantPrincipal$projectGrantFilter": "

The project grant filter of the project policy grant principal.

" + } + }, "ProjectId": { "base": null, "refs": { @@ -3841,6 +4266,7 @@ "ListSubscriptionsInput$approverProjectId": "

The identifier of the project for the subscription's approver.

", "ListSubscriptionsInput$owningProjectId": "

The identifier of the owning project.

", "MetadataGenerationRunItem$owningProjectId": "

The ID of the project that owns the asset for which the metadata generation was ran.

", + "ProjectPolicyGrantPrincipal$projectIdentifier": "

The project ID of the project policy grant principal.

", "ProjectSummary$id": "

The identifier of a project.

", "SearchInput$owningProjectIdentifier": "

The identifier of the owning project specified for the search.

", "StartDataSourceRunOutput$projectId": "

The identifier of the project.

", @@ -3884,6 +4310,12 @@ "UpdateProjectOutput$name": "

The name of the project that is to be updated.

" } }, + "ProjectPolicyGrantPrincipal": { + "base": "

The project policy grant principal.

", + "refs": { + "PolicyGrantPrincipal$project": "

The project of the policy grant principal.

" + } + }, "ProjectStatus": { "base": null, "refs": { @@ -4141,6 +4573,26 @@ "RedshiftRunConfigurationOutput$relationalFilterConfigurations": "

The relational filger configurations included in the configuration details of the Amazon Redshift data source.

" } }, + "RemoveEntityOwnerInput": { + "base": null, + "refs": { + } + }, + "RemoveEntityOwnerOutput": { + "base": null, + "refs": { + } + }, + "RemovePolicyGrantInput": { + "base": null, + "refs": { + } + }, + "RemovePolicyGrantOutput": { + "base": null, + "refs": { + } + }, "RequestReason": { "base": null, "refs": { @@ -4582,6 +5034,8 @@ "refs": { "AcceptChoice$predictionTarget": "

Specifies the target (for example, a column name) where a prediction can be accepted.

", "AcceptSubscriptionRequestOutput$reviewerId": "

Specifes the ID of the Amazon DataZone user who reviewed the subscription request.

", + "AddEntityOwnerInput$entityIdentifier": "

The ID of the entity to which you want to add an owner.

", + "AddPolicyGrantInput$entityIdentifier": "

The ID of the entity (resource) to which you want to add a policy grant.

", "AssetFilterSummary$effectiveRowFilter": "

The effective row filter of the asset filter.

", "AssetFilterSummary$errorMessage": "

The error message that is displayed if the action does not succeed.

", "AssetInDataProductListingItem$entityId": "

The entity ID of the listing of the asset in a data product.

", @@ -4645,6 +5099,9 @@ "DomainSummary$arn": "

The ARN of the Amazon DataZone domain.

", "DomainSummary$managedAccountId": "

The identifier of the Amazon Web Services account that manages the domain.

", "DomainSummary$portalUrl": "

The data portal URL for the Amazon DataZone domain.

", + "DomainUnitGroupProperties$groupId": "

The ID of the domain unit group.

", + "DomainUnitSummary$name": "

The name of the domain unit summary.

", + "DomainUnitUserProperties$userId": "

The ID of teh domain unit user.

", "EnvironmentActionSummary$description": "

The environment action description.

", "EnvironmentActionSummary$name": "

The name of the environment action.

", "EnvironmentBlueprintSummary$provider": "

The provider of the blueprint.

", @@ -4709,8 +5166,10 @@ "LineageNodeTypeItem$name": "

The name of the data lineage node type.

", "ListDataSourcesInput$environmentIdentifier": "

The identifier of the environment in which to list the data sources.

", "ListDataSourcesInput$projectIdentifier": "

The identifier of the project in which to list data sources.

", + "ListEntityOwnersInput$entityIdentifier": "

The ID of the entity that you want to list.

", "ListEnvironmentsInput$name": "

The name of the environment.

", "ListEnvironmentsInput$provider": "

The provider of the environment.

", + "ListPolicyGrantsInput$entityIdentifier": "

The ID of the entity for which you want to list policy grants.

", "ListProjectsInput$groupIdentifier": "

The identifier of a group.

", "ListProjectsInput$userIdentifier": "

The identifier of the Amazon DataZone user.

", "ListTagsForResourceRequest$resourceArn": "

The ARN of the resource whose tags you want to list.

", @@ -4727,12 +5186,16 @@ "NotificationResource$id": "

The ID of the resource mentioned in a notification.

", "NotificationResource$name": "

The name of the resource mentioned in a notification.

", "NotificationSubjects$member": null, + "OwnerGroupPropertiesOutput$groupId": "

The ID of the domain unit owners group.

", + "OwnerUserPropertiesOutput$userId": "

The ID of the owner user.

", "ProjectDeletionError$code": "

The code of the project deletion error.

", "ProjectDeletionError$message": "

The message of the project deletion error.

", "RegionalParameter$key": null, "RegionalParameter$value": null, "RejectChoice$predictionTarget": "

Specifies the target (for example, a column name) where a prediction can be rejected.

", "RejectSubscriptionRequestOutput$reviewerId": "

The identifier of the subscription request reviewer.

", + "RemoveEntityOwnerInput$entityIdentifier": "

The ID of the entity from which you want to remove an owner.

", + "RemovePolicyGrantInput$entityIdentifier": "

The ID of the entity from which you want to remove a policy grant.

", "Resource$name": "

The name of a provisioned resource of this Amazon DataZone environment.

", "Resource$provider": "

The provider of a provisioned resource of this Amazon DataZone environment.

", "Resource$type": "

The type of a provisioned resource of this Amazon DataZone environment.

", @@ -5167,6 +5630,14 @@ "TagResourceRequest$tags": "

Specifies the tags for the TagResource action.

" } }, + "TargetEntityType": { + "base": null, + "refs": { + "AddPolicyGrantInput$entityType": "

The type of entity (resource) to which the grant is added.

", + "ListPolicyGrantsInput$entityType": "

The type of entity for which you want to list policy grants.

", + "RemovePolicyGrantInput$entityType": "

The type of the entity from which you want to remove a policy grant.

" + } + }, "TaskId": { "base": null, "refs": { @@ -5362,6 +5833,13 @@ "refs": { } }, + "Unit": { + "base": "

The details of the policy of creating an environment.

", + "refs": { + "PolicyGrantDetail$createEnvironment": "

Specifies that this is a create environment policy.

", + "PolicyGrantDetail$delegateCreateEnvironmentProfile": "

Specifies that this is the delegation of the create environment profile policy.

" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -5402,6 +5880,16 @@ "refs": { } }, + "UpdateDomainUnitInput": { + "base": null, + "refs": { + } + }, + "UpdateDomainUnitOutput": { + "base": null, + "refs": { + } + }, "UpdateEnvironmentActionInput": { "base": null, "refs": { @@ -5538,6 +6026,7 @@ "DomainSummary$lastUpdatedAt": "

A timestamp of when a Amazon DataZone domain was last updated.

", "GetAssetTypeOutput$updatedAt": "

The timestamp of when the asset type was updated.

", "GetDomainOutput$lastUpdatedAt": "

The timestamp of when the Amazon DataZone domain was last updated.

", + "GetDomainUnitOutput$lastUpdatedAt": "

The timestamp at which the domain unit was last updated.

", "GetGlossaryOutput$updatedAt": "

The timestamp of when the business glossary was updated.

", "GetGlossaryTermOutput$updatedAt": "

The timestamp of when the business glossary term was updated.

", "GetLineageNodeOutput$updatedAt": "

The timestamp at which the data lineage node was updated.

", @@ -5557,6 +6046,7 @@ "SubscriptionSummary$updatedAt": "

The timestamp of when the subscription was updated.

", "SubscriptionTargetSummary$updatedAt": "

The timestamp of when the subscription target was updated.

", "UpdateDomainOutput$lastUpdatedAt": "

Specifies the timestamp of when the domain was last updated.

", + "UpdateDomainUnitOutput$lastUpdatedAt": "

The timestamp at which the domain unit was last updated.

", "UpdateSubscriptionGrantStatusOutput$updatedAt": "

The timestamp of when the subscription grant status is to be updated.

", "UpdateSubscriptionRequestOutput$updatedAt": "

The timestamp of when the subscription request was updated.

", "UpdateSubscriptionTargetOutput$updatedAt": "

The timestamp of when the subscription target was updated.

" @@ -5576,6 +6066,7 @@ "DataProductListingItem$listingUpdatedBy": "

The user who updated the listing.

", "DeleteSubscriptionGrantOutput$updatedBy": "

The Amazon DataZone user who updated the subscription grant that is deleted.

", "GetAssetTypeOutput$updatedBy": "

The Amazon DataZone user that updated the asset type.

", + "GetDomainUnitOutput$lastUpdatedBy": "

The user who last updated the domain unit.

", "GetGlossaryOutput$updatedBy": "

The Amazon DataZone user who updated the business glossary.

", "GetGlossaryTermOutput$updatedBy": "

The Amazon DataZone user who updated the business glossary term.

", "GetLineageNodeOutput$updatedBy": "

The user who updated the data lineage node.

", @@ -5594,6 +6085,7 @@ "SubscriptionRequestSummary$updatedBy": "

The identifier of the Amazon DataZone user who updated the subscription request.

", "SubscriptionSummary$updatedBy": "

The Amazon DataZone user who updated the subscription.

", "SubscriptionTargetSummary$updatedBy": "

The Amazon DataZone user who updated the subscription target.

", + "UpdateDomainUnitOutput$lastUpdatedBy": "

The user who last updated the domain unit.

", "UpdateSubscriptionGrantStatusOutput$updatedBy": "

The Amazon DataZone user who updated the subscription grant status.

", "UpdateSubscriptionRequestOutput$updatedBy": "

The Amazon DataZone user who updated the subscription request.

", "UpdateSubscriptionTargetOutput$updatedBy": "

The Amazon DataZone user who updated the subscription target.

" @@ -5623,7 +6115,15 @@ "refs": { "CreateUserProfileInput$userIdentifier": "

The identifier of the user for which the user profile is created.

", "GetUserProfileInput$userIdentifier": "

The identifier of the user for which you want to get the user profile.

", - "UpdateUserProfileInput$userIdentifier": "

The identifier of the user whose user profile is to be updated.

" + "OwnerUserProperties$userIdentifier": "

The ID of the owner user.

", + "UpdateUserProfileInput$userIdentifier": "

The identifier of the user whose user profile is to be updated.

", + "UserPolicyGrantPrincipal$userIdentifier": "

The user ID of the user policy grant principal.

" + } + }, + "UserPolicyGrantPrincipal": { + "base": "

The user policy grant principal.

", + "refs": { + "PolicyGrantPrincipal$user": "

The user of the policy grant principal.

" } }, "UserProfileDetails": { diff --git a/apis/datazone/2018-05-10/paginators-1.json b/apis/datazone/2018-05-10/paginators-1.json index f983daf1c8e..0b8bbfcfccb 100644 --- a/apis/datazone/2018-05-10/paginators-1.json +++ b/apis/datazone/2018-05-10/paginators-1.json @@ -36,12 +36,24 @@ "limit_key": "maxResults", "result_key": "items" }, + "ListDomainUnitsForParent": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, "ListDomains": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "items" }, + "ListEntityOwners": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "owners" + }, "ListEnvironmentActions": { "input_token": "nextToken", "output_token": "nextToken", @@ -90,6 +102,12 @@ "limit_key": "maxResults", "result_key": "notifications" }, + "ListPolicyGrants": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "grantList" + }, "ListProjectMemberships": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/apis/logs/2014-03-28/api-2.json b/apis/logs/2014-03-28/api-2.json index 779ed63b4e4..04864aef630 100644 --- a/apis/logs/2014-03-28/api-2.json +++ b/apis/logs/2014-03-28/api-2.json @@ -1852,6 +1852,59 @@ "type":"string", "max":256 }, + "Entity":{ + "type":"structure", + "members":{ + "keyAttributes":{"shape":"EntityKeyAttributes"}, + "attributes":{"shape":"EntityAttributes"} + } + }, + "EntityAttributes":{ + "type":"map", + "key":{"shape":"EntityAttributesKey"}, + "value":{"shape":"EntityAttributesValue"}, + "max":10, + "min":0 + }, + "EntityAttributesKey":{ + "type":"string", + "max":256, + "min":1 + }, + "EntityAttributesValue":{ + "type":"string", + "max":512, + "min":1 + }, + "EntityKeyAttributes":{ + "type":"map", + "key":{"shape":"EntityKeyAttributesKey"}, + "value":{"shape":"EntityKeyAttributesValue"}, + "max":3, + "min":2 + }, + "EntityKeyAttributesKey":{ + "type":"string", + "max":32, + "min":1 + }, + "EntityKeyAttributesValue":{ + "type":"string", + "max":512, + "min":1 + }, + "EntityRejectionErrorType":{ + "type":"string", + "enum":[ + "InvalidEntity", + "InvalidTypeValue", + "InvalidKeyAttributes", + "InvalidAttributes", + "EntitySizeTooLarge", + "UnsupportedLogGroupType", + "MissingRequiredFields" + ] + }, "Enumerations":{ "type":"map", "key":{"shape":"TokenString"}, @@ -2767,14 +2820,16 @@ "logGroupName":{"shape":"LogGroupName"}, "logStreamName":{"shape":"LogStreamName"}, "logEvents":{"shape":"InputLogEvents"}, - "sequenceToken":{"shape":"SequenceToken"} + "sequenceToken":{"shape":"SequenceToken"}, + "entity":{"shape":"Entity"} } }, "PutLogEventsResponse":{ "type":"structure", "members":{ "nextSequenceToken":{"shape":"SequenceToken"}, - "rejectedLogEventsInfo":{"shape":"RejectedLogEventsInfo"} + "rejectedLogEventsInfo":{"shape":"RejectedLogEventsInfo"}, + "rejectedEntityInfo":{"shape":"RejectedEntityInfo"} } }, "PutMetricFilterRequest":{ @@ -2948,6 +3003,13 @@ "max":10000, "min":0 }, + "RejectedEntityInfo":{ + "type":"structure", + "required":["errorType"], + "members":{ + "errorType":{"shape":"EntityRejectionErrorType"} + } + }, "RejectedLogEventsInfo":{ "type":"structure", "members":{ diff --git a/apis/logs/2014-03-28/docs-2.json b/apis/logs/2014-03-28/docs-2.json index 3761615478e..8e3c5d8ca5a 100644 --- a/apis/logs/2014-03-28/docs-2.json +++ b/apis/logs/2014-03-28/docs-2.json @@ -53,7 +53,7 @@ "ListLogAnomalyDetectors": "

Retrieves a list of the log anomaly detectors in the account.

", "ListTagsForResource": "

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.

", "ListTagsLogGroup": "

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.

Lists the tags for the specified log group.

", - "PutAccountPolicy": "

Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.

Data protection policy

A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.

Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

To use the PutAccountPolicy operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

The PutAccountPolicy operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Subscription filter policy

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

Each account can have one account-level subscription filter policy. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

", + "PutAccountPolicy": "

Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.

Data protection policy

A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.

Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

To use the PutAccountPolicy operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

The PutAccountPolicy operation applies to all log groups in the account. You can use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Subscription filter policy

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

", "PutDataProtectionPolicy": "

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.

Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

", "PutDeliveryDestination": "

Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.

", "PutDeliveryDestinationPolicy": "

Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:

Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.

", @@ -61,12 +61,12 @@ "PutDestination": "

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.

Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

To perform a PutDestination operation, you must also have the iam:PassRole permission.

", "PutDestinationPolicy": "

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

", "PutLogEvents": "

Uploads a batch of log events to the specified log stream.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.

The batch of events must satisfy the following constraints:

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.

", - "PutMetricFilter": "

Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

", + "PutMetricFilter": "

Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

Using regular expressions to create metric filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in metric filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

", "PutQueryDefinition": "

Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.

To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.

You must have the logs:PutQueryDefinition permission to be able to perform this operation.

", "PutResourcePolicy": "

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.

", "PutRetentionPolicy": "

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.

", - "PutSubscriptionFilter": "

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

", - "StartLiveTail": "

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.

The response to this operation is a response stream, over which the server sends live log events and the client receives them.

The following objects are sent over the stream:

You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.

For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.

", + "PutSubscriptionFilter": "

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

Using regular expressions to create subscription filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in subscription filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

", + "StartLiveTail": "

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.

The response to this operation is a response stream, over which the server sends live log events and the client receives them.

The following objects are sent over the stream:

You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.

For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.

", "StartQuery": "

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.

If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

", "StopQuery": "

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

", "TagLogGroup": "

The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

", @@ -121,7 +121,7 @@ "base": null, "refs": { "AccountPolicy$policyDocument": "

The policy document for this account policy.

The JSON specified in policyDocument can be up to 30,720 characters.

", - "PutAccountPolicyRequest$policyDocument": "

Specify the policy, in JSON.

Data protection policy

A data protection policy must include two JSON blocks:

For an example data protection policy, see the Examples section on this page.

The contents of the two DataIdentifer arrays must match exactly.

In addition to the two JSON blocks, the policyDocument can also include Name, Description, and Version fields. The Name is different than the operation's policyName parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

The JSON specified in policyDocument can be up to 30,720 characters long.

Subscription filter policy

A subscription filter policy can include the following attributes in a JSON block:

" + "PutAccountPolicyRequest$policyDocument": "

Specify the policy, in JSON.

Data protection policy

A data protection policy must include two JSON blocks:

For an example data protection policy, see the Examples section on this page.

The contents of the two DataIdentifer arrays must match exactly.

In addition to the two JSON blocks, the policyDocument can also include Name, Description, and Version fields. The Name is different than the operation's policyName parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

The JSON specified in policyDocument can be up to 30,720 characters long.

Subscription filter policy

A subscription filter policy can include the following attributes in a JSON block:

" } }, "AmazonResourceName": { @@ -736,6 +736,54 @@ "GetQueryResultsResponse$encryptionKey": "

If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.

" } }, + "Entity": { + "base": "

Reserved for future use.

", + "refs": { + "PutLogEventsRequest$entity": "

Reserved for future use.

" + } + }, + "EntityAttributes": { + "base": null, + "refs": { + "Entity$attributes": "

Reserved for future use.

" + } + }, + "EntityAttributesKey": { + "base": null, + "refs": { + "EntityAttributes$key": null + } + }, + "EntityAttributesValue": { + "base": null, + "refs": { + "EntityAttributes$value": null + } + }, + "EntityKeyAttributes": { + "base": null, + "refs": { + "Entity$keyAttributes": "

Reserved for future use.

" + } + }, + "EntityKeyAttributesKey": { + "base": null, + "refs": { + "EntityKeyAttributes$key": null + } + }, + "EntityKeyAttributesValue": { + "base": null, + "refs": { + "EntityKeyAttributes$value": null + } + }, + "EntityRejectionErrorType": { + "base": null, + "refs": { + "RejectedEntityInfo$errorType": "

Reserved for future use.

" + } + }, "Enumerations": { "base": null, "refs": { @@ -1080,7 +1128,7 @@ "InputLogStreamNames": { "base": null, "refs": { - "FilterLogEventsRequest$logStreamNames": "

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

", + "FilterLogEventsRequest$logStreamNames": "

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNames and logStreamNamePrefix, the action returns an InvalidParameterException error.

", "LiveTailSessionStart$logStreamNames": "

If your StartLiveTail operation request included a logStreamNames parameter that filtered the session to only include certain log streams, these streams are listed here.

", "LiveTailSessionStart$logStreamNamePrefixes": "

If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session to only include log streams that have names that start with certain prefixes, these prefixes are listed here.

", "StartLiveTailRequest$logStreamNames": "

If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.

If you specify this field, you can't also specify the logStreamNamePrefixes field.

You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

", @@ -1385,7 +1433,7 @@ "CreateLogStreamRequest$logStreamName": "

The name of the log stream.

", "DeleteLogStreamRequest$logStreamName": "

The name of the log stream.

", "DescribeLogStreamsRequest$logStreamNamePrefix": "

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

", - "FilterLogEventsRequest$logStreamNamePrefix": "

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

", + "FilterLogEventsRequest$logStreamNamePrefix": "

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

", "FilteredLogEvent$logStreamName": "

The name of the log stream to which this event belongs.

", "GetLogEventsRequest$logStreamName": "

The name of the log stream.

", "InputLogStreamNames$member": null, @@ -1411,7 +1459,7 @@ "base": null, "refs": { "DeliverySource$logType": "

The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

", - "PutDeliverySourceRequest$logType": "

Defines the type of log that the source is sending.

" + "PutDeliverySourceRequest$logType": "

Defines the type of log that the source is sending.

" } }, "MalformedQueryException": { @@ -1573,7 +1621,7 @@ } }, "PatternToken": { - "base": "

A tructures that contains information about one pattern token related to an anomaly.

For more information about patterns and tokens, see CreateLogAnomalyDetector.

", + "base": "

A structure that contains information about one pattern token related to an anomaly.

For more information about patterns and tokens, see CreateLogAnomalyDetector.

", "refs": { "PatternTokens$member": null } @@ -1845,6 +1893,12 @@ "StartQueryRequest$queryString": "

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

" } }, + "RejectedEntityInfo": { + "base": "

Reserved for future use.

", + "refs": { + "PutLogEventsResponse$rejectedEntityInfo": "

Reserved for future use.

" + } + }, "RejectedLogEventsInfo": { "base": "

Represents the rejected events.

", "refs": { diff --git a/apis/redshift-data/2019-12-20/api-2.json b/apis/redshift-data/2019-12-20/api-2.json index 8ad853881fe..a00a1d68c0e 100644 --- a/apis/redshift-data/2019-12-20/api-2.json +++ b/apis/redshift-data/2019-12-20/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"redshift-data", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceFullName":"Redshift Data API Service", "serviceId":"Redshift Data", "signatureVersion":"v4", @@ -23,8 +24,10 @@ "output":{"shape":"BatchExecuteStatementOutput"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"ActiveSessionsExceededException"}, {"shape":"ActiveStatementsExceededException"}, - {"shape":"BatchExecuteStatementException"} + {"shape":"BatchExecuteStatementException"}, + {"shape":"InternalServerException"} ] }, "CancelStatement":{ @@ -66,6 +69,7 @@ "output":{"shape":"DescribeTableResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"QueryTimeoutException"}, {"shape":"InternalServerException"}, {"shape":"DatabaseConnectionException"} ] @@ -80,8 +84,10 @@ "output":{"shape":"ExecuteStatementOutput"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"ActiveSessionsExceededException"}, {"shape":"ExecuteStatementException"}, - {"shape":"ActiveStatementsExceededException"} + {"shape":"ActiveStatementsExceededException"}, + {"shape":"InternalServerException"} ] }, "GetStatementResult":{ @@ -108,6 +114,7 @@ "output":{"shape":"ListDatabasesResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"QueryTimeoutException"}, {"shape":"InternalServerException"}, {"shape":"DatabaseConnectionException"} ] @@ -122,6 +129,7 @@ "output":{"shape":"ListSchemasResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"QueryTimeoutException"}, {"shape":"InternalServerException"}, {"shape":"DatabaseConnectionException"} ] @@ -149,12 +157,20 @@ "output":{"shape":"ListTablesResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"QueryTimeoutException"}, {"shape":"InternalServerException"}, {"shape":"DatabaseConnectionException"} ] } }, "shapes":{ + "ActiveSessionsExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, "ActiveStatementsExceededException":{ "type":"structure", "members":{ @@ -177,19 +193,18 @@ }, "BatchExecuteStatementInput":{ "type":"structure", - "required":[ - "Database", - "Sqls" - ], + "required":["Sqls"], "members":{ "ClientToken":{ "shape":"ClientToken", "idempotencyToken":true }, - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "Database":{"shape":"String"}, "DbUser":{"shape":"String"}, "SecretArn":{"shape":"SecretArn"}, + "SessionId":{"shape":"UUID"}, + "SessionKeepAliveSeconds":{"shape":"SessionAliveSeconds"}, "Sqls":{"shape":"SqlList"}, "StatementName":{"shape":"StatementNameString"}, "WithEvent":{"shape":"Boolean"}, @@ -199,12 +214,14 @@ "BatchExecuteStatementOutput":{ "type":"structure", "members":{ - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "CreatedAt":{"shape":"Timestamp"}, "Database":{"shape":"String"}, + "DbGroups":{"shape":"DbGroupList"}, "DbUser":{"shape":"String"}, - "Id":{"shape":"StatementId"}, + "Id":{"shape":"UUID"}, "SecretArn":{"shape":"SecretArn"}, + "SessionId":{"shape":"UUID"}, "WorkgroupName":{"shape":"WorkgroupNameString"} } }, @@ -229,7 +246,7 @@ "type":"structure", "required":["Id"], "members":{ - "Id":{"shape":"StatementId"} + "Id":{"shape":"UUID"} } }, "CancelStatementResponse":{ @@ -243,6 +260,12 @@ "max":64, "min":1 }, + "ClusterIdentifierString":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-z]([a-z0-9]|-[a-z0-9])*$" + }, "ColumnList":{ "type":"list", "member":{"shape":"ColumnMetadata"} @@ -282,11 +305,15 @@ "type":"list", "member":{"shape":"String"} }, + "DbGroupList":{ + "type":"list", + "member":{"shape":"String"} + }, "DescribeStatementRequest":{ "type":"structure", "required":["Id"], "members":{ - "Id":{"shape":"StatementId"} + "Id":{"shape":"UUID"} } }, "DescribeStatementResponse":{ @@ -300,7 +327,7 @@ "Duration":{"shape":"Long"}, "Error":{"shape":"String"}, "HasResultSet":{"shape":"Boolean"}, - "Id":{"shape":"StatementId"}, + "Id":{"shape":"UUID"}, "QueryParameters":{"shape":"SqlParametersList"}, "QueryString":{"shape":"StatementString"}, "RedshiftPid":{"shape":"Long"}, @@ -308,6 +335,7 @@ "ResultRows":{"shape":"Long"}, "ResultSize":{"shape":"Long"}, "SecretArn":{"shape":"SecretArn"}, + "SessionId":{"shape":"String"}, "Status":{"shape":"StatusString"}, "SubStatements":{"shape":"SubStatementList"}, "UpdatedAt":{"shape":"Timestamp"}, @@ -318,7 +346,7 @@ "type":"structure", "required":["Database"], "members":{ - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "ConnectedDatabase":{"shape":"String"}, "Database":{"shape":"String"}, "DbUser":{"shape":"String"}, @@ -353,20 +381,19 @@ }, "ExecuteStatementInput":{ "type":"structure", - "required":[ - "Database", - "Sql" - ], + "required":["Sql"], "members":{ "ClientToken":{ "shape":"ClientToken", "idempotencyToken":true }, - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "Database":{"shape":"String"}, "DbUser":{"shape":"String"}, "Parameters":{"shape":"SqlParametersList"}, "SecretArn":{"shape":"SecretArn"}, + "SessionId":{"shape":"UUID"}, + "SessionKeepAliveSeconds":{"shape":"SessionAliveSeconds"}, "Sql":{"shape":"StatementString"}, "StatementName":{"shape":"StatementNameString"}, "WithEvent":{"shape":"Boolean"}, @@ -376,12 +403,14 @@ "ExecuteStatementOutput":{ "type":"structure", "members":{ - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "CreatedAt":{"shape":"Timestamp"}, "Database":{"shape":"String"}, + "DbGroups":{"shape":"DbGroupList"}, "DbUser":{"shape":"String"}, - "Id":{"shape":"StatementId"}, + "Id":{"shape":"UUID"}, "SecretArn":{"shape":"SecretArn"}, + "SessionId":{"shape":"UUID"}, "WorkgroupName":{"shape":"WorkgroupNameString"} } }, @@ -405,7 +434,7 @@ "type":"structure", "required":["Id"], "members":{ - "Id":{"shape":"StatementId"}, + "Id":{"shape":"UUID"}, "NextToken":{"shape":"String"} } }, @@ -433,7 +462,7 @@ "type":"structure", "required":["Database"], "members":{ - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "Database":{"shape":"String"}, "DbUser":{"shape":"String"}, "MaxResults":{"shape":"PageSize"}, @@ -453,7 +482,7 @@ "type":"structure", "required":["Database"], "members":{ - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "ConnectedDatabase":{"shape":"String"}, "Database":{"shape":"String"}, "DbUser":{"shape":"String"}, @@ -498,7 +527,7 @@ "type":"structure", "required":["Database"], "members":{ - "ClusterIdentifier":{"shape":"Location"}, + "ClusterIdentifier":{"shape":"ClusterIdentifierString"}, "ConnectedDatabase":{"shape":"String"}, "Database":{"shape":"String"}, "DbUser":{"shape":"String"}, @@ -517,7 +546,6 @@ "Tables":{"shape":"TableList"} } }, - "Location":{"type":"string"}, "Long":{"type":"long"}, "PageSize":{ "type":"integer", @@ -532,6 +560,13 @@ "type":"string", "min":1 }, + "QueryTimeoutException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, "ResourceNotFoundException":{ "type":"structure", "required":[ @@ -549,6 +584,12 @@ "member":{"shape":"String"} }, "SecretArn":{"type":"string"}, + "SessionAliveSeconds":{ + "type":"integer", + "box":true, + "max":86400, + "min":0 + }, "SqlList":{ "type":"list", "member":{"shape":"StatementString"}, @@ -580,21 +621,18 @@ "required":["Id"], "members":{ "CreatedAt":{"shape":"Timestamp"}, - "Id":{"shape":"StatementId"}, + "Id":{"shape":"UUID"}, "IsBatchStatement":{"shape":"Boolean"}, "QueryParameters":{"shape":"SqlParametersList"}, "QueryString":{"shape":"StatementString"}, "QueryStrings":{"shape":"StatementStringList"}, "SecretArn":{"shape":"SecretArn"}, + "SessionId":{"shape":"UUID"}, "StatementName":{"shape":"StatementNameString"}, "Status":{"shape":"StatusString"}, "UpdatedAt":{"shape":"Timestamp"} } }, - "StatementId":{ - "type":"string", - "pattern":"^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d+)?$" - }, "StatementList":{ "type":"list", "member":{"shape":"StatementData"} @@ -641,7 +679,7 @@ "Duration":{"shape":"Long"}, "Error":{"shape":"String"}, "HasResultSet":{"shape":"Boolean"}, - "Id":{"shape":"StatementId"}, + "Id":{"shape":"UUID"}, "QueryString":{"shape":"StatementString"}, "RedshiftQueryId":{"shape":"Long"}, "ResultRows":{"shape":"Long"}, @@ -667,6 +705,10 @@ } }, "Timestamp":{"type":"timestamp"}, + "UUID":{ + "type":"string", + "pattern":"^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d+)?$" + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/apis/redshift-data/2019-12-20/docs-2.json b/apis/redshift-data/2019-12-20/docs-2.json index 288ef238ecf..5b04ee8f2bc 100644 --- a/apis/redshift-data/2019-12-20/docs-2.json +++ b/apis/redshift-data/2019-12-20/docs-2.json @@ -14,6 +14,11 @@ "ListTables": "

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

" }, "shapes": { + "ActiveSessionsExceededException": { + "base": "

The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.

", + "refs": { + } + }, "ActiveStatementsExceededException": { "base": "

The number of active statements exceeds the limit.

", "refs": { @@ -88,6 +93,19 @@ "ExecuteStatementInput$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" } }, + "ClusterIdentifierString": { + "base": null, + "refs": { + "BatchExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", + "BatchExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

", + "DescribeTableRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", + "ExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", + "ExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

", + "ListDatabasesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", + "ListSchemasRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", + "ListTablesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" + } + }, "ColumnList": { "base": null, "refs": { @@ -118,6 +136,13 @@ "ListDatabasesResponse$Databases": "

The names of databases.

" } }, + "DbGroupList": { + "base": null, + "refs": { + "BatchExecuteStatementOutput$DbGroups": "

A list of colon (:) separated names of database groups.

", + "ExecuteStatementOutput$DbGroups": "

A list of colon (:) separated names of database groups.

" + } + }, "DescribeStatementRequest": { "base": null, "refs": { @@ -235,19 +260,6 @@ "refs": { } }, - "Location": { - "base": null, - "refs": { - "BatchExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "BatchExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

", - "DescribeTableRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

", - "ListDatabasesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ListSchemasRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ListTablesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" - } - }, "Long": { "base": null, "refs": { @@ -284,6 +296,11 @@ "SqlParameter$value": "

The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see Data types in the Amazon Redshift Database Developer Guide.

" } }, + "QueryTimeoutException": { + "base": "

The Amazon Redshift Data API operation failed due to timeout.

", + "refs": { + } + }, "ResourceNotFoundException": { "base": "

The Amazon Redshift Data API operation failed due to a missing resource.

", "refs": { @@ -310,6 +327,13 @@ "StatementData$SecretArn": "

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

" } }, + "SessionAliveSeconds": { + "base": null, + "refs": { + "BatchExecuteStatementInput$SessionKeepAliveSeconds": "

The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

", + "ExecuteStatementInput$SessionKeepAliveSeconds": "

The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

" + } + }, "SqlList": { "base": null, "refs": { @@ -342,19 +366,6 @@ "StatementList$member": null } }, - "StatementId": { - "base": null, - "refs": { - "BatchExecuteStatementOutput$Id": "

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment.

", - "CancelStatementRequest$Id": "

The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

", - "DescribeStatementRequest$Id": "

The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements.

", - "DescribeStatementResponse$Id": "

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", - "ExecuteStatementOutput$Id": "

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", - "GetStatementResultRequest$Id": "

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

", - "StatementData$Id": "

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", - "SubStatementData$Id": "

The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.

" - } - }, "StatementList": { "base": null, "refs": { @@ -404,6 +415,7 @@ "String": { "base": null, "refs": { + "ActiveSessionsExceededException$Message": null, "ActiveStatementsExceededException$Message": null, "BatchExecuteStatementException$Message": null, "BatchExecuteStatementException$StatementId": "

Statement identifier of the exception.

", @@ -419,10 +431,12 @@ "ColumnMetadata$typeName": "

The database-specific data type of the column.

", "DatabaseConnectionException$Message": null, "DatabaseList$member": null, + "DbGroupList$member": null, "DescribeStatementResponse$ClusterIdentifier": "

The cluster identifier.

", "DescribeStatementResponse$Database": "

The name of the database.

", "DescribeStatementResponse$DbUser": "

The database user name.

", "DescribeStatementResponse$Error": "

The error message from the cluster if the SQL statement encountered an error while running.

", + "DescribeStatementResponse$SessionId": "

The session identifier of the query.

", "DescribeTableRequest$ConnectedDatabase": "

A database name. The connected database is specified when you connect with your authentication credentials.

", "DescribeTableRequest$Database": "

The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

", "DescribeTableRequest$DbUser": "

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

", @@ -460,6 +474,7 @@ "ListTablesRequest$SchemaPattern": "

A pattern to filter results by schema name. Within a schema pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

", "ListTablesRequest$TablePattern": "

A pattern to filter results by table name. Within a table pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

", "ListTablesResponse$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", + "QueryTimeoutException$Message": null, "ResourceNotFoundException$Message": "

The exception message.

", "ResourceNotFoundException$ResourceId": "

Resource identifier associated with the exception.

", "SchemaList$member": null, @@ -507,6 +522,24 @@ "SubStatementData$UpdatedAt": "

The date and time (UTC) that the statement metadata was last updated.

" } }, + "UUID": { + "base": null, + "refs": { + "BatchExecuteStatementInput$SessionId": "

The session identifier of the query.

", + "BatchExecuteStatementOutput$Id": "

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment.

", + "BatchExecuteStatementOutput$SessionId": "

The session identifier of the query.

", + "CancelStatementRequest$Id": "

The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

", + "DescribeStatementRequest$Id": "

The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements.

", + "DescribeStatementResponse$Id": "

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", + "ExecuteStatementInput$SessionId": "

The session identifier of the query.

", + "ExecuteStatementOutput$Id": "

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", + "ExecuteStatementOutput$SessionId": "

The session identifier of the query.

", + "GetStatementResultRequest$Id": "

The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

", + "StatementData$Id": "

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", + "StatementData$SessionId": "

The session identifier of the query.

", + "SubStatementData$Id": "

The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.

" + } + }, "ValidationException": { "base": "

The Amazon Redshift Data API operation failed due to invalid input.

", "refs": { diff --git a/apis/redshift-data/2019-12-20/endpoint-rule-set-1.json b/apis/redshift-data/2019-12-20/endpoint-rule-set-1.json index f7f336276e7..03ccfa2063b 100644 --- a/apis/redshift-data/2019-12-20/endpoint-rule-set-1.json +++ b/apis/redshift-data/2019-12-20/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "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": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +299,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/gems/aws-partitions/CHANGELOG.md b/gems/aws-partitions/CHANGELOG.md index dc83776f203..b28becc5c80 100644 --- a/gems/aws-partitions/CHANGELOG.md +++ b/gems/aws-partitions/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.970.0 (2024-08-30) +------------------ + +* Feature - Updated the partitions source data the determines the AWS service regions and endpoints. + 1.969.0 (2024-08-28) ------------------ diff --git a/gems/aws-partitions/VERSION b/gems/aws-partitions/VERSION index 13ec0e03067..1a97cae1bf0 100644 --- a/gems/aws-partitions/VERSION +++ b/gems/aws-partitions/VERSION @@ -1 +1 @@ -1.969.0 +1.970.0 diff --git a/gems/aws-partitions/partitions.json b/gems/aws-partitions/partitions.json index 1f468912dec..eb50706f93b 100644 --- a/gems/aws-partitions/partitions.json +++ b/gems/aws-partitions/partitions.json @@ -17527,7 +17527,18 @@ "protocols" : [ "https" ] }, "ca-central-1" : { - "protocols" : [ "https" ] + "protocols" : [ "https" ], + "variants" : [ { + "hostname" : "serverlessrepo-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "serverlessrepo-fips.ca-central-1.amazonaws.com" }, "eu-central-1" : { "protocols" : [ "https" ] diff --git a/gems/aws-sdk-backup/CHANGELOG.md b/gems/aws-sdk-backup/CHANGELOG.md index a7fe53d8734..2cd905ca576 100644 --- a/gems/aws-sdk-backup/CHANGELOG.md +++ b/gems/aws-sdk-backup/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.74.0 (2024-08-30) +------------------ + +* Feature - The latest update introduces two new attributes, VaultType and VaultState, to the DescribeBackupVault and ListBackupVaults APIs. The VaultState attribute reflects the current status of the vault, while the VaultType attribute indicates the specific category of the vault. + 1.73.0 (2024-07-02) ------------------ diff --git a/gems/aws-sdk-backup/VERSION b/gems/aws-sdk-backup/VERSION index 5e3a4256626..dc87e8af82f 100644 --- a/gems/aws-sdk-backup/VERSION +++ b/gems/aws-sdk-backup/VERSION @@ -1 +1 @@ -1.73.0 +1.74.0 diff --git a/gems/aws-sdk-backup/lib/aws-sdk-backup.rb b/gems/aws-sdk-backup/lib/aws-sdk-backup.rb index 4cab73f7c8d..aca7874cc6d 100644 --- a/gems/aws-sdk-backup/lib/aws-sdk-backup.rb +++ b/gems/aws-sdk-backup/lib/aws-sdk-backup.rb @@ -52,6 +52,6 @@ # @!group service module Aws::Backup - GEM_VERSION = '1.73.0' + GEM_VERSION = '1.74.0' end diff --git a/gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb b/gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb index d9301746363..02daeeaf69b 100644 --- a/gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb +++ b/gems/aws-sdk-backup/lib/aws-sdk-backup/client.rb @@ -425,19 +425,17 @@ def initialize(*args) # @!group API Operations - # This action removes the specified legal hold on a recovery point. This - # action can only be performed by a user with sufficient permissions. + # Removes the specified legal hold on a recovery point. This action can + # only be performed by a user with sufficient permissions. # # @option params [required, String] :legal_hold_id - # Legal hold ID required to remove the specified legal hold on a - # recovery point. + # The ID of the legal hold. # # @option params [required, String] :cancel_description - # String describing the reason for removing the legal hold. + # A string the describes the reason for removing the legal hold. # # @option params [Integer] :retain_record_in_days - # The integer amount in days specifying amount of days after this API - # operation to remove legal hold. + # The integer amount, in days, after which to remove legal hold. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -466,13 +464,11 @@ def cancel_legal_hold(params = {}, options = {}) # receive an `AlreadyExistsException` exception. # # @option params [required, Types::BackupPlanInput] :backup_plan - # Specifies the body of a backup plan. Includes a `BackupPlanName` and - # one or more sets of `Rules`. + # The body of a backup plan. Includes a `BackupPlanName` and one or more + # sets of `Rules`. # # @option params [Hash] :backup_plan_tags - # To help organize your resources, you can assign your own metadata to - # the resources that you create. Each tag is a key-value pair. The - # specified tags are assigned to all backups created with this plan. + # The tags to assign to the backup plan. # # @option params [String] :creator_request_id # Identifies the request and allows failed requests to be retried @@ -569,12 +565,10 @@ def create_backup_plan(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json # # @option params [required, String] :backup_plan_id - # Uniquely identifies the backup plan to be associated with the - # selection of resources. + # The ID of the backup plan. # # @option params [required, Types::BackupSelection] :backup_selection - # Specifies the body of a request to assign a set of resources to a - # backup plan. + # The body of a request to assign a set of resources to a backup plan. # # @option params [String] :creator_request_id # A unique string that identifies the request and allows failed requests @@ -667,8 +661,7 @@ def create_backup_selection(params = {}, options = {}) # They consist of letters, numbers, and hyphens. # # @option params [Hash] :backup_vault_tags - # Metadata that you can assign to help organize the resources that you - # create. Each tag is a key-value pair. + # The tags to assign to the backup vault. # # @option params [String] :encryption_key_arn # The server-side encryption key that is used to protect your backups; @@ -731,8 +724,8 @@ def create_backup_vault(params = {}, options = {}) # characters. # # @option params [required, Array] :framework_controls - # A list of the controls that make up the framework. Each control in the - # list has a name, input parameters, and scope. + # The controls that make up the framework. Each control in the list has + # a name, input parameters, and scope. # # @option params [String] :idempotency_token # A customer-chosen string that you can use to distinguish between @@ -744,8 +737,7 @@ def create_backup_vault(params = {}, options = {}) # not need to pass this option.** # # @option params [Hash] :framework_tags - # Metadata that you can assign to help organize the frameworks that you - # create. Each tag is a key-value pair. + # The tags to assign to the framework. # # @return [Types::CreateFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -795,17 +787,17 @@ def create_framework(params = {}, options = {}) req.send_request(options) end - # This action creates a legal hold on a recovery point (backup). A legal - # hold is a restraint on altering or deleting a backup until an - # authorized user cancels the legal hold. Any actions to delete or - # disassociate a recovery point will fail with an error if one or more - # active legal holds are on the recovery point. + # Creates a legal hold on a recovery point (backup). A legal hold is a + # restraint on altering or deleting a backup until an authorized user + # cancels the legal hold. Any actions to delete or disassociate a + # recovery point will fail with an error if one or more active legal + # holds are on the recovery point. # # @option params [required, String] :title - # This is the string title of the legal hold. + # The title of the legal hold. # # @option params [required, String] :description - # This is the string description of the legal hold. + # The description of the legal hold. # # @option params [String] :idempotency_token # This is a user-chosen string used to distinguish between otherwise @@ -813,8 +805,8 @@ def create_framework(params = {}, options = {}) # idempotency token results in a success message with no action taken. # # @option params [Types::RecoveryPointSelection] :recovery_point_selection - # This specifies criteria to assign a set of resources, such as resource - # types or backup vaults. + # The criteria to assign a set of resources, such as resource types or + # backup vaults. # # @option params [Hash] :tags # Optional tags to include. A tag is a key-value pair you can use to @@ -875,8 +867,7 @@ def create_legal_hold(params = {}, options = {}) req.send_request(options) end - # This request creates a logical container to where backups may be - # copied. + # Creates a logical container to where backups may be copied. # # This request includes a name, the Region, the maximum number of # retention days, the minimum number of retention days, and optionally @@ -888,41 +879,28 @@ def create_legal_hold(params = {}, options = {}) # # # @option params [required, String] :backup_vault_name - # This is the name of the vault that is being created. + # The name of a logical container where backups are stored. Logically + # air-gapped backup vaults are identified by names that are unique to + # the account used to create them and the Region where they are created. # # @option params [Hash] :backup_vault_tags - # These are the tags that will be included in the newly-created vault. + # The tags to assign to the vault. # # @option params [String] :creator_request_id - # This is the ID of the creation request. + # The ID of the creation request. # # This parameter is optional. If used, this parameter must contain 1 to # 50 alphanumeric or '-\_.' characters. # # @option params [required, Integer] :min_retention_days # This setting specifies the minimum retention period that the vault - # retains its recovery points. If this parameter is not specified, no - # minimum retention period is enforced. + # retains its recovery points. # - # If specified, any backup or copy job to the vault must have a - # lifecycle policy with a retention period equal to or longer than the - # minimum retention period. If a job retention period is shorter than - # that minimum retention period, then the vault fails the backup or copy - # job, and you should either modify your lifecycle settings or use a - # different vault. + # The minimum value accepted is 7 days. # # @option params [required, Integer] :max_retention_days - # This is the setting that specifies the maximum retention period that - # the vault retains its recovery points. If this parameter is not - # specified, Backup does not enforce a maximum retention period on the - # recovery points in the vault (allowing indefinite storage). - # - # If specified, any backup or copy job to the vault must have a - # lifecycle policy with a retention period equal to or shorter than the - # maximum retention period. If the job retention period is longer than - # that maximum retention period, then the vault fails the backup or copy - # job, and you should either modify your lifecycle settings or use a - # different vault. + # The maximum retention period that the vault retains its recovery + # points. # # @return [Types::CreateLogicallyAirGappedBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -992,8 +970,7 @@ def create_logically_air_gapped_backup_vault(params = {}, options = {}) # report coverage by Amazon Web Services Regions and frameworks. # # @option params [Hash] :report_plan_tags - # Metadata that you can assign to help organize the report plans that - # you create. Each tag is a key-value pair. + # The tags to assign to the report plan. # # @option params [String] :idempotency_token # A customer-chosen string that you can use to distinguish between @@ -1049,12 +1026,11 @@ def create_report_plan(params = {}, options = {}) req.send_request(options) end - # This is the first of two steps to create a restore testing plan; once - # this request is successful, finish the procedure with request - # CreateRestoreTestingSelection. + # Creates a restore testing plan. # - # You must include the parameter RestoreTestingPlan. You may optionally - # include CreatorRequestId and Tags. + # The first of two steps to create a restore testing plan. After this + # request is successful, finish the procedure using + # CreateRestoreTestingSelection. # # @option params [String] :creator_request_id # This is a unique string that identifies the request and allows failed @@ -1073,10 +1049,7 @@ def create_report_plan(params = {}, options = {}) # it must consist of only alphanumeric characters and underscores. # # @option params [Hash] :tags - # Optional tags to include. A tag is a key-value pair you can use to - # manage, filter, and search for your resources. Allowed characters - # include UTF-8 letters,numbers, spaces, and the following characters: + - # - = . \_ : /. + # The tags to assign to the restore testing plan. # # @return [Types::CreateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1293,7 +1266,6 @@ def delete_backup_selection(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1375,8 +1347,7 @@ def delete_backup_vault_lock_configuration(params = {}, options = {}) # @option params [required, String] :backup_vault_name # 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 Region where they are created. They consist of - # lowercase letters, numbers, and hyphens. + # create them and the Region where they are created. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1444,7 +1415,6 @@ def delete_framework(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [required, String] :recovery_point_arn # An Amazon Resource Name (ARN) that uniquely identifies a recovery @@ -1639,16 +1609,16 @@ def describe_backup_job(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [String] :backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # # @return [Types::DescribeBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeBackupVaultOutput#backup_vault_name #backup_vault_name} => String # * {Types::DescribeBackupVaultOutput#backup_vault_arn #backup_vault_arn} => String # * {Types::DescribeBackupVaultOutput#vault_type #vault_type} => String + # * {Types::DescribeBackupVaultOutput#vault_state #vault_state} => String # * {Types::DescribeBackupVaultOutput#encryption_key_arn #encryption_key_arn} => String # * {Types::DescribeBackupVaultOutput#creation_date #creation_date} => Time # * {Types::DescribeBackupVaultOutput#creator_request_id #creator_request_id} => String @@ -1670,6 +1640,7 @@ def describe_backup_job(params = {}, options = {}) # resp.backup_vault_name #=> String # resp.backup_vault_arn #=> String # resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT" + # resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED" # resp.encryption_key_arn #=> String # resp.creation_date #=> Time # resp.creator_request_id #=> String @@ -1872,7 +1843,6 @@ def describe_protected_resource(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [required, String] :recovery_point_arn # An Amazon Resource Name (ARN) that uniquely identifies a recovery @@ -1880,7 +1850,7 @@ def describe_protected_resource(params = {}, options = {}) # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`. # # @option params [String] :backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # # @return [Types::DescribeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2178,15 +2148,14 @@ def disassociate_recovery_point(params = {}, options = {}) # (composite) recovery point. # # @option params [required, String] :backup_vault_name - # This is the name of a logical container where the child (nested) - # recovery point is stored. Backup vaults are identified by names that - # are unique to the account used to create them and the Amazon Web - # Services Region where they are created. They consist of lowercase - # letters, numbers, and hyphens. + # The name of a logical container where the child (nested) recovery + # point is stored. Backup vaults are identified by names that are unique + # to the account used to create them and the Amazon Web Services Region + # where they are created. # # @option params [required, String] :recovery_point_arn - # This is the Amazon Resource Name (ARN) that uniquely identifies the - # child (nested) recovery point; for example, + # The Amazon Resource Name (ARN) that uniquely identifies the child + # (nested) recovery point; for example, # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.` # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -2485,7 +2454,6 @@ def get_backup_selection(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @return [Types::GetBackupVaultAccessPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2520,7 +2488,6 @@ def get_backup_vault_access_policy(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @return [Types::GetBackupVaultNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2556,8 +2523,7 @@ def get_backup_vault_notifications(params = {}, options = {}) # are the body of a legal hold in JSON format, in addition to metadata. # # @option params [required, String] :legal_hold_id - # This is the ID required to use `GetLegalHold`. This unique ID is - # associated with a specific legal hold. + # The ID of the legal hold. # # @return [Types::GetLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2612,7 +2578,6 @@ def get_legal_hold(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [required, String] :recovery_point_arn # An Amazon Resource Name (ARN) that uniquely identifies a recovery @@ -2620,7 +2585,7 @@ def get_legal_hold(params = {}, options = {}) # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`. # # @option params [String] :backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # # @return [Types::GetRecoveryPointRestoreMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2691,7 +2656,7 @@ def get_restore_job_metadata(params = {}, options = {}) # is an optional parameter. # # @option params [String] :backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # # @option params [required, String] :backup_vault_name # The name of a logical container where backups are stored. Backup @@ -2921,18 +2886,16 @@ def get_supported_resource_types(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html # # @option params [String] :aggregation_period - # This is the period that sets the boundaries for returned results. - # - # Acceptable values include + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # # @option params [Integer] :max_results - # This parameter sets the maximum number of items to be returned. + # The maximum number of items to be returned. # # The value is an integer. Range of accepted values is from 1 to 500. # @@ -3025,8 +2988,7 @@ def list_backup_job_summaries(params = {}, options = {}) # Returns only backup jobs that will be stored in the specified backup # vault. Backup vaults are identified by names that are unique to the # account used to create them and the Amazon Web Services Region where - # they are created. They consist of lowercase letters, numbers, and - # hyphens. + # they are created. # # @option params [Time,DateTime,Date,Integer,String] :by_created_before # Returns only backup jobs that were created before the specified date. @@ -3055,19 +3017,20 @@ def list_backup_job_summaries(params = {}, options = {}) # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # # @option params [String] :by_account_id # The account ID to list the jobs from. Returns only backup jobs @@ -3173,8 +3136,7 @@ def list_backup_jobs(params = {}, options = {}) req.send_request(options) end - # Returns metadata of your saved backup plan templates, including the - # template ID, name, and the creation and deletion dates. + # Lists the backup plan templates. # # @option params [String] :next_token # The next item following a partial list of returned items. For example, @@ -3183,7 +3145,7 @@ def list_backup_jobs(params = {}, options = {}) # the location pointed to by the next token. # # @option params [Integer] :max_results - # The maximum number of items to be returned. + # The maximum number of items to return. # # @return [Types::ListBackupPlanTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3272,10 +3234,7 @@ def list_backup_plan_versions(params = {}, options = {}) req.send_request(options) end - # Returns a list of all active backup plans for an authenticated - # account. The list contains information such as Amazon Resource Names - # (ARNs), plan IDs, creation and deletion dates, version IDs, plan - # names, and creator request IDs. + # Lists the active backup plans for the account. # # @option params [String] :next_token # The next item following a partial list of returned items. For example, @@ -3420,6 +3379,8 @@ def list_backup_selections(params = {}, options = {}) # resp.backup_vault_list #=> Array # resp.backup_vault_list[0].backup_vault_name #=> String # resp.backup_vault_list[0].backup_vault_arn #=> String + # resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT" + # resp.backup_vault_list[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED" # resp.backup_vault_list[0].creation_date #=> Time # resp.backup_vault_list[0].encryption_key_arn #=> String # resp.backup_vault_list[0].creator_request_id #=> String @@ -3502,13 +3463,13 @@ def list_backup_vaults(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html # # @option params [String] :aggregation_period - # This is the period that sets the boundaries for returned results. + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # # @option params [Integer] :max_results # This parameter sets the maximum number of items to be returned. @@ -3609,24 +3570,25 @@ def list_copy_job_summaries(params = {}, options = {}) # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # # @option params [String] :by_destination_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a source backup # vault to copy from; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # # @option params [String] :by_account_id # The account ID to list the jobs from. Returns only copy jobs @@ -3869,12 +3831,12 @@ def list_protected_resources(params = {}, options = {}) # backup vault. # # @option params [required, String] :backup_vault_name - # This is the list of protected resources by backup vault within the - # vault(s) you specify by name. + # The list of protected resources by backup vault within the vault(s) + # you specify by name. # # @option params [String] :backup_vault_account_id - # This is the list of protected resources by backup vault within the - # vault(s) you specify by account ID. + # The list of protected resources by backup vault within the vault(s) + # you specify by account ID. # # @option params [String] :next_token # The next item following a partial list of returned items. For example, @@ -3928,7 +3890,6 @@ def list_protected_resources_by_backup_vault(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # Backup vault name might not be available when a supported service # creates the backup. @@ -3973,19 +3934,20 @@ def list_protected_resources_by_backup_vault(params = {}, options = {}) # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # # @option params [String] :by_backup_plan_id # Returns only recovery points that match the specified backup plan ID. @@ -4071,16 +4033,16 @@ def list_recovery_points_by_backup_vault(params = {}, options = {}) # specified legal hold. # # @option params [required, String] :legal_hold_id - # This is the ID of the legal hold. + # The ID of the legal hold. # # @option params [String] :next_token - # This is the next item following a partial list of returned resources. - # For example, if a request is made to return `MaxResults` number of + # The next item following a partial list of returned resources. For + # example, if a request is made to return `MaxResults` number of # resources, `NextToken` allows you to return more items in your list # starting at the location pointed to by the next token. # # @option params [Integer] :max_results - # This is the maximum number of resource list items to be returned. + # The maximum number of resource list items to be returned. # # @return [Types::ListRecoveryPointsByLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -4115,8 +4077,8 @@ def list_recovery_points_by_legal_hold(params = {}, options = {}) req.send_request(options) end - # Returns detailed information about all the recovery points of the type - # specified by a resource Amazon Resource Name (ARN). + # The information about the recovery points of the type specified by a + # resource Amazon Resource Name (ARN). # # For Amazon EFS and Amazon EC2, this action only lists recovery points # created by Backup. @@ -4373,15 +4335,13 @@ def list_report_plans(params = {}, options = {}) # Relational Database Service (Amazon RDS) database. # # @option params [String] :aggregation_period - # This is the period that sets the boundaries for returned results. - # - # Acceptable values include + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # # @option params [Integer] :max_results # This parameter sets the maximum number of items to be returned. @@ -4473,19 +4433,20 @@ def list_restore_job_summaries(params = {}, options = {}) # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # # @option params [Time,DateTime,Date,Integer,String] :by_created_before # Returns only restore jobs that were created before the specified date. @@ -4744,17 +4705,8 @@ def list_restore_testing_selections(params = {}, options = {}) req.send_request(options) end - # Returns a list of key-value pairs assigned to a target recovery point, - # backup plan, or backup vault. - # - # `ListTags` only works for resource types that support full Backup - # management of their backups. Those resource types are listed in the - # "Full Backup management" section of the [ Feature availability by - # resource][1] table. - # - # - # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # Returns the tags assigned to the resource, such as a target recovery + # point, backup plan, or backup vault. # # @option params [required, String] :resource_arn # An Amazon Resource Name (ARN) that uniquely identifies a resource. The @@ -4808,7 +4760,6 @@ def list_tags(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [String] :policy # The backup vault access policy document in JSON format. @@ -4843,10 +4794,17 @@ def put_backup_vault_access_policy(params = {}, options = {}) # environments that are subject to SEC 17a-4, CFTC, and FINRA # regulations. For more information about how Backup Vault Lock relates # to these regulations, see the [Cohasset Associates Compliance - # Assessment.](samples/cohassetreport.zip) + # Assessment.][1] # # # + # For more information, see [Backup Vault Lock][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip + # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html + # # @option params [required, String] :backup_vault_name # The Backup Vault Lock configuration that specifies the name of the # backup vault it protects. @@ -4858,8 +4816,10 @@ def put_backup_vault_access_policy(params = {}, options = {}) # require you to retain certain data for at least seven years (2555 # days). # - # If this parameter is not specified, Vault Lock will not enforce a - # minimum retention period. + # This parameter is required when a vault lock is created through + # CloudFormation; otherwise, this parameter is optional. If this + # parameter is not specified, Vault Lock will not enforce a minimum + # retention period. # # If this parameter is specified, any backup or copy job to the vault # must have a lifecycle policy with a retention period equal to or @@ -4940,7 +4900,6 @@ def put_backup_vault_lock_configuration(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [required, String] :sns_topic_arn # The Amazon Resource Name (ARN) that specifies the topic for a backup @@ -4965,9 +4924,9 @@ def put_backup_vault_lock_configuration(params = {}, options = {}) # # * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED` # - # The list below shows items that are deprecated events (for reference) - # and are no longer in use. They are no longer supported and will not - # return statuses or notifications. Refer to the list above for current + # The list below includes both supported events and deprecated events + # that are no longer in use (for reference). Deprecated events do not + # return statuses or notifications. Refer to the list above for the # supported events. # # @@ -5003,7 +4962,7 @@ def put_backup_vault_notifications(params = {}, options = {}) # This is a unique identifier of a restore job within Backup. # # @option params [required, String] :validation_status - # This is the status of your restore validation. + # The status of your restore validation. # # @option params [String] :validation_status_message # This is an optional message string you can input to describe the @@ -5034,7 +4993,6 @@ def put_restore_validation_result(params = {}, options = {}) # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [required, String] :resource_arn # An Amazon Resource Name (ARN) that uniquely identifies a resource. The @@ -5088,25 +5046,22 @@ def put_restore_validation_result(params = {}, options = {}) # “transition to cold after days” setting cannot be changed after a # backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression for - # other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # This parameter has a maximum value of 100 years (36,500 days). # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # # @option params [Hash] :recovery_point_tags - # To help organize your resources, you can assign your own metadata to - # the resources that you create. Each tag is a key-value pair. + # The tags to assign to the resources. # # @option params [Hash] :backup_options - # Specifies the backup option for a selected resource. This option is - # only available for Windows Volume Shadow Copy Service (VSS) backup - # jobs. + # The backup option for a selected resource. This option is only + # available for Windows Volume Shadow Copy Service (VSS) backup jobs. # # Valid values: Set to `"WindowsVSS":"enabled"` to enable the # `WindowsVSS` backup option and create a Windows VSS backup. Set to @@ -5171,12 +5126,12 @@ def start_backup_job(params = {}, options = {}) # The name of a logical source container where backups are stored. # Backup vaults are identified by names that are unique to the account # used to create them and the Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # # @option params [required, String] :destination_backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a destination # backup vault to copy to; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # # @option params [required, String] :iam_role_arn # Specifies the IAM role ARN used to copy the target recovery point; for @@ -5189,23 +5144,26 @@ def start_backup_job(params = {}, options = {}) # with no action taken. # # @option params [Types::Lifecycle] :lifecycle - # Contains an array of `Transition` objects specifying how long in days - # before a recovery point transitions to cold storage or is deleted. + # Specifies the time period, 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 “retention” - # 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. + # for a minimum of 90 days. Therefore, on the console, the retention + # setting must be 90 days greater than the transition to cold after days + # setting. The transition to cold after days setting can't be changed + # after a backup has been transitioned to cold. + # + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression for - # other resource types. + # To remove the existing lifecycle and retention periods and keep your + # recovery points indefinitely, specify -1 for + # `MoveToColdStorageAfterDays` and `DeleteAfterDays`. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # # @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -5289,8 +5247,7 @@ def start_report_job(params = {}, options = {}) # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`. # # @option params [required, Hash] :metadata - # A set of metadata key-value pairs. Contains information, such as a - # resource name, required to restore a recovery point. + # A set of metadata key-value pairs. # # You can get configuration metadata about a resource at the time it was # backed up by calling `GetRecoveryPointRestoreMetadata`. However, @@ -5299,33 +5256,56 @@ def start_report_job(params = {}, options = {}) # 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: + # For more information about the metadata for each resource, see the + # following: + # + # * [Metadata for Amazon Aurora][1] + # + # * [Metadata for Amazon DocumentDB][2] + # + # * [Metadata for CloudFormation][3] # - # * `file-system-id`: The ID of the Amazon EFS file system that is - # backed up by Backup. Returned in `GetRecoveryPointRestoreMetadata`. + # * [Metadata for Amazon DynamoDB][4] # - # * `Encrypted`: A Boolean value that, if true, specifies that the file - # system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be - # set to `true`. + # * [ Metadata for Amazon EBS][5] # - # * `KmsKeyId`: Specifies the Amazon Web Services KMS key that is used - # to encrypt the restored file system. You can specify a key from - # another Amazon Web Services account provided that key it is properly - # shared with your account via Amazon Web Services KMS. + # * [Metadata for Amazon EC2][6] # - # * `PerformanceMode`: Specifies the throughput mode of the file system. + # * [Metadata for Amazon EFS][7] # - # * `CreationToken`: A user-supplied value that ensures the uniqueness - # (idempotency) of the request. + # * [Metadata for Amazon FSx][8] # - # * `newFileSystem`: A Boolean value that, if true, specifies that the - # recovery point is restored to a new Amazon EFS file system. + # * [Metadata for Amazon Neptune][9] # - # * `ItemsToRestore`: An array of one to five strings where each string - # is a file path. Use `ItemsToRestore` to restore specific files or - # directories rather than the entire file system. This parameter is - # optional. For example, `"itemsToRestore":"["/my.test"]"`. + # * [Metadata for Amazon RDS][10] + # + # * [Metadata for Amazon Redshift][11] + # + # * [Metadata for Storage Gateway][12] + # + # * [Metadata for Amazon S3][13] + # + # * [Metadata for Amazon Timestream][14] + # + # * [Metadata for virtual machines][15] + # + # + # + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli + # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli + # [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli + # [4]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli + # [5]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli + # [6]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli + # [7]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli + # [8]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli + # [9]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli + # [10]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli + # [11]: https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api + # [12]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli + # [13]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli + # [14]: https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api + # [15]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli # # @option params [String] :iam_role_arn # The Amazon Resource Name (ARN) of the IAM role that Backup uses to @@ -5342,35 +5322,35 @@ def start_report_job(params = {}, options = {}) # Starts a job to restore a recovery point for one of the following # resources: # - # * `Aurora` for Amazon Aurora + # * `Aurora` - Amazon Aurora # - # * `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility) + # * `DocumentDB` - Amazon DocumentDB # - # * `CloudFormation` for CloudFormation + # * `CloudFormation` - CloudFormation # - # * `DynamoDB` for Amazon DynamoDB + # * `DynamoDB` - Amazon DynamoDB # - # * `EBS` for Amazon Elastic Block Store + # * `EBS` - Amazon Elastic Block Store # - # * `EC2` for Amazon Elastic Compute Cloud + # * `EC2` - Amazon Elastic Compute Cloud # - # * `EFS` for Amazon Elastic File System + # * `EFS` - Amazon Elastic File System # - # * `FSx` for Amazon FSx + # * `FSx` - Amazon FSx # - # * `Neptune` for Amazon Neptune + # * `Neptune` - Amazon Neptune # - # * `RDS` for Amazon Relational Database Service + # * `RDS` - Amazon Relational Database Service # - # * `Redshift` for Amazon Redshift + # * `Redshift` - Amazon Redshift # - # * `Storage Gateway` for Storage Gateway + # * `Storage Gateway` - Storage Gateway # - # * `S3` for Amazon S3 + # * `S3` - Amazon Simple Storage Service # - # * `Timestream` for Amazon Timestream + # * `Timestream` - Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` - Virtual machines # # @option params [Boolean] :copy_source_tags_to_restored_resource # This is an optional parameter. If this equals `True`, tags included in @@ -5412,7 +5392,7 @@ def start_restore_job(params = {}, options = {}) # # This action is not supported for the following services: Amazon FSx # for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp - # ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB + # ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB # compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune. # # @option params [required, String] :backup_job_id @@ -5438,10 +5418,19 @@ def stop_backup_job(params = {}, options = {}) # Assigns a set of key-value pairs to a recovery point, backup plan, or # backup vault identified by an Amazon Resource Name (ARN). # + # This API is supported for recovery points for resource types including + # Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon + # RDS. + # # @option params [required, String] :resource_arn # An ARN that uniquely identifies a resource. The format of the ARN # depends on the type of the tagged resource. # + # ARNs that do not include `backup` are incompatible with tagging. + # `TagResource` and `UntagResource` with invalid ARNs will result in an + # error. Acceptable ARN content can include `arn:aws:backup:us-east`. + # Invalid ARN content may look like `arn:aws:ec2:us-east`. + # # @option params [required, Hash] :tags # Key-value pairs that are used to help organize your resources. You can # assign your own metadata to the resources you create. For clarity, @@ -5471,13 +5460,21 @@ def tag_resource(params = {}, options = {}) # Removes a set of key-value pairs from a recovery point, backup plan, # or backup vault identified by an Amazon Resource Name (ARN) # + # This API is not supported for recovery points for resource types + # including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, + # and Amazon RDS. + # # @option params [required, String] :resource_arn # An ARN that uniquely identifies a resource. The format of the ARN # depends on the type of the tagged resource. # + # ARNs that do not include `backup` are incompatible with tagging. + # `TagResource` and `UntagResource` with invalid ARNs will result in an + # error. Acceptable ARN content can include `arn:aws:backup:us-east`. + # Invalid ARN content may look like `arn:aws:ec2:us-east`. + # # @option params [required, Array] :tag_key_list - # A list of keys to identify which key-value tags to remove from a - # resource. + # The keys to identify which key-value tags to remove from a resource. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -5497,16 +5494,15 @@ def untag_resource(params = {}, options = {}) req.send_request(options) end - # Updates an existing backup plan identified by its `backupPlanId` with - # the input document in JSON format. The new version is uniquely - # identified by a `VersionId`. + # Updates the specified backup plan. The new version is uniquely + # identified by its ID. # # @option params [required, String] :backup_plan_id - # Uniquely identifies a backup plan. + # The ID of the backup plan. # # @option params [required, Types::BackupPlanInput] :backup_plan - # Specifies the body of a backup plan. Includes a `BackupPlanName` and - # one or more sets of `Rules`. + # The body of a backup plan. Includes a `BackupPlanName` and one or more + # sets of `Rules`. # # @return [Types::UpdateBackupPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -5582,8 +5578,7 @@ def update_backup_plan(params = {}, options = {}) req.send_request(options) end - # Updates an existing framework identified by its `FrameworkName` with - # the input document in JSON format. + # Updates the specified framework. # # @option params [required, String] :framework_name # The unique name of a framework. This name is between 1 and 256 @@ -5595,8 +5590,8 @@ def update_backup_plan(params = {}, options = {}) # characters. # # @option params [Array] :framework_controls - # A list of the controls that make up the framework. Each control in the - # list has a name, input parameters, and scope. + # The controls that make up the framework. Each control in the list has + # a name, input parameters, and scope. # # @option params [String] :idempotency_token # A customer-chosen string that you can use to distinguish between @@ -5689,28 +5684,31 @@ def update_global_settings(params = {}, options = {}) # cold storage and when it expires. Backup transitions and expires # backups automatically according to the lifecycle that you define. # + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. + # # Backups transitioned to cold storage must be stored in cold storage # for a minimum of 90 days. Therefore, the “retention” 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. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression for - # other resource types. + # If your lifecycle currently uses the parameters `DeleteAfterDays` and + # `MoveToColdStorageAfterDays`, include these parameters and their + # values when you call this operation. Not including them may result in + # your plan updating with null values. # # This operation does not support continuous backups. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # # @option params [required, String] :backup_vault_name # 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 Amazon Web Services Region where they are created. - # They consist of lowercase letters, numbers, and hyphens. # # @option params [required, String] :recovery_point_arn # An Amazon Resource Name (ARN) that uniquely identifies a recovery @@ -5817,8 +5815,7 @@ def update_region_settings(params = {}, options = {}) req.send_request(options) end - # Updates an existing report plan identified by its `ReportPlanName` - # with the input document in JSON format. + # Updates the specified report plan. # # @option params [required, String] :report_plan_name # The unique name of the report plan. This name is between 1 and 256 @@ -5830,13 +5827,12 @@ def update_region_settings(params = {}, options = {}) # characters. # # @option params [Types::ReportDeliveryChannel] :report_delivery_channel - # A structure that contains information about where to deliver your - # reports, specifically your Amazon S3 bucket name, S3 key prefix, and - # the formats of your reports. + # The information about where to deliver your reports, specifically your + # Amazon S3 bucket name, S3 key prefix, and the formats of your reports. # # @option params [Types::ReportSetting] :report_setting - # Identifies the report template for the report. Reports are built using - # a report template. The report templates are: + # The report template for the report. Reports are built using a report + # template. The report templates are: # # `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` @@ -5915,7 +5911,7 @@ def update_report_plan(params = {}, options = {}) # Specifies the body of a restore testing plan. # # @option params [required, String] :restore_testing_plan_name - # This is the restore testing plan name you wish to update. + # The name of the restore testing plan name. # # @return [Types::UpdateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -5958,13 +5954,13 @@ def update_restore_testing_plan(params = {}, options = {}) req.send_request(options) end + # Updates the specified restore testing selection. + # # Most elements except the `RestoreTestingSelectionName` can be updated # with this request. # - # `RestoreTestingSelection` can use either protected resource ARNs or - # conditions, but not both. That is, if your selection has - # `ProtectedResourceArns`, requesting an update with the parameter - # `ProtectedResourceConditions` will be unsuccessful. + # You can use either protected resource ARNs or conditions, but not + # both. # # @option params [required, String] :restore_testing_plan_name # The restore testing plan name is required to update the indicated @@ -5977,8 +5973,8 @@ def update_restore_testing_plan(params = {}, options = {}) # `ProtectedResourceConditions` will be unsuccessful. # # @option params [required, String] :restore_testing_selection_name - # This is the required restore testing selection name of the restore - # testing selection you wish to update. + # The required restore testing selection name of the restore testing + # selection you wish to update. # # @return [Types::UpdateRestoreTestingSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -6047,7 +6043,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-backup' - context[:gem_version] = '1.73.0' + context[:gem_version] = '1.74.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-backup/lib/aws-sdk-backup/client_api.rb b/gems/aws-sdk-backup/lib/aws-sdk-backup/client_api.rb index 0224743249c..ba1d5734483 100644 --- a/gems/aws-sdk-backup/lib/aws-sdk-backup/client_api.rb +++ b/gems/aws-sdk-backup/lib/aws-sdk-backup/client_api.rb @@ -496,6 +496,8 @@ module ClientApi BackupVaultListMember.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, location_name: "BackupVaultName")) BackupVaultListMember.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn")) + BackupVaultListMember.add_member(:vault_type, Shapes::ShapeRef.new(shape: VaultType, location_name: "VaultType")) + BackupVaultListMember.add_member(:vault_state, Shapes::ShapeRef.new(shape: VaultState, location_name: "VaultState")) BackupVaultListMember.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate")) BackupVaultListMember.add_member(:encryption_key_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "EncryptionKeyArn")) BackupVaultListMember.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId")) @@ -798,6 +800,7 @@ module ClientApi DescribeBackupVaultOutput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: string, location_name: "BackupVaultName")) DescribeBackupVaultOutput.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn")) DescribeBackupVaultOutput.add_member(:vault_type, Shapes::ShapeRef.new(shape: VaultType, location_name: "VaultType")) + DescribeBackupVaultOutput.add_member(:vault_state, Shapes::ShapeRef.new(shape: VaultState, location_name: "VaultState")) DescribeBackupVaultOutput.add_member(:encryption_key_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "EncryptionKeyArn")) DescribeBackupVaultOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate")) DescribeBackupVaultOutput.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId")) diff --git a/gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb b/gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb index b6fb506a9c5..2a5ccb6cc07 100644 --- a/gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb +++ b/gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb @@ -10,7 +10,7 @@ module Aws::Backup module Types - # A list of backup options for each resource type. + # The backup options for each resource type. # # @!attribute [rw] resource_type # Specifies an object containing resource type and backup options. The @@ -105,13 +105,13 @@ class AlreadyExistsException < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a backup # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -229,12 +229,12 @@ class AlreadyExistsException < Struct.new( # @return [Boolean] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The non-unique name of the resource that belongs to the specified + # backup. # @return [String] # # @!attribute [rw] initiation_date - # This is the date on which the backup job was initiated. + # The date on which the backup job was initiated. # @return [Time] # # @!attribute [rw] message_category @@ -369,8 +369,11 @@ class BackupJobSummary < Struct.new( # different selection of Amazon Web Services resources. # # @!attribute [rw] backup_plan_name - # The display name of a backup plan. Must contain 1 to 50 alphanumeric - # or '-\_.' characters. + # The display name of a backup plan. Must contain only alphanumeric or + # '-\_.' special characters. + # + # If this is set in the console, it can contain 1 to 50 characters; if + # this is set through CLI or API, it can contain 1 to 200 characters. # @return [String] # # @!attribute [rw] rules @@ -486,11 +489,11 @@ class BackupPlanTemplatesListMember < Struct.new( # @return [String] # # @!attribute [rw] last_execution_date - # The last time a job to back up resources was run with this rule. A - # date and time, in Unix format and Coordinated Universal Time (UTC). - # The value of `LastExecutionDate` is accurate to milliseconds. For - # example, the value 1516925490.087 represents Friday, January 26, - # 2018 12:11:30.087 AM. + # The last time this backup plan was run. A date and time, in Unix + # format and Coordinated Universal Time (UTC). The value of + # `LastExecutionDate` is accurate to milliseconds. For example, the + # value 1516925490.087 represents Friday, January 26, 2018 + # 12:11:30.087 AM. # @return [Time] # # @!attribute [rw] advanced_backup_settings @@ -524,7 +527,7 @@ class BackupPlansListMember < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] schedule_expression @@ -575,19 +578,18 @@ class BackupPlansListMember < Struct.new( # The “transition to cold after days” setting cannot be changed after # a backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @!attribute [rw] recovery_point_tags - # An array of key-value pair strings that are assigned to resources - # that are associated with this rule when restored from backup. + # The tags that are assigned to resources that are associated with + # this rule when restored from backup. # @return [Hash] # # @!attribute [rw] rule_id @@ -608,9 +610,9 @@ class BackupPlansListMember < Struct.new( # @return [Boolean] # # @!attribute [rw] schedule_expression_timezone - # This is the timezone in which the schedule expression is set. By - # default, ScheduleExpressions are in UTC. You can modify this to a - # specified timezone. + # The timezone in which the schedule expression is set. By default, + # ScheduleExpressions are in UTC. You can modify this to a specified + # timezone. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRule AWS API Documentation @@ -642,7 +644,7 @@ class BackupRule < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] schedule_expression @@ -684,23 +686,21 @@ class BackupRule < Struct.new( # for a minimum of 90 days. Therefore, the “retention” 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. + # a backup has been transitioned to cold storage. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # This parameter has a maximum value of 100 years (36,500 days). # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @!attribute [rw] recovery_point_tags - # To help organize your resources, you can assign your own metadata to - # the resources that you create. Each tag is a key-value pair. + # The tags to assign to the resources. # @return [Hash] # # @!attribute [rw] copy_actions @@ -716,9 +716,9 @@ class BackupRule < Struct.new( # @return [Boolean] # # @!attribute [rw] schedule_expression_timezone - # This is the timezone in which the schedule expression is set. By - # default, ScheduleExpressions are in UTC. You can modify this to a - # specified timezone. + # The timezone in which the schedule expression is set. By default, + # ScheduleExpressions are in UTC. You can modify this to a specified + # timezone. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRuleInput AWS API Documentation @@ -740,10 +740,16 @@ class BackupRuleInput < Struct.new( # Used to specify a set of resources to a backup plan. # - # Specifying your desired `Conditions`, `ListOfTags`, `NotResources`, - # and/or `Resources` is recommended. If none of these are specified, - # Backup will attempt to select all supported and opted-in storage - # resources, which could have unintended cost implications. + # We recommend that you specify conditions, tags, or resources to + # include or exclude. Otherwise, Backup attempts to select all supported + # and opted-in storage resources, which could have unintended cost + # implications. + # + # For more information, see [Assigning resources programmatically][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json # # @!attribute [rw] selection_name # The display name of a resource selection document. Must contain 1 to @@ -757,36 +763,35 @@ class BackupRuleInput < Struct.new( # @return [String] # # @!attribute [rw] resources - # A list of Amazon Resource Names (ARNs) to assign to a backup plan. - # The maximum number of ARNs is 500 without wildcards, or 30 ARNs with - # wildcards. + # The Amazon Resource Names (ARNs) of the resources to assign to a + # backup plan. The maximum number of ARNs is 500 without wildcards, or + # 30 ARNs with wildcards. # # If you need to assign many resources to a backup plan, consider a # different resource selection strategy, such as assigning all # resources of a resource type or refining your resource selection # using tags. + # + # If you specify multiple ARNs, the resources much match any of the + # ARNs (OR logic). # @return [Array] # # @!attribute [rw] list_of_tags - # A list of conditions that you define to assign resources to your - # backup plans using tags. For example, `"StringEquals": \{ "Key": - # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition - # operators are case sensitive. - # - # `ListOfTags` differs from `Conditions` as follows: + # The conditions that you define to assign resources to your backup + # plans using tags. For example, `"StringEquals": \{ "ConditionKey": + # "backup", "ConditionValue": "daily"\}`. # - # * When you specify more than one condition, you assign all resources - # that match AT LEAST ONE condition (using OR logic). + # `ListOfTags` supports only `StringEquals`. Condition operators are + # case sensitive. # - # * `ListOfTags` only supports `StringEquals`. `Conditions` supports - # `StringEquals`, `StringLike`, `StringNotEquals`, and - # `StringNotLike`. + # If you specify multiple conditions, the resources much match any of + # the conditions (OR logic). # @return [Array] # # @!attribute [rw] not_resources - # A list of Amazon Resource Names (ARNs) to exclude from a backup - # plan. The maximum number of ARNs is 500 without wildcards, or 30 - # ARNs with wildcards. + # The Amazon Resource Names (ARNs) of the resources to exclude from a + # backup plan. The maximum number of ARNs is 500 without wildcards, or + # 30 ARNs with wildcards. # # If you need to exclude many resources from a backup plan, consider a # different resource selection strategy, such as assigning only one or @@ -794,19 +799,16 @@ class BackupRuleInput < Struct.new( # @return [Array] # # @!attribute [rw] conditions - # A list of conditions that you define to assign resources to your - # backup plans using tags. For example, `"StringEquals": \{ "Key": - # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition - # operators are case sensitive. + # The conditions that you define to assign resources to your backup + # plans using tags. For example, `"StringEquals": \{ "ConditionKey": + # "aws:ResourceTag/backup", "ConditionValue": "daily" \}`. # - # `Conditions` differs from `ListOfTags` as follows: + # `Conditions` supports `StringEquals`, `StringLike`, + # `StringNotEquals`, and `StringNotLike`. Condition operators are case + # sensitive. # - # * When you specify more than one condition, you only assign the - # resources that match ALL conditions (using AND logic). - # - # * `Conditions` supports `StringEquals`, `StringLike`, - # `StringNotEquals`, and `StringNotLike`. `ListOfTags` only supports - # `StringEquals`. + # If you specify multiple conditions, the resources much match all + # conditions (AND logic). # @return [Types::Conditions] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupSelection AWS API Documentation @@ -878,13 +880,21 @@ class BackupSelectionsListMember < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a backup # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. + # @return [String] + # + # @!attribute [rw] vault_type + # The type of vault in which the described recovery point is stored. + # @return [String] + # + # @!attribute [rw] vault_state + # The current state of the vault. # @return [String] # # @!attribute [rw] creation_date @@ -979,6 +989,8 @@ class BackupSelectionsListMember < Struct.new( class BackupVaultListMember < Struct.new( :backup_vault_name, :backup_vault_arn, + :vault_type, + :vault_state, :creation_date, :encryption_key_arn, :creator_request_id, @@ -1004,14 +1016,13 @@ class BackupVaultListMember < Struct.new( # “transition to cold after days” setting cannot be changed after a # backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression for - # other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # # @!attribute [rw] move_to_cold_storage_at # A timestamp that specifies when to transition a recovery point to @@ -1032,17 +1043,15 @@ class CalculatedLifecycle < Struct.new( end # @!attribute [rw] legal_hold_id - # Legal hold ID required to remove the specified legal hold on a - # recovery point. + # The ID of the legal hold. # @return [String] # # @!attribute [rw] cancel_description - # String describing the reason for removing the legal hold. + # A string the describes the reason for removing the legal hold. # @return [String] # # @!attribute [rw] retain_record_in_days - # The integer amount in days specifying amount of days after this API - # operation to remove legal hold. + # The integer amount, in days, after which to remove legal hold. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CancelLegalHoldInput AWS API Documentation @@ -1098,6 +1107,9 @@ class Condition < Struct.new( # Includes information about tags you define to assign tagged resources # to a backup plan. # + # Include the prefix `aws:ResourceTag` in your tags. For example, + # `"aws:ResourceTag/TagKey1": "Value1"`. + # # @!attribute [rw] condition_key # The key in a key-value pair. For example, in the tag `Department: # Accounting`, `Department` is the key. @@ -1181,11 +1193,11 @@ class ConflictException < Struct.new( include Aws::Structure end - # A list of parameters for a control. A control can have zero, one, or - # more than one parameter. An example of a control with two parameters - # is: "backup plan frequency is at least `daily` and the retention - # period is at least `1 year`". The first parameter is `daily`. The - # second parameter is `1 year`. + # The parameters for a control. A control can have zero, one, or more + # than one parameter. An example of a control with two parameters is: + # "backup plan frequency is at least `daily` and the retention period + # is at least `1 year`". The first parameter is `daily`. The second + # parameter is `1 year`. # # @!attribute [rw] parameter_name # The name of a parameter, for example, `BackupPlanFrequency`. @@ -1231,8 +1243,12 @@ class ControlInputParameter < Struct.new( # The tag key-value pair applied to those Amazon Web Services # resources that you want to trigger an evaluation for a rule. A # maximum of one key-value pair can be provided. The tag value is - # optional, but it cannot be an empty string. The structure to assign - # a tag is: `[\{"Key":"string","Value":"string"\}]`. + # optional, but it cannot be an empty string if you are creating or + # editing a framework from the console (though the value can be an + # empty string when included in a CloudFormation template). + # + # The structure to assign a tag is: + # `[\{"Key":"string","Value":"string"\}]`. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ControlScope AWS API Documentation @@ -1248,30 +1264,32 @@ class ControlScope < Struct.new( # The details of the copy operation. # # @!attribute [rw] lifecycle - # Contains an array of `Transition` objects specifying how long in - # days before a recovery point transitions to cold storage or is - # deleted. + # Specifies the time period, 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 “retention” - # setting must be 90 days greater than the “transition to cold after - # days” setting. The “transition to cold after days” setting cannot be + # for a minimum of 90 days. Therefore, on the console, the retention + # setting must be 90 days greater than the transition to cold after + # days setting. The transition to cold after days setting can't be # changed after a backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # + # To remove the existing lifecycle and retention periods and keep your + # recovery points indefinitely, specify -1 for + # `MoveToColdStorageAfterDays` and `DeleteAfterDays`. # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @!attribute [rw] destination_backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies the # destination backup vault for the copied backup. For example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CopyAction AWS API Documentation @@ -1296,7 +1314,7 @@ class CopyAction < Struct.new( # @!attribute [rw] source_backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a source copy # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] source_recovery_point_arn @@ -1308,7 +1326,7 @@ class CopyAction < Struct.new( # @!attribute [rw] destination_backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a destination # copy vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] destination_recovery_point_arn @@ -1377,8 +1395,8 @@ class CopyAction < Struct.new( # @return [Boolean] # # @!attribute [rw] composite_member_identifier - # This is the identifier of a resource within a composite group, such - # as nested (child) recovery point belonging to a composite (parent) + # The identifier of a resource within a composite group, such as + # nested (child) recovery point belonging to a composite (parent) # stack. The ID is transferred from the [ logical ID][1] within a # stack. # @@ -1388,7 +1406,7 @@ class CopyAction < Struct.new( # @return [String] # # @!attribute [rw] number_of_child_jobs - # This is the number of child (nested) copy jobs. + # The number of child (nested) copy jobs. # @return [Integer] # # @!attribute [rw] child_jobs_in_state @@ -1397,8 +1415,8 @@ class CopyAction < Struct.new( # @return [Hash] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The non-unique name of the resource that belongs to the specified + # backup. # @return [String] # # @!attribute [rw] message_category @@ -1455,7 +1473,7 @@ class CopyJob < Struct.new( # of included jobs. # # @!attribute [rw] region - # This is the Amazon Web Services Regions within the job summary. + # The Amazon Web Services Regions within the job summary. # @return [String] # # @!attribute [rw] account_id @@ -1525,14 +1543,12 @@ class CopyJobSummary < Struct.new( end # @!attribute [rw] backup_plan - # Specifies the body of a backup plan. Includes a `BackupPlanName` and - # one or more sets of `Rules`. + # The body of a backup plan. Includes a `BackupPlanName` and one or + # more sets of `Rules`. # @return [Types::BackupPlanInput] # # @!attribute [rw] backup_plan_tags - # To help organize your resources, you can assign your own metadata to - # the resources that you create. Each tag is a key-value pair. The - # specified tags are assigned to all backups created with this plan. + # The tags to assign to the backup plan. # @return [Hash] # # @!attribute [rw] creator_request_id @@ -1556,7 +1572,7 @@ class CreateBackupPlanInput < Struct.new( end # @!attribute [rw] backup_plan_id - # Uniquely identifies a backup plan. + # The ID of the backup plan. # @return [String] # # @!attribute [rw] backup_plan_arn @@ -1578,9 +1594,8 @@ class CreateBackupPlanInput < Struct.new( # @return [String] # # @!attribute [rw] advanced_backup_settings - # A list of `BackupOptions` settings for a resource type. This option - # is only available for Windows Volume Shadow Copy Service (VSS) - # backup jobs. + # The settings for a resource type. This option is only available for + # Windows Volume Shadow Copy Service (VSS) backup jobs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlanOutput AWS API Documentation @@ -1596,13 +1611,11 @@ class CreateBackupPlanOutput < Struct.new( end # @!attribute [rw] backup_plan_id - # Uniquely identifies the backup plan to be associated with the - # selection of resources. + # The ID of the backup plan. # @return [String] # # @!attribute [rw] backup_selection - # Specifies the body of a request to assign a set of resources to a - # backup plan. + # The body of a request to assign a set of resources to a backup plan. # @return [Types::BackupSelection] # # @!attribute [rw] creator_request_id @@ -1630,7 +1643,7 @@ class CreateBackupSelectionInput < Struct.new( # @return [String] # # @!attribute [rw] backup_plan_id - # Uniquely identifies a backup plan. + # The ID of the backup plan. # @return [String] # # @!attribute [rw] creation_date @@ -1658,8 +1671,7 @@ class CreateBackupSelectionOutput < Struct.new( # @return [String] # # @!attribute [rw] backup_vault_tags - # Metadata that you can assign to help organize the resources that you - # create. Each tag is a key-value pair. + # The tags to assign to the backup vault. # @return [Hash] # # @!attribute [rw] encryption_key_arn @@ -1698,7 +1710,7 @@ class CreateBackupVaultInput < Struct.new( # @!attribute [rw] backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a backup # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] creation_date @@ -1730,8 +1742,8 @@ class CreateBackupVaultOutput < Struct.new( # @return [String] # # @!attribute [rw] framework_controls - # A list of the controls that make up the framework. Each control in - # the list has a name, input parameters, and scope. + # The controls that make up the framework. Each control in the list + # has a name, input parameters, and scope. # @return [Array] # # @!attribute [rw] idempotency_token @@ -1745,8 +1757,7 @@ class CreateBackupVaultOutput < Struct.new( # @return [String] # # @!attribute [rw] framework_tags - # Metadata that you can assign to help organize the frameworks that - # you create. Each tag is a key-value pair. + # The tags to assign to the framework. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateFrameworkInput AWS API Documentation @@ -1782,11 +1793,11 @@ class CreateFrameworkOutput < Struct.new( end # @!attribute [rw] title - # This is the string title of the legal hold. + # The title of the legal hold. # @return [String] # # @!attribute [rw] description - # This is the string description of the legal hold. + # The description of the legal hold. # @return [String] # # @!attribute [rw] idempotency_token @@ -1796,8 +1807,8 @@ class CreateFrameworkOutput < Struct.new( # @return [String] # # @!attribute [rw] recovery_point_selection - # This specifies criteria to assign a set of resources, such as - # resource types or backup vaults. + # The criteria to assign a set of resources, such as resource types or + # backup vaults. # @return [Types::RecoveryPointSelection] # # @!attribute [rw] tags @@ -1820,36 +1831,32 @@ class CreateLegalHoldInput < Struct.new( end # @!attribute [rw] title - # This is the string title of the legal hold returned after creating - # the legal hold. + # The title of the legal hold. # @return [String] # # @!attribute [rw] status - # This displays the status of the legal hold returned after creating - # the legal hold. Statuses can be `ACTIVE`, `PENDING`, `CANCELED`, - # `CANCELING`, or `FAILED`. + # The status of the legal hold. # @return [String] # # @!attribute [rw] description - # This is the returned string description of the legal hold. + # The description of the legal hold. # @return [String] # # @!attribute [rw] legal_hold_id - # Legal hold ID returned for the specified legal hold on a recovery - # point. + # The ID of the legal hold. # @return [String] # # @!attribute [rw] legal_hold_arn - # This is the ARN (Amazon Resource Number) of the created legal hold. + # The Amazon Resource Name (ARN) of the legal hold. # @return [String] # # @!attribute [rw] creation_date - # Time in number format when legal hold was created. + # The time when the legal hold was created. # @return [Time] # # @!attribute [rw] recovery_point_selection - # This specifies criteria to assign a set of resources, such as - # resource types or backup vaults. + # The criteria to assign to a set of resources, such as resource types + # or backup vaults. # @return [Types::RecoveryPointSelection] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLegalHoldOutput AWS API Documentation @@ -1867,15 +1874,18 @@ class CreateLegalHoldOutput < Struct.new( end # @!attribute [rw] backup_vault_name - # This is the name of the vault that is being created. + # The name of a logical container where backups are stored. Logically + # air-gapped backup vaults are identified by names that are unique to + # the account used to create them and the Region where they are + # created. # @return [String] # # @!attribute [rw] backup_vault_tags - # These are the tags that will be included in the newly-created vault. + # The tags to assign to the vault. # @return [Hash] # # @!attribute [rw] creator_request_id - # This is the ID of the creation request. + # The ID of the creation request. # # This parameter is optional. If used, this parameter must contain 1 # to 50 alphanumeric or '-\_.' characters. @@ -1883,29 +1893,14 @@ class CreateLegalHoldOutput < Struct.new( # # @!attribute [rw] min_retention_days # This setting specifies the minimum retention period that the vault - # retains its recovery points. If this parameter is not specified, no - # minimum retention period is enforced. + # retains its recovery points. # - # If specified, any backup or copy job to the vault must have a - # lifecycle policy with a retention period equal to or longer than the - # minimum retention period. If a job retention period is shorter than - # that minimum retention period, then the vault fails the backup or - # copy job, and you should either modify your lifecycle settings or - # use a different vault. + # The minimum value accepted is 7 days. # @return [Integer] # # @!attribute [rw] max_retention_days - # This is the setting that specifies the maximum retention period that - # the vault retains its recovery points. If this parameter is not - # specified, Backup does not enforce a maximum retention period on the - # recovery points in the vault (allowing indefinite storage). - # - # If specified, any backup or copy job to the vault must have a - # lifecycle policy with a retention period equal to or shorter than - # the maximum retention period. If the job retention period is longer - # than that maximum retention period, then the vault fails the backup - # or copy job, and you should either modify your lifecycle settings or - # use a different vault. + # The maximum retention period that the vault retains its recovery + # points. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLogicallyAirGappedBackupVaultInput AWS API Documentation @@ -1924,11 +1919,11 @@ class CreateLogicallyAirGappedBackupVaultInput < Struct.new( # The name of a logical container where backups are stored. Logically # air-gapped backup vaults are identified by names that are unique to # the account used to create them and the Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] backup_vault_arn - # This is the ARN (Amazon Resource Name) of the vault being created. + # The ARN (Amazon Resource Name) of the vault. # @return [String] # # @!attribute [rw] creation_date @@ -1940,7 +1935,7 @@ class CreateLogicallyAirGappedBackupVaultInput < Struct.new( # @return [Time] # # @!attribute [rw] vault_state - # This is the current state of the vault. + # The current state of the vault. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLogicallyAirGappedBackupVaultOutput AWS API Documentation @@ -1984,8 +1979,7 @@ class CreateLogicallyAirGappedBackupVaultOutput < Struct.new( # @return [Types::ReportSetting] # # @!attribute [rw] report_plan_tags - # Metadata that you can assign to help organize the report plans that - # you create. Each tag is a key-value pair. + # The tags to assign to the report plan. # @return [Hash] # # @!attribute [rw] idempotency_token @@ -2056,10 +2050,7 @@ class CreateReportPlanOutput < Struct.new( # @return [Types::RestoreTestingPlanForCreate] # # @!attribute [rw] tags - # Optional tags to include. A tag is a key-value pair you can use to - # manage, filter, and search for your resources. Allowed characters - # include UTF-8 letters,numbers, spaces, and the following characters: - # + - = . \_ : /. + # The tags to assign to the restore testing plan. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreTestingPlanInput AWS API Documentation @@ -2140,25 +2131,24 @@ class CreateRestoreTestingSelectionInput < Struct.new( end # @!attribute [rw] creation_time - # This is the time the resource testing selection was created - # successfully. + # The time that the resource testing selection was created. # @return [Time] # # @!attribute [rw] restore_testing_plan_arn - # This is the ARN of the restore testing plan with which the restore - # testing selection is associated. + # The ARN of the restore testing plan with which the restore testing + # selection is associated. # @return [String] # # @!attribute [rw] restore_testing_plan_name - # Unique string that is the name of the restore testing plan. + # The name of the restore testing plan. # # The name cannot be changed after creation. The name consists of only # alphanumeric characters and underscores. Maximum length is 50. # @return [String] # # @!attribute [rw] restore_testing_selection_name - # This is the unique name of the restore testing selection that - # belongs to the related restore testing plan. + # The name of the restore testing selection for the related restore + # testing plan. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreTestingSelectionOutput AWS API Documentation @@ -2288,7 +2278,7 @@ class DeleteBackupVaultAccessPolicyInput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultInput AWS API Documentation @@ -2314,8 +2304,7 @@ class DeleteBackupVaultLockConfigurationInput < Struct.new( # @!attribute [rw] backup_vault_name # 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 Region where they are created. They consist - # of lowercase letters, numbers, and hyphens. + # to create them and the Region where they are created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultNotificationsInput AWS API Documentation @@ -2342,7 +2331,7 @@ class DeleteFrameworkInput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -2453,13 +2442,13 @@ class DescribeBackupJobInput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a backup # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -2576,16 +2565,16 @@ class DescribeBackupJobInput < Struct.new( # @return [Hash] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The non-unique name of the resource that belongs to the specified + # backup. # @return [String] # # @!attribute [rw] initiation_date - # This is the date a backup job was initiated. + # The date a backup job was initiated. # @return [Time] # # @!attribute [rw] message_category - # This is the job count for the specified message category. + # The job count for the specified message category. # # Example strings may include `AccessDenied`, `SUCCESS`, # `AGGREGATE_ALL`, and `INVALIDPARAMETERS`. View [Monitoring][1] for a @@ -2634,11 +2623,11 @@ class DescribeBackupJobOutput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVaultInput AWS API Documentation @@ -2653,18 +2642,21 @@ class DescribeBackupVaultInput < Struct.new( # @!attribute [rw] backup_vault_name # 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 Region where they are created. They consist - # of lowercase letters, numbers, and hyphens. + # to create them and the Region where they are created. # @return [String] # # @!attribute [rw] backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a backup # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] vault_type - # This is the type of vault described. + # The type of vault described. + # @return [String] + # + # @!attribute [rw] vault_state + # The current state of the vault.-> # @return [String] # # @!attribute [rw] encryption_key_arn @@ -2701,7 +2693,7 @@ class DescribeBackupVaultInput < Struct.new( # @!attribute [rw] min_retention_days # The Backup Vault Lock setting that specifies the minimum retention # period that the vault retains its recovery points. If this parameter - # is not specified, Vault Lock does not enforce a minimum retention + # is not specified, Vault Lock will not enforce a minimum retention # period. # # If specified, any backup or copy job to the vault must have a @@ -2748,6 +2740,7 @@ class DescribeBackupVaultOutput < Struct.new( :backup_vault_name, :backup_vault_arn, :vault_type, + :vault_state, :encryption_key_arn, :creation_date, :creator_request_id, @@ -2810,8 +2803,8 @@ class DescribeFrameworkInput < Struct.new( # @return [String] # # @!attribute [rw] framework_controls - # A list of the controls that make up the framework. Each control in - # the list has a name, input parameters, and scope. + # The controls that make up the framework. Each control in the list + # has a name, input parameters, and scope. # @return [Array] # # @!attribute [rw] creation_time @@ -2927,31 +2920,29 @@ class DescribeProtectedResourceInput < Struct.new( # @return [Time] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The name of the resource that belongs to the specified backup. # @return [String] # # @!attribute [rw] last_backup_vault_arn - # This is the ARN (Amazon Resource Name) of the backup vault that - # contains the most recent backup recovery point. + # The ARN (Amazon Resource Name) of the backup vault that contains the + # most recent backup recovery point. # @return [String] # # @!attribute [rw] last_recovery_point_arn - # This is the ARN (Amazon Resource Name) of the most recent recovery - # point. + # The ARN (Amazon Resource Name) of the most recent recovery point. # @return [String] # # @!attribute [rw] latest_restore_execution_time_minutes - # This is the time in minutes the most recent restore job took to + # The time, in minutes, that the most recent restore job took to # complete. # @return [Integer] # # @!attribute [rw] latest_restore_job_creation_date - # This is the creation date of the most recent restore job. + # The creation date of the most recent restore job. # @return [Time] # # @!attribute [rw] latest_restore_recovery_point_creation_date - # This is the date the most recent recovery point was created. + # The date the most recent recovery point was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeProtectedResourceOutput AWS API Documentation @@ -2974,7 +2965,7 @@ class DescribeProtectedResourceOutput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -2984,7 +2975,7 @@ class DescribeProtectedResourceOutput < Struct.new( # @return [String] # # @!attribute [rw] backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPointInput AWS API Documentation @@ -3005,21 +2996,20 @@ class DescribeRecoveryPointInput < Struct.new( # @!attribute [rw] backup_vault_name # 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 Region where they are created. They consist - # of lowercase letters, numbers, and hyphens. + # to create them and the Region where they are created. # @return [String] # # @!attribute [rw] backup_vault_arn # An ARN that uniquely identifies a backup vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] source_backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies the source # vault where the resource was originally backed up in; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:BackupVault`. If the - # recovery is restored to the same Amazon Web Services account or - # Region, this value will be `null`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. + # If the recovery is restored to the same Amazon Web Services account + # or Region, this value will be `null`. # @return [String] # # @!attribute [rw] resource_arn @@ -3065,7 +3055,10 @@ class DescribeRecoveryPointInput < Struct.new( # taken some action that causes the continuous backup to be disabled. # This can be caused by the removal of permissions, turning off # versioning, turning off events being sent to EventBridge, or - # disabling the EventBridge rules that are put in place by Backup. + # disabling the EventBridge rules that are put in place by Backup. For + # recovery points of Amazon S3, Amazon RDS, and Amazon Aurora + # resources, this status occurs when the retention period of a + # continuous backup rule is changed. # # To resolve `STOPPED` status, ensure that all requested permissions # are in place and that versioning is enabled on the S3 bucket. Once @@ -3123,14 +3116,13 @@ class DescribeRecoveryPointInput < Struct.new( # setting. The “transition to cold after days” setting cannot be # changed after a backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @!attribute [rw] encryption_key_arn @@ -3165,8 +3157,8 @@ class DescribeRecoveryPointInput < Struct.new( # @return [String] # # @!attribute [rw] composite_member_identifier - # This is the identifier of a resource within a composite group, such - # as nested (child) recovery point belonging to a composite (parent) + # The identifier of a resource within a composite group, such as + # nested (child) recovery point belonging to a composite (parent) # stack. The ID is transferred from the [ logical ID][1] within a # stack. # @@ -3181,13 +3173,11 @@ class DescribeRecoveryPointInput < Struct.new( # @return [Boolean] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The name of the resource that belongs to the specified backup. # @return [String] # # @!attribute [rw] vault_type - # This is the type of vault in which the described recovery point is - # stored. + # The type of vault in which the described recovery point is stored. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPointOutput AWS API Documentation @@ -3228,19 +3218,18 @@ class DescribeRecoveryPointOutput < Struct.new( class DescribeRegionSettingsInput < Aws::EmptyStructure; end # @!attribute [rw] resource_type_opt_in_preference - # Returns a list of all services along with the opt-in preferences in - # the Region. + # The services along with the opt-in preferences in the Region. # @return [Hash] # # @!attribute [rw] resource_type_management_preference # Returns whether Backup fully manages the backups for a resource # type. # - # For the benefits of full Backup management, see [ Full Backup + # For the benefits of full Backup management, see [Full Backup # management][1]. # # For a list of resource types and whether each supports full Backup - # management, see the [ Feature availability by resource][2] table. + # management, see the [Feature availability by resource][2] table. # # If `"DynamoDB":false`, you can enable full Backup management for # DynamoDB backup by enabling [ Backup's advanced DynamoDB backup @@ -3249,7 +3238,7 @@ class DescribeRegionSettingsInput < Aws::EmptyStructure; end # # # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management - # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli # @return [Hash] # @@ -3277,8 +3266,8 @@ class DescribeReportJobInput < Struct.new( end # @!attribute [rw] report_job - # A list of information about a report job, including its completion - # and creation times, report destination, unique report job ID, Amazon + # The information about a report job, including its completion and + # creation times, report destination, unique report job ID, Amazon # Resource Name (ARN), report template, status, and status message. # @return [Types::ReportJob] # @@ -3386,9 +3375,11 @@ class DescribeRestoreJobInput < Struct.new( # @return [Integer] # # @!attribute [rw] created_resource_arn - # An Amazon Resource Name (ARN) that uniquely identifies a resource - # whose recovery point is being restored. The format of the ARN - # depends on the resource type of the backed-up resource. + # The Amazon Resource Name (ARN) of the resource that was created by + # the restore job. + # + # The format of the ARN depends on the resource type of the backed-up + # resource. # @return [String] # # @!attribute [rw] resource_type @@ -3397,8 +3388,8 @@ class DescribeRestoreJobInput < Struct.new( # @return [String] # # @!attribute [rw] recovery_point_creation_date - # This is the creation date of the recovery point made by the specifed - # restore job. + # The creation date of the recovery point made by the specifed restore + # job. # @return [Time] # # @!attribute [rw] created_by @@ -3407,17 +3398,15 @@ class DescribeRestoreJobInput < Struct.new( # @return [Types::RestoreJobCreator] # # @!attribute [rw] validation_status - # This is the status of validation run on the indicated restore job. + # The status of validation run on the indicated restore job. # @return [String] # # @!attribute [rw] validation_status_message - # This describes the status of validation run on the indicated restore - # job. + # The status message. # @return [String] # # @!attribute [rw] deletion_status - # This notes the status of the data generated by the restore test. The - # status may be `Deleting`, `Failed`, or `Successful`. + # The status of the data generated by the restore test. # @return [String] # # @!attribute [rw] deletion_status_message @@ -3451,16 +3440,15 @@ class DescribeRestoreJobOutput < Struct.new( end # @!attribute [rw] backup_vault_name - # This is the name of a logical container where the child (nested) - # recovery point is stored. Backup vaults are identified by names that - # are unique to the account used to create them and the Amazon Web - # Services Region where they are created. They consist of lowercase - # letters, numbers, and hyphens. + # The name of a logical container where the child (nested) recovery + # point is stored. Backup vaults are identified by names that are + # unique to the account used to create them and the Amazon Web + # Services Region where they are created. # @return [String] # # @!attribute [rw] recovery_point_arn - # This is the Amazon Resource Name (ARN) that uniquely identifies the - # child (nested) recovery point; for example, + # The Amazon Resource Name (ARN) that uniquely identifies the child + # (nested) recovery point; for example, # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.` # @return [String] # @@ -3579,7 +3567,7 @@ class Framework < Struct.new( # @return [String] # # @!attribute [rw] control_input_parameters - # A list of `ParameterName` and `ParameterValue` pairs. + # The name/value pairs. # @return [Array] # # @!attribute [rw] control_scope @@ -3714,11 +3702,11 @@ class GetBackupPlanInput < Struct.new( # @return [Time] # # @!attribute [rw] last_execution_date - # The last time a job to back up resources was run with this backup - # plan. A date and time, in Unix format and Coordinated Universal Time - # (UTC). The value of `LastExecutionDate` is accurate to milliseconds. - # For example, the value 1516925490.087 represents Friday, January 26, - # 2018 12:11:30.087 AM. + # The last time this backup plan was run. A date and time, in Unix + # format and Coordinated Universal Time (UTC). The value of + # `LastExecutionDate` is accurate to milliseconds. For example, the + # value 1516925490.087 represents Friday, January 26, 2018 + # 12:11:30.087 AM. # @return [Time] # # @!attribute [rw] advanced_backup_settings @@ -3803,7 +3791,7 @@ class GetBackupSelectionOutput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultAccessPolicyInput AWS API Documentation @@ -3817,14 +3805,13 @@ class GetBackupVaultAccessPolicyInput < Struct.new( # @!attribute [rw] backup_vault_name # 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 Region where they are created. They consist - # of lowercase letters, numbers, and hyphens. + # to create them and the Region where they are created. # @return [String] # # @!attribute [rw] backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a backup # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] policy @@ -3845,7 +3832,7 @@ class GetBackupVaultAccessPolicyOutput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotificationsInput AWS API Documentation @@ -3859,14 +3846,13 @@ class GetBackupVaultNotificationsInput < Struct.new( # @!attribute [rw] backup_vault_name # 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 Region where they are created. They consist - # of lowercase letters, numbers, and hyphens. + # to create them and the Region where they are created. # @return [String] # # @!attribute [rw] backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a backup # vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] sns_topic_arn @@ -3892,8 +3878,7 @@ class GetBackupVaultNotificationsOutput < Struct.new( end # @!attribute [rw] legal_hold_id - # This is the ID required to use `GetLegalHold`. This unique ID is - # associated with a specific legal hold. + # The ID of the legal hold. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetLegalHoldInput AWS API Documentation @@ -3905,48 +3890,45 @@ class GetLegalHoldInput < Struct.new( end # @!attribute [rw] title - # This is the string title of the legal hold. + # The title of the legal hold. # @return [String] # # @!attribute [rw] status - # This is the status of the legal hold. Statuses can be `ACTIVE`, - # `CREATING`, `CANCELED`, and `CANCELING`. + # The status of the legal hold. # @return [String] # # @!attribute [rw] description - # This is the returned string description of the legal hold. + # The description of the legal hold. # @return [String] # # @!attribute [rw] cancel_description - # String describing the reason for removing the legal hold. + # The reason for removing the legal hold. # @return [String] # # @!attribute [rw] legal_hold_id - # This is the returned ID associated with a specified legal hold. + # The ID of the legal hold. # @return [String] # # @!attribute [rw] legal_hold_arn - # This is the returned framework ARN for the specified legal hold. An - # Amazon Resource Name (ARN) uniquely identifies a resource. The - # format of the ARN depends on the resource type. + # The framework ARN for the specified legal hold. The format of the + # ARN depends on the resource type. # @return [String] # # @!attribute [rw] creation_date - # Time in number format when legal hold was created. + # The time when the legal hold was created. # @return [Time] # # @!attribute [rw] cancellation_date - # Time in number when legal hold was cancelled. + # The time when the legal hold was cancelled. # @return [Time] # # @!attribute [rw] retain_record_until - # This is the date and time until which the legal hold record will be - # retained. + # The date and time until which the legal hold record is retained. # @return [Time] # # @!attribute [rw] recovery_point_selection - # This specifies criteria to assign a set of resources, such as - # resource types or backup vaults. + # The criteria to assign a set of resources, such as resource types or + # backup vaults. # @return [Types::RecoveryPointSelection] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetLegalHoldOutput AWS API Documentation @@ -3970,7 +3952,7 @@ class GetLegalHoldOutput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -3980,7 +3962,7 @@ class GetLegalHoldOutput < Struct.new( # @return [String] # # @!attribute [rw] backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetRecoveryPointRestoreMetadataInput AWS API Documentation @@ -3995,7 +3977,7 @@ class GetRecoveryPointRestoreMetadataInput < Struct.new( # @!attribute [rw] backup_vault_arn # An ARN that uniquely identifies a backup vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -4010,7 +3992,7 @@ class GetRecoveryPointRestoreMetadataInput < Struct.new( # @return [Hash] # # @!attribute [rw] resource_type - # This is the resource type associated with the recovery point. + # The resource type of the recovery point. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetRecoveryPointRestoreMetadataOutput AWS API Documentation @@ -4054,7 +4036,7 @@ class GetRestoreJobMetadataOutput < Struct.new( end # @!attribute [rw] backup_vault_account_id - # This is the account ID of the specified backup vault. + # The account ID of the specified backup vault. # @return [String] # # @!attribute [rw] backup_vault_name @@ -4152,6 +4134,10 @@ class GetRestoreTestingSelectionOutput < Struct.new( # # * `Aurora` for Amazon Aurora # + # * `CloudFormation` for CloudFormation + # + # * `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility) + # # * `DynamoDB` for Amazon DynamoDB # # * `EBS` for Amazon Elastic Block Store @@ -4160,15 +4146,24 @@ class GetRestoreTestingSelectionOutput < Struct.new( # # * `EFS` for Amazon Elastic File System # - # * `FSX` for Amazon FSx + # * `FSx` for Amazon FSx + # + # * `Neptune` for Amazon Neptune # # * `RDS` for Amazon Relational Database Service # + # * `Redshift` for Amazon Redshift + # + # * `S3` for Amazon Simple Storage Service (Amazon S3) + # + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances + # # * `Storage Gateway` for Storage Gateway # - # * `DocDB` for Amazon DocumentDB (with MongoDB compatibility) + # * `Timestream` for Amazon Timestream # - # * `Neptune` for Amazon Neptune + # * `VirtualMachine` for VMware virtual machines # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetSupportedResourceTypesOutput AWS API Documentation @@ -4298,34 +4293,32 @@ class KeyValue < Struct.new( # by resource IDs. # # @!attribute [rw] title - # This is the title of a legal hold. + # The title of a legal hold. # @return [String] # # @!attribute [rw] status - # This is the status of the legal hold. Statuses can be `ACTIVE`, - # `CREATING`, `CANCELED`, and `CANCELING`. + # The status of the legal hold. # @return [String] # # @!attribute [rw] description - # This is the description of a legal hold. + # The description of a legal hold. # @return [String] # # @!attribute [rw] legal_hold_id - # ID of specific legal hold on one or more recovery points. + # The ID of the legal hold. # @return [String] # # @!attribute [rw] legal_hold_arn - # This is an Amazon Resource Number (ARN) that uniquely identifies the - # legal hold; for example, + # The Amazon Resource Name (ARN) of the legal hold; for example, # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`. # @return [String] # # @!attribute [rw] creation_date - # This is the time in number format when legal hold was created. + # The time when the legal hold was created. # @return [Time] # # @!attribute [rw] cancellation_date - # This is the time in number format when legal hold was cancelled. + # The time when the legal hold was cancelled. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/LegalHold AWS API Documentation @@ -4342,39 +4335,42 @@ class LegalHold < Struct.new( include Aws::Structure end - # Contains an array of `Transition` objects specifying how long in days - # before a recovery point transitions to cold storage or is deleted. + # Specifies the time period, 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 “retention” - # 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. + # for a minimum of 90 days. Therefore, on the console, the retention + # setting must be 90 days greater than the transition to cold after days + # setting. The transition to cold after days setting can't be changed + # after a backup has been transitioned to cold. + # + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression for - # other resource types. + # To remove the existing lifecycle and retention periods and keep your + # recovery points indefinitely, specify -1 for + # `MoveToColdStorageAfterDays` and `DeleteAfterDays`. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # # @!attribute [rw] move_to_cold_storage_after_days - # Specifies the number of days after creation that a recovery point is - # moved to cold storage. + # The number of days after creation that a recovery point is moved to + # cold storage. # @return [Integer] # # @!attribute [rw] delete_after_days - # Specifies the number of days after creation that a recovery point is - # deleted. Must be greater than 90 days plus - # `MoveToColdStorageAfterDays`. + # The number of days after creation that a recovery point is deleted. + # This value must be at least 90 days after the number of days + # specified in `MoveToColdStorageAfterDays`. # @return [Integer] # # @!attribute [rw] opt_in_to_archive_for_supported_resources - # Optional Boolean. If this is true, this setting will instruct your - # backup plan to transition supported resources to archive (cold) - # storage tier in accordance with your lifecycle settings. + # If the value is true, your backup plan transitions supported + # resources to archive (cold) storage tier in accordance with your + # lifecycle settings. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/Lifecycle AWS API Documentation @@ -4484,19 +4480,17 @@ class LimitExceededException < Struct.new( # @return [String] # # @!attribute [rw] aggregation_period - # This is the period that sets the boundaries for returned results. - # - # Acceptable values include + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # @return [String] # # @!attribute [rw] max_results - # This parameter sets the maximum number of items to be returned. + # The maximum number of items to be returned. # # The value is an integer. Range of accepted values is from 1 to 500. # @return [Integer] @@ -4523,19 +4517,17 @@ class ListBackupJobSummariesInput < Struct.new( end # @!attribute [rw] backup_job_summaries - # This request returns a summary that contains Region, Account, State, - # ResourceType, MessageCategory, StartTime, EndTime, and Count of - # included jobs. + # The summary information. # @return [Array] # # @!attribute [rw] aggregation_period - # This is the period that sets the boundaries for returned results. + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # @return [String] # # @!attribute [rw] next_token @@ -4592,8 +4584,7 @@ class ListBackupJobSummariesOutput < Struct.new( # Returns only backup jobs that will be stored in the specified backup # vault. Backup vaults are identified by names that are unique to the # account used to create them and the Amazon Web Services Region where - # they are created. They consist of lowercase letters, numbers, and - # hyphens. + # they are created. # @return [String] # # @!attribute [rw] by_created_before @@ -4626,19 +4617,20 @@ class ListBackupJobSummariesOutput < Struct.new( # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # @return [String] # # @!attribute [rw] by_account_id @@ -4731,7 +4723,7 @@ class ListBackupJobsOutput < Struct.new( # @return [String] # # @!attribute [rw] max_results - # The maximum number of items to be returned. + # The maximum number of items to return. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanTemplatesInput AWS API Documentation @@ -4844,8 +4836,7 @@ class ListBackupPlansInput < Struct.new( # @return [String] # # @!attribute [rw] backup_plans_list - # An array of backup plan list items containing metadata about your - # saved backup plans. + # Information about the backup plans. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlansOutput AWS API Documentation @@ -5014,13 +5005,13 @@ class ListBackupVaultsOutput < Struct.new( # @return [String] # # @!attribute [rw] aggregation_period - # This is the period that sets the boundaries for returned results. + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # @return [String] # # @!attribute [rw] max_results @@ -5057,13 +5048,13 @@ class ListCopyJobSummariesInput < Struct.new( # @return [Array] # # @!attribute [rw] aggregation_period - # This is the period that sets the boundaries for returned results. + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # @return [String] # # @!attribute [rw] next_token @@ -5132,25 +5123,26 @@ class ListCopyJobSummariesOutput < Struct.new( # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # @return [String] # # @!attribute [rw] by_destination_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a source # backup vault to copy from; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] by_account_id @@ -5253,7 +5245,7 @@ class ListFrameworksInput < Struct.new( end # @!attribute [rw] frameworks - # A list of frameworks with details for each framework, including the + # The frameworks with details for each framework, including the # framework name, Amazon Resource Name (ARN), description, number of # controls, creation time, and deployment status. # @return [Array] @@ -5314,13 +5306,13 @@ class ListLegalHoldsOutput < Struct.new( end # @!attribute [rw] backup_vault_name - # This is the list of protected resources by backup vault within the - # vault(s) you specify by name. + # The list of protected resources by backup vault within the vault(s) + # you specify by name. # @return [String] # # @!attribute [rw] backup_vault_account_id - # This is the list of protected resources by backup vault within the - # vault(s) you specify by account ID. + # The list of protected resources by backup vault within the vault(s) + # you specify by account ID. # @return [String] # # @!attribute [rw] next_token @@ -5412,7 +5404,7 @@ class ListProtectedResourcesOutput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # # Backup vault name might not be available when a supported service # creates the backup. @@ -5462,19 +5454,20 @@ class ListProtectedResourcesOutput < Struct.new( # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # @return [String] # # @!attribute [rw] by_backup_plan_id @@ -5536,18 +5529,18 @@ class ListRecoveryPointsByBackupVaultOutput < Struct.new( end # @!attribute [rw] legal_hold_id - # This is the ID of the legal hold. + # The ID of the legal hold. # @return [String] # # @!attribute [rw] next_token - # This is the next item following a partial list of returned - # resources. For example, if a request is made to return `MaxResults` - # number of resources, `NextToken` allows you to return more items in - # your list starting at the location pointed to by the next token. + # The next item following a partial list of returned resources. For + # example, if a request is made to return `MaxResults` number of + # resources, `NextToken` allows you to return more items in your list + # starting at the location pointed to by the next token. # @return [String] # # @!attribute [rw] max_results - # This is the maximum number of resource list items to be returned. + # The maximum number of resource list items to be returned. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByLegalHoldInput AWS API Documentation @@ -5561,13 +5554,11 @@ class ListRecoveryPointsByLegalHoldInput < Struct.new( end # @!attribute [rw] recovery_points - # This is a list of the recovery points returned by - # `ListRecoveryPointsByLegalHold`. + # The recovery points. # @return [Array] # # @!attribute [rw] next_token - # This return is the next item following a partial list of returned - # resources. + # The next item following a partial list of returned resources. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByLegalHoldOutput AWS API Documentation @@ -5737,11 +5728,11 @@ class ListReportPlansInput < Struct.new( end # @!attribute [rw] report_plans - # A list of your report plans with detailed information for each plan. - # This information includes the Amazon Resource Name (ARN), report - # plan name, description, settings, delivery channel, deployment - # status, creation time, and last times the report plan attempted to - # and successfully ran. + # The report plans with detailed information for each plan. This + # information includes the Amazon Resource Name (ARN), report plan + # name, description, settings, delivery channel, deployment status, + # creation time, and last times the report plan attempted to and + # successfully ran. # @return [Array] # # @!attribute [rw] next_token @@ -5799,15 +5790,13 @@ class ListReportPlansOutput < Struct.new( # @return [String] # # @!attribute [rw] aggregation_period - # This is the period that sets the boundaries for returned results. + # The period for the returned results. # - # Acceptable values include + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. - # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # @return [String] # # @!attribute [rw] max_results @@ -5843,13 +5832,13 @@ class ListRestoreJobSummariesInput < Struct.new( # @return [Array] # # @!attribute [rw] aggregation_period - # This is the period that sets the boundaries for returned results. + # The period for the returned results. # - # * `ONE_DAY` for daily job count for the prior 14 days. + # * `ONE_DAY` - The daily job count for the prior 14 days. # - # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days. + # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days. # - # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days. + # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days. # @return [String] # # @!attribute [rw] next_token @@ -5971,19 +5960,20 @@ class ListRestoreJobsByProtectedResourceOutput < Struct.new( # # * `Neptune` for Amazon Neptune # + # * `RDS` for Amazon Relational Database Service + # # * `Redshift` for Amazon Redshift # - # * `RDS` for Amazon Relational Database Service + # * `S3` for Amazon Simple Storage Service (Amazon S3) # - # * `SAP HANA on Amazon EC2` for SAP HANA databases + # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic + # Compute Cloud instances # # * `Storage Gateway` for Storage Gateway # - # * `S3` for Amazon S3 - # # * `Timestream` for Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` for VMware virtual machines # @return [String] # # @!attribute [rw] by_created_before @@ -6175,8 +6165,7 @@ class ListTagsInput < Struct.new( # @return [String] # # @!attribute [rw] tags - # To help organize your resources, you can assign your own metadata to - # the resources you create. Each tag is a key-value pair. + # Information about the tags. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTagsOutput AWS API Documentation @@ -6236,18 +6225,17 @@ class MissingParameterValueException < Struct.new( # @return [Time] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The non-unique name of the resource that belongs to the specified + # backup. # @return [String] # # @!attribute [rw] last_backup_vault_arn - # This is the ARN (Amazon Resource Name) of the backup vault that - # contains the most recent backup recovery point. + # The ARN (Amazon Resource Name) of the backup vault that contains the + # most recent backup recovery point. # @return [String] # # @!attribute [rw] last_recovery_point_arn - # This is the ARN (Amazon Resource Name) of the most recent recovery - # point. + # The ARN (Amazon Resource Name) of the most recent recovery point. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ProtectedResource AWS API Documentation @@ -6263,12 +6251,8 @@ class ProtectedResource < Struct.new( include Aws::Structure end - # A list of conditions that you define for resources in your restore - # testing plan using tags. - # - # For example, `"StringEquals": \{ "Key": - # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition - # operators are case sensitive. + # The conditions that you define for resources in your restore testing + # plan using tags. # # @!attribute [rw] string_equals # Filters the values of your tagged resources for only those resources @@ -6294,7 +6278,7 @@ class ProtectedResourceConditions < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] policy @@ -6322,8 +6306,10 @@ class PutBackupVaultAccessPolicyInput < Struct.new( # require you to retain certain data for at least seven years (2555 # days). # - # If this parameter is not specified, Vault Lock will not enforce a - # minimum retention period. + # This parameter is required when a vault lock is created through + # CloudFormation; otherwise, this parameter is optional. If this + # parameter is not specified, Vault Lock will not enforce a minimum + # retention period. # # If this parameter is specified, any backup or copy job to the vault # must have a lifecycle policy with a retention period equal to or @@ -6395,7 +6381,7 @@ class PutBackupVaultLockConfigurationInput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] sns_topic_arn @@ -6422,10 +6408,10 @@ class PutBackupVaultLockConfigurationInput < Struct.new( # # * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED` # - # The list below shows items that are deprecated events (for - # reference) and are no longer in use. They are no longer supported - # and will not return statuses or notifications. Refer to the list - # above for current supported events. + # The list below includes both supported events and deprecated events + # that are no longer in use (for reference). Deprecated events do not + # return statuses or notifications. Refer to the list above for the + # supported events. # # # @@ -6449,7 +6435,7 @@ class PutBackupVaultNotificationsInput < Struct.new( # @return [String] # # @!attribute [rw] validation_status - # This is the status of your restore validation. + # The status of your restore validation. # @return [String] # # @!attribute [rw] validation_status_message @@ -6480,12 +6466,12 @@ class PutRestoreValidationResultInput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] backup_vault_arn # An ARN that uniquely identifies a backup vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] source_backup_vault_arn @@ -6524,8 +6510,7 @@ class PutRestoreValidationResultInput < Struct.new( # @return [String] # # @!attribute [rw] status_message - # A message explaining the reason of the recovery point deletion - # failure. + # A message explaining the current status of the recovery point. # @return [String] # # @!attribute [rw] creation_date @@ -6562,14 +6547,13 @@ class PutRestoreValidationResultInput < Struct.new( # The “transition to cold after days” setting cannot be changed after # a backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @!attribute [rw] encryption_key_arn @@ -6592,13 +6576,13 @@ class PutRestoreValidationResultInput < Struct.new( # @return [Time] # # @!attribute [rw] parent_recovery_point_arn - # This is the Amazon Resource Name (ARN) of the parent (composite) - # recovery point. + # The Amazon Resource Name (ARN) of the parent (composite) recovery + # point. # @return [String] # # @!attribute [rw] composite_member_identifier - # This is the identifier of a resource within a composite group, such - # as nested (child) recovery point belonging to a composite (parent) + # The identifier of a resource within a composite group, such as + # nested (child) recovery point belonging to a composite (parent) # stack. The ID is transferred from the [ logical ID][1] within a # stack. # @@ -6613,13 +6597,12 @@ class PutRestoreValidationResultInput < Struct.new( # @return [Boolean] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The non-unique name of the resource that belongs to the specified + # backup. # @return [String] # # @!attribute [rw] vault_type - # This is the type of vault in which the described recovery point is - # stored. + # The type of vault in which the described recovery point is stored. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByBackupVault AWS API Documentation @@ -6672,8 +6655,7 @@ class RecoveryPointByBackupVault < Struct.new( # @return [String] # # @!attribute [rw] status_message - # A message explaining the reason of the recovery point deletion - # failure. + # A message explaining the current status of the recovery point. # @return [String] # # @!attribute [rw] encryption_key_arn @@ -6690,7 +6672,7 @@ class RecoveryPointByBackupVault < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] is_parent @@ -6699,18 +6681,17 @@ class RecoveryPointByBackupVault < Struct.new( # @return [Boolean] # # @!attribute [rw] parent_recovery_point_arn - # This is the Amazon Resource Name (ARN) of the parent (composite) - # recovery point. + # The Amazon Resource Name (ARN) of the parent (composite) recovery + # point. # @return [String] # # @!attribute [rw] resource_name - # This is the non-unique name of the resource that belongs to the - # specified backup. + # The non-unique name of the resource that belongs to the specified + # backup. # @return [String] # # @!attribute [rw] vault_type - # This is the type of vault in which the described recovery point is - # stored. + # The type of vault in which the described recovery point is stored. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByResource AWS API Documentation @@ -6771,23 +6752,23 @@ class RecoveryPointCreator < Struct.new( # case they will no longer be a member. # # @!attribute [rw] recovery_point_arn - # This is the Amazon Resource Name (ARN) of the parent (composite) - # recovery point. + # The Amazon Resource Name (ARN) of the parent (composite) recovery + # point. # @return [String] # # @!attribute [rw] resource_arn - # This is the Amazon Resource Name (ARN) that uniquely identifies a - # saved resource. + # The Amazon Resource Name (ARN) that uniquely identifies a saved + # resource. # @return [String] # # @!attribute [rw] resource_type - # This is the Amazon Web Services resource type that is saved as a - # recovery point. + # The Amazon Web Services resource type that is saved as a recovery + # point. # @return [String] # # @!attribute [rw] backup_vault_name - # This is the name of the backup vault (the logical container in which - # backups are stored). + # The name of the backup vault (the logical container in which backups + # are stored). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointMember AWS API Documentation @@ -6851,7 +6832,7 @@ class RecoveryPointSelection < Struct.new( # @return [String] # # @!attribute [rw] formats - # A list of the format of your reports: `CSV`, `JSON`, or both. If not + # The format of your reports: `CSV`, `JSON`, or both. If not # specified, the default format is `CSV`. # @return [Array] # @@ -7059,6 +7040,8 @@ class ReportPlan < Struct.new( # # @!attribute [rw] accounts # These are the accounts to be included in the report. + # + # Use string value of `ROOT` to include all organizational units. # @return [Array] # # @!attribute [rw] organization_units @@ -7067,6 +7050,8 @@ class ReportPlan < Struct.new( # # @!attribute [rw] regions # These are the Regions to be included in the report. + # + # Use the wildcard as the string value to include all Regions. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ReportSetting AWS API Documentation @@ -7231,8 +7216,8 @@ class RestoreJobSummary < Struct.new( # @return [Integer] # # @!attribute [rw] iam_role_arn - # Specifies the IAM role ARN used to create the target recovery point; - # for example, `arn:aws:iam::123456789012:role/S3Access`. + # The IAM role ARN used to create the target recovery point; for + # example, `arn:aws:iam::123456789012:role/S3Access`. # @return [String] # # @!attribute [rw] expected_completion_time_minutes @@ -7263,7 +7248,7 @@ class RestoreJobSummary < Struct.new( # @return [Types::RestoreJobCreator] # # @!attribute [rw] validation_status - # This is the status of validation run on the indicated restore job. + # The status of validation run on the indicated restore job. # @return [String] # # @!attribute [rw] validation_status_message @@ -7309,10 +7294,35 @@ class RestoreJobsListMember < Struct.new( # This contains metadata about a restore testing plan. # # @!attribute [rw] recovery_point_selection - # Required: Algorithm; Required: Recovery point types; IncludeVaults - # (one or more). Optional: SelectionWindowDays ('30' if not - # specified); ExcludeVaults (list of selectors), defaults to empty - # list if not listed. + # `RecoveryPointSelection` has five parameters (three required and two + # optional). The values you specify determine which recovery point is + # included in the restore test. You must indicate with `Algorithm` if + # you want the latest recovery point within your `SelectionWindowDays` + # or if you want a random recovery point, and you must indicate + # through `IncludeVaults` from which vaults the recovery points can be + # chosen. + # + # `Algorithm` (*required*) Valid values: "`LATEST_WITHIN_WINDOW`" or + # "`RANDOM_WITHIN_WINDOW`". + # + # `Recovery point types` (*required*) Valid values: "`SNAPSHOT`" + # and/or "`CONTINUOUS`". Include `SNAPSHOT` to restore only snapshot + # recovery points; include `CONTINUOUS` to restore continuous recovery + # points (point in time restore / PITR); use both to restore either a + # snapshot or a continuous recovery point. The recovery point will be + # determined by the value for `Algorithm`. + # + # `IncludeVaults` (*required*). You must include one or more backup + # vaults. Use the wildcard \["*"\] or specific ARNs. + # + # `SelectionWindowDays` (*optional*) Value must be an integer (in + # days) from 1 to 365. If not included, the value defaults to `30`. + # + # `ExcludeVaults` (*optional*). You can choose to input one or more + # specific backup vault ARNs to exclude those vaults' contents from + # restore eligibility. Or, you can include a list of selectors. If + # this parameter and its value are not included, it defaults to empty + # list. # @return [Types::RestoreTestingRecoveryPointSelection] # # @!attribute [rw] restore_testing_plan_name @@ -7399,7 +7409,7 @@ class RestoreTestingPlanForCreate < Struct.new( # @return [String] # # @!attribute [rw] restore_testing_plan_name - # This is the restore testing plan name. + # The restore testing plan name. # @return [String] # # @!attribute [rw] schedule_expression @@ -7470,7 +7480,7 @@ class RestoreTestingPlanForGet < Struct.new( # @return [String] # # @!attribute [rw] restore_testing_plan_name - # This is the restore testing plan name. + # The restore testing plan name. # @return [String] # # @!attribute [rw] schedule_expression @@ -7549,10 +7559,33 @@ class RestoreTestingPlanForUpdate < Struct.new( include Aws::Structure end - # Required: Algorithm; Required: Recovery point types; IncludeVaults(one - # or more). Optional: SelectionWindowDays ('30' if not - # specified);ExcludeVaults (list of selectors), defaults to empty list - # if not listed. + # `RecoveryPointSelection` has five parameters (three required and two + # optional). The values you specify determine which recovery point is + # included in the restore test. You must indicate with `Algorithm` if + # you want the latest recovery point within your `SelectionWindowDays` + # or if you want a random recovery point, and you must indicate through + # `IncludeVaults` from which vaults the recovery points can be chosen. + # + # `Algorithm` (*required*) Valid values: "`LATEST_WITHIN_WINDOW`" or + # "`RANDOM_WITHIN_WINDOW`". + # + # `Recovery point types` (*required*) Valid values: "`SNAPSHOT`" + # and/or "`CONTINUOUS`". Include `SNAPSHOT` to restore only snapshot + # recovery points; include `CONTINUOUS` to restore continuous recovery + # points (point in time restore / PITR); use both to restore either a + # snapshot or a continuous recovery point. The recovery point will be + # determined by the value for `Algorithm`. + # + # `IncludeVaults` (*required*). You must include one or more backup + # vaults. Use the wildcard \["*"\] or specific ARNs. + # + # `SelectionWindowDays` (*optional*) Value must be an integer (in days) + # from 1 to 365. If not included, the value defaults to `30`. + # + # `ExcludeVaults` (*optional*). You can choose to input one or more + # specific backup vault ARNs to exclude those vaults' contents from + # restore eligibility. Or, you can include a list of selectors. If this + # parameter and its value are not included, it defaults to empty list. # # @!attribute [rw] algorithm # Acceptable values include "LATEST\_WITHIN\_WINDOW" or @@ -7573,6 +7606,12 @@ class RestoreTestingPlanForUpdate < Struct.new( # # @!attribute [rw] recovery_point_types # These are the types of recovery points. + # + # Include `SNAPSHOT` to restore only snapshot recovery points; include + # `CONTINUOUS` to restore continuous recovery points (point in time + # restore / PITR); use both to restore either a snapshot or a + # continuous recovery point. The recovery point will be determined by + # the value for `Algorithm`. # @return [Array] # # @!attribute [rw] selection_window_days @@ -7671,8 +7710,8 @@ class RestoreTestingRecoveryPointSelection < Struct.new( # @return [Hash] # # @!attribute [rw] restore_testing_selection_name - # This is the unique name of the restore testing selection that - # belongs to the related restore testing plan. + # The unique name of the restore testing selection that belongs to the + # related restore testing plan. # @return [String] # # @!attribute [rw] validation_window_hours @@ -7756,8 +7795,8 @@ class RestoreTestingSelectionForCreate < Struct.new( # @return [String] # # @!attribute [rw] restore_testing_selection_name - # This is the unique name of the restore testing selection that - # belongs to the related restore testing plan. + # The unique name of the restore testing selection that belongs to the + # related restore testing plan. # @return [String] # # @!attribute [rw] validation_window_hours @@ -7787,11 +7826,10 @@ class RestoreTestingSelectionForGet < Struct.new( # This contains metadata about a restore testing selection. # # @!attribute [rw] creation_time - # This is the date and time that a restore testing selection was - # created, in Unix format and Coordinated Universal Time (UTC). The - # value of `CreationTime` is accurate to milliseconds. For example, - # the value 1516925490.087 represents Friday, January 26,2018 - # 12:11:30.087 AM. + # The date and time that a restore testing selection was created, in + # Unix format and Coordinated Universal Time (UTC). The value of + # `CreationTime` is accurate to milliseconds. For example, the value + # 1516925490.087 represents Friday, January 26,2018 12:11:30.087 AM. # @return [Time] # # @!attribute [rw] iam_role_arn @@ -7853,12 +7891,8 @@ class RestoreTestingSelectionForList < Struct.new( # @return [Array] # # @!attribute [rw] protected_resource_conditions - # A list of conditions that you define for resources in your restore - # testing plan using tags. - # - # For example, `"StringEquals": \{ "Key": - # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition - # operators are case sensitive. + # The conditions that you define for resources in your restore testing + # plan using tags. # @return [Types::ProtectedResourceConditions] # # @!attribute [rw] restore_metadata_overrides @@ -7922,7 +7956,7 @@ class ServiceUnavailableException < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] resource_arn @@ -7983,27 +8017,24 @@ class ServiceUnavailableException < Struct.new( # The “transition to cold after days” setting cannot be changed after # a backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # This parameter has a maximum value of 100 years (36,500 days). # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @!attribute [rw] recovery_point_tags - # To help organize your resources, you can assign your own metadata to - # the resources that you create. Each tag is a key-value pair. + # The tags to assign to the resources. # @return [Hash] # # @!attribute [rw] backup_options - # Specifies the backup option for a selected resource. This option is - # only available for Windows Volume Shadow Copy Service (VSS) backup - # jobs. + # The backup option for a selected resource. This option is only + # available for Windows Volume Shadow Copy Service (VSS) backup jobs. # # Valid values: Set to `"WindowsVSS":"enabled"` to enable the # `WindowsVSS` backup option and create a Windows VSS backup. Set to @@ -8072,14 +8103,13 @@ class StartBackupJobOutput < Struct.new( # The name of a logical source container where backups are stored. # Backup vaults are identified by names that are unique to the account # used to create them and the Amazon Web Services Region where they - # are created. They consist of lowercase letters, numbers, and - # hyphens. + # are created. # @return [String] # # @!attribute [rw] destination_backup_vault_arn # An Amazon Resource Name (ARN) that uniquely identifies a destination # backup vault to copy to; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] iam_role_arn @@ -8095,24 +8125,26 @@ class StartBackupJobOutput < Struct.new( # @return [String] # # @!attribute [rw] lifecycle - # Contains an array of `Transition` objects specifying how long in - # days before a recovery point transitions to cold storage or is - # deleted. + # Specifies the time period, 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 “retention” - # setting must be 90 days greater than the “transition to cold after - # days” setting. The “transition to cold after days” setting cannot be + # for a minimum of 90 days. Therefore, on the console, the retention + # setting must be 90 days greater than the transition to cold after + # days setting. The transition to cold after days setting can't be # changed after a backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # + # To remove the existing lifecycle and retention periods and keep your + # recovery points indefinitely, specify -1 for + # `MoveToColdStorageAfterDays` and `DeleteAfterDays`. # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJobInput AWS API Documentation @@ -8197,8 +8229,7 @@ class StartReportJobOutput < Struct.new( # @return [String] # # @!attribute [rw] metadata - # A set of metadata key-value pairs. Contains information, such as a - # resource name, required to restore a recovery point. + # A set of metadata key-value pairs. # # You can get configuration metadata about a resource at the time it # was backed up by calling `GetRecoveryPointRestoreMetadata`. However, @@ -8207,36 +8238,56 @@ class StartReportJobOutput < Struct.new( # 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: + # For more information about the metadata for each resource, see the + # following: + # + # * [Metadata for Amazon Aurora][1] + # + # * [Metadata for Amazon DocumentDB][2] + # + # * [Metadata for CloudFormation][3] + # + # * [Metadata for Amazon DynamoDB][4] + # + # * [ Metadata for Amazon EBS][5] + # + # * [Metadata for Amazon EC2][6] + # + # * [Metadata for Amazon EFS][7] + # + # * [Metadata for Amazon FSx][8] # - # * `file-system-id`: The ID of the Amazon EFS file system that is - # backed up by Backup. Returned in - # `GetRecoveryPointRestoreMetadata`. + # * [Metadata for Amazon Neptune][9] # - # * `Encrypted`: A Boolean value that, if true, specifies that the - # file system is encrypted. If `KmsKeyId` is specified, `Encrypted` - # must be set to `true`. + # * [Metadata for Amazon RDS][10] # - # * `KmsKeyId`: Specifies the Amazon Web Services KMS key that is used - # to encrypt the restored file system. You can specify a key from - # another Amazon Web Services account provided that key it is - # properly shared with your account via Amazon Web Services KMS. + # * [Metadata for Amazon Redshift][11] # - # * `PerformanceMode`: Specifies the throughput mode of the file - # system. + # * [Metadata for Storage Gateway][12] # - # * `CreationToken`: A user-supplied value that ensures the uniqueness - # (idempotency) of the request. + # * [Metadata for Amazon S3][13] # - # * `newFileSystem`: A Boolean value that, if true, specifies that the - # recovery point is restored to a new Amazon EFS file system. + # * [Metadata for Amazon Timestream][14] # - # * `ItemsToRestore`: An array of one to five strings where each - # string is a file path. Use `ItemsToRestore` to restore specific - # files or directories rather than the entire file system. This - # parameter is optional. For example, - # `"itemsToRestore":"["/my.test"]"`. + # * [Metadata for virtual machines][15] + # + # + # + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli + # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli + # [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli + # [4]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli + # [5]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli + # [6]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli + # [7]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli + # [8]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli + # [9]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli + # [10]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli + # [11]: https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api + # [12]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli + # [13]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli + # [14]: https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api + # [15]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli # @return [Hash] # # @!attribute [rw] iam_role_arn @@ -8256,35 +8307,35 @@ class StartReportJobOutput < Struct.new( # Starts a job to restore a recovery point for one of the following # resources: # - # * `Aurora` for Amazon Aurora + # * `Aurora` - Amazon Aurora # - # * `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility) + # * `DocumentDB` - Amazon DocumentDB # - # * `CloudFormation` for CloudFormation + # * `CloudFormation` - CloudFormation # - # * `DynamoDB` for Amazon DynamoDB + # * `DynamoDB` - Amazon DynamoDB # - # * `EBS` for Amazon Elastic Block Store + # * `EBS` - Amazon Elastic Block Store # - # * `EC2` for Amazon Elastic Compute Cloud + # * `EC2` - Amazon Elastic Compute Cloud # - # * `EFS` for Amazon Elastic File System + # * `EFS` - Amazon Elastic File System # - # * `FSx` for Amazon FSx + # * `FSx` - Amazon FSx # - # * `Neptune` for Amazon Neptune + # * `Neptune` - Amazon Neptune # - # * `RDS` for Amazon Relational Database Service + # * `RDS` - Amazon Relational Database Service # - # * `Redshift` for Amazon Redshift + # * `Redshift` - Amazon Redshift # - # * `Storage Gateway` for Storage Gateway + # * `Storage Gateway` - Storage Gateway # - # * `S3` for Amazon S3 + # * `S3` - Amazon Simple Storage Service # - # * `Timestream` for Amazon Timestream + # * `Timestream` - Amazon Timestream # - # * `VirtualMachine` for virtual machines + # * `VirtualMachine` - Virtual machines # @return [String] # # @!attribute [rw] copy_source_tags_to_restored_resource @@ -8334,6 +8385,12 @@ class StopBackupJobInput < Struct.new( # @!attribute [rw] resource_arn # An ARN that uniquely identifies a resource. The format of the ARN # depends on the type of the tagged resource. + # + # ARNs that do not include `backup` are incompatible with tagging. + # `TagResource` and `UntagResource` with invalid ARNs will result in + # an error. Acceptable ARN content can include + # `arn:aws:backup:us-east`. Invalid ARN content may look like + # `arn:aws:ec2:us-east`. # @return [String] # # @!attribute [rw] tags @@ -8355,11 +8412,16 @@ class TagResourceInput < Struct.new( # @!attribute [rw] resource_arn # An ARN that uniquely identifies a resource. The format of the ARN # depends on the type of the tagged resource. + # + # ARNs that do not include `backup` are incompatible with tagging. + # `TagResource` and `UntagResource` with invalid ARNs will result in + # an error. Acceptable ARN content can include + # `arn:aws:backup:us-east`. Invalid ARN content may look like + # `arn:aws:ec2:us-east`. # @return [String] # # @!attribute [rw] tag_key_list - # A list of keys to identify which key-value tags to remove from a - # resource. + # The keys to identify which key-value tags to remove from a resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UntagResourceInput AWS API Documentation @@ -8372,12 +8434,12 @@ class UntagResourceInput < Struct.new( end # @!attribute [rw] backup_plan_id - # Uniquely identifies a backup plan. + # The ID of the backup plan. # @return [String] # # @!attribute [rw] backup_plan - # Specifies the body of a backup plan. Includes a `BackupPlanName` and - # one or more sets of `Rules`. + # The body of a backup plan. Includes a `BackupPlanName` and one or + # more sets of `Rules`. # @return [Types::BackupPlanInput] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlanInput AWS API Documentation @@ -8439,8 +8501,8 @@ class UpdateBackupPlanOutput < Struct.new( # @return [String] # # @!attribute [rw] framework_controls - # A list of the controls that make up the framework. Each control in - # the list has a name, input parameters, and scope. + # The controls that make up the framework. Each control in the list + # has a name, input parameters, and scope. # @return [Array] # # @!attribute [rw] idempotency_token @@ -8510,7 +8572,7 @@ class UpdateGlobalSettingsInput < Struct.new( # 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 Amazon Web Services Region where they are - # created. They consist of lowercase letters, numbers, and hyphens. + # created. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -8543,7 +8605,7 @@ class UpdateRecoveryPointLifecycleInput < Struct.new( # @!attribute [rw] backup_vault_arn # An ARN that uniquely identifies a backup vault; for example, - # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`. + # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. # @return [String] # # @!attribute [rw] recovery_point_arn @@ -8563,14 +8625,13 @@ class UpdateRecoveryPointLifecycleInput < Struct.new( # The “transition to cold after days” setting cannot be changed after # a backup has been transitioned to cold. # - # Resource types that are able to be transitioned to cold storage are - # listed in the "Lifecycle to cold storage" section of the [ Feature - # availability by resource][1] table. Backup ignores this expression - # for other resource types. + # Resource types that can transition to cold storage are listed in the + # [Feature availability by resource][1] table. Backup ignores this + # expression for other resource types. # # # - # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource # @return [Types::Lifecycle] # # @!attribute [rw] calculated_lifecycle @@ -8636,14 +8697,14 @@ class UpdateRegionSettingsInput < Struct.new( # @return [String] # # @!attribute [rw] report_delivery_channel - # A structure that contains information about where to deliver your - # reports, specifically your Amazon S3 bucket name, S3 key prefix, and - # the formats of your reports. + # The information about where to deliver your reports, specifically + # your Amazon S3 bucket name, S3 key prefix, and the formats of your + # reports. # @return [Types::ReportDeliveryChannel] # # @!attribute [rw] report_setting - # Identifies the report template for the report. Reports are built - # using a report template. The report templates are: + # The report template for the report. Reports are built using a report + # template. The report templates are: # # `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` @@ -8706,7 +8767,7 @@ class UpdateReportPlanOutput < Struct.new( # @return [Types::RestoreTestingPlanForUpdate] # # @!attribute [rw] restore_testing_plan_name - # This is the restore testing plan name you wish to update. + # The name of the restore testing plan name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingPlanInput AWS API Documentation @@ -8719,7 +8780,7 @@ class UpdateRestoreTestingPlanInput < Struct.new( end # @!attribute [rw] creation_time - # This is the time the resource testing plan was created. + # The time the resource testing plan was created. # @return [Time] # # @!attribute [rw] restore_testing_plan_arn @@ -8732,7 +8793,7 @@ class UpdateRestoreTestingPlanInput < Struct.new( # @return [String] # # @!attribute [rw] update_time - # This is the time the update completed for the restore testing plan. + # The time the update completed for the restore testing plan. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingPlanOutput AWS API Documentation @@ -8760,8 +8821,8 @@ class UpdateRestoreTestingPlanOutput < Struct.new( # @return [Types::RestoreTestingSelectionForUpdate] # # @!attribute [rw] restore_testing_selection_name - # This is the required restore testing selection name of the restore - # testing selection you wish to update. + # The required restore testing selection name of the restore testing + # selection you wish to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingSelectionInput AWS API Documentation @@ -8775,8 +8836,7 @@ class UpdateRestoreTestingSelectionInput < Struct.new( end # @!attribute [rw] creation_time - # This is the time the resource testing selection was updated - # successfully. + # The time the resource testing selection was updated successfully. # @return [Time] # # @!attribute [rw] restore_testing_plan_arn @@ -8784,17 +8844,16 @@ class UpdateRestoreTestingSelectionInput < Struct.new( # @return [String] # # @!attribute [rw] restore_testing_plan_name - # This is the restore testing plan with which the updated restore - # testing selection is associated. + # The restore testing plan with which the updated restore testing + # selection is associated. # @return [String] # # @!attribute [rw] restore_testing_selection_name - # This is the returned restore testing selection name. + # The returned restore testing selection name. # @return [String] # # @!attribute [rw] update_time - # This is the time the update completed for the restore testing - # selection. + # The time the update completed for the restore testing selection. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingSelectionOutput AWS API Documentation diff --git a/gems/aws-sdk-backup/sig/client.rbs b/gems/aws-sdk-backup/sig/client.rbs index c240ad6279c..77b02e525db 100644 --- a/gems/aws-sdk-backup/sig/client.rbs +++ b/gems/aws-sdk-backup/sig/client.rbs @@ -483,6 +483,7 @@ module Aws def backup_vault_name: () -> ::String def backup_vault_arn: () -> ::String def vault_type: () -> ("BACKUP_VAULT" | "LOGICALLY_AIR_GAPPED_BACKUP_VAULT") + def vault_state: () -> ("CREATING" | "AVAILABLE" | "FAILED") def encryption_key_arn: () -> ::String def creation_date: () -> ::Time def creator_request_id: () -> ::String diff --git a/gems/aws-sdk-backup/sig/types.rbs b/gems/aws-sdk-backup/sig/types.rbs index 62e3a5bb480..3dfc0391347 100644 --- a/gems/aws-sdk-backup/sig/types.rbs +++ b/gems/aws-sdk-backup/sig/types.rbs @@ -150,6 +150,8 @@ module Aws::Backup class BackupVaultListMember attr_accessor backup_vault_name: ::String attr_accessor backup_vault_arn: ::String + attr_accessor vault_type: ("BACKUP_VAULT" | "LOGICALLY_AIR_GAPPED_BACKUP_VAULT") + attr_accessor vault_state: ("CREATING" | "AVAILABLE" | "FAILED") attr_accessor creation_date: ::Time attr_accessor encryption_key_arn: ::String attr_accessor creator_request_id: ::String @@ -532,6 +534,7 @@ module Aws::Backup attr_accessor backup_vault_name: ::String attr_accessor backup_vault_arn: ::String attr_accessor vault_type: ("BACKUP_VAULT" | "LOGICALLY_AIR_GAPPED_BACKUP_VAULT") + attr_accessor vault_state: ("CREATING" | "AVAILABLE" | "FAILED") attr_accessor encryption_key_arn: ::String attr_accessor creation_date: ::Time attr_accessor creator_request_id: ::String diff --git a/gems/aws-sdk-cloudwatchlogs/CHANGELOG.md b/gems/aws-sdk-cloudwatchlogs/CHANGELOG.md index e6c6cb01f29..9a823559f00 100644 --- a/gems/aws-sdk-cloudwatchlogs/CHANGELOG.md +++ b/gems/aws-sdk-cloudwatchlogs/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.89.0 (2024-08-30) +------------------ + +* Feature - This release introduces a new optional parameter: Entity, in PutLogEvents request + 1.88.0 (2024-07-30) ------------------ diff --git a/gems/aws-sdk-cloudwatchlogs/VERSION b/gems/aws-sdk-cloudwatchlogs/VERSION index 59be592144c..636ea711ad9 100644 --- a/gems/aws-sdk-cloudwatchlogs/VERSION +++ b/gems/aws-sdk-cloudwatchlogs/VERSION @@ -1 +1 @@ -1.88.0 +1.89.0 diff --git a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs.rb b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs.rb index b217da7a89a..c83b13b1a4b 100644 --- a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs.rb +++ b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs.rb @@ -53,6 +53,6 @@ # @!group service module Aws::CloudWatchLogs - GEM_VERSION = '1.88.0' + GEM_VERSION = '1.89.0' end diff --git a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb index 23c95af9f22..277784b51a6 100644 --- a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb +++ b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb @@ -2463,18 +2463,17 @@ def disassociate_kms_key(params = {}, options = {}) # @option params [Array] :log_stream_names # Filters the results to only logs from the log streams in this list. # - # If you specify a value for both `logStreamNamePrefix` and - # `logStreamNames`, the action returns an `InvalidParameterException` - # error. + # If you specify a value for both `logStreamNames` and + # `logStreamNamePrefix`, the action returns an + # `InvalidParameterException` error. # # @option params [String] :log_stream_name_prefix # Filters the results to include only events from log streams that have # names starting with this prefix. # # If you specify a value for both `logStreamNamePrefix` and - # `logStreamNames`, but the value for `logStreamNamePrefix` does not - # match any log stream names specified in `logStreamNames`, the action - # returns an `InvalidParameterException` error. + # `logStreamNames`, the action returns an `InvalidParameterException` + # error. # # @option params [Integer] :start_time # The start of the time range, expressed as the number of milliseconds @@ -3400,11 +3399,11 @@ def list_tags_log_group(params = {}, options = {}) # [PutDestination][5], for cross-account delivery. Kinesis Data # Streams and Firehose are supported as logical destinations. # - # Each account can have one account-level subscription filter policy. If - # you are updating an existing filter, you must specify the correct name - # in `PolicyName`. To perform a `PutAccountPolicy` subscription filter - # operation for any destination except a Lambda function, you must also - # have the `iam:PassRole` permission. + # Each account can have one account-level subscription filter policy per + # Region. If you are updating an existing filter, you must specify the + # correct name in `PolicyName`. To perform a `PutAccountPolicy` + # subscription filter operation for any destination except a Lambda + # function, you must also have the `iam:PassRole` permission. # # # @@ -3489,7 +3488,7 @@ def list_tags_log_group(params = {}, options = {}) # * **FilterPattern** A filter pattern for subscribing to a filtered # stream of log events. # - # * **Distribution**The method used to distribute log data to the + # * **Distribution** The method used to distribute log data to the # destination. By default, log data is grouped by log stream, but the # grouping can be set to `Random` for a more even distribution. This # property is only applicable when the destination is an Kinesis Data @@ -3896,9 +3895,11 @@ def put_delivery_destination_policy(params = {}, options = {}) # @option params [required, String] :log_type # Defines the type of log that the source is sending. # + # * For Amazon Bedrock, the valid value is `APPLICATION_LOGS`. + # # * For Amazon CodeWhisperer, the valid value is `EVENT_LOGS`. # - # * For IAM Identity Centerr, the valid value is `ERROR_LOGS`. + # * For IAM Identity Center, the valid value is `ERROR_LOGS`. # # * For Amazon WorkMail, the valid values are `ACCESS_CONTROL_LOGS`, # `AUTHENTICATION_LOGS`, `WORKMAIL_AVAILABILITY_PROVIDER_LOGS`, and @@ -4142,10 +4143,14 @@ def put_destination_policy(params = {}, options = {}) # `InvalidSequenceTokenException` or `DataAlreadyAcceptedException` even # if the sequence token is not valid. # + # @option params [Types::Entity] :entity + # Reserved for future use. + # # @return [Types::PutLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutLogEventsResponse#next_sequence_token #next_sequence_token} => String # * {Types::PutLogEventsResponse#rejected_log_events_info #rejected_log_events_info} => Types::RejectedLogEventsInfo + # * {Types::PutLogEventsResponse#rejected_entity_info #rejected_entity_info} => Types::RejectedEntityInfo # # @example Request syntax with placeholder values # @@ -4159,6 +4164,14 @@ def put_destination_policy(params = {}, options = {}) # }, # ], # sequence_token: "SequenceToken", + # entity: { + # key_attributes: { + # "EntityKeyAttributesKey" => "EntityKeyAttributesValue", + # }, + # attributes: { + # "EntityAttributesKey" => "EntityAttributesValue", + # }, + # }, # }) # # @example Response structure @@ -4167,6 +4180,7 @@ def put_destination_policy(params = {}, options = {}) # resp.rejected_log_events_info.too_new_log_event_start_index #=> Integer # resp.rejected_log_events_info.too_old_log_event_end_index #=> Integer # resp.rejected_log_events_info.expired_log_event_end_index #=> Integer + # resp.rejected_entity_info.error_type #=> String, one of "InvalidEntity", "InvalidTypeValue", "InvalidKeyAttributes", "InvalidAttributes", "EntitySizeTooLarge", "UnsupportedLogGroupType", "MissingRequiredFields" # # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEvents AWS API Documentation # @@ -4185,6 +4199,14 @@ def put_log_events(params = {}, options = {}) # The maximum number of metric filters that can be associated with a log # group is 100. # + # Using regular expressions to create metric filters is supported. For + # these filters, there is a quotas of quota of two regular expression + # patterns within a single filter pattern. There is also a quota of five + # regular expression patterns per log group. For more information about + # using regular expressions in metric filters, see [ Filter pattern + # syntax for metric filters, subscription filters, filter log events, + # and Live Tail][2]. + # # When you create a metric filter, you can also optionally assign a unit # and dimensions to the metric that is created. # @@ -4200,12 +4222,13 @@ def put_log_events(params = {}, options = {}) # # You can also set up a billing alarm to alert you if your charges are # higher than expected. For more information, see [ Creating a Billing - # Alarm to Monitor Your Estimated Amazon Web Services Charges][2]. + # Alarm to Monitor Your Estimated Amazon Web Services Charges][3]. # # # # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html - # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html + # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html + # [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html # # @option params [required, String] :log_group_name # The name of the log group. @@ -4497,6 +4520,14 @@ def put_retention_policy(params = {}, options = {}) # it. If you are updating an existing filter, you must specify the # correct name in `filterName`. # + # Using regular expressions to create subscription filters is supported. + # For these filters, there is a quotas of quota of two regular + # expression patterns within a single filter pattern. There is also a + # quota of five regular expression patterns per log group. For more + # information about using regular expressions in subscription filters, + # see [ Filter pattern syntax for metric filters, subscription filters, + # filter log events, and Live Tail][3]. + # # To perform a `PutSubscriptionFilter` operation for any destination # except a Lambda function, you must also have the `iam:PassRole` # permission. @@ -4505,6 +4536,7 @@ def put_retention_policy(params = {}, options = {}) # # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html + # [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html # # @option params [required, String] :log_group_name # The name of the log group. @@ -4630,8 +4662,8 @@ def put_subscription_filter(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionStart.html # [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionUpdate.html - # [4]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionStreamingException.html - # [5]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionTimeoutException.html + # [4]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionStreamingException + # [5]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionTimeoutException # [6]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/example_cloudwatch-logs_StartLiveTail_section.html # # @option params [required, Array] :log_group_identifiers @@ -5382,7 +5414,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-cloudwatchlogs' - context[:gem_version] = '1.88.0' + context[:gem_version] = '1.89.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client_api.rb b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client_api.rb index c9fb416a00c..63113a15f8f 100644 --- a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client_api.rb +++ b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client_api.rb @@ -119,6 +119,14 @@ module ClientApi Distribution = Shapes::StringShape.new(name: 'Distribution') DynamicTokenPosition = Shapes::IntegerShape.new(name: 'DynamicTokenPosition') EncryptionKey = Shapes::StringShape.new(name: 'EncryptionKey') + Entity = Shapes::StructureShape.new(name: 'Entity') + EntityAttributes = Shapes::MapShape.new(name: 'EntityAttributes') + EntityAttributesKey = Shapes::StringShape.new(name: 'EntityAttributesKey') + EntityAttributesValue = Shapes::StringShape.new(name: 'EntityAttributesValue') + EntityKeyAttributes = Shapes::MapShape.new(name: 'EntityKeyAttributes') + EntityKeyAttributesKey = Shapes::StringShape.new(name: 'EntityKeyAttributesKey') + EntityKeyAttributesValue = Shapes::StringShape.new(name: 'EntityKeyAttributesValue') + EntityRejectionErrorType = Shapes::StringShape.new(name: 'EntityRejectionErrorType') Enumerations = Shapes::MapShape.new(name: 'Enumerations') EpochMillis = Shapes::IntegerShape.new(name: 'EpochMillis') EvaluationFrequency = Shapes::StringShape.new(name: 'EvaluationFrequency') @@ -283,6 +291,7 @@ module ClientApi QueryStatistics = Shapes::StructureShape.new(name: 'QueryStatistics') QueryStatus = Shapes::StringShape.new(name: 'QueryStatus') QueryString = Shapes::StringShape.new(name: 'QueryString') + RejectedEntityInfo = Shapes::StructureShape.new(name: 'RejectedEntityInfo') RejectedLogEventsInfo = Shapes::StructureShape.new(name: 'RejectedLogEventsInfo') RequestId = Shapes::StringShape.new(name: 'RequestId') ResourceAlreadyExistsException = Shapes::StructureShape.new(name: 'ResourceAlreadyExistsException') @@ -687,6 +696,16 @@ module ClientApi DisassociateKmsKeyRequest.add_member(:resource_identifier, Shapes::ShapeRef.new(shape: ResourceIdentifier, location_name: "resourceIdentifier")) DisassociateKmsKeyRequest.struct_class = Types::DisassociateKmsKeyRequest + Entity.add_member(:key_attributes, Shapes::ShapeRef.new(shape: EntityKeyAttributes, location_name: "keyAttributes")) + Entity.add_member(:attributes, Shapes::ShapeRef.new(shape: EntityAttributes, location_name: "attributes")) + Entity.struct_class = Types::Entity + + EntityAttributes.key = Shapes::ShapeRef.new(shape: EntityAttributesKey) + EntityAttributes.value = Shapes::ShapeRef.new(shape: EntityAttributesValue) + + EntityKeyAttributes.key = Shapes::ShapeRef.new(shape: EntityKeyAttributesKey) + EntityKeyAttributes.value = Shapes::ShapeRef.new(shape: EntityKeyAttributesValue) + Enumerations.key = Shapes::ShapeRef.new(shape: TokenString) Enumerations.value = Shapes::ShapeRef.new(shape: TokenValue) @@ -1063,10 +1082,12 @@ module ClientApi PutLogEventsRequest.add_member(:log_stream_name, Shapes::ShapeRef.new(shape: LogStreamName, required: true, location_name: "logStreamName")) PutLogEventsRequest.add_member(:log_events, Shapes::ShapeRef.new(shape: InputLogEvents, required: true, location_name: "logEvents")) PutLogEventsRequest.add_member(:sequence_token, Shapes::ShapeRef.new(shape: SequenceToken, location_name: "sequenceToken")) + PutLogEventsRequest.add_member(:entity, Shapes::ShapeRef.new(shape: Entity, location_name: "entity")) PutLogEventsRequest.struct_class = Types::PutLogEventsRequest PutLogEventsResponse.add_member(:next_sequence_token, Shapes::ShapeRef.new(shape: SequenceToken, location_name: "nextSequenceToken")) PutLogEventsResponse.add_member(:rejected_log_events_info, Shapes::ShapeRef.new(shape: RejectedLogEventsInfo, location_name: "rejectedLogEventsInfo")) + PutLogEventsResponse.add_member(:rejected_entity_info, Shapes::ShapeRef.new(shape: RejectedEntityInfo, location_name: "rejectedEntityInfo")) PutLogEventsResponse.struct_class = Types::PutLogEventsResponse PutMetricFilterRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName, required: true, location_name: "logGroupName")) @@ -1137,6 +1158,9 @@ module ClientApi QueryStatistics.add_member(:bytes_scanned, Shapes::ShapeRef.new(shape: StatsValue, location_name: "bytesScanned")) QueryStatistics.struct_class = Types::QueryStatistics + RejectedEntityInfo.add_member(:error_type, Shapes::ShapeRef.new(shape: EntityRejectionErrorType, required: true, location_name: "errorType")) + RejectedEntityInfo.struct_class = Types::RejectedEntityInfo + RejectedLogEventsInfo.add_member(:too_new_log_event_start_index, Shapes::ShapeRef.new(shape: LogEventIndex, location_name: "tooNewLogEventStartIndex")) RejectedLogEventsInfo.add_member(:too_old_log_event_end_index, Shapes::ShapeRef.new(shape: LogEventIndex, location_name: "tooOldLogEventEndIndex")) RejectedLogEventsInfo.add_member(:expired_log_event_end_index, Shapes::ShapeRef.new(shape: LogEventIndex, location_name: "expiredLogEventEndIndex")) diff --git a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb index bb548f8e38b..ce356beed79 100644 --- a/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb +++ b/gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb @@ -1896,6 +1896,25 @@ class DisassociateKmsKeyRequest < Struct.new( include Aws::Structure end + # Reserved for future use. + # + # @!attribute [rw] key_attributes + # Reserved for future use. + # @return [Hash] + # + # @!attribute [rw] attributes + # Reserved for future use. + # @return [Hash] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/Entity AWS API Documentation + # + class Entity < Struct.new( + :key_attributes, + :attributes) + SENSITIVE = [] + include Aws::Structure + end + # Represents an export task. # # @!attribute [rw] task_id @@ -2018,9 +2037,9 @@ class ExportTaskStatus < Struct.new( # @!attribute [rw] log_stream_names # Filters the results to only logs from the log streams in this list. # - # If you specify a value for both `logStreamNamePrefix` and - # `logStreamNames`, the action returns an `InvalidParameterException` - # error. + # If you specify a value for both `logStreamNames` and + # `logStreamNamePrefix`, the action returns an + # `InvalidParameterException` error. # @return [Array] # # @!attribute [rw] log_stream_name_prefix @@ -2028,9 +2047,8 @@ class ExportTaskStatus < Struct.new( # have names starting with this prefix. # # If you specify a value for both `logStreamNamePrefix` and - # `logStreamNames`, but the value for `logStreamNamePrefix` does not - # match any log stream names specified in `logStreamNames`, the action - # returns an `InvalidParameterException` error. + # `logStreamNames`, the action returns an `InvalidParameterException` + # error. # @return [String] # # @!attribute [rw] start_time @@ -3434,7 +3452,7 @@ class OutputLogEvent < Struct.new( include Aws::Structure end - # A tructures that contains information about one pattern token related + # A structure that contains information about one pattern token related # to an anomaly. # # For more information about patterns and tokens, see @@ -3567,7 +3585,7 @@ class Policy < Struct.new( # * **FilterPattern** A filter pattern for subscribing to a filtered # stream of log events. # - # * **Distribution**The method used to distribute log data to the + # * **Distribution** The method used to distribute log data to the # destination. By default, log data is grouped by log stream, but # the grouping can be set to `Random` for a more even distribution. # This property is only applicable when the destination is an @@ -3805,9 +3823,11 @@ class PutDeliveryDestinationResponse < Struct.new( # @!attribute [rw] log_type # Defines the type of log that the source is sending. # + # * For Amazon Bedrock, the valid value is `APPLICATION_LOGS`. + # # * For Amazon CodeWhisperer, the valid value is `EVENT_LOGS`. # - # * For IAM Identity Centerr, the valid value is `ERROR_LOGS`. + # * For IAM Identity Center, the valid value is `ERROR_LOGS`. # # * For Amazon WorkMail, the valid values are `ACCESS_CONTROL_LOGS`, # `AUTHENTICATION_LOGS`, `WORKMAIL_AVAILABILITY_PROVIDER_LOGS`, and @@ -3959,13 +3979,18 @@ class PutDestinationResponse < Struct.new( # even if the sequence token is not valid. # @return [String] # + # @!attribute [rw] entity + # Reserved for future use. + # @return [Types::Entity] + # # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEventsRequest AWS API Documentation # class PutLogEventsRequest < Struct.new( :log_group_name, :log_stream_name, :log_events, - :sequence_token) + :sequence_token, + :entity) SENSITIVE = [] include Aws::Structure end @@ -3987,11 +4012,16 @@ class PutLogEventsRequest < Struct.new( # The rejected events. # @return [Types::RejectedLogEventsInfo] # + # @!attribute [rw] rejected_entity_info + # Reserved for future use. + # @return [Types::RejectedEntityInfo] + # # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEventsResponse AWS API Documentation # class PutLogEventsResponse < Struct.new( :next_sequence_token, - :rejected_log_events_info) + :rejected_log_events_info, + :rejected_entity_info) SENSITIVE = [] include Aws::Structure end @@ -4401,6 +4431,20 @@ class QueryStatistics < Struct.new( include Aws::Structure end + # Reserved for future use. + # + # @!attribute [rw] error_type + # Reserved for future use. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/RejectedEntityInfo AWS API Documentation + # + class RejectedEntityInfo < Struct.new( + :error_type) + SENSITIVE = [] + include Aws::Structure + end + # Represents the rejected events. # # @!attribute [rw] too_new_log_event_start_index diff --git a/gems/aws-sdk-cloudwatchlogs/sig/client.rbs b/gems/aws-sdk-cloudwatchlogs/sig/client.rbs index 9701011ae9b..a0ef55da2e6 100644 --- a/gems/aws-sdk-cloudwatchlogs/sig/client.rbs +++ b/gems/aws-sdk-cloudwatchlogs/sig/client.rbs @@ -720,6 +720,7 @@ module Aws include ::Seahorse::Client::_ResponseSuccess[Types::PutLogEventsResponse] def next_sequence_token: () -> ::String def rejected_log_events_info: () -> Types::RejectedLogEventsInfo + def rejected_entity_info: () -> Types::RejectedEntityInfo end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudWatchLogs/Client.html#put_log_events-instance_method def put_log_events: ( @@ -731,7 +732,11 @@ module Aws message: ::String }, ], - ?sequence_token: ::String + ?sequence_token: ::String, + ?entity: { + key_attributes: Hash[::String, ::String]?, + attributes: Hash[::String, ::String]? + } ) -> _PutLogEventsResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutLogEventsResponseSuccess diff --git a/gems/aws-sdk-cloudwatchlogs/sig/types.rbs b/gems/aws-sdk-cloudwatchlogs/sig/types.rbs index b5921405f6f..082f8448a97 100644 --- a/gems/aws-sdk-cloudwatchlogs/sig/types.rbs +++ b/gems/aws-sdk-cloudwatchlogs/sig/types.rbs @@ -450,6 +450,12 @@ module Aws::CloudWatchLogs SENSITIVE: [] end + class Entity + attr_accessor key_attributes: ::Hash[::String, ::String] + attr_accessor attributes: ::Hash[::String, ::String] + SENSITIVE: [] + end + class ExportTask attr_accessor task_id: ::String attr_accessor task_name: ::String @@ -913,12 +919,14 @@ module Aws::CloudWatchLogs attr_accessor log_stream_name: ::String attr_accessor log_events: ::Array[Types::InputLogEvent] attr_accessor sequence_token: ::String + attr_accessor entity: Types::Entity SENSITIVE: [] end class PutLogEventsResponse attr_accessor next_sequence_token: ::String attr_accessor rejected_log_events_info: Types::RejectedLogEventsInfo + attr_accessor rejected_entity_info: Types::RejectedEntityInfo SENSITIVE: [] end @@ -1008,6 +1016,11 @@ module Aws::CloudWatchLogs SENSITIVE: [] end + class RejectedEntityInfo + attr_accessor error_type: ("InvalidEntity" | "InvalidTypeValue" | "InvalidKeyAttributes" | "InvalidAttributes" | "EntitySizeTooLarge" | "UnsupportedLogGroupType" | "MissingRequiredFields") + SENSITIVE: [] + end + class RejectedLogEventsInfo attr_accessor too_new_log_event_start_index: ::Integer attr_accessor too_old_log_event_end_index: ::Integer diff --git a/gems/aws-sdk-core/CHANGELOG.md b/gems/aws-sdk-core/CHANGELOG.md index c90724ac8d6..0fff50ca704 100644 --- a/gems/aws-sdk-core/CHANGELOG.md +++ b/gems/aws-sdk-core/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +3.202.2 (2024-08-30) +------------------ + * Issue - revert auto-loading of bundled gems. 3.202.1 (2024-08-29) diff --git a/gems/aws-sdk-core/VERSION b/gems/aws-sdk-core/VERSION index 02027ae10d6..dab5cb85b1b 100644 --- a/gems/aws-sdk-core/VERSION +++ b/gems/aws-sdk-core/VERSION @@ -1 +1 @@ -3.202.1 +3.202.2 diff --git a/gems/aws-sdk-core/lib/aws-sdk-sso.rb b/gems/aws-sdk-core/lib/aws-sdk-sso.rb index b524eb82ef6..71475b707b3 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sso.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sso.rb @@ -54,6 +54,6 @@ # @!group service module Aws::SSO - GEM_VERSION = '3.202.1' + GEM_VERSION = '3.202.2' end diff --git a/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb b/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb index 3c775709f72..fc94dfe7648 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sso/client.rb @@ -642,7 +642,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-core' - context[:gem_version] = '3.202.1' + context[:gem_version] = '3.202.2' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb b/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb index 5938fbf58d6..9ba4d894548 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-ssooidc.rb @@ -54,6 +54,6 @@ # @!group service module Aws::SSOOIDC - GEM_VERSION = '3.202.1' + GEM_VERSION = '3.202.2' end diff --git a/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb b/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb index 99d22aed640..82eeaab497c 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-ssooidc/client.rb @@ -995,7 +995,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-core' - context[:gem_version] = '3.202.1' + context[:gem_version] = '3.202.2' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-core/lib/aws-sdk-sts.rb b/gems/aws-sdk-core/lib/aws-sdk-sts.rb index 27433aa841c..40d98b1ef9b 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sts.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sts.rb @@ -54,6 +54,6 @@ # @!group service module Aws::STS - GEM_VERSION = '3.202.1' + GEM_VERSION = '3.202.2' end diff --git a/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb b/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb index cd8f0f5e2ad..36f54013763 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-sts/client.rb @@ -2389,7 +2389,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-core' - context[:gem_version] = '3.202.1' + context[:gem_version] = '3.202.2' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-datazone/CHANGELOG.md b/gems/aws-sdk-datazone/CHANGELOG.md index 08816a0ff7d..5e6f6f7d9dc 100644 --- a/gems/aws-sdk-datazone/CHANGELOG.md +++ b/gems/aws-sdk-datazone/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.20.0 (2024-08-30) +------------------ + +* Feature - Amazon DataZone now adds new governance capabilities of Domain Units for organization within your Data Domains, and Authorization Policies for tighter controls. + 1.19.0 (2024-08-28) ------------------ diff --git a/gems/aws-sdk-datazone/VERSION b/gems/aws-sdk-datazone/VERSION index 815d5ca06d5..39893559155 100644 --- a/gems/aws-sdk-datazone/VERSION +++ b/gems/aws-sdk-datazone/VERSION @@ -1 +1 @@ -1.19.0 +1.20.0 diff --git a/gems/aws-sdk-datazone/lib/aws-sdk-datazone.rb b/gems/aws-sdk-datazone/lib/aws-sdk-datazone.rb index d9ff47c0bda..9ac3f0cddd3 100644 --- a/gems/aws-sdk-datazone/lib/aws-sdk-datazone.rb +++ b/gems/aws-sdk-datazone/lib/aws-sdk-datazone.rb @@ -52,6 +52,6 @@ # @!group service module Aws::DataZone - GEM_VERSION = '1.19.0' + GEM_VERSION = '1.20.0' end diff --git a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb index ffbb7f97a64..5694f229c3d 100644 --- a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb +++ b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb @@ -581,6 +581,167 @@ def accept_subscription_request(params = {}, options = {}) req.send_request(options) end + # Adds the owner of an entity (a domain unit). + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [required, String] :domain_identifier + # The ID of the domain in which you want to add the entity owner. + # + # @option params [required, String] :entity_identifier + # The ID of the entity to which you want to add an owner. + # + # @option params [required, String] :entity_type + # The type of an entity. + # + # @option params [required, Types::OwnerProperties] :owner + # The owner that you want to add to the entity. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.add_entity_owner({ + # client_token: "ClientToken", + # domain_identifier: "DomainId", # required + # entity_identifier: "String", # required + # entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT + # owner: { # required + # group: { + # group_identifier: "GroupIdentifier", # required + # }, + # user: { + # user_identifier: "UserIdentifier", # required + # }, + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AddEntityOwner AWS API Documentation + # + # @overload add_entity_owner(params = {}) + # @param [Hash] params ({}) + def add_entity_owner(params = {}, options = {}) + req = build_request(:add_entity_owner, params) + req.send_request(options) + end + + # Adds a policy grant (an authorization policy) to a specified entity, + # including domain units, environment blueprint configurations, or + # environment profiles. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [required, Types::PolicyGrantDetail] :detail + # The details of the policy grant. + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to add a policy grant. + # + # @option params [required, String] :entity_identifier + # The ID of the entity (resource) to which you want to add a policy + # grant. + # + # @option params [required, String] :entity_type + # The type of entity (resource) to which the grant is added. + # + # @option params [required, String] :policy_type + # The type of policy that you want to grant. + # + # @option params [required, Types::PolicyGrantPrincipal] :principal + # The principal to whom the permissions are granted. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.add_policy_grant({ + # client_token: "ClientToken", + # detail: { # required + # add_to_project_member_pool: { + # include_child_domain_units: false, + # }, + # create_asset_type: { + # include_child_domain_units: false, + # }, + # create_domain_unit: { + # include_child_domain_units: false, + # }, + # create_environment: { + # }, + # create_environment_profile: { + # domain_unit_id: "DomainUnitId", + # }, + # create_form_type: { + # include_child_domain_units: false, + # }, + # create_glossary: { + # include_child_domain_units: false, + # }, + # create_project: { + # include_child_domain_units: false, + # }, + # delegate_create_environment_profile: { + # }, + # override_domain_unit_owners: { + # include_child_domain_units: false, + # }, + # override_project_owners: { + # include_child_domain_units: false, + # }, + # }, + # domain_identifier: "DomainId", # required + # entity_identifier: "String", # required + # entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE + # policy_type: "CREATE_DOMAIN_UNIT", # required, accepts CREATE_DOMAIN_UNIT, OVERRIDE_DOMAIN_UNIT_OWNERS, ADD_TO_PROJECT_MEMBER_POOL, OVERRIDE_PROJECT_OWNERS, CREATE_GLOSSARY, CREATE_FORM_TYPE, CREATE_ASSET_TYPE, CREATE_PROJECT, CREATE_ENVIRONMENT_PROFILE, DELEGATE_CREATE_ENVIRONMENT_PROFILE, CREATE_ENVIRONMENT + # principal: { # required + # domain_unit: { + # domain_unit_designation: "OWNER", # required, accepts OWNER + # domain_unit_grant_filter: { + # all_domain_units_grant_filter: { + # }, + # }, + # domain_unit_identifier: "DomainUnitId", + # }, + # group: { + # group_identifier: "GroupIdentifier", + # }, + # project: { + # project_designation: "OWNER", # required, accepts OWNER, CONTRIBUTOR + # project_grant_filter: { + # domain_unit_filter: { + # domain_unit: "DomainUnitId", # required + # include_child_domain_units: false, + # }, + # }, + # project_identifier: "ProjectId", + # }, + # user: { + # all_users_grant_filter: { + # }, + # user_identifier: "UserIdentifier", + # }, + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AddPolicyGrant AWS API Documentation + # + # @overload add_policy_grant(params = {}) + # @param [Hash] params ({}) + def add_policy_grant(params = {}, options = {}) + req = build_request(:add_policy_grant, params) + req.send_request(options) + end + # Associates the environment role in Amazon DataZone. # # @option params [required, String] :domain_identifier @@ -1696,6 +1857,7 @@ def create_data_source(params = {}, options = {}) # * {Types::CreateDomainOutput#kms_key_identifier #kms_key_identifier} => String # * {Types::CreateDomainOutput#name #name} => String # * {Types::CreateDomainOutput#portal_url #portal_url} => String + # * {Types::CreateDomainOutput#root_domain_unit_id #root_domain_unit_id} => String # * {Types::CreateDomainOutput#single_sign_on #single_sign_on} => Types::SingleSignOn # * {Types::CreateDomainOutput#status #status} => String # * {Types::CreateDomainOutput#tags #tags} => Hash<String,String> @@ -1726,6 +1888,7 @@ def create_data_source(params = {}, options = {}) # resp.kms_key_identifier #=> String # resp.name #=> String # resp.portal_url #=> String + # resp.root_domain_unit_id #=> String # resp.single_sign_on.type #=> String, one of "IAM_IDC", "DISABLED" # resp.single_sign_on.user_assignment #=> String, one of "AUTOMATIC", "MANUAL" # resp.status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "DELETING", "DELETED", "DELETION_FAILED" @@ -1741,6 +1904,73 @@ def create_domain(params = {}, options = {}) req.send_request(options) end + # Creates a domain unit in Amazon DataZone. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [String] :description + # The description of the domain unit. + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to crate a domain unit. + # + # @option params [required, String] :name + # The name of the domain unit. + # + # @option params [required, String] :parent_domain_unit_identifier + # The ID of the parent domain unit. + # + # @return [Types::CreateDomainUnitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CreateDomainUnitOutput#ancestor_domain_unit_ids #ancestor_domain_unit_ids} => Array<String> + # * {Types::CreateDomainUnitOutput#created_at #created_at} => Time + # * {Types::CreateDomainUnitOutput#created_by #created_by} => String + # * {Types::CreateDomainUnitOutput#description #description} => String + # * {Types::CreateDomainUnitOutput#domain_id #domain_id} => String + # * {Types::CreateDomainUnitOutput#id #id} => String + # * {Types::CreateDomainUnitOutput#name #name} => String + # * {Types::CreateDomainUnitOutput#owners #owners} => Array<Types::DomainUnitOwnerProperties> + # * {Types::CreateDomainUnitOutput#parent_domain_unit_id #parent_domain_unit_id} => String + # + # @example Request syntax with placeholder values + # + # resp = client.create_domain_unit({ + # client_token: "ClientToken", + # description: "DomainUnitDescription", + # domain_identifier: "DomainId", # required + # name: "DomainUnitName", # required + # parent_domain_unit_identifier: "DomainUnitId", # required + # }) + # + # @example Response structure + # + # resp.ancestor_domain_unit_ids #=> Array + # resp.ancestor_domain_unit_ids[0] #=> String + # resp.created_at #=> Time + # resp.created_by #=> String + # resp.description #=> String + # resp.domain_id #=> String + # resp.id #=> String + # resp.name #=> String + # resp.owners #=> Array + # resp.owners[0].group.group_id #=> String + # resp.owners[0].user.user_id #=> String + # resp.parent_domain_unit_id #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateDomainUnit AWS API Documentation + # + # @overload create_domain_unit(params = {}) + # @param [Hash] params ({}) + def create_domain_unit(params = {}, options = {}) + req = build_request(:create_domain_unit, params) + req.send_request(options) + end + # Create an Amazon DataZone environment. # # @option params [String] :description @@ -2353,6 +2583,11 @@ def create_listing_change_set(params = {}, options = {}) # @option params [required, String] :domain_identifier # The ID of the Amazon DataZone domain in which this project is created. # + # @option params [String] :domain_unit_id + # The ID of the domain unit. This parameter is not required and if it is + # not specified, then the project is created at the root domain unit + # level. + # # @option params [Array] :glossary_terms # The glossary terms that can be used in this Amazon DataZone project. # @@ -2365,6 +2600,7 @@ def create_listing_change_set(params = {}, options = {}) # * {Types::CreateProjectOutput#created_by #created_by} => String # * {Types::CreateProjectOutput#description #description} => String # * {Types::CreateProjectOutput#domain_id #domain_id} => String + # * {Types::CreateProjectOutput#domain_unit_id #domain_unit_id} => String # * {Types::CreateProjectOutput#failure_reasons #failure_reasons} => Array<Types::ProjectDeletionError> # * {Types::CreateProjectOutput#glossary_terms #glossary_terms} => Array<String> # * {Types::CreateProjectOutput#id #id} => String @@ -2377,6 +2613,7 @@ def create_listing_change_set(params = {}, options = {}) # resp = client.create_project({ # description: "Description", # domain_identifier: "DomainId", # required + # domain_unit_id: "DomainUnitId", # glossary_terms: ["GlossaryTermId"], # name: "ProjectName", # required # }) @@ -2387,6 +2624,7 @@ def create_listing_change_set(params = {}, options = {}) # resp.created_by #=> String # resp.description #=> String # resp.domain_id #=> String + # resp.domain_unit_id #=> String # resp.failure_reasons #=> Array # resp.failure_reasons[0].code #=> String # resp.failure_reasons[0].message #=> String @@ -3081,6 +3319,32 @@ def delete_domain(params = {}, options = {}) req.send_request(options) end + # Deletes a domain unit. + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to delete a domain unit. + # + # @option params [required, String] :identifier + # The ID of the domain unit that you want to delete. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.delete_domain_unit({ + # domain_identifier: "DomainId", # required + # identifier: "DomainUnitId", # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DeleteDomainUnit AWS API Documentation + # + # @overload delete_domain_unit(params = {}) + # @param [Hash] params ({}) + def delete_domain_unit(params = {}, options = {}) + req = build_request(:delete_domain_unit, params) + req.send_request(options) + end + # Deletes an environment in Amazon DataZone. # # @option params [required, String] :domain_identifier @@ -4055,6 +4319,7 @@ def get_data_source_run(params = {}, options = {}) # * {Types::GetDomainOutput#last_updated_at #last_updated_at} => Time # * {Types::GetDomainOutput#name #name} => String # * {Types::GetDomainOutput#portal_url #portal_url} => String + # * {Types::GetDomainOutput#root_domain_unit_id #root_domain_unit_id} => String # * {Types::GetDomainOutput#single_sign_on #single_sign_on} => Types::SingleSignOn # * {Types::GetDomainOutput#status #status} => String # * {Types::GetDomainOutput#tags #tags} => Hash<String,String> @@ -4076,6 +4341,7 @@ def get_data_source_run(params = {}, options = {}) # resp.last_updated_at #=> Time # resp.name #=> String # resp.portal_url #=> String + # resp.root_domain_unit_id #=> String # resp.single_sign_on.type #=> String, one of "IAM_IDC", "DISABLED" # resp.single_sign_on.user_assignment #=> String, one of "AUTOMATIC", "MANUAL" # resp.status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "DELETING", "DELETED", "DELETION_FAILED" @@ -4091,6 +4357,58 @@ def get_domain(params = {}, options = {}) req.send_request(options) end + # Gets the details of the specified domain unit. + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to get a domain unit. + # + # @option params [required, String] :identifier + # The identifier of the domain unit that you want to get. + # + # @return [Types::GetDomainUnitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetDomainUnitOutput#created_at #created_at} => Time + # * {Types::GetDomainUnitOutput#created_by #created_by} => String + # * {Types::GetDomainUnitOutput#description #description} => String + # * {Types::GetDomainUnitOutput#domain_id #domain_id} => String + # * {Types::GetDomainUnitOutput#id #id} => String + # * {Types::GetDomainUnitOutput#last_updated_at #last_updated_at} => Time + # * {Types::GetDomainUnitOutput#last_updated_by #last_updated_by} => String + # * {Types::GetDomainUnitOutput#name #name} => String + # * {Types::GetDomainUnitOutput#owners #owners} => Array<Types::DomainUnitOwnerProperties> + # * {Types::GetDomainUnitOutput#parent_domain_unit_id #parent_domain_unit_id} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_domain_unit({ + # domain_identifier: "DomainId", # required + # identifier: "DomainUnitId", # required + # }) + # + # @example Response structure + # + # resp.created_at #=> Time + # resp.created_by #=> String + # resp.description #=> String + # resp.domain_id #=> String + # resp.id #=> String + # resp.last_updated_at #=> Time + # resp.last_updated_by #=> String + # resp.name #=> String + # resp.owners #=> Array + # resp.owners[0].group.group_id #=> String + # resp.owners[0].user.user_id #=> String + # resp.parent_domain_unit_id #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetDomainUnit AWS API Documentation + # + # @overload get_domain_unit(params = {}) + # @param [Hash] params ({}) + def get_domain_unit(params = {}, options = {}) + req = build_request(:get_domain_unit, params) + req.send_request(options) + end + # Gets an Amazon DataZone environment. # # @option params [required, String] :domain_identifier @@ -4914,6 +5232,7 @@ def get_metadata_generation_run(params = {}, options = {}) # * {Types::GetProjectOutput#created_by #created_by} => String # * {Types::GetProjectOutput#description #description} => String # * {Types::GetProjectOutput#domain_id #domain_id} => String + # * {Types::GetProjectOutput#domain_unit_id #domain_unit_id} => String # * {Types::GetProjectOutput#failure_reasons #failure_reasons} => Array<Types::ProjectDeletionError> # * {Types::GetProjectOutput#glossary_terms #glossary_terms} => Array<String> # * {Types::GetProjectOutput#id #id} => String @@ -4934,6 +5253,7 @@ def get_metadata_generation_run(params = {}, options = {}) # resp.created_by #=> String # resp.description #=> String # resp.domain_id #=> String + # resp.domain_unit_id #=> String # resp.failure_reasons #=> Array # resp.failure_reasons[0].code #=> String # resp.failure_reasons[0].message #=> String @@ -5764,6 +6084,62 @@ def list_data_sources(params = {}, options = {}) req.send_request(options) end + # Lists child domain units for the specified parent domain unit. + # + # @option params [required, String] :domain_identifier + # The ID of the domain in which you want to list domain units for a + # parent domain unit. + # + # @option params [Integer] :max_results + # The maximum number of domain units to return in a single call to + # ListDomainUnitsForParent. When the number of domain units to be listed + # is greater than the value of MaxResults, the response contains a + # NextToken value that you can use in a subsequent call to + # ListDomainUnitsForParent to list the next set of domain units. + # + # @option params [String] :next_token + # When the number of domain units is greater than the default value for + # the MaxResults parameter, or if you explicitly specify a value for + # MaxResults that is less than the number of domain units, the response + # includes a pagination token named NextToken. You can specify this + # NextToken value in a subsequent call to ListDomainUnitsForParent to + # list the next set of domain units. + # + # @option params [required, String] :parent_domain_unit_identifier + # The ID of the parent domain unit. + # + # @return [Types::ListDomainUnitsForParentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListDomainUnitsForParentOutput#items #items} => Array<Types::DomainUnitSummary> + # * {Types::ListDomainUnitsForParentOutput#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_domain_units_for_parent({ + # domain_identifier: "DomainId", # required + # max_results: 1, + # next_token: "PaginationToken", + # parent_domain_unit_identifier: "DomainUnitId", # required + # }) + # + # @example Response structure + # + # resp.items #=> Array + # resp.items[0].id #=> String + # resp.items[0].name #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListDomainUnitsForParent AWS API Documentation + # + # @overload list_domain_units_for_parent(params = {}) + # @param [Hash] params ({}) + def list_domain_units_for_parent(params = {}, options = {}) + req = build_request(:list_domain_units_for_parent, params) + req.send_request(options) + end + # Lists Amazon DataZone domains. # # @option params [Integer] :max_results @@ -5822,6 +6198,65 @@ def list_domains(params = {}, options = {}) req.send_request(options) end + # Lists the entity (domain units) owners. + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to list entity owners. + # + # @option params [required, String] :entity_identifier + # The ID of the entity that you want to list. + # + # @option params [required, String] :entity_type + # The type of the entity that you want to list. + # + # @option params [Integer] :max_results + # The maximum number of entities to return in a single call to + # `ListEntityOwners`. When the number of entities to be listed is + # greater than the value of `MaxResults`, the response contains a + # `NextToken` value that you can use in a subsequent call to + # `ListEntityOwners` to list the next set of entities. + # + # @option params [String] :next_token + # When the number of entities is greater than the default value for the + # `MaxResults` parameter, or if you explicitly specify a value for + # `MaxResults` that is less than the number of entities, the response + # includes a pagination token named `NextToken`. You can specify this + # `NextToken` value in a subsequent call to `ListEntityOwners` to list + # the next set of entities. + # + # @return [Types::ListEntityOwnersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListEntityOwnersOutput#next_token #next_token} => String + # * {Types::ListEntityOwnersOutput#owners #owners} => Array<Types::OwnerPropertiesOutput> + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_entity_owners({ + # domain_identifier: "DomainId", # required + # entity_identifier: "String", # required + # entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT + # max_results: 1, + # next_token: "PaginationToken", + # }) + # + # @example Response structure + # + # resp.next_token #=> String + # resp.owners #=> Array + # resp.owners[0].group.group_id #=> String + # resp.owners[0].user.user_id #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListEntityOwners AWS API Documentation + # + # @overload list_entity_owners(params = {}) + # @param [Hash] params ({}) + def list_entity_owners(params = {}, options = {}) + req = build_request(:list_entity_owners, params) + req.send_request(options) + end + # Lists existing environment actions. # # @option params [required, String] :domain_identifier @@ -6434,6 +6869,86 @@ def list_notifications(params = {}, options = {}) req.send_request(options) end + # Lists policy grants. + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to list policy grants. + # + # @option params [required, String] :entity_identifier + # The ID of the entity for which you want to list policy grants. + # + # @option params [required, String] :entity_type + # The type of entity for which you want to list policy grants. + # + # @option params [Integer] :max_results + # The maximum number of grants to return in a single call to + # `ListPolicyGrants`. When the number of grants to be listed is greater + # than the value of `MaxResults`, the response contains a `NextToken` + # value that you can use in a subsequent call to `ListPolicyGrants` to + # list the next set of grants. + # + # @option params [String] :next_token + # When the number of grants is greater than the default value for the + # `MaxResults` parameter, or if you explicitly specify a value for + # `MaxResults` that is less than the number of grants, the response + # includes a pagination token named `NextToken`. You can specify this + # `NextToken` value in a subsequent call to `ListPolicyGrants` to list + # the next set of grants. + # + # @option params [required, String] :policy_type + # The type of policy that you want to list. + # + # @return [Types::ListPolicyGrantsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListPolicyGrantsOutput#grant_list #grant_list} => Array<Types::PolicyGrantMember> + # * {Types::ListPolicyGrantsOutput#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_policy_grants({ + # domain_identifier: "DomainId", # required + # entity_identifier: "String", # required + # entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE + # max_results: 1, + # next_token: "PaginationToken", + # policy_type: "CREATE_DOMAIN_UNIT", # required, accepts CREATE_DOMAIN_UNIT, OVERRIDE_DOMAIN_UNIT_OWNERS, ADD_TO_PROJECT_MEMBER_POOL, OVERRIDE_PROJECT_OWNERS, CREATE_GLOSSARY, CREATE_FORM_TYPE, CREATE_ASSET_TYPE, CREATE_PROJECT, CREATE_ENVIRONMENT_PROFILE, DELEGATE_CREATE_ENVIRONMENT_PROFILE, CREATE_ENVIRONMENT + # }) + # + # @example Response structure + # + # resp.grant_list #=> Array + # resp.grant_list[0].created_at #=> Time + # resp.grant_list[0].created_by #=> String + # resp.grant_list[0].detail.add_to_project_member_pool.include_child_domain_units #=> Boolean + # resp.grant_list[0].detail.create_asset_type.include_child_domain_units #=> Boolean + # resp.grant_list[0].detail.create_domain_unit.include_child_domain_units #=> Boolean + # resp.grant_list[0].detail.create_environment_profile.domain_unit_id #=> String + # resp.grant_list[0].detail.create_form_type.include_child_domain_units #=> Boolean + # resp.grant_list[0].detail.create_glossary.include_child_domain_units #=> Boolean + # resp.grant_list[0].detail.create_project.include_child_domain_units #=> Boolean + # resp.grant_list[0].detail.override_domain_unit_owners.include_child_domain_units #=> Boolean + # resp.grant_list[0].detail.override_project_owners.include_child_domain_units #=> Boolean + # resp.grant_list[0].principal.domain_unit.domain_unit_designation #=> String, one of "OWNER" + # resp.grant_list[0].principal.domain_unit.domain_unit_identifier #=> String + # resp.grant_list[0].principal.group.group_identifier #=> String + # resp.grant_list[0].principal.project.project_designation #=> String, one of "OWNER", "CONTRIBUTOR" + # resp.grant_list[0].principal.project.project_grant_filter.domain_unit_filter.domain_unit #=> String + # resp.grant_list[0].principal.project.project_grant_filter.domain_unit_filter.include_child_domain_units #=> Boolean + # resp.grant_list[0].principal.project.project_identifier #=> String + # resp.grant_list[0].principal.user.user_identifier #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListPolicyGrants AWS API Documentation + # + # @overload list_policy_grants(params = {}) + # @param [Hash] params ({}) + def list_policy_grants(params = {}, options = {}) + req = build_request(:list_policy_grants, params) + req.send_request(options) + end + # Lists all members of the specified project. # # @option params [required, String] :domain_identifier @@ -6553,6 +7068,7 @@ def list_project_memberships(params = {}, options = {}) # resp.items[0].created_by #=> String # resp.items[0].description #=> String # resp.items[0].domain_id #=> String + # resp.items[0].domain_unit_id #=> String # resp.items[0].failure_reasons #=> Array # resp.items[0].failure_reasons[0].code #=> String # resp.items[0].failure_reasons[0].message #=> String @@ -7440,6 +7956,128 @@ def reject_subscription_request(params = {}, options = {}) req.send_request(options) end + # Removes an owner from an entity. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to remove an owner from an entity. + # + # @option params [required, String] :entity_identifier + # The ID of the entity from which you want to remove an owner. + # + # @option params [required, String] :entity_type + # The type of the entity from which you want to remove an owner. + # + # @option params [required, Types::OwnerProperties] :owner + # The owner that you want to remove from an entity. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.remove_entity_owner({ + # client_token: "ClientToken", + # domain_identifier: "DomainId", # required + # entity_identifier: "String", # required + # entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT + # owner: { # required + # group: { + # group_identifier: "GroupIdentifier", # required + # }, + # user: { + # user_identifier: "UserIdentifier", # required + # }, + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/RemoveEntityOwner AWS API Documentation + # + # @overload remove_entity_owner(params = {}) + # @param [Hash] params ({}) + def remove_entity_owner(params = {}, options = {}) + req = build_request(:remove_entity_owner, params) + req.send_request(options) + end + + # Removes a policy grant. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to remove a policy grant. + # + # @option params [required, String] :entity_identifier + # The ID of the entity from which you want to remove a policy grant. + # + # @option params [required, String] :entity_type + # The type of the entity from which you want to remove a policy grant. + # + # @option params [required, String] :policy_type + # The type of the policy that you want to remove. + # + # @option params [required, Types::PolicyGrantPrincipal] :principal + # The principal from which you want to remove a policy grant. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.remove_policy_grant({ + # client_token: "ClientToken", + # domain_identifier: "DomainId", # required + # entity_identifier: "String", # required + # entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE + # policy_type: "CREATE_DOMAIN_UNIT", # required, accepts CREATE_DOMAIN_UNIT, OVERRIDE_DOMAIN_UNIT_OWNERS, ADD_TO_PROJECT_MEMBER_POOL, OVERRIDE_PROJECT_OWNERS, CREATE_GLOSSARY, CREATE_FORM_TYPE, CREATE_ASSET_TYPE, CREATE_PROJECT, CREATE_ENVIRONMENT_PROFILE, DELEGATE_CREATE_ENVIRONMENT_PROFILE, CREATE_ENVIRONMENT + # principal: { # required + # domain_unit: { + # domain_unit_designation: "OWNER", # required, accepts OWNER + # domain_unit_grant_filter: { + # all_domain_units_grant_filter: { + # }, + # }, + # domain_unit_identifier: "DomainUnitId", + # }, + # group: { + # group_identifier: "GroupIdentifier", + # }, + # project: { + # project_designation: "OWNER", # required, accepts OWNER, CONTRIBUTOR + # project_grant_filter: { + # domain_unit_filter: { + # domain_unit: "DomainUnitId", # required + # include_child_domain_units: false, + # }, + # }, + # project_identifier: "ProjectId", + # }, + # user: { + # all_users_grant_filter: { + # }, + # user_identifier: "UserIdentifier", + # }, + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/RemovePolicyGrant AWS API Documentation + # + # @overload remove_policy_grant(params = {}) + # @param [Hash] params ({}) + def remove_policy_grant(params = {}, options = {}) + req = build_request(:remove_policy_grant, params) + req.send_request(options) + end + # Revokes a specified subscription in Amazon DataZone. # # @option params [required, String] :domain_identifier @@ -8690,6 +9328,7 @@ def update_data_source(params = {}, options = {}) # * {Types::UpdateDomainOutput#id #id} => String # * {Types::UpdateDomainOutput#last_updated_at #last_updated_at} => Time # * {Types::UpdateDomainOutput#name #name} => String + # * {Types::UpdateDomainOutput#root_domain_unit_id #root_domain_unit_id} => String # * {Types::UpdateDomainOutput#single_sign_on #single_sign_on} => Types::SingleSignOn # # @example Request syntax with placeholder values @@ -8713,6 +9352,7 @@ def update_data_source(params = {}, options = {}) # resp.id #=> String # resp.last_updated_at #=> Time # resp.name #=> String + # resp.root_domain_unit_id #=> String # resp.single_sign_on.type #=> String, one of "IAM_IDC", "DISABLED" # resp.single_sign_on.user_assignment #=> String, one of "AUTOMATIC", "MANUAL" # @@ -8725,6 +9365,66 @@ def update_domain(params = {}, options = {}) req.send_request(options) end + # Updates the domain unit. + # + # @option params [String] :description + # The description of the domain unit that you want to update. + # + # @option params [required, String] :domain_identifier + # The ID of the domain where you want to update a domain unit. + # + # @option params [required, String] :identifier + # The ID of the domain unit that you want to update. + # + # @option params [String] :name + # The name of the domain unit that you want to update. + # + # @return [Types::UpdateDomainUnitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::UpdateDomainUnitOutput#created_at #created_at} => Time + # * {Types::UpdateDomainUnitOutput#created_by #created_by} => String + # * {Types::UpdateDomainUnitOutput#description #description} => String + # * {Types::UpdateDomainUnitOutput#domain_id #domain_id} => String + # * {Types::UpdateDomainUnitOutput#id #id} => String + # * {Types::UpdateDomainUnitOutput#last_updated_at #last_updated_at} => Time + # * {Types::UpdateDomainUnitOutput#last_updated_by #last_updated_by} => String + # * {Types::UpdateDomainUnitOutput#name #name} => String + # * {Types::UpdateDomainUnitOutput#owners #owners} => Array<Types::DomainUnitOwnerProperties> + # * {Types::UpdateDomainUnitOutput#parent_domain_unit_id #parent_domain_unit_id} => String + # + # @example Request syntax with placeholder values + # + # resp = client.update_domain_unit({ + # description: "DomainUnitDescription", + # domain_identifier: "DomainId", # required + # identifier: "DomainUnitId", # required + # name: "DomainUnitName", + # }) + # + # @example Response structure + # + # resp.created_at #=> Time + # resp.created_by #=> String + # resp.description #=> String + # resp.domain_id #=> String + # resp.id #=> String + # resp.last_updated_at #=> Time + # resp.last_updated_by #=> String + # resp.name #=> String + # resp.owners #=> Array + # resp.owners[0].group.group_id #=> String + # resp.owners[0].user.user_id #=> String + # resp.parent_domain_unit_id #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateDomainUnit AWS API Documentation + # + # @overload update_domain_unit(params = {}) + # @param [Hash] params ({}) + def update_domain_unit(params = {}, options = {}) + req = build_request(:update_domain_unit, params) + req.send_request(options) + end + # Updates the specified environment in Amazon DataZone. # # @option params [String] :description @@ -9182,8 +9882,7 @@ def update_group_profile(params = {}, options = {}) # The description to be updated as part of the `UpdateProject` action. # # @option params [required, String] :domain_identifier - # The identifier of the Amazon DataZone domain in which a project is to - # be updated. + # The ID of the Amazon DataZone domain where a project is being updated. # # @option params [Array] :glossary_terms # The glossary terms to be updated as part of the `UpdateProject` @@ -9201,6 +9900,7 @@ def update_group_profile(params = {}, options = {}) # * {Types::UpdateProjectOutput#created_by #created_by} => String # * {Types::UpdateProjectOutput#description #description} => String # * {Types::UpdateProjectOutput#domain_id #domain_id} => String + # * {Types::UpdateProjectOutput#domain_unit_id #domain_unit_id} => String # * {Types::UpdateProjectOutput#failure_reasons #failure_reasons} => Array<Types::ProjectDeletionError> # * {Types::UpdateProjectOutput#glossary_terms #glossary_terms} => Array<String> # * {Types::UpdateProjectOutput#id #id} => String @@ -9224,6 +9924,7 @@ def update_group_profile(params = {}, options = {}) # resp.created_by #=> String # resp.description #=> String # resp.domain_id #=> String + # resp.domain_unit_id #=> String # resp.failure_reasons #=> Array # resp.failure_reasons[0].code #=> String # resp.failure_reasons[0].message #=> String @@ -9583,7 +10284,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-datazone' - context[:gem_version] = '1.19.0' + context[:gem_version] = '1.20.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client_api.rb b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client_api.rb index 239bb5de628..df68d13a063 100644 --- a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client_api.rb +++ b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/client_api.rb @@ -26,6 +26,13 @@ module ClientApi AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException') ActionLink = Shapes::StringShape.new(name: 'ActionLink') ActionParameters = Shapes::UnionShape.new(name: 'ActionParameters') + AddEntityOwnerInput = Shapes::StructureShape.new(name: 'AddEntityOwnerInput') + AddEntityOwnerOutput = Shapes::StructureShape.new(name: 'AddEntityOwnerOutput') + AddPolicyGrantInput = Shapes::StructureShape.new(name: 'AddPolicyGrantInput') + AddPolicyGrantOutput = Shapes::StructureShape.new(name: 'AddPolicyGrantOutput') + AddToProjectMemberPoolPolicyGrantDetail = Shapes::StructureShape.new(name: 'AddToProjectMemberPoolPolicyGrantDetail') + AllDomainUnitsGrantFilter = Shapes::StructureShape.new(name: 'AllDomainUnitsGrantFilter') + AllUsersGrantFilter = Shapes::StructureShape.new(name: 'AllUsersGrantFilter') ApplicableAssetTypes = Shapes::ListShape.new(name: 'ApplicableAssetTypes') AssetFilterConfiguration = Shapes::UnionShape.new(name: 'AssetFilterConfiguration') AssetFilterSummary = Shapes::StructureShape.new(name: 'AssetFilterSummary') @@ -80,6 +87,7 @@ module ClientApi CreateAssetRevisionOutput = Shapes::StructureShape.new(name: 'CreateAssetRevisionOutput') CreateAssetTypeInput = Shapes::StructureShape.new(name: 'CreateAssetTypeInput') CreateAssetTypeOutput = Shapes::StructureShape.new(name: 'CreateAssetTypeOutput') + CreateAssetTypePolicyGrantDetail = Shapes::StructureShape.new(name: 'CreateAssetTypePolicyGrantDetail') CreateDataProductInput = Shapes::StructureShape.new(name: 'CreateDataProductInput') CreateDataProductOutput = Shapes::StructureShape.new(name: 'CreateDataProductOutput') CreateDataProductRevisionInput = Shapes::StructureShape.new(name: 'CreateDataProductRevisionInput') @@ -88,16 +96,22 @@ module ClientApi CreateDataSourceOutput = Shapes::StructureShape.new(name: 'CreateDataSourceOutput') CreateDomainInput = Shapes::StructureShape.new(name: 'CreateDomainInput') CreateDomainOutput = Shapes::StructureShape.new(name: 'CreateDomainOutput') + CreateDomainUnitInput = Shapes::StructureShape.new(name: 'CreateDomainUnitInput') + CreateDomainUnitOutput = Shapes::StructureShape.new(name: 'CreateDomainUnitOutput') + CreateDomainUnitPolicyGrantDetail = Shapes::StructureShape.new(name: 'CreateDomainUnitPolicyGrantDetail') CreateEnvironmentActionInput = Shapes::StructureShape.new(name: 'CreateEnvironmentActionInput') CreateEnvironmentActionOutput = Shapes::StructureShape.new(name: 'CreateEnvironmentActionOutput') CreateEnvironmentInput = Shapes::StructureShape.new(name: 'CreateEnvironmentInput') CreateEnvironmentOutput = Shapes::StructureShape.new(name: 'CreateEnvironmentOutput') CreateEnvironmentProfileInput = Shapes::StructureShape.new(name: 'CreateEnvironmentProfileInput') CreateEnvironmentProfileOutput = Shapes::StructureShape.new(name: 'CreateEnvironmentProfileOutput') + CreateEnvironmentProfilePolicyGrantDetail = Shapes::StructureShape.new(name: 'CreateEnvironmentProfilePolicyGrantDetail') CreateFormTypeInput = Shapes::StructureShape.new(name: 'CreateFormTypeInput') CreateFormTypeOutput = Shapes::StructureShape.new(name: 'CreateFormTypeOutput') + CreateFormTypePolicyGrantDetail = Shapes::StructureShape.new(name: 'CreateFormTypePolicyGrantDetail') CreateGlossaryInput = Shapes::StructureShape.new(name: 'CreateGlossaryInput') CreateGlossaryOutput = Shapes::StructureShape.new(name: 'CreateGlossaryOutput') + CreateGlossaryPolicyGrantDetail = Shapes::StructureShape.new(name: 'CreateGlossaryPolicyGrantDetail') CreateGlossaryTermInput = Shapes::StructureShape.new(name: 'CreateGlossaryTermInput') CreateGlossaryTermOutput = Shapes::StructureShape.new(name: 'CreateGlossaryTermOutput') CreateGroupProfileInput = Shapes::StructureShape.new(name: 'CreateGroupProfileInput') @@ -108,6 +122,7 @@ module ClientApi CreateProjectMembershipInput = Shapes::StructureShape.new(name: 'CreateProjectMembershipInput') CreateProjectMembershipOutput = Shapes::StructureShape.new(name: 'CreateProjectMembershipOutput') CreateProjectOutput = Shapes::StructureShape.new(name: 'CreateProjectOutput') + CreateProjectPolicyGrantDetail = Shapes::StructureShape.new(name: 'CreateProjectPolicyGrantDetail') CreateSubscriptionGrantInput = Shapes::StructureShape.new(name: 'CreateSubscriptionGrantInput') CreateSubscriptionGrantOutput = Shapes::StructureShape.new(name: 'CreateSubscriptionGrantOutput') CreateSubscriptionRequestInput = Shapes::StructureShape.new(name: 'CreateSubscriptionRequestInput') @@ -155,6 +170,7 @@ module ClientApi DataSourceSummaries = Shapes::ListShape.new(name: 'DataSourceSummaries') DataSourceSummary = Shapes::StructureShape.new(name: 'DataSourceSummary') DataSourceType = Shapes::StringShape.new(name: 'DataSourceType') + DataZoneEntityType = Shapes::StringShape.new(name: 'DataZoneEntityType') DateTime = Shapes::TimestampShape.new(name: 'DateTime', timestampFormat: "iso8601") DecisionComment = Shapes::StringShape.new(name: 'DecisionComment') DeleteAssetFilterInput = Shapes::StructureShape.new(name: 'DeleteAssetFilterInput') @@ -168,6 +184,8 @@ module ClientApi DeleteDataSourceOutput = Shapes::StructureShape.new(name: 'DeleteDataSourceOutput') DeleteDomainInput = Shapes::StructureShape.new(name: 'DeleteDomainInput') DeleteDomainOutput = Shapes::StructureShape.new(name: 'DeleteDomainOutput') + DeleteDomainUnitInput = Shapes::StructureShape.new(name: 'DeleteDomainUnitInput') + DeleteDomainUnitOutput = Shapes::StructureShape.new(name: 'DeleteDomainUnitOutput') DeleteEnvironmentActionInput = Shapes::StructureShape.new(name: 'DeleteEnvironmentActionInput') DeleteEnvironmentBlueprintConfigurationInput = Shapes::StructureShape.new(name: 'DeleteEnvironmentBlueprintConfigurationInput') DeleteEnvironmentBlueprintConfigurationOutput = Shapes::StructureShape.new(name: 'DeleteEnvironmentBlueprintConfigurationOutput') @@ -210,12 +228,27 @@ module ClientApi DomainStatus = Shapes::StringShape.new(name: 'DomainStatus') DomainSummaries = Shapes::ListShape.new(name: 'DomainSummaries') DomainSummary = Shapes::StructureShape.new(name: 'DomainSummary') + DomainUnitDescription = Shapes::StringShape.new(name: 'DomainUnitDescription') + DomainUnitDesignation = Shapes::StringShape.new(name: 'DomainUnitDesignation') + DomainUnitFilterForProject = Shapes::StructureShape.new(name: 'DomainUnitFilterForProject') + DomainUnitGrantFilter = Shapes::UnionShape.new(name: 'DomainUnitGrantFilter') + DomainUnitGroupProperties = Shapes::StructureShape.new(name: 'DomainUnitGroupProperties') + DomainUnitId = Shapes::StringShape.new(name: 'DomainUnitId') + DomainUnitIds = Shapes::ListShape.new(name: 'DomainUnitIds') + DomainUnitName = Shapes::StringShape.new(name: 'DomainUnitName') + DomainUnitOwnerProperties = Shapes::UnionShape.new(name: 'DomainUnitOwnerProperties') + DomainUnitOwners = Shapes::ListShape.new(name: 'DomainUnitOwners') + DomainUnitPolicyGrantPrincipal = Shapes::StructureShape.new(name: 'DomainUnitPolicyGrantPrincipal') + DomainUnitSummaries = Shapes::ListShape.new(name: 'DomainUnitSummaries') + DomainUnitSummary = Shapes::StructureShape.new(name: 'DomainUnitSummary') + DomainUnitUserProperties = Shapes::StructureShape.new(name: 'DomainUnitUserProperties') EdgeDirection = Shapes::StringShape.new(name: 'EdgeDirection') EditedValue = Shapes::StringShape.new(name: 'EditedValue') EnableSetting = Shapes::StringShape.new(name: 'EnableSetting') EnabledRegionList = Shapes::ListShape.new(name: 'EnabledRegionList') EntityId = Shapes::StringShape.new(name: 'EntityId') EntityIdentifier = Shapes::StringShape.new(name: 'EntityIdentifier') + EntityOwners = Shapes::ListShape.new(name: 'EntityOwners') EntityType = Shapes::StringShape.new(name: 'EntityType') EnvironmentActionId = Shapes::StringShape.new(name: 'EnvironmentActionId') EnvironmentActionList = Shapes::ListShape.new(name: 'EnvironmentActionList') @@ -285,6 +318,8 @@ module ClientApi GetDataSourceRunOutput = Shapes::StructureShape.new(name: 'GetDataSourceRunOutput') GetDomainInput = Shapes::StructureShape.new(name: 'GetDomainInput') GetDomainOutput = Shapes::StructureShape.new(name: 'GetDomainOutput') + GetDomainUnitInput = Shapes::StructureShape.new(name: 'GetDomainUnitInput') + GetDomainUnitOutput = Shapes::StructureShape.new(name: 'GetDomainUnitOutput') GetEnvironmentActionInput = Shapes::StructureShape.new(name: 'GetEnvironmentActionInput') GetEnvironmentActionOutput = Shapes::StructureShape.new(name: 'GetEnvironmentActionOutput') GetEnvironmentBlueprintConfigurationInput = Shapes::StructureShape.new(name: 'GetEnvironmentBlueprintConfigurationInput') @@ -352,6 +387,7 @@ module ClientApi GreaterThanOrEqualToExpression = Shapes::StructureShape.new(name: 'GreaterThanOrEqualToExpression') GroupDetails = Shapes::StructureShape.new(name: 'GroupDetails') GroupIdentifier = Shapes::StringShape.new(name: 'GroupIdentifier') + GroupPolicyGrantPrincipal = Shapes::UnionShape.new(name: 'GroupPolicyGrantPrincipal') GroupProfileId = Shapes::StringShape.new(name: 'GroupProfileId') GroupProfileName = Shapes::StringShape.new(name: 'GroupProfileName') GroupProfileStatus = Shapes::StringShape.new(name: 'GroupProfileStatus') @@ -395,8 +431,12 @@ module ClientApi ListDataSourceRunsOutput = Shapes::StructureShape.new(name: 'ListDataSourceRunsOutput') ListDataSourcesInput = Shapes::StructureShape.new(name: 'ListDataSourcesInput') ListDataSourcesOutput = Shapes::StructureShape.new(name: 'ListDataSourcesOutput') + ListDomainUnitsForParentInput = Shapes::StructureShape.new(name: 'ListDomainUnitsForParentInput') + ListDomainUnitsForParentOutput = Shapes::StructureShape.new(name: 'ListDomainUnitsForParentOutput') ListDomainsInput = Shapes::StructureShape.new(name: 'ListDomainsInput') ListDomainsOutput = Shapes::StructureShape.new(name: 'ListDomainsOutput') + ListEntityOwnersInput = Shapes::StructureShape.new(name: 'ListEntityOwnersInput') + ListEntityOwnersOutput = Shapes::StructureShape.new(name: 'ListEntityOwnersOutput') ListEnvironmentActionSummaries = Shapes::ListShape.new(name: 'ListEnvironmentActionSummaries') ListEnvironmentActionsInput = Shapes::StructureShape.new(name: 'ListEnvironmentActionsInput') ListEnvironmentActionsOutput = Shapes::StructureShape.new(name: 'ListEnvironmentActionsOutput') @@ -414,6 +454,8 @@ module ClientApi ListMetadataGenerationRunsOutput = Shapes::StructureShape.new(name: 'ListMetadataGenerationRunsOutput') ListNotificationsInput = Shapes::StructureShape.new(name: 'ListNotificationsInput') ListNotificationsOutput = Shapes::StructureShape.new(name: 'ListNotificationsOutput') + ListPolicyGrantsInput = Shapes::StructureShape.new(name: 'ListPolicyGrantsInput') + ListPolicyGrantsOutput = Shapes::StructureShape.new(name: 'ListPolicyGrantsOutput') ListProjectMembershipsInput = Shapes::StructureShape.new(name: 'ListProjectMembershipsInput') ListProjectMembershipsOutput = Shapes::StructureShape.new(name: 'ListProjectMembershipsOutput') ListProjectsInput = Shapes::StructureShape.new(name: 'ListProjectsInput') @@ -441,6 +483,7 @@ module ClientApi ListingSummaryItem = Shapes::StructureShape.new(name: 'ListingSummaryItem') ListingSummaryItems = Shapes::ListShape.new(name: 'ListingSummaryItems') LongDescription = Shapes::StringShape.new(name: 'LongDescription') + ManagedPolicyType = Shapes::StringShape.new(name: 'ManagedPolicyType') MaxResults = Shapes::IntegerShape.new(name: 'MaxResults') MaxResultsForListDomains = Shapes::IntegerShape.new(name: 'MaxResultsForListDomains') Member = Shapes::UnionShape.new(name: 'Member') @@ -466,7 +509,19 @@ module ClientApi NotificationSubjects = Shapes::ListShape.new(name: 'NotificationSubjects') NotificationType = Shapes::StringShape.new(name: 'NotificationType') NotificationsList = Shapes::ListShape.new(name: 'NotificationsList') + OverrideDomainUnitOwnersPolicyGrantDetail = Shapes::StructureShape.new(name: 'OverrideDomainUnitOwnersPolicyGrantDetail') + OverrideProjectOwnersPolicyGrantDetail = Shapes::StructureShape.new(name: 'OverrideProjectOwnersPolicyGrantDetail') + OwnerGroupProperties = Shapes::StructureShape.new(name: 'OwnerGroupProperties') + OwnerGroupPropertiesOutput = Shapes::StructureShape.new(name: 'OwnerGroupPropertiesOutput') + OwnerProperties = Shapes::UnionShape.new(name: 'OwnerProperties') + OwnerPropertiesOutput = Shapes::UnionShape.new(name: 'OwnerPropertiesOutput') + OwnerUserProperties = Shapes::StructureShape.new(name: 'OwnerUserProperties') + OwnerUserPropertiesOutput = Shapes::StructureShape.new(name: 'OwnerUserPropertiesOutput') PaginationToken = Shapes::StringShape.new(name: 'PaginationToken') + PolicyGrantDetail = Shapes::UnionShape.new(name: 'PolicyGrantDetail') + PolicyGrantList = Shapes::ListShape.new(name: 'PolicyGrantList') + PolicyGrantMember = Shapes::StructureShape.new(name: 'PolicyGrantMember') + PolicyGrantPrincipal = Shapes::UnionShape.new(name: 'PolicyGrantPrincipal') PostLineageEventInput = Shapes::StructureShape.new(name: 'PostLineageEventInput') PostLineageEventOutput = Shapes::StructureShape.new(name: 'PostLineageEventOutput') PostTimeSeriesDataPointsInput = Shapes::StructureShape.new(name: 'PostTimeSeriesDataPointsInput') @@ -474,10 +529,13 @@ module ClientApi PredictionChoices = Shapes::ListShape.new(name: 'PredictionChoices') PredictionConfiguration = Shapes::StructureShape.new(name: 'PredictionConfiguration') ProjectDeletionError = Shapes::StructureShape.new(name: 'ProjectDeletionError') + ProjectDesignation = Shapes::StringShape.new(name: 'ProjectDesignation') + ProjectGrantFilter = Shapes::UnionShape.new(name: 'ProjectGrantFilter') ProjectId = Shapes::StringShape.new(name: 'ProjectId') ProjectMember = Shapes::StructureShape.new(name: 'ProjectMember') ProjectMembers = Shapes::ListShape.new(name: 'ProjectMembers') ProjectName = Shapes::StringShape.new(name: 'ProjectName') + ProjectPolicyGrantPrincipal = Shapes::StructureShape.new(name: 'ProjectPolicyGrantPrincipal') ProjectStatus = Shapes::StringShape.new(name: 'ProjectStatus') ProjectSummaries = Shapes::ListShape.new(name: 'ProjectSummaries') ProjectSummary = Shapes::StructureShape.new(name: 'ProjectSummary') @@ -518,6 +576,10 @@ module ClientApi RelationalFilterConfigurationDatabaseNameString = Shapes::StringShape.new(name: 'RelationalFilterConfigurationDatabaseNameString') RelationalFilterConfigurationSchemaNameString = Shapes::StringShape.new(name: 'RelationalFilterConfigurationSchemaNameString') RelationalFilterConfigurations = Shapes::ListShape.new(name: 'RelationalFilterConfigurations') + RemoveEntityOwnerInput = Shapes::StructureShape.new(name: 'RemoveEntityOwnerInput') + RemoveEntityOwnerOutput = Shapes::StructureShape.new(name: 'RemoveEntityOwnerOutput') + RemovePolicyGrantInput = Shapes::StructureShape.new(name: 'RemovePolicyGrantInput') + RemovePolicyGrantOutput = Shapes::StructureShape.new(name: 'RemovePolicyGrantOutput') RequestReason = Shapes::StringShape.new(name: 'RequestReason') Resource = Shapes::StructureShape.new(name: 'Resource') ResourceList = Shapes::ListShape.new(name: 'ResourceList') @@ -617,6 +679,7 @@ module ClientApi TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse') TagValue = Shapes::StringShape.new(name: 'TagValue') Tags = Shapes::MapShape.new(name: 'Tags') + TargetEntityType = Shapes::StringShape.new(name: 'TargetEntityType') TaskId = Shapes::StringShape.new(name: 'TaskId') TaskStatus = Shapes::StringShape.new(name: 'TaskStatus') TermRelations = Shapes::StructureShape.new(name: 'TermRelations') @@ -642,6 +705,7 @@ module ClientApi TypeName = Shapes::StringShape.new(name: 'TypeName') TypesSearchScope = Shapes::StringShape.new(name: 'TypesSearchScope') UnauthorizedException = Shapes::StructureShape.new(name: 'UnauthorizedException') + Unit = Shapes::StructureShape.new(name: 'Unit') UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest') UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse') UpdateAssetFilterInput = Shapes::StructureShape.new(name: 'UpdateAssetFilterInput') @@ -650,6 +714,8 @@ module ClientApi UpdateDataSourceOutput = Shapes::StructureShape.new(name: 'UpdateDataSourceOutput') UpdateDomainInput = Shapes::StructureShape.new(name: 'UpdateDomainInput') UpdateDomainOutput = Shapes::StructureShape.new(name: 'UpdateDomainOutput') + UpdateDomainUnitInput = Shapes::StructureShape.new(name: 'UpdateDomainUnitInput') + UpdateDomainUnitOutput = Shapes::StructureShape.new(name: 'UpdateDomainUnitOutput') UpdateEnvironmentActionInput = Shapes::StructureShape.new(name: 'UpdateEnvironmentActionInput') UpdateEnvironmentActionOutput = Shapes::StructureShape.new(name: 'UpdateEnvironmentActionOutput') UpdateEnvironmentInput = Shapes::StructureShape.new(name: 'UpdateEnvironmentInput') @@ -680,6 +746,7 @@ module ClientApi UserDesignation = Shapes::StringShape.new(name: 'UserDesignation') UserDetails = Shapes::StructureShape.new(name: 'UserDetails') UserIdentifier = Shapes::StringShape.new(name: 'UserIdentifier') + UserPolicyGrantPrincipal = Shapes::UnionShape.new(name: 'UserPolicyGrantPrincipal') UserProfileDetails = Shapes::UnionShape.new(name: 'UserProfileDetails') UserProfileId = Shapes::StringShape.new(name: 'UserProfileId') UserProfileName = Shapes::StringShape.new(name: 'UserProfileName') @@ -748,6 +815,33 @@ module ClientApi ActionParameters.add_member_subclass(:unknown, Types::ActionParameters::Unknown) ActionParameters.struct_class = Types::ActionParameters + AddEntityOwnerInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + AddEntityOwnerInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + AddEntityOwnerInput.add_member(:entity_identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "entityIdentifier")) + AddEntityOwnerInput.add_member(:entity_type, Shapes::ShapeRef.new(shape: DataZoneEntityType, required: true, location: "uri", location_name: "entityType")) + AddEntityOwnerInput.add_member(:owner, Shapes::ShapeRef.new(shape: OwnerProperties, required: true, location_name: "owner")) + AddEntityOwnerInput.struct_class = Types::AddEntityOwnerInput + + AddEntityOwnerOutput.struct_class = Types::AddEntityOwnerOutput + + AddPolicyGrantInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + AddPolicyGrantInput.add_member(:detail, Shapes::ShapeRef.new(shape: PolicyGrantDetail, required: true, location_name: "detail")) + AddPolicyGrantInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + AddPolicyGrantInput.add_member(:entity_identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "entityIdentifier")) + AddPolicyGrantInput.add_member(:entity_type, Shapes::ShapeRef.new(shape: TargetEntityType, required: true, location: "uri", location_name: "entityType")) + AddPolicyGrantInput.add_member(:policy_type, Shapes::ShapeRef.new(shape: ManagedPolicyType, required: true, location_name: "policyType")) + AddPolicyGrantInput.add_member(:principal, Shapes::ShapeRef.new(shape: PolicyGrantPrincipal, required: true, location_name: "principal")) + AddPolicyGrantInput.struct_class = Types::AddPolicyGrantInput + + AddPolicyGrantOutput.struct_class = Types::AddPolicyGrantOutput + + AddToProjectMemberPoolPolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + AddToProjectMemberPoolPolicyGrantDetail.struct_class = Types::AddToProjectMemberPoolPolicyGrantDetail + + AllDomainUnitsGrantFilter.struct_class = Types::AllDomainUnitsGrantFilter + + AllUsersGrantFilter.struct_class = Types::AllUsersGrantFilter + ApplicableAssetTypes.member = Shapes::ShapeRef.new(shape: TypeName) AssetFilterConfiguration.add_member(:column_configuration, Shapes::ShapeRef.new(shape: ColumnFilterConfiguration, location_name: "columnConfiguration")) @@ -1030,6 +1124,9 @@ module ClientApi CreateAssetTypeOutput.add_member(:updated_by, Shapes::ShapeRef.new(shape: UpdatedBy, location_name: "updatedBy")) CreateAssetTypeOutput.struct_class = Types::CreateAssetTypeOutput + CreateAssetTypePolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + CreateAssetTypePolicyGrantDetail.struct_class = Types::CreateAssetTypePolicyGrantDetail + CreateDataProductInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) CreateDataProductInput.add_member(:description, Shapes::ShapeRef.new(shape: DataProductDescription, location_name: "description")) CreateDataProductInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) @@ -1135,11 +1232,33 @@ module ClientApi CreateDomainOutput.add_member(:kms_key_identifier, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyIdentifier")) CreateDomainOutput.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name")) CreateDomainOutput.add_member(:portal_url, Shapes::ShapeRef.new(shape: String, location_name: "portalUrl")) + CreateDomainOutput.add_member(:root_domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "rootDomainUnitId")) CreateDomainOutput.add_member(:single_sign_on, Shapes::ShapeRef.new(shape: SingleSignOn, location_name: "singleSignOn")) CreateDomainOutput.add_member(:status, Shapes::ShapeRef.new(shape: DomainStatus, location_name: "status")) CreateDomainOutput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) CreateDomainOutput.struct_class = Types::CreateDomainOutput + CreateDomainUnitInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + CreateDomainUnitInput.add_member(:description, Shapes::ShapeRef.new(shape: DomainUnitDescription, location_name: "description")) + CreateDomainUnitInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + CreateDomainUnitInput.add_member(:name, Shapes::ShapeRef.new(shape: DomainUnitName, required: true, location_name: "name")) + CreateDomainUnitInput.add_member(:parent_domain_unit_identifier, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location_name: "parentDomainUnitIdentifier")) + CreateDomainUnitInput.struct_class = Types::CreateDomainUnitInput + + CreateDomainUnitOutput.add_member(:ancestor_domain_unit_ids, Shapes::ShapeRef.new(shape: DomainUnitIds, required: true, location_name: "ancestorDomainUnitIds")) + CreateDomainUnitOutput.add_member(:created_at, Shapes::ShapeRef.new(shape: CreatedAt, location_name: "createdAt")) + CreateDomainUnitOutput.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, location_name: "createdBy")) + CreateDomainUnitOutput.add_member(:description, Shapes::ShapeRef.new(shape: DomainUnitDescription, location_name: "description")) + CreateDomainUnitOutput.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId")) + CreateDomainUnitOutput.add_member(:id, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location_name: "id")) + CreateDomainUnitOutput.add_member(:name, Shapes::ShapeRef.new(shape: DomainUnitName, required: true, location_name: "name")) + CreateDomainUnitOutput.add_member(:owners, Shapes::ShapeRef.new(shape: DomainUnitOwners, required: true, location_name: "owners")) + CreateDomainUnitOutput.add_member(:parent_domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "parentDomainUnitId")) + CreateDomainUnitOutput.struct_class = Types::CreateDomainUnitOutput + + CreateDomainUnitPolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + CreateDomainUnitPolicyGrantDetail.struct_class = Types::CreateDomainUnitPolicyGrantDetail + CreateEnvironmentActionInput.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description")) CreateEnvironmentActionInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) CreateEnvironmentActionInput.add_member(:environment_identifier, Shapes::ShapeRef.new(shape: EnvironmentId, required: true, location: "uri", location_name: "environmentIdentifier")) @@ -1214,6 +1333,9 @@ module ClientApi CreateEnvironmentProfileOutput.add_member(:user_parameters, Shapes::ShapeRef.new(shape: CustomParameterList, location_name: "userParameters")) CreateEnvironmentProfileOutput.struct_class = Types::CreateEnvironmentProfileOutput + CreateEnvironmentProfilePolicyGrantDetail.add_member(:domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "domainUnitId")) + CreateEnvironmentProfilePolicyGrantDetail.struct_class = Types::CreateEnvironmentProfilePolicyGrantDetail + CreateFormTypeInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) CreateFormTypeInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) CreateFormTypeInput.add_member(:model, Shapes::ShapeRef.new(shape: Model, required: true, location_name: "model")) @@ -1231,6 +1353,9 @@ module ClientApi CreateFormTypeOutput.add_member(:revision, Shapes::ShapeRef.new(shape: Revision, required: true, location_name: "revision")) CreateFormTypeOutput.struct_class = Types::CreateFormTypeOutput + CreateFormTypePolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + CreateFormTypePolicyGrantDetail.struct_class = Types::CreateFormTypePolicyGrantDetail + CreateGlossaryInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) CreateGlossaryInput.add_member(:description, Shapes::ShapeRef.new(shape: GlossaryDescription, location_name: "description")) CreateGlossaryInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) @@ -1247,6 +1372,9 @@ module ClientApi CreateGlossaryOutput.add_member(:status, Shapes::ShapeRef.new(shape: GlossaryStatus, location_name: "status")) CreateGlossaryOutput.struct_class = Types::CreateGlossaryOutput + CreateGlossaryPolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + CreateGlossaryPolicyGrantDetail.struct_class = Types::CreateGlossaryPolicyGrantDetail + CreateGlossaryTermInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) CreateGlossaryTermInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) CreateGlossaryTermInput.add_member(:glossary_identifier, Shapes::ShapeRef.new(shape: GlossaryTermId, required: true, location_name: "glossaryIdentifier")) @@ -1293,6 +1421,7 @@ module ClientApi CreateProjectInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) CreateProjectInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + CreateProjectInput.add_member(:domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "domainUnitId")) CreateProjectInput.add_member(:glossary_terms, Shapes::ShapeRef.new(shape: GlossaryTerms, location_name: "glossaryTerms")) CreateProjectInput.add_member(:name, Shapes::ShapeRef.new(shape: ProjectName, required: true, location_name: "name")) CreateProjectInput.struct_class = Types::CreateProjectInput @@ -1309,6 +1438,7 @@ module ClientApi CreateProjectOutput.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, required: true, location_name: "createdBy")) CreateProjectOutput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) CreateProjectOutput.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId")) + CreateProjectOutput.add_member(:domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "domainUnitId")) CreateProjectOutput.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) CreateProjectOutput.add_member(:glossary_terms, Shapes::ShapeRef.new(shape: GlossaryTerms, location_name: "glossaryTerms")) CreateProjectOutput.add_member(:id, Shapes::ShapeRef.new(shape: ProjectId, required: true, location_name: "id")) @@ -1317,6 +1447,9 @@ module ClientApi CreateProjectOutput.add_member(:project_status, Shapes::ShapeRef.new(shape: ProjectStatus, location_name: "projectStatus")) CreateProjectOutput.struct_class = Types::CreateProjectOutput + CreateProjectPolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + CreateProjectPolicyGrantDetail.struct_class = Types::CreateProjectPolicyGrantDetail + CreateSubscriptionGrantInput.add_member(:asset_target_names, Shapes::ShapeRef.new(shape: AssetTargetNames, location_name: "assetTargetNames")) CreateSubscriptionGrantInput.add_member(:client_token, Shapes::ShapeRef.new(shape: String, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) CreateSubscriptionGrantInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) @@ -1598,6 +1731,12 @@ module ClientApi DeleteDomainOutput.add_member(:status, Shapes::ShapeRef.new(shape: DomainStatus, required: true, location_name: "status")) DeleteDomainOutput.struct_class = Types::DeleteDomainOutput + DeleteDomainUnitInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + DeleteDomainUnitInput.add_member(:identifier, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location: "uri", location_name: "identifier")) + DeleteDomainUnitInput.struct_class = Types::DeleteDomainUnitInput + + DeleteDomainUnitOutput.struct_class = Types::DeleteDomainUnitOutput + DeleteEnvironmentActionInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) DeleteEnvironmentActionInput.add_member(:environment_identifier, Shapes::ShapeRef.new(shape: EnvironmentId, required: true, location: "uri", location_name: "environmentIdentifier")) DeleteEnvironmentActionInput.add_member(:identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "identifier")) @@ -1730,8 +1869,49 @@ module ClientApi DomainSummary.add_member(:status, Shapes::ShapeRef.new(shape: DomainStatus, required: true, location_name: "status")) DomainSummary.struct_class = Types::DomainSummary + DomainUnitFilterForProject.add_member(:domain_unit, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location_name: "domainUnit")) + DomainUnitFilterForProject.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits", metadata: {"box"=>true})) + DomainUnitFilterForProject.struct_class = Types::DomainUnitFilterForProject + + DomainUnitGrantFilter.add_member(:all_domain_units_grant_filter, Shapes::ShapeRef.new(shape: AllDomainUnitsGrantFilter, location_name: "allDomainUnitsGrantFilter")) + DomainUnitGrantFilter.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + DomainUnitGrantFilter.add_member_subclass(:all_domain_units_grant_filter, Types::DomainUnitGrantFilter::AllDomainUnitsGrantFilter) + DomainUnitGrantFilter.add_member_subclass(:unknown, Types::DomainUnitGrantFilter::Unknown) + DomainUnitGrantFilter.struct_class = Types::DomainUnitGrantFilter + + DomainUnitGroupProperties.add_member(:group_id, Shapes::ShapeRef.new(shape: String, location_name: "groupId")) + DomainUnitGroupProperties.struct_class = Types::DomainUnitGroupProperties + + DomainUnitIds.member = Shapes::ShapeRef.new(shape: DomainUnitId) + + DomainUnitOwnerProperties.add_member(:group, Shapes::ShapeRef.new(shape: DomainUnitGroupProperties, location_name: "group")) + DomainUnitOwnerProperties.add_member(:user, Shapes::ShapeRef.new(shape: DomainUnitUserProperties, location_name: "user")) + DomainUnitOwnerProperties.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + DomainUnitOwnerProperties.add_member_subclass(:group, Types::DomainUnitOwnerProperties::Group) + DomainUnitOwnerProperties.add_member_subclass(:user, Types::DomainUnitOwnerProperties::User) + DomainUnitOwnerProperties.add_member_subclass(:unknown, Types::DomainUnitOwnerProperties::Unknown) + DomainUnitOwnerProperties.struct_class = Types::DomainUnitOwnerProperties + + DomainUnitOwners.member = Shapes::ShapeRef.new(shape: DomainUnitOwnerProperties) + + DomainUnitPolicyGrantPrincipal.add_member(:domain_unit_designation, Shapes::ShapeRef.new(shape: DomainUnitDesignation, required: true, location_name: "domainUnitDesignation")) + DomainUnitPolicyGrantPrincipal.add_member(:domain_unit_grant_filter, Shapes::ShapeRef.new(shape: DomainUnitGrantFilter, location_name: "domainUnitGrantFilter")) + DomainUnitPolicyGrantPrincipal.add_member(:domain_unit_identifier, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "domainUnitIdentifier")) + DomainUnitPolicyGrantPrincipal.struct_class = Types::DomainUnitPolicyGrantPrincipal + + DomainUnitSummaries.member = Shapes::ShapeRef.new(shape: DomainUnitSummary) + + DomainUnitSummary.add_member(:id, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location_name: "id")) + DomainUnitSummary.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "name")) + DomainUnitSummary.struct_class = Types::DomainUnitSummary + + DomainUnitUserProperties.add_member(:user_id, Shapes::ShapeRef.new(shape: String, location_name: "userId")) + DomainUnitUserProperties.struct_class = Types::DomainUnitUserProperties + EnabledRegionList.member = Shapes::ShapeRef.new(shape: RegionName) + EntityOwners.member = Shapes::ShapeRef.new(shape: OwnerPropertiesOutput) + EnvironmentActionList.member = Shapes::ShapeRef.new(shape: ConfigurableEnvironmentAction) EnvironmentActionSummary.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description")) @@ -2027,11 +2207,28 @@ module ClientApi GetDomainOutput.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: UpdatedAt, location_name: "lastUpdatedAt")) GetDomainOutput.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name")) GetDomainOutput.add_member(:portal_url, Shapes::ShapeRef.new(shape: String, location_name: "portalUrl")) + GetDomainOutput.add_member(:root_domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "rootDomainUnitId")) GetDomainOutput.add_member(:single_sign_on, Shapes::ShapeRef.new(shape: SingleSignOn, location_name: "singleSignOn")) GetDomainOutput.add_member(:status, Shapes::ShapeRef.new(shape: DomainStatus, required: true, location_name: "status")) GetDomainOutput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags")) GetDomainOutput.struct_class = Types::GetDomainOutput + GetDomainUnitInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + GetDomainUnitInput.add_member(:identifier, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location: "uri", location_name: "identifier")) + GetDomainUnitInput.struct_class = Types::GetDomainUnitInput + + GetDomainUnitOutput.add_member(:created_at, Shapes::ShapeRef.new(shape: CreatedAt, location_name: "createdAt")) + GetDomainUnitOutput.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, location_name: "createdBy")) + GetDomainUnitOutput.add_member(:description, Shapes::ShapeRef.new(shape: DomainUnitDescription, location_name: "description")) + GetDomainUnitOutput.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId")) + GetDomainUnitOutput.add_member(:id, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location_name: "id")) + GetDomainUnitOutput.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: UpdatedAt, location_name: "lastUpdatedAt")) + GetDomainUnitOutput.add_member(:last_updated_by, Shapes::ShapeRef.new(shape: UpdatedBy, location_name: "lastUpdatedBy")) + GetDomainUnitOutput.add_member(:name, Shapes::ShapeRef.new(shape: DomainUnitName, required: true, location_name: "name")) + GetDomainUnitOutput.add_member(:owners, Shapes::ShapeRef.new(shape: DomainUnitOwners, required: true, location_name: "owners")) + GetDomainUnitOutput.add_member(:parent_domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "parentDomainUnitId")) + GetDomainUnitOutput.struct_class = Types::GetDomainUnitOutput + GetEnvironmentActionInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) GetEnvironmentActionInput.add_member(:environment_identifier, Shapes::ShapeRef.new(shape: EnvironmentId, required: true, location: "uri", location_name: "environmentIdentifier")) GetEnvironmentActionInput.add_member(:identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "identifier")) @@ -2263,6 +2460,7 @@ module ClientApi GetProjectOutput.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, required: true, location_name: "createdBy")) GetProjectOutput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) GetProjectOutput.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId")) + GetProjectOutput.add_member(:domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "domainUnitId")) GetProjectOutput.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) GetProjectOutput.add_member(:glossary_terms, Shapes::ShapeRef.new(shape: GlossaryTerms, location_name: "glossaryTerms")) GetProjectOutput.add_member(:id, Shapes::ShapeRef.new(shape: ProjectId, required: true, location_name: "id")) @@ -2441,6 +2639,12 @@ module ClientApi GroupDetails.add_member(:group_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "groupId")) GroupDetails.struct_class = Types::GroupDetails + GroupPolicyGrantPrincipal.add_member(:group_identifier, Shapes::ShapeRef.new(shape: GroupIdentifier, location_name: "groupIdentifier")) + GroupPolicyGrantPrincipal.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + GroupPolicyGrantPrincipal.add_member_subclass(:group_identifier, Types::GroupPolicyGrantPrincipal::GroupIdentifier) + GroupPolicyGrantPrincipal.add_member_subclass(:unknown, Types::GroupPolicyGrantPrincipal::Unknown) + GroupPolicyGrantPrincipal.struct_class = Types::GroupPolicyGrantPrincipal + GroupProfileSummaries.member = Shapes::ShapeRef.new(shape: GroupProfileSummary) GroupProfileSummary.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, location_name: "domainId")) @@ -2589,6 +2793,16 @@ module ClientApi ListDataSourcesOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListDataSourcesOutput.struct_class = Types::ListDataSourcesOutput + ListDomainUnitsForParentInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + ListDomainUnitsForParentInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsForListDomains, location: "querystring", location_name: "maxResults")) + ListDomainUnitsForParentInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) + ListDomainUnitsForParentInput.add_member(:parent_domain_unit_identifier, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location: "querystring", location_name: "parentDomainUnitIdentifier")) + ListDomainUnitsForParentInput.struct_class = Types::ListDomainUnitsForParentInput + + ListDomainUnitsForParentOutput.add_member(:items, Shapes::ShapeRef.new(shape: DomainUnitSummaries, required: true, location_name: "items")) + ListDomainUnitsForParentOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListDomainUnitsForParentOutput.struct_class = Types::ListDomainUnitsForParentOutput + ListDomainsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsForListDomains, location: "querystring", location_name: "maxResults")) ListDomainsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) ListDomainsInput.add_member(:status, Shapes::ShapeRef.new(shape: DomainStatus, location: "querystring", location_name: "status")) @@ -2598,6 +2812,17 @@ module ClientApi ListDomainsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) ListDomainsOutput.struct_class = Types::ListDomainsOutput + ListEntityOwnersInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + ListEntityOwnersInput.add_member(:entity_identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "entityIdentifier")) + ListEntityOwnersInput.add_member(:entity_type, Shapes::ShapeRef.new(shape: DataZoneEntityType, required: true, location: "uri", location_name: "entityType")) + ListEntityOwnersInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsForListDomains, location: "querystring", location_name: "maxResults")) + ListEntityOwnersInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) + ListEntityOwnersInput.struct_class = Types::ListEntityOwnersInput + + ListEntityOwnersOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListEntityOwnersOutput.add_member(:owners, Shapes::ShapeRef.new(shape: EntityOwners, required: true, location_name: "owners")) + ListEntityOwnersOutput.struct_class = Types::ListEntityOwnersOutput + ListEnvironmentActionSummaries.member = Shapes::ShapeRef.new(shape: EnvironmentActionSummary) ListEnvironmentActionsInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) @@ -2700,6 +2925,18 @@ module ClientApi ListNotificationsOutput.add_member(:notifications, Shapes::ShapeRef.new(shape: NotificationsList, location_name: "notifications")) ListNotificationsOutput.struct_class = Types::ListNotificationsOutput + ListPolicyGrantsInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + ListPolicyGrantsInput.add_member(:entity_identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "entityIdentifier")) + ListPolicyGrantsInput.add_member(:entity_type, Shapes::ShapeRef.new(shape: TargetEntityType, required: true, location: "uri", location_name: "entityType")) + ListPolicyGrantsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsForListDomains, location: "querystring", location_name: "maxResults")) + ListPolicyGrantsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) + ListPolicyGrantsInput.add_member(:policy_type, Shapes::ShapeRef.new(shape: ManagedPolicyType, required: true, location: "querystring", location_name: "policyType")) + ListPolicyGrantsInput.struct_class = Types::ListPolicyGrantsInput + + ListPolicyGrantsOutput.add_member(:grant_list, Shapes::ShapeRef.new(shape: PolicyGrantList, required: true, location_name: "grantList")) + ListPolicyGrantsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListPolicyGrantsOutput.struct_class = Types::ListPolicyGrantsOutput + ListProjectMembershipsInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) ListProjectMembershipsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults")) ListProjectMembershipsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) @@ -2909,6 +3146,86 @@ module ClientApi NotificationsList.member = Shapes::ShapeRef.new(shape: NotificationOutput) + OverrideDomainUnitOwnersPolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + OverrideDomainUnitOwnersPolicyGrantDetail.struct_class = Types::OverrideDomainUnitOwnersPolicyGrantDetail + + OverrideProjectOwnersPolicyGrantDetail.add_member(:include_child_domain_units, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeChildDomainUnits")) + OverrideProjectOwnersPolicyGrantDetail.struct_class = Types::OverrideProjectOwnersPolicyGrantDetail + + OwnerGroupProperties.add_member(:group_identifier, Shapes::ShapeRef.new(shape: GroupIdentifier, required: true, location_name: "groupIdentifier")) + OwnerGroupProperties.struct_class = Types::OwnerGroupProperties + + OwnerGroupPropertiesOutput.add_member(:group_id, Shapes::ShapeRef.new(shape: String, location_name: "groupId")) + OwnerGroupPropertiesOutput.struct_class = Types::OwnerGroupPropertiesOutput + + OwnerProperties.add_member(:group, Shapes::ShapeRef.new(shape: OwnerGroupProperties, location_name: "group")) + OwnerProperties.add_member(:user, Shapes::ShapeRef.new(shape: OwnerUserProperties, location_name: "user")) + OwnerProperties.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + OwnerProperties.add_member_subclass(:group, Types::OwnerProperties::Group) + OwnerProperties.add_member_subclass(:user, Types::OwnerProperties::User) + OwnerProperties.add_member_subclass(:unknown, Types::OwnerProperties::Unknown) + OwnerProperties.struct_class = Types::OwnerProperties + + OwnerPropertiesOutput.add_member(:group, Shapes::ShapeRef.new(shape: OwnerGroupPropertiesOutput, location_name: "group")) + OwnerPropertiesOutput.add_member(:user, Shapes::ShapeRef.new(shape: OwnerUserPropertiesOutput, location_name: "user")) + OwnerPropertiesOutput.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + OwnerPropertiesOutput.add_member_subclass(:group, Types::OwnerPropertiesOutput::Group) + OwnerPropertiesOutput.add_member_subclass(:user, Types::OwnerPropertiesOutput::User) + OwnerPropertiesOutput.add_member_subclass(:unknown, Types::OwnerPropertiesOutput::Unknown) + OwnerPropertiesOutput.struct_class = Types::OwnerPropertiesOutput + + OwnerUserProperties.add_member(:user_identifier, Shapes::ShapeRef.new(shape: UserIdentifier, required: true, location_name: "userIdentifier")) + OwnerUserProperties.struct_class = Types::OwnerUserProperties + + OwnerUserPropertiesOutput.add_member(:user_id, Shapes::ShapeRef.new(shape: String, location_name: "userId")) + OwnerUserPropertiesOutput.struct_class = Types::OwnerUserPropertiesOutput + + PolicyGrantDetail.add_member(:add_to_project_member_pool, Shapes::ShapeRef.new(shape: AddToProjectMemberPoolPolicyGrantDetail, location_name: "addToProjectMemberPool")) + PolicyGrantDetail.add_member(:create_asset_type, Shapes::ShapeRef.new(shape: CreateAssetTypePolicyGrantDetail, location_name: "createAssetType")) + PolicyGrantDetail.add_member(:create_domain_unit, Shapes::ShapeRef.new(shape: CreateDomainUnitPolicyGrantDetail, location_name: "createDomainUnit")) + PolicyGrantDetail.add_member(:create_environment, Shapes::ShapeRef.new(shape: Unit, location_name: "createEnvironment")) + PolicyGrantDetail.add_member(:create_environment_profile, Shapes::ShapeRef.new(shape: CreateEnvironmentProfilePolicyGrantDetail, location_name: "createEnvironmentProfile")) + PolicyGrantDetail.add_member(:create_form_type, Shapes::ShapeRef.new(shape: CreateFormTypePolicyGrantDetail, location_name: "createFormType")) + PolicyGrantDetail.add_member(:create_glossary, Shapes::ShapeRef.new(shape: CreateGlossaryPolicyGrantDetail, location_name: "createGlossary")) + PolicyGrantDetail.add_member(:create_project, Shapes::ShapeRef.new(shape: CreateProjectPolicyGrantDetail, location_name: "createProject")) + PolicyGrantDetail.add_member(:delegate_create_environment_profile, Shapes::ShapeRef.new(shape: Unit, location_name: "delegateCreateEnvironmentProfile")) + PolicyGrantDetail.add_member(:override_domain_unit_owners, Shapes::ShapeRef.new(shape: OverrideDomainUnitOwnersPolicyGrantDetail, location_name: "overrideDomainUnitOwners")) + PolicyGrantDetail.add_member(:override_project_owners, Shapes::ShapeRef.new(shape: OverrideProjectOwnersPolicyGrantDetail, location_name: "overrideProjectOwners")) + PolicyGrantDetail.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + PolicyGrantDetail.add_member_subclass(:add_to_project_member_pool, Types::PolicyGrantDetail::AddToProjectMemberPool) + PolicyGrantDetail.add_member_subclass(:create_asset_type, Types::PolicyGrantDetail::CreateAssetType) + PolicyGrantDetail.add_member_subclass(:create_domain_unit, Types::PolicyGrantDetail::CreateDomainUnit) + PolicyGrantDetail.add_member_subclass(:create_environment, Types::PolicyGrantDetail::CreateEnvironment) + PolicyGrantDetail.add_member_subclass(:create_environment_profile, Types::PolicyGrantDetail::CreateEnvironmentProfile) + PolicyGrantDetail.add_member_subclass(:create_form_type, Types::PolicyGrantDetail::CreateFormType) + PolicyGrantDetail.add_member_subclass(:create_glossary, Types::PolicyGrantDetail::CreateGlossary) + PolicyGrantDetail.add_member_subclass(:create_project, Types::PolicyGrantDetail::CreateProject) + PolicyGrantDetail.add_member_subclass(:delegate_create_environment_profile, Types::PolicyGrantDetail::DelegateCreateEnvironmentProfile) + PolicyGrantDetail.add_member_subclass(:override_domain_unit_owners, Types::PolicyGrantDetail::OverrideDomainUnitOwners) + PolicyGrantDetail.add_member_subclass(:override_project_owners, Types::PolicyGrantDetail::OverrideProjectOwners) + PolicyGrantDetail.add_member_subclass(:unknown, Types::PolicyGrantDetail::Unknown) + PolicyGrantDetail.struct_class = Types::PolicyGrantDetail + + PolicyGrantList.member = Shapes::ShapeRef.new(shape: PolicyGrantMember) + + PolicyGrantMember.add_member(:created_at, Shapes::ShapeRef.new(shape: CreatedAt, location_name: "createdAt")) + PolicyGrantMember.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, location_name: "createdBy")) + PolicyGrantMember.add_member(:detail, Shapes::ShapeRef.new(shape: PolicyGrantDetail, location_name: "detail")) + PolicyGrantMember.add_member(:principal, Shapes::ShapeRef.new(shape: PolicyGrantPrincipal, location_name: "principal")) + PolicyGrantMember.struct_class = Types::PolicyGrantMember + + PolicyGrantPrincipal.add_member(:domain_unit, Shapes::ShapeRef.new(shape: DomainUnitPolicyGrantPrincipal, location_name: "domainUnit")) + PolicyGrantPrincipal.add_member(:group, Shapes::ShapeRef.new(shape: GroupPolicyGrantPrincipal, location_name: "group")) + PolicyGrantPrincipal.add_member(:project, Shapes::ShapeRef.new(shape: ProjectPolicyGrantPrincipal, location_name: "project")) + PolicyGrantPrincipal.add_member(:user, Shapes::ShapeRef.new(shape: UserPolicyGrantPrincipal, location_name: "user")) + PolicyGrantPrincipal.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + PolicyGrantPrincipal.add_member_subclass(:domain_unit, Types::PolicyGrantPrincipal::DomainUnit) + PolicyGrantPrincipal.add_member_subclass(:group, Types::PolicyGrantPrincipal::Group) + PolicyGrantPrincipal.add_member_subclass(:project, Types::PolicyGrantPrincipal::Project) + PolicyGrantPrincipal.add_member_subclass(:user, Types::PolicyGrantPrincipal::User) + PolicyGrantPrincipal.add_member_subclass(:unknown, Types::PolicyGrantPrincipal::Unknown) + PolicyGrantPrincipal.struct_class = Types::PolicyGrantPrincipal + PostLineageEventInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location: "querystring", location_name: "clientToken", metadata: {"idempotencyToken"=>true})) PostLineageEventInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) PostLineageEventInput.add_member(:event, Shapes::ShapeRef.new(shape: LineageEvent, required: true, location_name: "event")) @@ -2940,18 +3257,30 @@ module ClientApi ProjectDeletionError.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message")) ProjectDeletionError.struct_class = Types::ProjectDeletionError + ProjectGrantFilter.add_member(:domain_unit_filter, Shapes::ShapeRef.new(shape: DomainUnitFilterForProject, location_name: "domainUnitFilter")) + ProjectGrantFilter.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + ProjectGrantFilter.add_member_subclass(:domain_unit_filter, Types::ProjectGrantFilter::DomainUnitFilter) + ProjectGrantFilter.add_member_subclass(:unknown, Types::ProjectGrantFilter::Unknown) + ProjectGrantFilter.struct_class = Types::ProjectGrantFilter + ProjectMember.add_member(:designation, Shapes::ShapeRef.new(shape: UserDesignation, required: true, location_name: "designation")) ProjectMember.add_member(:member_details, Shapes::ShapeRef.new(shape: MemberDetails, required: true, location_name: "memberDetails")) ProjectMember.struct_class = Types::ProjectMember ProjectMembers.member = Shapes::ShapeRef.new(shape: ProjectMember) + ProjectPolicyGrantPrincipal.add_member(:project_designation, Shapes::ShapeRef.new(shape: ProjectDesignation, required: true, location_name: "projectDesignation")) + ProjectPolicyGrantPrincipal.add_member(:project_grant_filter, Shapes::ShapeRef.new(shape: ProjectGrantFilter, location_name: "projectGrantFilter")) + ProjectPolicyGrantPrincipal.add_member(:project_identifier, Shapes::ShapeRef.new(shape: ProjectId, location_name: "projectIdentifier")) + ProjectPolicyGrantPrincipal.struct_class = Types::ProjectPolicyGrantPrincipal + ProjectSummaries.member = Shapes::ShapeRef.new(shape: ProjectSummary) ProjectSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, location_name: "createdAt")) ProjectSummary.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, required: true, location_name: "createdBy")) ProjectSummary.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) ProjectSummary.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId")) + ProjectSummary.add_member(:domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "domainUnitId")) ProjectSummary.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) ProjectSummary.add_member(:id, Shapes::ShapeRef.new(shape: ProjectId, required: true, location_name: "id")) ProjectSummary.add_member(:name, Shapes::ShapeRef.new(shape: ProjectName, required: true, location_name: "name")) @@ -3089,6 +3418,25 @@ module ClientApi RelationalFilterConfigurations.member = Shapes::ShapeRef.new(shape: RelationalFilterConfiguration) + RemoveEntityOwnerInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + RemoveEntityOwnerInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + RemoveEntityOwnerInput.add_member(:entity_identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "entityIdentifier")) + RemoveEntityOwnerInput.add_member(:entity_type, Shapes::ShapeRef.new(shape: DataZoneEntityType, required: true, location: "uri", location_name: "entityType")) + RemoveEntityOwnerInput.add_member(:owner, Shapes::ShapeRef.new(shape: OwnerProperties, required: true, location_name: "owner")) + RemoveEntityOwnerInput.struct_class = Types::RemoveEntityOwnerInput + + RemoveEntityOwnerOutput.struct_class = Types::RemoveEntityOwnerOutput + + RemovePolicyGrantInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + RemovePolicyGrantInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + RemovePolicyGrantInput.add_member(:entity_identifier, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "entityIdentifier")) + RemovePolicyGrantInput.add_member(:entity_type, Shapes::ShapeRef.new(shape: TargetEntityType, required: true, location: "uri", location_name: "entityType")) + RemovePolicyGrantInput.add_member(:policy_type, Shapes::ShapeRef.new(shape: ManagedPolicyType, required: true, location_name: "policyType")) + RemovePolicyGrantInput.add_member(:principal, Shapes::ShapeRef.new(shape: PolicyGrantPrincipal, required: true, location_name: "principal")) + RemovePolicyGrantInput.struct_class = Types::RemovePolicyGrantInput + + RemovePolicyGrantOutput.struct_class = Types::RemovePolicyGrantOutput + Resource.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name")) Resource.add_member(:provider, Shapes::ShapeRef.new(shape: String, location_name: "provider")) Resource.add_member(:type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "type")) @@ -3561,6 +3909,8 @@ module ClientApi UnauthorizedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message")) UnauthorizedException.struct_class = Types::UnauthorizedException + Unit.struct_class = Types::Unit + UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resourceArn")) UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location: "querystring", location_name: "tagKeys")) UntagResourceRequest.struct_class = Types::UntagResourceRequest @@ -3638,9 +3988,28 @@ module ClientApi UpdateDomainOutput.add_member(:id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "id")) UpdateDomainOutput.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: UpdatedAt, location_name: "lastUpdatedAt")) UpdateDomainOutput.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name")) + UpdateDomainOutput.add_member(:root_domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "rootDomainUnitId")) UpdateDomainOutput.add_member(:single_sign_on, Shapes::ShapeRef.new(shape: SingleSignOn, location_name: "singleSignOn")) UpdateDomainOutput.struct_class = Types::UpdateDomainOutput + UpdateDomainUnitInput.add_member(:description, Shapes::ShapeRef.new(shape: DomainUnitDescription, location_name: "description")) + UpdateDomainUnitInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) + UpdateDomainUnitInput.add_member(:identifier, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location: "uri", location_name: "identifier")) + UpdateDomainUnitInput.add_member(:name, Shapes::ShapeRef.new(shape: DomainUnitName, location_name: "name")) + UpdateDomainUnitInput.struct_class = Types::UpdateDomainUnitInput + + UpdateDomainUnitOutput.add_member(:created_at, Shapes::ShapeRef.new(shape: CreatedAt, location_name: "createdAt")) + UpdateDomainUnitOutput.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, location_name: "createdBy")) + UpdateDomainUnitOutput.add_member(:description, Shapes::ShapeRef.new(shape: DomainUnitDescription, location_name: "description")) + UpdateDomainUnitOutput.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId")) + UpdateDomainUnitOutput.add_member(:id, Shapes::ShapeRef.new(shape: DomainUnitId, required: true, location_name: "id")) + UpdateDomainUnitOutput.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: UpdatedAt, location_name: "lastUpdatedAt")) + UpdateDomainUnitOutput.add_member(:last_updated_by, Shapes::ShapeRef.new(shape: UpdatedBy, location_name: "lastUpdatedBy")) + UpdateDomainUnitOutput.add_member(:name, Shapes::ShapeRef.new(shape: DomainUnitName, required: true, location_name: "name")) + UpdateDomainUnitOutput.add_member(:owners, Shapes::ShapeRef.new(shape: DomainUnitOwners, required: true, location_name: "owners")) + UpdateDomainUnitOutput.add_member(:parent_domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "parentDomainUnitId")) + UpdateDomainUnitOutput.struct_class = Types::UpdateDomainUnitOutput + UpdateEnvironmentActionInput.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description")) UpdateEnvironmentActionInput.add_member(:domain_identifier, Shapes::ShapeRef.new(shape: DomainId, required: true, location: "uri", location_name: "domainIdentifier")) UpdateEnvironmentActionInput.add_member(:environment_identifier, Shapes::ShapeRef.new(shape: EnvironmentId, required: true, location: "uri", location_name: "environmentIdentifier")) @@ -3768,6 +4137,7 @@ module ClientApi UpdateProjectOutput.add_member(:created_by, Shapes::ShapeRef.new(shape: CreatedBy, required: true, location_name: "createdBy")) UpdateProjectOutput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description")) UpdateProjectOutput.add_member(:domain_id, Shapes::ShapeRef.new(shape: DomainId, required: true, location_name: "domainId")) + UpdateProjectOutput.add_member(:domain_unit_id, Shapes::ShapeRef.new(shape: DomainUnitId, location_name: "domainUnitId")) UpdateProjectOutput.add_member(:failure_reasons, Shapes::ShapeRef.new(shape: FailureReasons, location_name: "failureReasons")) UpdateProjectOutput.add_member(:glossary_terms, Shapes::ShapeRef.new(shape: GlossaryTerms, location_name: "glossaryTerms")) UpdateProjectOutput.add_member(:id, Shapes::ShapeRef.new(shape: ProjectId, required: true, location_name: "id")) @@ -3864,6 +4234,14 @@ module ClientApi UserDetails.add_member(:user_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "userId")) UserDetails.struct_class = Types::UserDetails + UserPolicyGrantPrincipal.add_member(:all_users_grant_filter, Shapes::ShapeRef.new(shape: AllUsersGrantFilter, location_name: "allUsersGrantFilter")) + UserPolicyGrantPrincipal.add_member(:user_identifier, Shapes::ShapeRef.new(shape: UserIdentifier, location_name: "userIdentifier")) + UserPolicyGrantPrincipal.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + UserPolicyGrantPrincipal.add_member_subclass(:all_users_grant_filter, Types::UserPolicyGrantPrincipal::AllUsersGrantFilter) + UserPolicyGrantPrincipal.add_member_subclass(:user_identifier, Types::UserPolicyGrantPrincipal::UserIdentifier) + UserPolicyGrantPrincipal.add_member_subclass(:unknown, Types::UserPolicyGrantPrincipal::Unknown) + UserPolicyGrantPrincipal.struct_class = Types::UserPolicyGrantPrincipal + UserProfileDetails.add_member(:iam, Shapes::ShapeRef.new(shape: IamUserProfileDetails, location_name: "iam")) UserProfileDetails.add_member(:sso, Shapes::ShapeRef.new(shape: SsoUserProfileDetails, location_name: "sso")) UserProfileDetails.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) @@ -3932,6 +4310,37 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) end) + api.add_operation(:add_entity_owner, Seahorse::Model::Operation.new.tap do |o| + o.name = "AddEntityOwner" + o.http_method = "POST" + o.http_request_uri = "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/addOwner" + o.input = Shapes::ShapeRef.new(shape: AddEntityOwnerInput) + o.output = Shapes::ShapeRef.new(shape: AddEntityOwnerOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + + api.add_operation(:add_policy_grant, Seahorse::Model::Operation.new.tap do |o| + o.name = "AddPolicyGrant" + o.http_method = "POST" + o.http_request_uri = "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/addGrant" + o.input = Shapes::ShapeRef.new(shape: AddPolicyGrantInput) + o.output = Shapes::ShapeRef.new(shape: AddPolicyGrantOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + api.add_operation(:associate_environment_role, Seahorse::Model::Operation.new.tap do |o| o.name = "AssociateEnvironmentRole" o.http_method = "PUT" @@ -4102,6 +4511,21 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) end) + api.add_operation(:create_domain_unit, Seahorse::Model::Operation.new.tap do |o| + o.name = "CreateDomainUnit" + o.http_method = "POST" + o.http_request_uri = "/v2/domains/{domainIdentifier}/domain-units" + o.input = Shapes::ShapeRef.new(shape: CreateDomainUnitInput) + o.output = Shapes::ShapeRef.new(shape: CreateDomainUnitOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + api.add_operation(:create_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "CreateEnvironment" o.http_method = "POST" @@ -4404,6 +4828,21 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) end) + api.add_operation(:delete_domain_unit, Seahorse::Model::Operation.new.tap do |o| + o.name = "DeleteDomainUnit" + o.http_method = "DELETE" + o.http_request_uri = "/v2/domains/{domainIdentifier}/domain-units/{identifier}" + o.input = Shapes::ShapeRef.new(shape: DeleteDomainUnitInput) + o.output = Shapes::ShapeRef.new(shape: DeleteDomainUnitOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + api.add_operation(:delete_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "DeleteEnvironment" o.http_method = "DELETE" @@ -4726,6 +5165,20 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) end) + api.add_operation(:get_domain_unit, Seahorse::Model::Operation.new.tap do |o| + o.name = "GetDomainUnit" + o.http_method = "GET" + o.http_request_uri = "/v2/domains/{domainIdentifier}/domain-units/{identifier}" + o.input = Shapes::ShapeRef.new(shape: GetDomainUnitInput) + o.output = Shapes::ShapeRef.new(shape: GetDomainUnitOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + api.add_operation(:get_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "GetEnvironment" o.http_method = "GET" @@ -5147,6 +5600,25 @@ module ClientApi ) end) + api.add_operation(:list_domain_units_for_parent, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListDomainUnitsForParent" + o.http_method = "GET" + o.http_request_uri = "/v2/domains/{domainIdentifier}/domain-units" + o.input = Shapes::ShapeRef.new(shape: ListDomainUnitsForParentInput) + o.output = Shapes::ShapeRef.new(shape: ListDomainUnitsForParentOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_domains, Seahorse::Model::Operation.new.tap do |o| o.name = "ListDomains" o.http_method = "GET" @@ -5169,6 +5641,25 @@ module ClientApi ) end) + api.add_operation(:list_entity_owners, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListEntityOwners" + o.http_method = "GET" + o.http_request_uri = "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/owners" + o.input = Shapes::ShapeRef.new(shape: ListEntityOwnersInput) + o.output = Shapes::ShapeRef.new(shape: ListEntityOwnersOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_environment_actions, Seahorse::Model::Operation.new.tap do |o| o.name = "ListEnvironmentActions" o.http_method = "GET" @@ -5326,6 +5817,25 @@ module ClientApi ) end) + api.add_operation(:list_policy_grants, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListPolicyGrants" + o.http_method = "GET" + o.http_request_uri = "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/grants" + o.input = Shapes::ShapeRef.new(shape: ListPolicyGrantsInput) + o.output = Shapes::ShapeRef.new(shape: ListPolicyGrantsOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_project_memberships, Seahorse::Model::Operation.new.tap do |o| o.name = "ListProjectMemberships" o.http_method = "GET" @@ -5556,6 +6066,33 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) end) + api.add_operation(:remove_entity_owner, Seahorse::Model::Operation.new.tap do |o| + o.name = "RemoveEntityOwner" + o.http_method = "POST" + o.http_request_uri = "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/removeOwner" + o.input = Shapes::ShapeRef.new(shape: RemoveEntityOwnerInput) + o.output = Shapes::ShapeRef.new(shape: RemoveEntityOwnerOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + + api.add_operation(:remove_policy_grant, Seahorse::Model::Operation.new.tap do |o| + o.name = "RemovePolicyGrant" + o.http_method = "POST" + o.http_request_uri = "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/removeGrant" + o.input = Shapes::ShapeRef.new(shape: RemovePolicyGrantInput) + o.output = Shapes::ShapeRef.new(shape: RemovePolicyGrantOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + api.add_operation(:revoke_subscription, Seahorse::Model::Operation.new.tap do |o| o.name = "RevokeSubscription" o.http_method = "PUT" @@ -5774,6 +6311,21 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) end) + api.add_operation(:update_domain_unit, Seahorse::Model::Operation.new.tap do |o| + o.name = "UpdateDomainUnit" + o.http_method = "PUT" + o.http_request_uri = "/v2/domains/{domainIdentifier}/domain-units/{identifier}" + o.input = Shapes::ShapeRef.new(shape: UpdateDomainUnitInput) + o.output = Shapes::ShapeRef.new(shape: UpdateDomainUnitOutput) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: ConflictException) + o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException) + end) + api.add_operation(:update_environment, Seahorse::Model::Operation.new.tap do |o| o.name = "UpdateEnvironment" o.http_method = "PATCH" diff --git a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/endpoints.rb b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/endpoints.rb index 7ae2734b67c..db512d887ab 100644 --- a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/endpoints.rb +++ b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/endpoints.rb @@ -38,6 +38,32 @@ def self.build(context) end end + class AddEntityOwner + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + + class AddPolicyGrant + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class AssociateEnvironmentRole def self.build(context) unless context.config.regional_endpoint @@ -181,6 +207,19 @@ def self.build(context) end end + class CreateDomainUnit + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class CreateEnvironment def self.build(context) unless context.config.regional_endpoint @@ -441,6 +480,19 @@ def self.build(context) end end + class DeleteDomainUnit + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class DeleteEnvironment def self.build(context) unless context.config.regional_endpoint @@ -727,6 +779,19 @@ def self.build(context) end end + class GetDomainUnit + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class GetEnvironment def self.build(context) unless context.config.regional_endpoint @@ -1078,6 +1143,19 @@ def self.build(context) end end + class ListDomainUnitsForParent + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ListDomains def self.build(context) unless context.config.regional_endpoint @@ -1091,6 +1169,19 @@ def self.build(context) end end + class ListEntityOwners + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ListEnvironmentActions def self.build(context) unless context.config.regional_endpoint @@ -1195,6 +1286,19 @@ def self.build(context) end end + class ListPolicyGrants + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class ListProjectMemberships def self.build(context) unless context.config.regional_endpoint @@ -1364,6 +1468,32 @@ def self.build(context) end end + class RemoveEntityOwner + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + + class RemovePolicyGrant + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class RevokeSubscription def self.build(context) unless context.config.regional_endpoint @@ -1533,6 +1663,19 @@ def self.build(context) end end + class UpdateDomainUnit + def self.build(context) + unless context.config.regional_endpoint + endpoint = context.config.endpoint.to_s + end + Aws::DataZone::EndpointParameters.new( + region: context.config.region, + use_fips: context.config.use_fips_endpoint, + endpoint: endpoint, + ) + end + end + class UpdateEnvironment def self.build(context) unless context.config.regional_endpoint diff --git a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/plugins/endpoints.rb b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/plugins/endpoints.rb index 6e4bba7edf1..2764366016b 100644 --- a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/plugins/endpoints.rb +++ b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/plugins/endpoints.rb @@ -62,6 +62,10 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::AcceptPredictions.build(context) when :accept_subscription_request Aws::DataZone::Endpoints::AcceptSubscriptionRequest.build(context) + when :add_entity_owner + Aws::DataZone::Endpoints::AddEntityOwner.build(context) + when :add_policy_grant + Aws::DataZone::Endpoints::AddPolicyGrant.build(context) when :associate_environment_role Aws::DataZone::Endpoints::AssociateEnvironmentRole.build(context) when :cancel_metadata_generation_run @@ -84,6 +88,8 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::CreateDataSource.build(context) when :create_domain Aws::DataZone::Endpoints::CreateDomain.build(context) + when :create_domain_unit + Aws::DataZone::Endpoints::CreateDomainUnit.build(context) when :create_environment Aws::DataZone::Endpoints::CreateEnvironment.build(context) when :create_environment_action @@ -124,6 +130,8 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::DeleteDataSource.build(context) when :delete_domain Aws::DataZone::Endpoints::DeleteDomain.build(context) + when :delete_domain_unit + Aws::DataZone::Endpoints::DeleteDomainUnit.build(context) when :delete_environment Aws::DataZone::Endpoints::DeleteEnvironment.build(context) when :delete_environment_action @@ -168,6 +176,8 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::GetDataSourceRun.build(context) when :get_domain Aws::DataZone::Endpoints::GetDomain.build(context) + when :get_domain_unit + Aws::DataZone::Endpoints::GetDomainUnit.build(context) when :get_environment Aws::DataZone::Endpoints::GetEnvironment.build(context) when :get_environment_action @@ -222,8 +232,12 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::ListDataSourceRuns.build(context) when :list_data_sources Aws::DataZone::Endpoints::ListDataSources.build(context) + when :list_domain_units_for_parent + Aws::DataZone::Endpoints::ListDomainUnitsForParent.build(context) when :list_domains Aws::DataZone::Endpoints::ListDomains.build(context) + when :list_entity_owners + Aws::DataZone::Endpoints::ListEntityOwners.build(context) when :list_environment_actions Aws::DataZone::Endpoints::ListEnvironmentActions.build(context) when :list_environment_blueprint_configurations @@ -240,6 +254,8 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::ListMetadataGenerationRuns.build(context) when :list_notifications Aws::DataZone::Endpoints::ListNotifications.build(context) + when :list_policy_grants + Aws::DataZone::Endpoints::ListPolicyGrants.build(context) when :list_project_memberships Aws::DataZone::Endpoints::ListProjectMemberships.build(context) when :list_projects @@ -266,6 +282,10 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::RejectPredictions.build(context) when :reject_subscription_request Aws::DataZone::Endpoints::RejectSubscriptionRequest.build(context) + when :remove_entity_owner + Aws::DataZone::Endpoints::RemoveEntityOwner.build(context) + when :remove_policy_grant + Aws::DataZone::Endpoints::RemovePolicyGrant.build(context) when :revoke_subscription Aws::DataZone::Endpoints::RevokeSubscription.build(context) when :search @@ -292,6 +312,8 @@ def parameters_for_operation(context) Aws::DataZone::Endpoints::UpdateDataSource.build(context) when :update_domain Aws::DataZone::Endpoints::UpdateDomain.build(context) + when :update_domain_unit + Aws::DataZone::Endpoints::UpdateDomainUnit.build(context) when :update_environment Aws::DataZone::Endpoints::UpdateEnvironment.build(context) when :update_environment_action diff --git a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb index e8bee24f58d..51af466b915 100644 --- a/gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb +++ b/gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb @@ -260,6 +260,127 @@ class AwsConsoleLink < ActionParameters; end class Unknown < ActionParameters; end end + # @!attribute [rw] client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] + # + # @!attribute [rw] domain_identifier + # The ID of the domain in which you want to add the entity owner. + # @return [String] + # + # @!attribute [rw] entity_identifier + # The ID of the entity to which you want to add an owner. + # @return [String] + # + # @!attribute [rw] entity_type + # The type of an entity. + # @return [String] + # + # @!attribute [rw] owner + # The owner that you want to add to the entity. + # @return [Types::OwnerProperties] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AddEntityOwnerInput AWS API Documentation + # + class AddEntityOwnerInput < Struct.new( + :client_token, + :domain_identifier, + :entity_identifier, + :entity_type, + :owner) + SENSITIVE = [] + include Aws::Structure + end + + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AddEntityOwnerOutput AWS API Documentation + # + class AddEntityOwnerOutput < Aws::EmptyStructure; end + + # @!attribute [rw] client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] + # + # @!attribute [rw] detail + # The details of the policy grant. + # @return [Types::PolicyGrantDetail] + # + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to add a policy grant. + # @return [String] + # + # @!attribute [rw] entity_identifier + # The ID of the entity (resource) to which you want to add a policy + # grant. + # @return [String] + # + # @!attribute [rw] entity_type + # The type of entity (resource) to which the grant is added. + # @return [String] + # + # @!attribute [rw] policy_type + # The type of policy that you want to grant. + # @return [String] + # + # @!attribute [rw] principal + # The principal to whom the permissions are granted. + # @return [Types::PolicyGrantPrincipal] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AddPolicyGrantInput AWS API Documentation + # + class AddPolicyGrantInput < Struct.new( + :client_token, + :detail, + :domain_identifier, + :entity_identifier, + :entity_type, + :policy_type, + :principal) + SENSITIVE = [] + include Aws::Structure + end + + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AddPolicyGrantOutput AWS API Documentation + # + class AddPolicyGrantOutput < Aws::EmptyStructure; end + + # The details of the policy grant. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy grant is applied to child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AddToProjectMemberPoolPolicyGrantDetail AWS API Documentation + # + class AddToProjectMemberPoolPolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + + # The grant filter for all domain units. + # + # @api private + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AllDomainUnitsGrantFilter AWS API Documentation + # + class AllDomainUnitsGrantFilter < Aws::EmptyStructure; end + + # The all users grant filter. + # + # @api private + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/AllUsersGrantFilter AWS API Documentation + # + class AllUsersGrantFilter < Aws::EmptyStructure; end + # The configuration details of the asset filter. # # @note AssetFilterConfiguration is a union - when making an API calls you must set exactly one of the members. @@ -1582,6 +1703,20 @@ class CreateAssetTypeOutput < Struct.new( include Aws::Structure end + # The details of the policy grant. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy grant is applied to child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateAssetTypePolicyGrantDetail AWS API Documentation + # + class CreateAssetTypePolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] client_token # A unique, case-sensitive identifier that is provided to ensure the # idempotency of the request. @@ -2121,6 +2256,10 @@ class CreateDomainInput < Struct.new( # The URL of the data portal for this Amazon DataZone domain. # @return [String] # + # @!attribute [rw] root_domain_unit_id + # The ID of the root domain unit. + # @return [String] + # # @!attribute [rw] single_sign_on # The single-sign on configuration of the Amazon DataZone domain. # @return [Types::SingleSignOn] @@ -2143,6 +2282,7 @@ class CreateDomainOutput < Struct.new( :kms_key_identifier, :name, :portal_url, + :root_domain_unit_id, :single_sign_on, :status, :tags) @@ -2150,6 +2290,108 @@ class CreateDomainOutput < Struct.new( include Aws::Structure end + # @!attribute [rw] client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] + # + # @!attribute [rw] description + # The description of the domain unit. + # @return [String] + # + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to crate a domain unit. + # @return [String] + # + # @!attribute [rw] name + # The name of the domain unit. + # @return [String] + # + # @!attribute [rw] parent_domain_unit_identifier + # The ID of the parent domain unit. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateDomainUnitInput AWS API Documentation + # + class CreateDomainUnitInput < Struct.new( + :client_token, + :description, + :domain_identifier, + :name, + :parent_domain_unit_identifier) + SENSITIVE = [:description, :name] + include Aws::Structure + end + + # @!attribute [rw] ancestor_domain_unit_ids + # The IDs of the ancestor domain units. + # @return [Array] + # + # @!attribute [rw] created_at + # The timestamp at which the domain unit was created. + # @return [Time] + # + # @!attribute [rw] created_by + # The user who created the domain unit. + # @return [String] + # + # @!attribute [rw] description + # The description of the domain unit. + # @return [String] + # + # @!attribute [rw] domain_id + # The ID of the domain where the domain unit was created. + # @return [String] + # + # @!attribute [rw] id + # The ID of the domain unit. + # @return [String] + # + # @!attribute [rw] name + # The name of the domain unit. + # @return [String] + # + # @!attribute [rw] owners + # The owners of the domain unit. + # @return [Array] + # + # @!attribute [rw] parent_domain_unit_id + # The ID of the parent domain unit. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateDomainUnitOutput AWS API Documentation + # + class CreateDomainUnitOutput < Struct.new( + :ancestor_domain_unit_ids, + :created_at, + :created_by, + :description, + :domain_id, + :id, + :name, + :owners, + :parent_domain_unit_id) + SENSITIVE = [:description, :name] + include Aws::Structure + end + + # The details of the policy grant. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy grant is applied to child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateDomainUnitPolicyGrantDetail AWS API Documentation + # + class CreateDomainUnitPolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] description # The description of the environment action that is being created in # the environment. @@ -2527,6 +2769,20 @@ class CreateEnvironmentProfileOutput < Struct.new( include Aws::Structure end + # The details of the policy grant. + # + # @!attribute [rw] domain_unit_id + # The ID of the domain unit. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateEnvironmentProfilePolicyGrantDetail AWS API Documentation + # + class CreateEnvironmentProfilePolicyGrantDetail < Struct.new( + :domain_unit_id) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] description # The description of this Amazon DataZone metadata form type. # @return [String] @@ -2612,6 +2868,20 @@ class CreateFormTypeOutput < Struct.new( include Aws::Structure end + # The details of the policy grant. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy grant is applied to child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateFormTypePolicyGrantDetail AWS API Documentation + # + class CreateFormTypePolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] client_token # A unique, case-sensitive identifier that is provided to ensure the # idempotency of the request. @@ -2692,6 +2962,20 @@ class CreateGlossaryOutput < Struct.new( include Aws::Structure end + # The details of the policy grant. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy grant is applied to child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateGlossaryPolicyGrantDetail AWS API Documentation + # + class CreateGlossaryPolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] client_token # A unique, case-sensitive identifier that is provided to ensure the # idempotency of the request. @@ -2919,6 +3203,12 @@ class CreateListingChangeSetOutput < Struct.new( # created. # @return [String] # + # @!attribute [rw] domain_unit_id + # The ID of the domain unit. This parameter is not required and if it + # is not specified, then the project is created at the root domain + # unit level. + # @return [String] + # # @!attribute [rw] glossary_terms # The glossary terms that can be used in this Amazon DataZone project. # @return [Array] @@ -2932,6 +3222,7 @@ class CreateListingChangeSetOutput < Struct.new( class CreateProjectInput < Struct.new( :description, :domain_identifier, + :domain_unit_id, :glossary_terms, :name) SENSITIVE = [:description, :name] @@ -2987,6 +3278,10 @@ class CreateProjectMembershipOutput < Aws::EmptyStructure; end # was created. # @return [String] # + # @!attribute [rw] domain_unit_id + # The ID of the domain unit. + # @return [String] + # # @!attribute [rw] failure_reasons # Specifies the error message that is returned if the operation cannot # be successfully completed. @@ -3019,6 +3314,7 @@ class CreateProjectOutput < Struct.new( :created_by, :description, :domain_id, + :domain_unit_id, :failure_reasons, :glossary_terms, :id, @@ -3029,6 +3325,20 @@ class CreateProjectOutput < Struct.new( include Aws::Structure end + # The details of the policy grant. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy grant is applied to child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateProjectPolicyGrantDetail AWS API Documentation + # + class CreateProjectPolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] asset_target_names # The names of the assets for which the subscription grant is created. # @return [Array] @@ -4315,6 +4625,27 @@ class DeleteDomainOutput < Struct.new( include Aws::Structure end + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to delete a domain unit. + # @return [String] + # + # @!attribute [rw] identifier + # The ID of the domain unit that you want to delete. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DeleteDomainUnitInput AWS API Documentation + # + class DeleteDomainUnitInput < Struct.new( + :domain_identifier, + :identifier) + SENSITIVE = [] + include Aws::Structure + end + + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DeleteDomainUnitOutput AWS API Documentation + # + class DeleteDomainUnitOutput < Aws::EmptyStructure; end + # @!attribute [rw] domain_identifier # The ID of the Amazon DataZone domain in which an environment action # is deleted. @@ -4872,56 +5203,198 @@ class DomainSummary < Struct.new( include Aws::Structure end - # The details about the specified action configured for an environment. - # For example, the details of the specified console links for an - # analytics tool that is available in this environment. + # The domain unit filter of the project grant filter. # - # @!attribute [rw] description - # The environment action description. + # @!attribute [rw] domain_unit + # The domain unit ID to use in the filter. # @return [String] # - # @!attribute [rw] domain_id - # The Amazon DataZone domain ID of the environment action. - # @return [String] + # @!attribute [rw] include_child_domain_units + # Specifies whether to include child domain units. + # @return [Boolean] # - # @!attribute [rw] environment_id - # The environment ID of the environment action. - # @return [String] + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DomainUnitFilterForProject AWS API Documentation # - # @!attribute [rw] id - # The ID of the environment action. - # @return [String] + class DomainUnitFilterForProject < Struct.new( + :domain_unit, + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + + # The grant filter for the domain unit. In the current release of Amazon + # DataZone, the only supported filter is the + # `allDomainUnitsGrantFilter`. # - # @!attribute [rw] name - # The name of the environment action. - # @return [String] + # @note DomainUnitGrantFilter is a union - when making an API calls you must set exactly one of the members. # - # @!attribute [rw] parameters - # The parameters of the environment action. - # @return [Types::ActionParameters] + # @note DomainUnitGrantFilter is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DomainUnitGrantFilter corresponding to the set member. # - # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/EnvironmentActionSummary AWS API Documentation + # @!attribute [rw] all_domain_units_grant_filter + # Specifies a grant filter containing all domain units. + # @return [Types::AllDomainUnitsGrantFilter] # - class EnvironmentActionSummary < Struct.new( - :description, - :domain_id, - :environment_id, - :id, - :name, - :parameters) + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DomainUnitGrantFilter AWS API Documentation + # + class DomainUnitGrantFilter < Struct.new( + :all_domain_units_grant_filter, + :unknown) SENSITIVE = [] include Aws::Structure + include Aws::Structure::Union + + class AllDomainUnitsGrantFilter < DomainUnitGrantFilter; end + class Unknown < DomainUnitGrantFilter; end end - # The configuration details of an environment blueprint. + # The properties of a domain unit group. # - # @!attribute [rw] created_at - # The timestamp of when an environment blueprint was created. - # @return [Time] - # - # @!attribute [rw] domain_id - # The identifier of the Amazon DataZone domain in which an environment - # blueprint exists. + # @!attribute [rw] group_id + # The ID of the domain unit group. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DomainUnitGroupProperties AWS API Documentation + # + class DomainUnitGroupProperties < Struct.new( + :group_id) + SENSITIVE = [] + include Aws::Structure + end + + # The properties of the domain unit owner. + # + # @note DomainUnitOwnerProperties is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DomainUnitOwnerProperties corresponding to the set member. + # + # @!attribute [rw] group + # Indicates that the domain unit owner is a group. + # @return [Types::DomainUnitGroupProperties] + # + # @!attribute [rw] user + # Indicates that the domain unit owner is a user. + # @return [Types::DomainUnitUserProperties] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DomainUnitOwnerProperties AWS API Documentation + # + class DomainUnitOwnerProperties < Struct.new( + :group, + :user, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class Group < DomainUnitOwnerProperties; end + class User < DomainUnitOwnerProperties; end + class Unknown < DomainUnitOwnerProperties; end + end + + # The domain unit principal to whom the policy is granted. + # + # @!attribute [rw] domain_unit_designation + # Specifes the designation of the domain unit users. + # @return [String] + # + # @!attribute [rw] domain_unit_grant_filter + # The grant filter for the domain unit. + # @return [Types::DomainUnitGrantFilter] + # + # @!attribute [rw] domain_unit_identifier + # The ID of the domain unit. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DomainUnitPolicyGrantPrincipal AWS API Documentation + # + class DomainUnitPolicyGrantPrincipal < Struct.new( + :domain_unit_designation, + :domain_unit_grant_filter, + :domain_unit_identifier) + SENSITIVE = [] + include Aws::Structure + end + + # The summary of the domain unit. + # + # @!attribute [rw] id + # The ID of the domain unit summary. + # @return [String] + # + # @!attribute [rw] name + # The name of the domain unit summary. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DomainUnitSummary AWS API Documentation + # + class DomainUnitSummary < Struct.new( + :id, + :name) + SENSITIVE = [] + include Aws::Structure + end + + # The properties of the domain unit user. + # + # @!attribute [rw] user_id + # The ID of teh domain unit user. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DomainUnitUserProperties AWS API Documentation + # + class DomainUnitUserProperties < Struct.new( + :user_id) + SENSITIVE = [] + include Aws::Structure + end + + # The details about the specified action configured for an environment. + # For example, the details of the specified console links for an + # analytics tool that is available in this environment. + # + # @!attribute [rw] description + # The environment action description. + # @return [String] + # + # @!attribute [rw] domain_id + # The Amazon DataZone domain ID of the environment action. + # @return [String] + # + # @!attribute [rw] environment_id + # The environment ID of the environment action. + # @return [String] + # + # @!attribute [rw] id + # The ID of the environment action. + # @return [String] + # + # @!attribute [rw] name + # The name of the environment action. + # @return [String] + # + # @!attribute [rw] parameters + # The parameters of the environment action. + # @return [Types::ActionParameters] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/EnvironmentActionSummary AWS API Documentation + # + class EnvironmentActionSummary < Struct.new( + :description, + :domain_id, + :environment_id, + :id, + :name, + :parameters) + SENSITIVE = [] + include Aws::Structure + end + + # The configuration details of an environment blueprint. + # + # @!attribute [rw] created_at + # The timestamp of when an environment blueprint was created. + # @return [Time] + # + # @!attribute [rw] domain_id + # The identifier of the Amazon DataZone domain in which an environment + # blueprint exists. # @return [String] # # @!attribute [rw] enabled_regions @@ -6163,6 +6636,10 @@ class GetDomainInput < Struct.new( # The URL of the data portal for this Amazon DataZone domain. # @return [String] # + # @!attribute [rw] root_domain_unit_id + # The ID of the root domain in Amazon Datazone. + # @return [String] + # # @!attribute [rw] single_sign_on # The single sing-on option of the specified Amazon DataZone domain. # @return [Types::SingleSignOn] @@ -6187,6 +6664,7 @@ class GetDomainOutput < Struct.new( :last_updated_at, :name, :portal_url, + :root_domain_unit_id, :single_sign_on, :status, :tags) @@ -6194,6 +6672,80 @@ class GetDomainOutput < Struct.new( include Aws::Structure end + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to get a domain unit. + # @return [String] + # + # @!attribute [rw] identifier + # The identifier of the domain unit that you want to get. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetDomainUnitInput AWS API Documentation + # + class GetDomainUnitInput < Struct.new( + :domain_identifier, + :identifier) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] created_at + # The time stamp at which the domain unit was created. + # @return [Time] + # + # @!attribute [rw] created_by + # The user who created the domain unit. + # @return [String] + # + # @!attribute [rw] description + # The description of the domain unit. + # @return [String] + # + # @!attribute [rw] domain_id + # The ID of the domain in which the domain unit lives. + # @return [String] + # + # @!attribute [rw] id + # The ID of the domain unit. + # @return [String] + # + # @!attribute [rw] last_updated_at + # The timestamp at which the domain unit was last updated. + # @return [Time] + # + # @!attribute [rw] last_updated_by + # The user who last updated the domain unit. + # @return [String] + # + # @!attribute [rw] name + # The name of the domain unit. + # @return [String] + # + # @!attribute [rw] owners + # The owners of the domain unit. + # @return [Array] + # + # @!attribute [rw] parent_domain_unit_id + # The ID of the parent domain unit. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetDomainUnitOutput AWS API Documentation + # + class GetDomainUnitOutput < Struct.new( + :created_at, + :created_by, + :description, + :domain_id, + :id, + :last_updated_at, + :last_updated_by, + :name, + :owners, + :parent_domain_unit_id) + SENSITIVE = [:description, :name] + include Aws::Structure + end + # @!attribute [rw] domain_identifier # The ID of the Amazon DataZone domain in which the # `GetEnvironmentAction` API is invoked. @@ -7293,6 +7845,10 @@ class GetProjectInput < Struct.new( # The ID of the Amazon DataZone domain in which the project exists. # @return [String] # + # @!attribute [rw] domain_unit_id + # The ID of the domain unit. + # @return [String] + # # @!attribute [rw] failure_reasons # Specifies the error message that is returned if the operation cannot # be successfully completed. @@ -7325,6 +7881,7 @@ class GetProjectOutput < Struct.new( :created_by, :description, :domain_id, + :domain_unit_id, :failure_reasons, :glossary_terms, :id, @@ -8123,6 +8680,29 @@ class GroupDetails < Struct.new( include Aws::Structure end + # The group principal to whom the policy is granted. + # + # @note GroupPolicyGrantPrincipal is a union - when making an API calls you must set exactly one of the members. + # + # @note GroupPolicyGrantPrincipal is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of GroupPolicyGrantPrincipal corresponding to the set member. + # + # @!attribute [rw] group_identifier + # The ID Of the group of the group principal. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GroupPolicyGrantPrincipal AWS API Documentation + # + class GroupPolicyGrantPrincipal < Struct.new( + :group_identifier, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class GroupIdentifier < GroupPolicyGrantPrincipal; end + class Unknown < GroupPolicyGrantPrincipal; end + end + # The details of a group profile. # # @!attribute [rw] domain_id @@ -8857,6 +9437,65 @@ class ListDataSourcesOutput < Struct.new( include Aws::Structure end + # @!attribute [rw] domain_identifier + # The ID of the domain in which you want to list domain units for a + # parent domain unit. + # @return [String] + # + # @!attribute [rw] max_results + # The maximum number of domain units to return in a single call to + # ListDomainUnitsForParent. When the number of domain units to be + # listed is greater than the value of MaxResults, the response + # contains a NextToken value that you can use in a subsequent call to + # ListDomainUnitsForParent to list the next set of domain units. + # @return [Integer] + # + # @!attribute [rw] next_token + # When the number of domain units is greater than the default value + # for the MaxResults parameter, or if you explicitly specify a value + # for MaxResults that is less than the number of domain units, the + # response includes a pagination token named NextToken. You can + # specify this NextToken value in a subsequent call to + # ListDomainUnitsForParent to list the next set of domain units. + # @return [String] + # + # @!attribute [rw] parent_domain_unit_identifier + # The ID of the parent domain unit. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListDomainUnitsForParentInput AWS API Documentation + # + class ListDomainUnitsForParentInput < Struct.new( + :domain_identifier, + :max_results, + :next_token, + :parent_domain_unit_identifier) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] items + # The results returned by this action. + # @return [Array] + # + # @!attribute [rw] next_token + # When the number of domain units is greater than the default value + # for the MaxResults parameter, or if you explicitly specify a value + # for MaxResults that is less than the number of domain units, the + # response includes a pagination token named NextToken. You can + # specify this NextToken value in a subsequent call to + # ListDomainUnitsForParent to list the next set of domain units. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListDomainUnitsForParentOutput AWS API Documentation + # + class ListDomainUnitsForParentOutput < Struct.new( + :items, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] max_results # The maximum number of domains to return in a single call to # `ListDomains`. When the number of domains to be listed is greater @@ -8910,6 +9549,69 @@ class ListDomainsOutput < Struct.new( include Aws::Structure end + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to list entity owners. + # @return [String] + # + # @!attribute [rw] entity_identifier + # The ID of the entity that you want to list. + # @return [String] + # + # @!attribute [rw] entity_type + # The type of the entity that you want to list. + # @return [String] + # + # @!attribute [rw] max_results + # The maximum number of entities to return in a single call to + # `ListEntityOwners`. When the number of entities to be listed is + # greater than the value of `MaxResults`, the response contains a + # `NextToken` value that you can use in a subsequent call to + # `ListEntityOwners` to list the next set of entities. + # @return [Integer] + # + # @!attribute [rw] next_token + # When the number of entities is greater than the default value for + # the `MaxResults` parameter, or if you explicitly specify a value for + # `MaxResults` that is less than the number of entities, the response + # includes a pagination token named `NextToken`. You can specify this + # `NextToken` value in a subsequent call to `ListEntityOwners` to list + # the next set of entities. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListEntityOwnersInput AWS API Documentation + # + class ListEntityOwnersInput < Struct.new( + :domain_identifier, + :entity_identifier, + :entity_type, + :max_results, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] next_token + # When the number of entities is greater than the default value for + # the `MaxResults` parameter, or if you explicitly specify a value for + # `MaxResults` that is less than the number of entities, the response + # includes a pagination token named `NextToken`. You can specify this + # `NextToken` value in a subsequent call to `ListEntityOwners` to list + # the next set of entities. + # @return [String] + # + # @!attribute [rw] owners + # The owners of the entity. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListEntityOwnersOutput AWS API Documentation + # + class ListEntityOwnersOutput < Struct.new( + :next_token, + :owners) + SENSITIVE = [] + include Aws::Structure + end + # @!attribute [rw] domain_identifier # The ID of the Amazon DataZone domain in which the environment # actions are listed. @@ -9501,7 +10203,75 @@ class ListNotificationsOutput < Struct.new( end # @!attribute [rw] domain_identifier - # The identifier of the Amazon DataZone domain in which you want to + # The ID of the domain where you want to list policy grants. + # @return [String] + # + # @!attribute [rw] entity_identifier + # The ID of the entity for which you want to list policy grants. + # @return [String] + # + # @!attribute [rw] entity_type + # The type of entity for which you want to list policy grants. + # @return [String] + # + # @!attribute [rw] max_results + # The maximum number of grants to return in a single call to + # `ListPolicyGrants`. When the number of grants to be listed is + # greater than the value of `MaxResults`, the response contains a + # `NextToken` value that you can use in a subsequent call to + # `ListPolicyGrants` to list the next set of grants. + # @return [Integer] + # + # @!attribute [rw] next_token + # When the number of grants is greater than the default value for the + # `MaxResults` parameter, or if you explicitly specify a value for + # `MaxResults` that is less than the number of grants, the response + # includes a pagination token named `NextToken`. You can specify this + # `NextToken` value in a subsequent call to `ListPolicyGrants` to list + # the next set of grants. + # @return [String] + # + # @!attribute [rw] policy_type + # The type of policy that you want to list. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListPolicyGrantsInput AWS API Documentation + # + class ListPolicyGrantsInput < Struct.new( + :domain_identifier, + :entity_identifier, + :entity_type, + :max_results, + :next_token, + :policy_type) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] grant_list + # The results of this action - the listed grants. + # @return [Array] + # + # @!attribute [rw] next_token + # When the number of grants is greater than the default value for the + # `MaxResults` parameter, or if you explicitly specify a value for + # `MaxResults` that is less than the number of grants, the response + # includes a pagination token named `NextToken`. You can specify this + # `NextToken` value in a subsequent call to `ListPolicyGrants` to list + # the next set of grants. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListPolicyGrantsOutput AWS API Documentation + # + class ListPolicyGrantsOutput < Struct.new( + :grant_list, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] domain_identifier + # The identifier of the Amazon DataZone domain in which you want to # list project memberships. # @return [String] # @@ -10511,6 +11281,299 @@ class NotificationResource < Struct.new( include Aws::Structure end + # The grant details of the override domain unit owners policy. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy is inherited by child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OverrideDomainUnitOwnersPolicyGrantDetail AWS API Documentation + # + class OverrideDomainUnitOwnersPolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + + # The details of the override project owners policy grant. + # + # @!attribute [rw] include_child_domain_units + # Specifies whether the policy is inherited by child domain units. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OverrideProjectOwnersPolicyGrantDetail AWS API Documentation + # + class OverrideProjectOwnersPolicyGrantDetail < Struct.new( + :include_child_domain_units) + SENSITIVE = [] + include Aws::Structure + end + + # The properties of the domain unit owners group. + # + # @!attribute [rw] group_identifier + # The ID of the domain unit owners group. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OwnerGroupProperties AWS API Documentation + # + class OwnerGroupProperties < Struct.new( + :group_identifier) + SENSITIVE = [] + include Aws::Structure + end + + # The properties of the domain unit owners group. + # + # @!attribute [rw] group_id + # The ID of the domain unit owners group. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OwnerGroupPropertiesOutput AWS API Documentation + # + class OwnerGroupPropertiesOutput < Struct.new( + :group_id) + SENSITIVE = [] + include Aws::Structure + end + + # The properties of a domain unit's owner. + # + # @note OwnerProperties is a union - when making an API calls you must set exactly one of the members. + # + # @!attribute [rw] group + # Specifies that the domain unit owner is a group. + # @return [Types::OwnerGroupProperties] + # + # @!attribute [rw] user + # Specifies that the domain unit owner is a user. + # @return [Types::OwnerUserProperties] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OwnerProperties AWS API Documentation + # + class OwnerProperties < Struct.new( + :group, + :user, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class Group < OwnerProperties; end + class User < OwnerProperties; end + class Unknown < OwnerProperties; end + end + + # The ID of the domain unit owners group. + # + # @note OwnerPropertiesOutput is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OwnerPropertiesOutput corresponding to the set member. + # + # @!attribute [rw] group + # Specifies that the domain unit owner is a group. + # @return [Types::OwnerGroupPropertiesOutput] + # + # @!attribute [rw] user + # Specifies that the domain unit owner is a user. + # @return [Types::OwnerUserPropertiesOutput] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OwnerPropertiesOutput AWS API Documentation + # + class OwnerPropertiesOutput < Struct.new( + :group, + :user, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class Group < OwnerPropertiesOutput; end + class User < OwnerPropertiesOutput; end + class Unknown < OwnerPropertiesOutput; end + end + + # The properties of the owner user. + # + # @!attribute [rw] user_identifier + # The ID of the owner user. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OwnerUserProperties AWS API Documentation + # + class OwnerUserProperties < Struct.new( + :user_identifier) + SENSITIVE = [] + include Aws::Structure + end + + # The properties of the owner user. + # + # @!attribute [rw] user_id + # The ID of the owner user. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/OwnerUserPropertiesOutput AWS API Documentation + # + class OwnerUserPropertiesOutput < Struct.new( + :user_id) + SENSITIVE = [] + include Aws::Structure + end + + # The details of the policy grant. + # + # @note PolicyGrantDetail is a union - when making an API calls you must set exactly one of the members. + # + # @note PolicyGrantDetail is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PolicyGrantDetail corresponding to the set member. + # + # @!attribute [rw] add_to_project_member_pool + # Specifies that the policy grant is to be added to the members of the + # project. + # @return [Types::AddToProjectMemberPoolPolicyGrantDetail] + # + # @!attribute [rw] create_asset_type + # Specifies that this is a create asset type policy. + # @return [Types::CreateAssetTypePolicyGrantDetail] + # + # @!attribute [rw] create_domain_unit + # Specifies that this is a create domain unit policy. + # @return [Types::CreateDomainUnitPolicyGrantDetail] + # + # @!attribute [rw] create_environment + # Specifies that this is a create environment policy. + # @return [Types::Unit] + # + # @!attribute [rw] create_environment_profile + # Specifies that this is a create environment profile policy. + # @return [Types::CreateEnvironmentProfilePolicyGrantDetail] + # + # @!attribute [rw] create_form_type + # Specifies that this is a create form type policy. + # @return [Types::CreateFormTypePolicyGrantDetail] + # + # @!attribute [rw] create_glossary + # Specifies that this is a create glossary policy. + # @return [Types::CreateGlossaryPolicyGrantDetail] + # + # @!attribute [rw] create_project + # Specifies that this is a create project policy. + # @return [Types::CreateProjectPolicyGrantDetail] + # + # @!attribute [rw] delegate_create_environment_profile + # Specifies that this is the delegation of the create environment + # profile policy. + # @return [Types::Unit] + # + # @!attribute [rw] override_domain_unit_owners + # Specifies whether to override domain unit owners. + # @return [Types::OverrideDomainUnitOwnersPolicyGrantDetail] + # + # @!attribute [rw] override_project_owners + # Specifies whether to override project owners. + # @return [Types::OverrideProjectOwnersPolicyGrantDetail] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/PolicyGrantDetail AWS API Documentation + # + class PolicyGrantDetail < Struct.new( + :add_to_project_member_pool, + :create_asset_type, + :create_domain_unit, + :create_environment, + :create_environment_profile, + :create_form_type, + :create_glossary, + :create_project, + :delegate_create_environment_profile, + :override_domain_unit_owners, + :override_project_owners, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class AddToProjectMemberPool < PolicyGrantDetail; end + class CreateAssetType < PolicyGrantDetail; end + class CreateDomainUnit < PolicyGrantDetail; end + class CreateEnvironment < PolicyGrantDetail; end + class CreateEnvironmentProfile < PolicyGrantDetail; end + class CreateFormType < PolicyGrantDetail; end + class CreateGlossary < PolicyGrantDetail; end + class CreateProject < PolicyGrantDetail; end + class DelegateCreateEnvironmentProfile < PolicyGrantDetail; end + class OverrideDomainUnitOwners < PolicyGrantDetail; end + class OverrideProjectOwners < PolicyGrantDetail; end + class Unknown < PolicyGrantDetail; end + end + + # A member of the policy grant list. + # + # @!attribute [rw] created_at + # Specifies the timestamp at which policy grant member was created. + # @return [Time] + # + # @!attribute [rw] created_by + # Specifies the user who created the policy grant member. + # @return [String] + # + # @!attribute [rw] detail + # The details of the policy grant member. + # @return [Types::PolicyGrantDetail] + # + # @!attribute [rw] principal + # The principal of the policy grant member. + # @return [Types::PolicyGrantPrincipal] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/PolicyGrantMember AWS API Documentation + # + class PolicyGrantMember < Struct.new( + :created_at, + :created_by, + :detail, + :principal) + SENSITIVE = [] + include Aws::Structure + end + + # The policy grant principal. + # + # @note PolicyGrantPrincipal is a union - when making an API calls you must set exactly one of the members. + # + # @note PolicyGrantPrincipal is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PolicyGrantPrincipal corresponding to the set member. + # + # @!attribute [rw] domain_unit + # The domain unit of the policy grant principal. + # @return [Types::DomainUnitPolicyGrantPrincipal] + # + # @!attribute [rw] group + # The group of the policy grant principal. + # @return [Types::GroupPolicyGrantPrincipal] + # + # @!attribute [rw] project + # The project of the policy grant principal. + # @return [Types::ProjectPolicyGrantPrincipal] + # + # @!attribute [rw] user + # The user of the policy grant principal. + # @return [Types::UserPolicyGrantPrincipal] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/PolicyGrantPrincipal AWS API Documentation + # + class PolicyGrantPrincipal < Struct.new( + :domain_unit, + :group, + :project, + :user, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class DomainUnit < PolicyGrantPrincipal; end + class Group < PolicyGrantPrincipal; end + class Project < PolicyGrantPrincipal; end + class User < PolicyGrantPrincipal; end + class Unknown < PolicyGrantPrincipal; end + end + # @!attribute [rw] client_token # A unique, case-sensitive identifier that is provided to ensure the # idempotency of the request. @@ -10643,6 +11706,29 @@ class ProjectDeletionError < Struct.new( include Aws::Structure end + # The project grant filter. + # + # @note ProjectGrantFilter is a union - when making an API calls you must set exactly one of the members. + # + # @note ProjectGrantFilter is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProjectGrantFilter corresponding to the set member. + # + # @!attribute [rw] domain_unit_filter + # The domain unit filter of the project grant filter. + # @return [Types::DomainUnitFilterForProject] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ProjectGrantFilter AWS API Documentation + # + class ProjectGrantFilter < Struct.new( + :domain_unit_filter, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class DomainUnitFilter < ProjectGrantFilter; end + class Unknown < ProjectGrantFilter; end + end + # The details of a project member. # # @!attribute [rw] designation @@ -10662,6 +11748,30 @@ class ProjectMember < Struct.new( include Aws::Structure end + # The project policy grant principal. + # + # @!attribute [rw] project_designation + # The project designation of the project policy grant principal. + # @return [String] + # + # @!attribute [rw] project_grant_filter + # The project grant filter of the project policy grant principal. + # @return [Types::ProjectGrantFilter] + # + # @!attribute [rw] project_identifier + # The project ID of the project policy grant principal. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ProjectPolicyGrantPrincipal AWS API Documentation + # + class ProjectPolicyGrantPrincipal < Struct.new( + :project_designation, + :project_grant_filter, + :project_identifier) + SENSITIVE = [] + include Aws::Structure + end + # The details of a Amazon DataZone project. # # @!attribute [rw] created_at @@ -10680,6 +11790,10 @@ class ProjectMember < Struct.new( # The identifier of a Amazon DataZone domain where the project exists. # @return [String] # + # @!attribute [rw] domain_unit_id + # The ID of the domain unit. + # @return [String] + # # @!attribute [rw] failure_reasons # Specifies the error message that is returned if the operation cannot # be successfully completed. @@ -10708,6 +11822,7 @@ class ProjectSummary < Struct.new( :created_by, :description, :domain_id, + :domain_unit_id, :failure_reasons, :id, :name, @@ -11267,6 +12382,92 @@ class RelationalFilterConfiguration < Struct.new( include Aws::Structure end + # @!attribute [rw] client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] + # + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to remove an owner from an + # entity. + # @return [String] + # + # @!attribute [rw] entity_identifier + # The ID of the entity from which you want to remove an owner. + # @return [String] + # + # @!attribute [rw] entity_type + # The type of the entity from which you want to remove an owner. + # @return [String] + # + # @!attribute [rw] owner + # The owner that you want to remove from an entity. + # @return [Types::OwnerProperties] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/RemoveEntityOwnerInput AWS API Documentation + # + class RemoveEntityOwnerInput < Struct.new( + :client_token, + :domain_identifier, + :entity_identifier, + :entity_type, + :owner) + SENSITIVE = [] + include Aws::Structure + end + + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/RemoveEntityOwnerOutput AWS API Documentation + # + class RemoveEntityOwnerOutput < Aws::EmptyStructure; end + + # @!attribute [rw] client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] + # + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to remove a policy grant. + # @return [String] + # + # @!attribute [rw] entity_identifier + # The ID of the entity from which you want to remove a policy grant. + # @return [String] + # + # @!attribute [rw] entity_type + # The type of the entity from which you want to remove a policy grant. + # @return [String] + # + # @!attribute [rw] policy_type + # The type of the policy that you want to remove. + # @return [String] + # + # @!attribute [rw] principal + # The principal from which you want to remove a policy grant. + # @return [Types::PolicyGrantPrincipal] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/RemovePolicyGrantInput AWS API Documentation + # + class RemovePolicyGrantInput < Struct.new( + :client_token, + :domain_identifier, + :entity_identifier, + :entity_type, + :policy_type, + :principal) + SENSITIVE = [] + include Aws::Structure + end + + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/RemovePolicyGrantOutput AWS API Documentation + # + class RemovePolicyGrantOutput < Aws::EmptyStructure; end + # The details of a provisioned resource of this Amazon DataZone # environment. # @@ -13229,6 +14430,14 @@ class UnauthorizedException < Struct.new( include Aws::Structure end + # The details of the policy of creating an environment. + # + # @api private + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/Unit AWS API Documentation + # + class Unit < Aws::EmptyStructure; end + # @!attribute [rw] resource_arn # The ARN of the resource to be untagged in Amazon DataZone. # @return [String] @@ -13610,6 +14819,10 @@ class UpdateDomainInput < Struct.new( # The name to be updated as part of the `UpdateDomain` action. # @return [String] # + # @!attribute [rw] root_domain_unit_id + # The ID of the root domain unit. + # @return [String] + # # @!attribute [rw] single_sign_on # The single sign-on option of the Amazon DataZone domain. # @return [Types::SingleSignOn] @@ -13622,11 +14835,97 @@ class UpdateDomainOutput < Struct.new( :id, :last_updated_at, :name, + :root_domain_unit_id, :single_sign_on) SENSITIVE = [] include Aws::Structure end + # @!attribute [rw] description + # The description of the domain unit that you want to update. + # @return [String] + # + # @!attribute [rw] domain_identifier + # The ID of the domain where you want to update a domain unit. + # @return [String] + # + # @!attribute [rw] identifier + # The ID of the domain unit that you want to update. + # @return [String] + # + # @!attribute [rw] name + # The name of the domain unit that you want to update. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateDomainUnitInput AWS API Documentation + # + class UpdateDomainUnitInput < Struct.new( + :description, + :domain_identifier, + :identifier, + :name) + SENSITIVE = [:description, :name] + include Aws::Structure + end + + # @!attribute [rw] created_at + # The time stamp at which the domain unit that you want to update was + # created. + # @return [Time] + # + # @!attribute [rw] created_by + # The user who created the domain unit that you want to update. + # @return [String] + # + # @!attribute [rw] description + # The description of the domain unit that you want to update. + # @return [String] + # + # @!attribute [rw] domain_id + # The ID of the domain where you want to update the domain unit. + # @return [String] + # + # @!attribute [rw] id + # The ID of the domain unit that you want to update. + # @return [String] + # + # @!attribute [rw] last_updated_at + # The timestamp at which the domain unit was last updated. + # @return [Time] + # + # @!attribute [rw] last_updated_by + # The user who last updated the domain unit. + # @return [String] + # + # @!attribute [rw] name + # The name of the domain unit that you want to update. + # @return [String] + # + # @!attribute [rw] owners + # The owners of the domain unit that you want to update. + # @return [Array] + # + # @!attribute [rw] parent_domain_unit_id + # The ID of the parent domain unit. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateDomainUnitOutput AWS API Documentation + # + class UpdateDomainUnitOutput < Struct.new( + :created_at, + :created_by, + :description, + :domain_id, + :id, + :last_updated_at, + :last_updated_by, + :name, + :owners, + :parent_domain_unit_id) + SENSITIVE = [:description, :name] + include Aws::Structure + end + # @!attribute [rw] description # The description of the environment action. # @return [String] @@ -14223,8 +15522,8 @@ class UpdateGroupProfileOutput < Struct.new( # @return [String] # # @!attribute [rw] domain_identifier - # The identifier of the Amazon DataZone domain in which a project is - # to be updated. + # The ID of the Amazon DataZone domain where a project is being + # updated. # @return [String] # # @!attribute [rw] glossary_terms @@ -14269,6 +15568,10 @@ class UpdateProjectInput < Struct.new( # updated. # @return [String] # + # @!attribute [rw] domain_unit_id + # The ID of the domain unit. + # @return [String] + # # @!attribute [rw] failure_reasons # Specifies the error message that is returned if the operation cannot # be successfully completed. @@ -14301,6 +15604,7 @@ class UpdateProjectOutput < Struct.new( :created_by, :description, :domain_id, + :domain_unit_id, :failure_reasons, :glossary_terms, :id, @@ -14742,6 +16046,35 @@ class UserDetails < Struct.new( include Aws::Structure end + # The user policy grant principal. + # + # @note UserPolicyGrantPrincipal is a union - when making an API calls you must set exactly one of the members. + # + # @note UserPolicyGrantPrincipal is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of UserPolicyGrantPrincipal corresponding to the set member. + # + # @!attribute [rw] all_users_grant_filter + # The all users grant filter of the user policy grant principal. + # @return [Types::AllUsersGrantFilter] + # + # @!attribute [rw] user_identifier + # The user ID of the user policy grant principal. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UserPolicyGrantPrincipal AWS API Documentation + # + class UserPolicyGrantPrincipal < Struct.new( + :all_users_grant_filter, + :user_identifier, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class AllUsersGrantFilter < UserPolicyGrantPrincipal; end + class UserIdentifier < UserPolicyGrantPrincipal; end + class Unknown < UserPolicyGrantPrincipal; end + end + # The details of the user profile in Amazon DataZone. # # @note UserProfileDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of UserProfileDetails corresponding to the set member. diff --git a/gems/aws-sdk-datazone/sig/client.rbs b/gems/aws-sdk-datazone/sig/client.rbs index cff34674fde..041e2c066b8 100644 --- a/gems/aws-sdk-datazone/sig/client.rbs +++ b/gems/aws-sdk-datazone/sig/client.rbs @@ -122,6 +122,100 @@ module Aws ) -> _AcceptSubscriptionRequestResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AcceptSubscriptionRequestResponseSuccess + interface _AddEntityOwnerResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::AddEntityOwnerOutput] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#add_entity_owner-instance_method + def add_entity_owner: ( + ?client_token: ::String, + domain_identifier: ::String, + entity_identifier: ::String, + entity_type: ("DOMAIN_UNIT"), + owner: { + group: { + group_identifier: ::String + }?, + user: { + user_identifier: ::String + }? + } + ) -> _AddEntityOwnerResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AddEntityOwnerResponseSuccess + + interface _AddPolicyGrantResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::AddPolicyGrantOutput] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#add_policy_grant-instance_method + def add_policy_grant: ( + ?client_token: ::String, + detail: { + add_to_project_member_pool: { + include_child_domain_units: bool? + }?, + create_asset_type: { + include_child_domain_units: bool? + }?, + create_domain_unit: { + include_child_domain_units: bool? + }?, + create_environment: { + }?, + create_environment_profile: { + domain_unit_id: ::String? + }?, + create_form_type: { + include_child_domain_units: bool? + }?, + create_glossary: { + include_child_domain_units: bool? + }?, + create_project: { + include_child_domain_units: bool? + }?, + delegate_create_environment_profile: { + }?, + override_domain_unit_owners: { + include_child_domain_units: bool? + }?, + override_project_owners: { + include_child_domain_units: bool? + }? + }, + domain_identifier: ::String, + entity_identifier: ::String, + entity_type: ("DOMAIN_UNIT" | "ENVIRONMENT_BLUEPRINT_CONFIGURATION" | "ENVIRONMENT_PROFILE"), + policy_type: ("CREATE_DOMAIN_UNIT" | "OVERRIDE_DOMAIN_UNIT_OWNERS" | "ADD_TO_PROJECT_MEMBER_POOL" | "OVERRIDE_PROJECT_OWNERS" | "CREATE_GLOSSARY" | "CREATE_FORM_TYPE" | "CREATE_ASSET_TYPE" | "CREATE_PROJECT" | "CREATE_ENVIRONMENT_PROFILE" | "DELEGATE_CREATE_ENVIRONMENT_PROFILE" | "CREATE_ENVIRONMENT"), + principal: { + domain_unit: { + domain_unit_designation: ("OWNER"), + domain_unit_grant_filter: { + all_domain_units_grant_filter: { + }? + }?, + domain_unit_identifier: ::String? + }?, + group: { + group_identifier: ::String? + }?, + project: { + project_designation: ("OWNER" | "CONTRIBUTOR"), + project_grant_filter: { + domain_unit_filter: { + domain_unit: ::String, + include_child_domain_units: bool? + }? + }?, + project_identifier: ::String? + }?, + user: { + all_users_grant_filter: { + }?, + user_identifier: ::String? + }? + } + ) -> _AddPolicyGrantResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AddPolicyGrantResponseSuccess + interface _AssociateEnvironmentRoleResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::AssociateEnvironmentRoleOutput] end @@ -570,6 +664,7 @@ module Aws def kms_key_identifier: () -> ::String def name: () -> ::String def portal_url: () -> ::String + def root_domain_unit_id: () -> ::String def single_sign_on: () -> Types::SingleSignOn def status: () -> ("CREATING" | "AVAILABLE" | "CREATION_FAILED" | "DELETING" | "DELETED" | "DELETION_FAILED") def tags: () -> ::Hash[::String, ::String] @@ -589,6 +684,28 @@ module Aws ) -> _CreateDomainResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDomainResponseSuccess + interface _CreateDomainUnitResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::CreateDomainUnitOutput] + def ancestor_domain_unit_ids: () -> ::Array[::String] + def created_at: () -> ::Time + def created_by: () -> ::String + def description: () -> ::String + def domain_id: () -> ::String + def id: () -> ::String + def name: () -> ::String + def owners: () -> ::Array[Types::DomainUnitOwnerProperties] + def parent_domain_unit_id: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#create_domain_unit-instance_method + def create_domain_unit: ( + ?client_token: ::String, + ?description: ::String, + domain_identifier: ::String, + name: ::String, + parent_domain_unit_identifier: ::String + ) -> _CreateDomainUnitResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDomainUnitResponseSuccess + interface _CreateEnvironmentResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::CreateEnvironmentOutput] def aws_account_id: () -> ::String @@ -797,6 +914,7 @@ module Aws def created_by: () -> ::String def description: () -> ::String def domain_id: () -> ::String + def domain_unit_id: () -> ::String def failure_reasons: () -> ::Array[Types::ProjectDeletionError] def glossary_terms: () -> ::Array[::String] def id: () -> ::String @@ -808,6 +926,7 @@ module Aws def create_project: ( ?description: ::String, domain_identifier: ::String, + ?domain_unit_id: ::String, ?glossary_terms: Array[::String], name: ::String ) -> _CreateProjectResponseSuccess @@ -1036,6 +1155,16 @@ module Aws ) -> _DeleteDomainResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDomainResponseSuccess + interface _DeleteDomainUnitResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDomainUnitOutput] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#delete_domain_unit-instance_method + def delete_domain_unit: ( + domain_identifier: ::String, + identifier: ::String + ) -> _DeleteDomainUnitResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDomainUnitResponseSuccess + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#delete_environment-instance_method def delete_environment: ( domain_identifier: ::String, @@ -1358,6 +1487,7 @@ module Aws def last_updated_at: () -> ::Time def name: () -> ::String def portal_url: () -> ::String + def root_domain_unit_id: () -> ::String def single_sign_on: () -> Types::SingleSignOn def status: () -> ("CREATING" | "AVAILABLE" | "CREATION_FAILED" | "DELETING" | "DELETED" | "DELETION_FAILED") def tags: () -> ::Hash[::String, ::String] @@ -1368,6 +1498,26 @@ module Aws ) -> _GetDomainResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDomainResponseSuccess + interface _GetDomainUnitResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::GetDomainUnitOutput] + def created_at: () -> ::Time + def created_by: () -> ::String + def description: () -> ::String + def domain_id: () -> ::String + def id: () -> ::String + def last_updated_at: () -> ::Time + def last_updated_by: () -> ::String + def name: () -> ::String + def owners: () -> ::Array[Types::DomainUnitOwnerProperties] + def parent_domain_unit_id: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#get_domain_unit-instance_method + def get_domain_unit: ( + domain_identifier: ::String, + identifier: ::String + ) -> _GetDomainUnitResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDomainUnitResponseSuccess + interface _GetEnvironmentResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::GetEnvironmentOutput] def aws_account_id: () -> ::String @@ -1653,6 +1803,7 @@ module Aws def created_by: () -> ::String def description: () -> ::String def domain_id: () -> ::String + def domain_unit_id: () -> ::String def failure_reasons: () -> ::Array[Types::ProjectDeletionError] def glossary_terms: () -> ::Array[::String] def id: () -> ::String @@ -1882,6 +2033,20 @@ module Aws ) -> _ListDataSourcesResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourcesResponseSuccess + interface _ListDomainUnitsForParentResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::ListDomainUnitsForParentOutput] + def items: () -> ::Array[Types::DomainUnitSummary] + def next_token: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#list_domain_units_for_parent-instance_method + def list_domain_units_for_parent: ( + domain_identifier: ::String, + ?max_results: ::Integer, + ?next_token: ::String, + parent_domain_unit_identifier: ::String + ) -> _ListDomainUnitsForParentResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDomainUnitsForParentResponseSuccess + interface _ListDomainsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListDomainsOutput] def items: () -> ::Array[Types::DomainSummary] @@ -1895,6 +2060,21 @@ module Aws ) -> _ListDomainsResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDomainsResponseSuccess + interface _ListEntityOwnersResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::ListEntityOwnersOutput] + def next_token: () -> ::String + def owners: () -> ::Array[Types::OwnerPropertiesOutput] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#list_entity_owners-instance_method + def list_entity_owners: ( + domain_identifier: ::String, + entity_identifier: ::String, + entity_type: ("DOMAIN_UNIT"), + ?max_results: ::Integer, + ?next_token: ::String + ) -> _ListEntityOwnersResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEntityOwnersResponseSuccess + interface _ListEnvironmentActionsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListEnvironmentActionsOutput] def items: () -> ::Array[Types::EnvironmentActionSummary] @@ -2027,6 +2207,22 @@ module Aws ) -> _ListNotificationsResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListNotificationsResponseSuccess + interface _ListPolicyGrantsResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::ListPolicyGrantsOutput] + def grant_list: () -> ::Array[Types::PolicyGrantMember] + def next_token: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#list_policy_grants-instance_method + def list_policy_grants: ( + domain_identifier: ::String, + entity_identifier: ::String, + entity_type: ("DOMAIN_UNIT" | "ENVIRONMENT_BLUEPRINT_CONFIGURATION" | "ENVIRONMENT_PROFILE"), + ?max_results: ::Integer, + ?next_token: ::String, + policy_type: ("CREATE_DOMAIN_UNIT" | "OVERRIDE_DOMAIN_UNIT_OWNERS" | "ADD_TO_PROJECT_MEMBER_POOL" | "OVERRIDE_PROJECT_OWNERS" | "CREATE_GLOSSARY" | "CREATE_FORM_TYPE" | "CREATE_ASSET_TYPE" | "CREATE_PROJECT" | "CREATE_ENVIRONMENT_PROFILE" | "DELEGATE_CREATE_ENVIRONMENT_PROFILE" | "CREATE_ENVIRONMENT") + ) -> _ListPolicyGrantsResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPolicyGrantsResponseSuccess + interface _ListProjectMembershipsResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListProjectMembershipsOutput] def members: () -> ::Array[Types::ProjectMember] @@ -2277,6 +2473,67 @@ module Aws ) -> _RejectSubscriptionRequestResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RejectSubscriptionRequestResponseSuccess + interface _RemoveEntityOwnerResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::RemoveEntityOwnerOutput] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#remove_entity_owner-instance_method + def remove_entity_owner: ( + ?client_token: ::String, + domain_identifier: ::String, + entity_identifier: ::String, + entity_type: ("DOMAIN_UNIT"), + owner: { + group: { + group_identifier: ::String + }?, + user: { + user_identifier: ::String + }? + } + ) -> _RemoveEntityOwnerResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveEntityOwnerResponseSuccess + + interface _RemovePolicyGrantResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::RemovePolicyGrantOutput] + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#remove_policy_grant-instance_method + def remove_policy_grant: ( + ?client_token: ::String, + domain_identifier: ::String, + entity_identifier: ::String, + entity_type: ("DOMAIN_UNIT" | "ENVIRONMENT_BLUEPRINT_CONFIGURATION" | "ENVIRONMENT_PROFILE"), + policy_type: ("CREATE_DOMAIN_UNIT" | "OVERRIDE_DOMAIN_UNIT_OWNERS" | "ADD_TO_PROJECT_MEMBER_POOL" | "OVERRIDE_PROJECT_OWNERS" | "CREATE_GLOSSARY" | "CREATE_FORM_TYPE" | "CREATE_ASSET_TYPE" | "CREATE_PROJECT" | "CREATE_ENVIRONMENT_PROFILE" | "DELEGATE_CREATE_ENVIRONMENT_PROFILE" | "CREATE_ENVIRONMENT"), + principal: { + domain_unit: { + domain_unit_designation: ("OWNER"), + domain_unit_grant_filter: { + all_domain_units_grant_filter: { + }? + }?, + domain_unit_identifier: ::String? + }?, + group: { + group_identifier: ::String? + }?, + project: { + project_designation: ("OWNER" | "CONTRIBUTOR"), + project_grant_filter: { + domain_unit_filter: { + domain_unit: ::String, + include_child_domain_units: bool? + }? + }?, + project_identifier: ::String? + }?, + user: { + all_users_grant_filter: { + }?, + user_identifier: ::String? + }? + } + ) -> _RemovePolicyGrantResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemovePolicyGrantResponseSuccess + interface _RevokeSubscriptionResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::RevokeSubscriptionOutput] def created_at: () -> ::Time @@ -2702,6 +2959,7 @@ module Aws def id: () -> ::String def last_updated_at: () -> ::Time def name: () -> ::String + def root_domain_unit_id: () -> ::String def single_sign_on: () -> Types::SingleSignOn end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#update_domain-instance_method @@ -2718,6 +2976,28 @@ module Aws ) -> _UpdateDomainResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDomainResponseSuccess + interface _UpdateDomainUnitResponseSuccess + include ::Seahorse::Client::_ResponseSuccess[Types::UpdateDomainUnitOutput] + def created_at: () -> ::Time + def created_by: () -> ::String + def description: () -> ::String + def domain_id: () -> ::String + def id: () -> ::String + def last_updated_at: () -> ::Time + def last_updated_by: () -> ::String + def name: () -> ::String + def owners: () -> ::Array[Types::DomainUnitOwnerProperties] + def parent_domain_unit_id: () -> ::String + end + # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DataZone/Client.html#update_domain_unit-instance_method + def update_domain_unit: ( + ?description: ::String, + domain_identifier: ::String, + identifier: ::String, + ?name: ::String + ) -> _UpdateDomainUnitResponseSuccess + | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDomainUnitResponseSuccess + interface _UpdateEnvironmentResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::UpdateEnvironmentOutput] def aws_account_id: () -> ::String @@ -2876,6 +3156,7 @@ module Aws def created_by: () -> ::String def description: () -> ::String def domain_id: () -> ::String + def domain_unit_id: () -> ::String def failure_reasons: () -> ::Array[Types::ProjectDeletionError] def glossary_terms: () -> ::Array[::String] def id: () -> ::String diff --git a/gems/aws-sdk-datazone/sig/types.rbs b/gems/aws-sdk-datazone/sig/types.rbs index 94132cbaf49..c59b11e4329 100644 --- a/gems/aws-sdk-datazone/sig/types.rbs +++ b/gems/aws-sdk-datazone/sig/types.rbs @@ -77,6 +77,43 @@ module Aws::DataZone end end + class AddEntityOwnerInput + attr_accessor client_token: ::String + attr_accessor domain_identifier: ::String + attr_accessor entity_identifier: ::String + attr_accessor entity_type: ("DOMAIN_UNIT") + attr_accessor owner: Types::OwnerProperties + SENSITIVE: [] + end + + class AddEntityOwnerOutput < Aws::EmptyStructure + end + + class AddPolicyGrantInput + attr_accessor client_token: ::String + attr_accessor detail: Types::PolicyGrantDetail + attr_accessor domain_identifier: ::String + attr_accessor entity_identifier: ::String + attr_accessor entity_type: ("DOMAIN_UNIT" | "ENVIRONMENT_BLUEPRINT_CONFIGURATION" | "ENVIRONMENT_PROFILE") + attr_accessor policy_type: ("CREATE_DOMAIN_UNIT" | "OVERRIDE_DOMAIN_UNIT_OWNERS" | "ADD_TO_PROJECT_MEMBER_POOL" | "OVERRIDE_PROJECT_OWNERS" | "CREATE_GLOSSARY" | "CREATE_FORM_TYPE" | "CREATE_ASSET_TYPE" | "CREATE_PROJECT" | "CREATE_ENVIRONMENT_PROFILE" | "DELEGATE_CREATE_ENVIRONMENT_PROFILE" | "CREATE_ENVIRONMENT") + attr_accessor principal: Types::PolicyGrantPrincipal + SENSITIVE: [] + end + + class AddPolicyGrantOutput < Aws::EmptyStructure + end + + class AddToProjectMemberPoolPolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + + class AllDomainUnitsGrantFilter < Aws::EmptyStructure + end + + class AllUsersGrantFilter < Aws::EmptyStructure + end + class AssetFilterConfiguration attr_accessor column_configuration: Types::ColumnFilterConfiguration attr_accessor row_configuration: Types::RowFilterConfiguration @@ -411,6 +448,11 @@ module Aws::DataZone SENSITIVE: [:description] end + class CreateAssetTypePolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + class CreateDataProductInput attr_accessor client_token: ::String attr_accessor description: ::String @@ -531,12 +573,40 @@ module Aws::DataZone attr_accessor kms_key_identifier: ::String attr_accessor name: ::String attr_accessor portal_url: ::String + attr_accessor root_domain_unit_id: ::String attr_accessor single_sign_on: Types::SingleSignOn attr_accessor status: ("CREATING" | "AVAILABLE" | "CREATION_FAILED" | "DELETING" | "DELETED" | "DELETION_FAILED") attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end + class CreateDomainUnitInput + attr_accessor client_token: ::String + attr_accessor description: ::String + attr_accessor domain_identifier: ::String + attr_accessor name: ::String + attr_accessor parent_domain_unit_identifier: ::String + SENSITIVE: [:description, :name] + end + + class CreateDomainUnitOutput + attr_accessor ancestor_domain_unit_ids: ::Array[::String] + attr_accessor created_at: ::Time + attr_accessor created_by: ::String + attr_accessor description: ::String + attr_accessor domain_id: ::String + attr_accessor id: ::String + attr_accessor name: ::String + attr_accessor owners: ::Array[Types::DomainUnitOwnerProperties] + attr_accessor parent_domain_unit_id: ::String + SENSITIVE: [:description, :name] + end + + class CreateDomainUnitPolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + class CreateEnvironmentActionInput attr_accessor description: ::String attr_accessor domain_identifier: ::String @@ -623,6 +693,11 @@ module Aws::DataZone SENSITIVE: [:description, :name] end + class CreateEnvironmentProfilePolicyGrantDetail + attr_accessor domain_unit_id: ::String + SENSITIVE: [] + end + class CreateFormTypeInput attr_accessor description: ::String attr_accessor domain_identifier: ::String @@ -644,6 +719,11 @@ module Aws::DataZone SENSITIVE: [:description, :name] end + class CreateFormTypePolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + class CreateGlossaryInput attr_accessor client_token: ::String attr_accessor description: ::String @@ -664,6 +744,11 @@ module Aws::DataZone SENSITIVE: [:description, :name] end + class CreateGlossaryPolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + class CreateGlossaryTermInput attr_accessor client_token: ::String attr_accessor domain_identifier: ::String @@ -723,6 +808,7 @@ module Aws::DataZone class CreateProjectInput attr_accessor description: ::String attr_accessor domain_identifier: ::String + attr_accessor domain_unit_id: ::String attr_accessor glossary_terms: ::Array[::String] attr_accessor name: ::String SENSITIVE: [:description, :name] @@ -744,6 +830,7 @@ module Aws::DataZone attr_accessor created_by: ::String attr_accessor description: ::String attr_accessor domain_id: ::String + attr_accessor domain_unit_id: ::String attr_accessor failure_reasons: ::Array[Types::ProjectDeletionError] attr_accessor glossary_terms: ::Array[::String] attr_accessor id: ::String @@ -753,6 +840,11 @@ module Aws::DataZone SENSITIVE: [:description, :name] end + class CreateProjectPolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + class CreateSubscriptionGrantInput attr_accessor asset_target_names: ::Array[Types::AssetTargetNameMap] attr_accessor client_token: ::String @@ -1087,6 +1179,15 @@ module Aws::DataZone SENSITIVE: [] end + class DeleteDomainUnitInput + attr_accessor domain_identifier: ::String + attr_accessor identifier: ::String + SENSITIVE: [] + end + + class DeleteDomainUnitOutput < Aws::EmptyStructure + end + class DeleteEnvironmentActionInput attr_accessor domain_identifier: ::String attr_accessor environment_identifier: ::String @@ -1262,6 +1363,60 @@ module Aws::DataZone SENSITIVE: [:description, :name] end + class DomainUnitFilterForProject + attr_accessor domain_unit: ::String + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + + class DomainUnitGrantFilter + attr_accessor all_domain_units_grant_filter: Types::AllDomainUnitsGrantFilter + attr_accessor unknown: untyped + SENSITIVE: [] + + class AllDomainUnitsGrantFilter < DomainUnitGrantFilter + end + class Unknown < DomainUnitGrantFilter + end + end + + class DomainUnitGroupProperties + attr_accessor group_id: ::String + SENSITIVE: [] + end + + class DomainUnitOwnerProperties + attr_accessor group: Types::DomainUnitGroupProperties + attr_accessor user: Types::DomainUnitUserProperties + attr_accessor unknown: untyped + SENSITIVE: [] + + class Group < DomainUnitOwnerProperties + end + class User < DomainUnitOwnerProperties + end + class Unknown < DomainUnitOwnerProperties + end + end + + class DomainUnitPolicyGrantPrincipal + attr_accessor domain_unit_designation: ("OWNER") + attr_accessor domain_unit_grant_filter: Types::DomainUnitGrantFilter + attr_accessor domain_unit_identifier: ::String + SENSITIVE: [] + end + + class DomainUnitSummary + attr_accessor id: ::String + attr_accessor name: ::String + SENSITIVE: [] + end + + class DomainUnitUserProperties + attr_accessor user_id: ::String + SENSITIVE: [] + end + class EnvironmentActionSummary attr_accessor description: ::String attr_accessor domain_id: ::String @@ -1595,12 +1750,33 @@ module Aws::DataZone attr_accessor last_updated_at: ::Time attr_accessor name: ::String attr_accessor portal_url: ::String + attr_accessor root_domain_unit_id: ::String attr_accessor single_sign_on: Types::SingleSignOn attr_accessor status: ("CREATING" | "AVAILABLE" | "CREATION_FAILED" | "DELETING" | "DELETED" | "DELETION_FAILED") attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end + class GetDomainUnitInput + attr_accessor domain_identifier: ::String + attr_accessor identifier: ::String + SENSITIVE: [] + end + + class GetDomainUnitOutput + attr_accessor created_at: ::Time + attr_accessor created_by: ::String + attr_accessor description: ::String + attr_accessor domain_id: ::String + attr_accessor id: ::String + attr_accessor last_updated_at: ::Time + attr_accessor last_updated_by: ::String + attr_accessor name: ::String + attr_accessor owners: ::Array[Types::DomainUnitOwnerProperties] + attr_accessor parent_domain_unit_id: ::String + SENSITIVE: [:description, :name] + end + class GetEnvironmentActionInput attr_accessor domain_identifier: ::String attr_accessor environment_identifier: ::String @@ -1891,6 +2067,7 @@ module Aws::DataZone attr_accessor created_by: ::String attr_accessor description: ::String attr_accessor domain_id: ::String + attr_accessor domain_unit_id: ::String attr_accessor failure_reasons: ::Array[Types::ProjectDeletionError] attr_accessor glossary_terms: ::Array[::String] attr_accessor id: ::String @@ -2114,6 +2291,17 @@ module Aws::DataZone SENSITIVE: [] end + class GroupPolicyGrantPrincipal + attr_accessor group_identifier: ::String + attr_accessor unknown: untyped + SENSITIVE: [] + + class GroupIdentifier < GroupPolicyGrantPrincipal + end + class Unknown < GroupPolicyGrantPrincipal + end + end + class GroupProfileSummary attr_accessor domain_id: ::String attr_accessor group_name: ::String @@ -2304,6 +2492,20 @@ module Aws::DataZone SENSITIVE: [] end + class ListDomainUnitsForParentInput + attr_accessor domain_identifier: ::String + attr_accessor max_results: ::Integer + attr_accessor next_token: ::String + attr_accessor parent_domain_unit_identifier: ::String + SENSITIVE: [] + end + + class ListDomainUnitsForParentOutput + attr_accessor items: ::Array[Types::DomainUnitSummary] + attr_accessor next_token: ::String + SENSITIVE: [] + end + class ListDomainsInput attr_accessor max_results: ::Integer attr_accessor next_token: ::String @@ -2317,6 +2519,21 @@ module Aws::DataZone SENSITIVE: [] end + class ListEntityOwnersInput + attr_accessor domain_identifier: ::String + attr_accessor entity_identifier: ::String + attr_accessor entity_type: ("DOMAIN_UNIT") + attr_accessor max_results: ::Integer + attr_accessor next_token: ::String + SENSITIVE: [] + end + + class ListEntityOwnersOutput + attr_accessor next_token: ::String + attr_accessor owners: ::Array[Types::OwnerPropertiesOutput] + SENSITIVE: [] + end + class ListEnvironmentActionsInput attr_accessor domain_identifier: ::String attr_accessor environment_identifier: ::String @@ -2449,6 +2666,22 @@ module Aws::DataZone SENSITIVE: [] end + class ListPolicyGrantsInput + attr_accessor domain_identifier: ::String + attr_accessor entity_identifier: ::String + attr_accessor entity_type: ("DOMAIN_UNIT" | "ENVIRONMENT_BLUEPRINT_CONFIGURATION" | "ENVIRONMENT_PROFILE") + attr_accessor max_results: ::Integer + attr_accessor next_token: ::String + attr_accessor policy_type: ("CREATE_DOMAIN_UNIT" | "OVERRIDE_DOMAIN_UNIT_OWNERS" | "ADD_TO_PROJECT_MEMBER_POOL" | "OVERRIDE_PROJECT_OWNERS" | "CREATE_GLOSSARY" | "CREATE_FORM_TYPE" | "CREATE_ASSET_TYPE" | "CREATE_PROJECT" | "CREATE_ENVIRONMENT_PROFILE" | "DELEGATE_CREATE_ENVIRONMENT_PROFILE" | "CREATE_ENVIRONMENT") + SENSITIVE: [] + end + + class ListPolicyGrantsOutput + attr_accessor grant_list: ::Array[Types::PolicyGrantMember] + attr_accessor next_token: ::String + SENSITIVE: [] + end + class ListProjectMembershipsInput attr_accessor domain_identifier: ::String attr_accessor max_results: ::Integer @@ -2722,6 +2955,133 @@ module Aws::DataZone SENSITIVE: [] end + class OverrideDomainUnitOwnersPolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + + class OverrideProjectOwnersPolicyGrantDetail + attr_accessor include_child_domain_units: bool + SENSITIVE: [] + end + + class OwnerGroupProperties + attr_accessor group_identifier: ::String + SENSITIVE: [] + end + + class OwnerGroupPropertiesOutput + attr_accessor group_id: ::String + SENSITIVE: [] + end + + class OwnerProperties + attr_accessor group: Types::OwnerGroupProperties + attr_accessor user: Types::OwnerUserProperties + attr_accessor unknown: untyped + SENSITIVE: [] + + class Group < OwnerProperties + end + class User < OwnerProperties + end + class Unknown < OwnerProperties + end + end + + class OwnerPropertiesOutput + attr_accessor group: Types::OwnerGroupPropertiesOutput + attr_accessor user: Types::OwnerUserPropertiesOutput + attr_accessor unknown: untyped + SENSITIVE: [] + + class Group < OwnerPropertiesOutput + end + class User < OwnerPropertiesOutput + end + class Unknown < OwnerPropertiesOutput + end + end + + class OwnerUserProperties + attr_accessor user_identifier: ::String + SENSITIVE: [] + end + + class OwnerUserPropertiesOutput + attr_accessor user_id: ::String + SENSITIVE: [] + end + + class PolicyGrantDetail + attr_accessor add_to_project_member_pool: Types::AddToProjectMemberPoolPolicyGrantDetail + attr_accessor create_asset_type: Types::CreateAssetTypePolicyGrantDetail + attr_accessor create_domain_unit: Types::CreateDomainUnitPolicyGrantDetail + attr_accessor create_environment: Types::Unit + attr_accessor create_environment_profile: Types::CreateEnvironmentProfilePolicyGrantDetail + attr_accessor create_form_type: Types::CreateFormTypePolicyGrantDetail + attr_accessor create_glossary: Types::CreateGlossaryPolicyGrantDetail + attr_accessor create_project: Types::CreateProjectPolicyGrantDetail + attr_accessor delegate_create_environment_profile: Types::Unit + attr_accessor override_domain_unit_owners: Types::OverrideDomainUnitOwnersPolicyGrantDetail + attr_accessor override_project_owners: Types::OverrideProjectOwnersPolicyGrantDetail + attr_accessor unknown: untyped + SENSITIVE: [] + + class AddToProjectMemberPool < PolicyGrantDetail + end + class CreateAssetType < PolicyGrantDetail + end + class CreateDomainUnit < PolicyGrantDetail + end + class CreateEnvironment < PolicyGrantDetail + end + class CreateEnvironmentProfile < PolicyGrantDetail + end + class CreateFormType < PolicyGrantDetail + end + class CreateGlossary < PolicyGrantDetail + end + class CreateProject < PolicyGrantDetail + end + class DelegateCreateEnvironmentProfile < PolicyGrantDetail + end + class OverrideDomainUnitOwners < PolicyGrantDetail + end + class OverrideProjectOwners < PolicyGrantDetail + end + class Unknown < PolicyGrantDetail + end + end + + class PolicyGrantMember + attr_accessor created_at: ::Time + attr_accessor created_by: ::String + attr_accessor detail: Types::PolicyGrantDetail + attr_accessor principal: Types::PolicyGrantPrincipal + SENSITIVE: [] + end + + class PolicyGrantPrincipal + attr_accessor domain_unit: Types::DomainUnitPolicyGrantPrincipal + attr_accessor group: Types::GroupPolicyGrantPrincipal + attr_accessor project: Types::ProjectPolicyGrantPrincipal + attr_accessor user: Types::UserPolicyGrantPrincipal + attr_accessor unknown: untyped + SENSITIVE: [] + + class DomainUnit < PolicyGrantPrincipal + end + class Group < PolicyGrantPrincipal + end + class Project < PolicyGrantPrincipal + end + class User < PolicyGrantPrincipal + end + class Unknown < PolicyGrantPrincipal + end + end + class PostLineageEventInput attr_accessor client_token: ::String attr_accessor domain_identifier: ::String @@ -2760,17 +3120,36 @@ module Aws::DataZone SENSITIVE: [] end + class ProjectGrantFilter + attr_accessor domain_unit_filter: Types::DomainUnitFilterForProject + attr_accessor unknown: untyped + SENSITIVE: [] + + class DomainUnitFilter < ProjectGrantFilter + end + class Unknown < ProjectGrantFilter + end + end + class ProjectMember attr_accessor designation: ("PROJECT_OWNER" | "PROJECT_CONTRIBUTOR") attr_accessor member_details: Types::MemberDetails SENSITIVE: [] end + class ProjectPolicyGrantPrincipal + attr_accessor project_designation: ("OWNER" | "CONTRIBUTOR") + attr_accessor project_grant_filter: Types::ProjectGrantFilter + attr_accessor project_identifier: ::String + SENSITIVE: [] + end + class ProjectSummary attr_accessor created_at: ::Time attr_accessor created_by: ::String attr_accessor description: ::String attr_accessor domain_id: ::String + attr_accessor domain_unit_id: ::String attr_accessor failure_reasons: ::Array[Types::ProjectDeletionError] attr_accessor id: ::String attr_accessor name: ::String @@ -2941,6 +3320,31 @@ module Aws::DataZone SENSITIVE: [] end + class RemoveEntityOwnerInput + attr_accessor client_token: ::String + attr_accessor domain_identifier: ::String + attr_accessor entity_identifier: ::String + attr_accessor entity_type: ("DOMAIN_UNIT") + attr_accessor owner: Types::OwnerProperties + SENSITIVE: [] + end + + class RemoveEntityOwnerOutput < Aws::EmptyStructure + end + + class RemovePolicyGrantInput + attr_accessor client_token: ::String + attr_accessor domain_identifier: ::String + attr_accessor entity_identifier: ::String + attr_accessor entity_type: ("DOMAIN_UNIT" | "ENVIRONMENT_BLUEPRINT_CONFIGURATION" | "ENVIRONMENT_PROFILE") + attr_accessor policy_type: ("CREATE_DOMAIN_UNIT" | "OVERRIDE_DOMAIN_UNIT_OWNERS" | "ADD_TO_PROJECT_MEMBER_POOL" | "OVERRIDE_PROJECT_OWNERS" | "CREATE_GLOSSARY" | "CREATE_FORM_TYPE" | "CREATE_ASSET_TYPE" | "CREATE_PROJECT" | "CREATE_ENVIRONMENT_PROFILE" | "DELEGATE_CREATE_ENVIRONMENT_PROFILE" | "CREATE_ENVIRONMENT") + attr_accessor principal: Types::PolicyGrantPrincipal + SENSITIVE: [] + end + + class RemovePolicyGrantOutput < Aws::EmptyStructure + end + class Resource attr_accessor name: ::String attr_accessor provider: ::String @@ -3519,6 +3923,9 @@ module Aws::DataZone SENSITIVE: [] end + class Unit < Aws::EmptyStructure + end + class UntagResourceRequest attr_accessor resource_arn: ::String attr_accessor tag_keys: ::Array[::String] @@ -3610,10 +4017,33 @@ module Aws::DataZone attr_accessor id: ::String attr_accessor last_updated_at: ::Time attr_accessor name: ::String + attr_accessor root_domain_unit_id: ::String attr_accessor single_sign_on: Types::SingleSignOn SENSITIVE: [] end + class UpdateDomainUnitInput + attr_accessor description: ::String + attr_accessor domain_identifier: ::String + attr_accessor identifier: ::String + attr_accessor name: ::String + SENSITIVE: [:description, :name] + end + + class UpdateDomainUnitOutput + attr_accessor created_at: ::Time + attr_accessor created_by: ::String + attr_accessor description: ::String + attr_accessor domain_id: ::String + attr_accessor id: ::String + attr_accessor last_updated_at: ::Time + attr_accessor last_updated_by: ::String + attr_accessor name: ::String + attr_accessor owners: ::Array[Types::DomainUnitOwnerProperties] + attr_accessor parent_domain_unit_id: ::String + SENSITIVE: [:description, :name] + end + class UpdateEnvironmentActionInput attr_accessor description: ::String attr_accessor domain_identifier: ::String @@ -3768,6 +4198,7 @@ module Aws::DataZone attr_accessor created_by: ::String attr_accessor description: ::String attr_accessor domain_id: ::String + attr_accessor domain_unit_id: ::String attr_accessor failure_reasons: ::Array[Types::ProjectDeletionError] attr_accessor glossary_terms: ::Array[::String] attr_accessor id: ::String @@ -3879,6 +4310,20 @@ module Aws::DataZone SENSITIVE: [] end + class UserPolicyGrantPrincipal + attr_accessor all_users_grant_filter: Types::AllUsersGrantFilter + attr_accessor user_identifier: ::String + attr_accessor unknown: untyped + SENSITIVE: [] + + class AllUsersGrantFilter < UserPolicyGrantPrincipal + end + class UserIdentifier < UserPolicyGrantPrincipal + end + class Unknown < UserPolicyGrantPrincipal + end + end + class UserProfileDetails attr_accessor iam: Types::IamUserProfileDetails attr_accessor sso: Types::SsoUserProfileDetails diff --git a/gems/aws-sdk-redshiftdataapiservice/CHANGELOG.md b/gems/aws-sdk-redshiftdataapiservice/CHANGELOG.md index 90f658aa56b..72c7b6b443c 100644 --- a/gems/aws-sdk-redshiftdataapiservice/CHANGELOG.md +++ b/gems/aws-sdk-redshiftdataapiservice/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.42.0 (2024-08-30) +------------------ + +* Feature - The release include the new Redshift DataAPI feature for session use, customer execute query with --session-keep-alive-seconds parameter and can submit follow-up queries to same sessions with returned`session-id` + 1.41.0 (2024-07-02) ------------------ diff --git a/gems/aws-sdk-redshiftdataapiservice/VERSION b/gems/aws-sdk-redshiftdataapiservice/VERSION index 7d47e599800..a50908ca3da 100644 --- a/gems/aws-sdk-redshiftdataapiservice/VERSION +++ b/gems/aws-sdk-redshiftdataapiservice/VERSION @@ -1 +1 @@ -1.41.0 +1.42.0 diff --git a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice.rb b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice.rb index 27450dc3c81..b853af5c27c 100644 --- a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice.rb +++ b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice.rb @@ -52,6 +52,6 @@ # @!group service module Aws::RedshiftDataAPIService - GEM_VERSION = '1.41.0' + GEM_VERSION = '1.42.0' end diff --git a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb index deed5b0b30f..3c5b2ccffa7 100644 --- a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb +++ b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client.rb @@ -487,7 +487,7 @@ def initialize(*args) # a cluster and authenticating using either Secrets Manager or temporary # credentials. # - # @option params [required, String] :database + # @option params [String] :database # The name of the database. This parameter is required when # authenticating using either Secrets Manager or temporary credentials. # @@ -500,6 +500,14 @@ def initialize(*args) # The name or ARN of the secret that enables access to the database. # This parameter is required when authenticating using Secrets Manager. # + # @option params [String] :session_id + # The session identifier of the query. + # + # @option params [Integer] :session_keep_alive_seconds + # The number of seconds to keep the session alive after the query + # finishes. The maximum time a session can keep alive is 24 hours. After + # 24 hours, the session is forced closed and the query is terminated. + # # @option params [required, Array] :sqls # One or more SQL statements to run. The SQL statements are run as # a single transaction. They run serially in the order of the array. @@ -525,19 +533,23 @@ def initialize(*args) # * {Types::BatchExecuteStatementOutput#cluster_identifier #cluster_identifier} => String # * {Types::BatchExecuteStatementOutput#created_at #created_at} => Time # * {Types::BatchExecuteStatementOutput#database #database} => String + # * {Types::BatchExecuteStatementOutput#db_groups #db_groups} => Array<String> # * {Types::BatchExecuteStatementOutput#db_user #db_user} => String # * {Types::BatchExecuteStatementOutput#id #id} => String # * {Types::BatchExecuteStatementOutput#secret_arn #secret_arn} => String + # * {Types::BatchExecuteStatementOutput#session_id #session_id} => String # * {Types::BatchExecuteStatementOutput#workgroup_name #workgroup_name} => String # # @example Request syntax with placeholder values # # resp = client.batch_execute_statement({ # client_token: "ClientToken", - # cluster_identifier: "Location", - # database: "String", # required + # cluster_identifier: "ClusterIdentifierString", + # database: "String", # db_user: "String", # secret_arn: "SecretArn", + # session_id: "UUID", + # session_keep_alive_seconds: 1, # sqls: ["StatementString"], # required # statement_name: "StatementNameString", # with_event: false, @@ -549,9 +561,12 @@ def initialize(*args) # resp.cluster_identifier #=> String # resp.created_at #=> Time # resp.database #=> String + # resp.db_groups #=> Array + # resp.db_groups[0] #=> String # resp.db_user #=> String # resp.id #=> String # resp.secret_arn #=> String + # resp.session_id #=> String # resp.workgroup_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement AWS API Documentation @@ -586,7 +601,7 @@ def batch_execute_statement(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.cancel_statement({ - # id: "StatementId", # required + # id: "UUID", # required # }) # # @example Response structure @@ -641,6 +656,7 @@ def cancel_statement(params = {}, options = {}) # * {Types::DescribeStatementResponse#result_rows #result_rows} => Integer # * {Types::DescribeStatementResponse#result_size #result_size} => Integer # * {Types::DescribeStatementResponse#secret_arn #secret_arn} => String + # * {Types::DescribeStatementResponse#session_id #session_id} => String # * {Types::DescribeStatementResponse#status #status} => String # * {Types::DescribeStatementResponse#sub_statements #sub_statements} => Array<Types::SubStatementData> # * {Types::DescribeStatementResponse#updated_at #updated_at} => Time @@ -649,7 +665,7 @@ def cancel_statement(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.describe_statement({ - # id: "StatementId", # required + # id: "UUID", # required # }) # # @example Response structure @@ -671,6 +687,7 @@ def cancel_statement(params = {}, options = {}) # resp.result_rows #=> Integer # resp.result_size #=> Integer # resp.secret_arn #=> String + # resp.session_id #=> String # resp.status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL" # resp.sub_statements #=> Array # resp.sub_statements[0].created_at #=> Time @@ -800,7 +817,7 @@ def describe_statement(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.describe_table({ - # cluster_identifier: "Location", + # cluster_identifier: "ClusterIdentifierString", # connected_database: "String", # database: "String", # required # db_user: "String", @@ -895,7 +912,7 @@ def describe_table(params = {}, options = {}) # a cluster and authenticating using either Secrets Manager or temporary # credentials. # - # @option params [required, String] :database + # @option params [String] :database # The name of the database. This parameter is required when # authenticating using either Secrets Manager or temporary credentials. # @@ -911,6 +928,14 @@ def describe_table(params = {}, options = {}) # The name or ARN of the secret that enables access to the database. # This parameter is required when authenticating using Secrets Manager. # + # @option params [String] :session_id + # The session identifier of the query. + # + # @option params [Integer] :session_keep_alive_seconds + # The number of seconds to keep the session alive after the query + # finishes. The maximum time a session can keep alive is 24 hours. After + # 24 hours, the session is forced closed and the query is terminated. + # # @option params [required, String] :sql # The SQL statement text to run. # @@ -932,17 +957,19 @@ def describe_table(params = {}, options = {}) # * {Types::ExecuteStatementOutput#cluster_identifier #cluster_identifier} => String # * {Types::ExecuteStatementOutput#created_at #created_at} => Time # * {Types::ExecuteStatementOutput#database #database} => String + # * {Types::ExecuteStatementOutput#db_groups #db_groups} => Array<String> # * {Types::ExecuteStatementOutput#db_user #db_user} => String # * {Types::ExecuteStatementOutput#id #id} => String # * {Types::ExecuteStatementOutput#secret_arn #secret_arn} => String + # * {Types::ExecuteStatementOutput#session_id #session_id} => String # * {Types::ExecuteStatementOutput#workgroup_name #workgroup_name} => String # # @example Request syntax with placeholder values # # resp = client.execute_statement({ # client_token: "ClientToken", - # cluster_identifier: "Location", - # database: "String", # required + # cluster_identifier: "ClusterIdentifierString", + # database: "String", # db_user: "String", # parameters: [ # { @@ -951,6 +978,8 @@ def describe_table(params = {}, options = {}) # }, # ], # secret_arn: "SecretArn", + # session_id: "UUID", + # session_keep_alive_seconds: 1, # sql: "StatementString", # required # statement_name: "StatementNameString", # with_event: false, @@ -962,9 +991,12 @@ def describe_table(params = {}, options = {}) # resp.cluster_identifier #=> String # resp.created_at #=> Time # resp.database #=> String + # resp.db_groups #=> Array + # resp.db_groups[0] #=> String # resp.db_user #=> String # resp.id #=> String # resp.secret_arn #=> String + # resp.session_id #=> String # resp.workgroup_name #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatement AWS API Documentation @@ -1016,7 +1048,7 @@ def execute_statement(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.get_statement_result({ - # id: "StatementId", # required + # id: "UUID", # required # next_token: "String", # }) # @@ -1144,7 +1176,7 @@ def get_statement_result(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.list_databases({ - # cluster_identifier: "Location", + # cluster_identifier: "ClusterIdentifierString", # database: "String", # required # db_user: "String", # max_results: 1, @@ -1267,7 +1299,7 @@ def list_databases(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.list_schemas({ - # cluster_identifier: "Location", + # cluster_identifier: "ClusterIdentifierString", # connected_database: "String", # database: "String", # required # db_user: "String", @@ -1382,6 +1414,7 @@ def list_schemas(params = {}, options = {}) # resp.statements[0].query_strings #=> Array # resp.statements[0].query_strings[0] #=> String # resp.statements[0].secret_arn #=> String + # resp.statements[0].session_id #=> String # resp.statements[0].statement_name #=> String # resp.statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL" # resp.statements[0].updated_at #=> Time @@ -1508,7 +1541,7 @@ def list_statements(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.list_tables({ - # cluster_identifier: "Location", + # cluster_identifier: "ClusterIdentifierString", # connected_database: "String", # database: "String", # required # db_user: "String", @@ -1550,7 +1583,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-redshiftdataapiservice' - context[:gem_version] = '1.41.0' + context[:gem_version] = '1.42.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client_api.rb b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client_api.rb index da893f9e598..bd2f73b3d67 100644 --- a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client_api.rb +++ b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/client_api.rb @@ -13,6 +13,7 @@ module ClientApi include Seahorse::Model + ActiveSessionsExceededException = Shapes::StructureShape.new(name: 'ActiveSessionsExceededException') ActiveStatementsExceededException = Shapes::StructureShape.new(name: 'ActiveStatementsExceededException') BatchExecuteStatementException = Shapes::StructureShape.new(name: 'BatchExecuteStatementException') BatchExecuteStatementInput = Shapes::StructureShape.new(name: 'BatchExecuteStatementInput') @@ -25,11 +26,13 @@ module ClientApi CancelStatementRequest = Shapes::StructureShape.new(name: 'CancelStatementRequest') CancelStatementResponse = Shapes::StructureShape.new(name: 'CancelStatementResponse') ClientToken = Shapes::StringShape.new(name: 'ClientToken') + ClusterIdentifierString = Shapes::StringShape.new(name: 'ClusterIdentifierString') ColumnList = Shapes::ListShape.new(name: 'ColumnList') ColumnMetadata = Shapes::StructureShape.new(name: 'ColumnMetadata') ColumnMetadataList = Shapes::ListShape.new(name: 'ColumnMetadataList') DatabaseConnectionException = Shapes::StructureShape.new(name: 'DatabaseConnectionException') DatabaseList = Shapes::ListShape.new(name: 'DatabaseList') + DbGroupList = Shapes::ListShape.new(name: 'DbGroupList') DescribeStatementRequest = Shapes::StructureShape.new(name: 'DescribeStatementRequest') DescribeStatementResponse = Shapes::StructureShape.new(name: 'DescribeStatementResponse') DescribeTableRequest = Shapes::StructureShape.new(name: 'DescribeTableRequest') @@ -52,20 +55,20 @@ module ClientApi ListStatementsResponse = Shapes::StructureShape.new(name: 'ListStatementsResponse') ListTablesRequest = Shapes::StructureShape.new(name: 'ListTablesRequest') ListTablesResponse = Shapes::StructureShape.new(name: 'ListTablesResponse') - Location = Shapes::StringShape.new(name: 'Location') Long = Shapes::IntegerShape.new(name: 'Long') PageSize = Shapes::IntegerShape.new(name: 'PageSize') ParameterName = Shapes::StringShape.new(name: 'ParameterName') ParameterValue = Shapes::StringShape.new(name: 'ParameterValue') + QueryTimeoutException = Shapes::StructureShape.new(name: 'QueryTimeoutException') ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException') SchemaList = Shapes::ListShape.new(name: 'SchemaList') SecretArn = Shapes::StringShape.new(name: 'SecretArn') + SessionAliveSeconds = Shapes::IntegerShape.new(name: 'SessionAliveSeconds') SqlList = Shapes::ListShape.new(name: 'SqlList') SqlParameter = Shapes::StructureShape.new(name: 'SqlParameter') SqlParametersList = Shapes::ListShape.new(name: 'SqlParametersList') SqlRecords = Shapes::ListShape.new(name: 'SqlRecords') StatementData = Shapes::StructureShape.new(name: 'StatementData') - StatementId = Shapes::StringShape.new(name: 'StatementId') StatementList = Shapes::ListShape.new(name: 'StatementList') StatementNameString = Shapes::StringShape.new(name: 'StatementNameString') StatementStatusString = Shapes::StringShape.new(name: 'StatementStatusString') @@ -78,10 +81,14 @@ module ClientApi TableList = Shapes::ListShape.new(name: 'TableList') TableMember = Shapes::StructureShape.new(name: 'TableMember') Timestamp = Shapes::TimestampShape.new(name: 'Timestamp') + UUID = Shapes::StringShape.new(name: 'UUID') ValidationException = Shapes::StructureShape.new(name: 'ValidationException') WorkgroupNameString = Shapes::StringShape.new(name: 'WorkgroupNameString') bool = Shapes::BooleanShape.new(name: 'bool') + ActiveSessionsExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message")) + ActiveSessionsExceededException.struct_class = Types::ActiveSessionsExceededException + ActiveStatementsExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message")) ActiveStatementsExceededException.struct_class = Types::ActiveStatementsExceededException @@ -90,26 +97,30 @@ module ClientApi BatchExecuteStatementException.struct_class = Types::BatchExecuteStatementException BatchExecuteStatementInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true})) - BatchExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) - BatchExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database")) + BatchExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) + BatchExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database")) BatchExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) BatchExecuteStatementInput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn")) + BatchExecuteStatementInput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId")) + BatchExecuteStatementInput.add_member(:session_keep_alive_seconds, Shapes::ShapeRef.new(shape: SessionAliveSeconds, location_name: "SessionKeepAliveSeconds")) BatchExecuteStatementInput.add_member(:sqls, Shapes::ShapeRef.new(shape: SqlList, required: true, location_name: "Sqls")) BatchExecuteStatementInput.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName")) BatchExecuteStatementInput.add_member(:with_event, Shapes::ShapeRef.new(shape: Boolean, location_name: "WithEvent")) BatchExecuteStatementInput.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName")) BatchExecuteStatementInput.struct_class = Types::BatchExecuteStatementInput - BatchExecuteStatementOutput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) + BatchExecuteStatementOutput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) BatchExecuteStatementOutput.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt")) BatchExecuteStatementOutput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database")) + BatchExecuteStatementOutput.add_member(:db_groups, Shapes::ShapeRef.new(shape: DbGroupList, location_name: "DbGroups")) BatchExecuteStatementOutput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) - BatchExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, location_name: "Id")) + BatchExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "Id")) BatchExecuteStatementOutput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn")) + BatchExecuteStatementOutput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId")) BatchExecuteStatementOutput.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName")) BatchExecuteStatementOutput.struct_class = Types::BatchExecuteStatementOutput - CancelStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id")) + CancelStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id")) CancelStatementRequest.struct_class = Types::CancelStatementRequest CancelStatementResponse.add_member(:status, Shapes::ShapeRef.new(shape: Boolean, location_name: "Status")) @@ -139,7 +150,9 @@ module ClientApi DatabaseList.member = Shapes::ShapeRef.new(shape: String) - DescribeStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id")) + DbGroupList.member = Shapes::ShapeRef.new(shape: String) + + DescribeStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id")) DescribeStatementRequest.struct_class = Types::DescribeStatementRequest DescribeStatementResponse.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ClusterIdentifier")) @@ -149,7 +162,7 @@ module ClientApi DescribeStatementResponse.add_member(:duration, Shapes::ShapeRef.new(shape: Long, location_name: "Duration")) DescribeStatementResponse.add_member(:error, Shapes::ShapeRef.new(shape: String, location_name: "Error")) DescribeStatementResponse.add_member(:has_result_set, Shapes::ShapeRef.new(shape: Boolean, location_name: "HasResultSet")) - DescribeStatementResponse.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id")) + DescribeStatementResponse.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id")) DescribeStatementResponse.add_member(:query_parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "QueryParameters")) DescribeStatementResponse.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString")) DescribeStatementResponse.add_member(:redshift_pid, Shapes::ShapeRef.new(shape: Long, location_name: "RedshiftPid")) @@ -157,13 +170,14 @@ module ClientApi DescribeStatementResponse.add_member(:result_rows, Shapes::ShapeRef.new(shape: Long, location_name: "ResultRows")) DescribeStatementResponse.add_member(:result_size, Shapes::ShapeRef.new(shape: Long, location_name: "ResultSize")) DescribeStatementResponse.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn")) + DescribeStatementResponse.add_member(:session_id, Shapes::ShapeRef.new(shape: String, location_name: "SessionId")) DescribeStatementResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusString, location_name: "Status")) DescribeStatementResponse.add_member(:sub_statements, Shapes::ShapeRef.new(shape: SubStatementList, location_name: "SubStatements")) DescribeStatementResponse.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt")) DescribeStatementResponse.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName")) DescribeStatementResponse.struct_class = Types::DescribeStatementResponse - DescribeTableRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) + DescribeTableRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) DescribeTableRequest.add_member(:connected_database, Shapes::ShapeRef.new(shape: String, location_name: "ConnectedDatabase")) DescribeTableRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database")) DescribeTableRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) @@ -185,23 +199,27 @@ module ClientApi ExecuteStatementException.struct_class = Types::ExecuteStatementException ExecuteStatementInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true})) - ExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) - ExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database")) + ExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) + ExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database")) ExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) ExecuteStatementInput.add_member(:parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "Parameters")) ExecuteStatementInput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn")) + ExecuteStatementInput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId")) + ExecuteStatementInput.add_member(:session_keep_alive_seconds, Shapes::ShapeRef.new(shape: SessionAliveSeconds, location_name: "SessionKeepAliveSeconds")) ExecuteStatementInput.add_member(:sql, Shapes::ShapeRef.new(shape: StatementString, required: true, location_name: "Sql")) ExecuteStatementInput.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName")) ExecuteStatementInput.add_member(:with_event, Shapes::ShapeRef.new(shape: Boolean, location_name: "WithEvent")) ExecuteStatementInput.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName")) ExecuteStatementInput.struct_class = Types::ExecuteStatementInput - ExecuteStatementOutput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) + ExecuteStatementOutput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) ExecuteStatementOutput.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt")) ExecuteStatementOutput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database")) + ExecuteStatementOutput.add_member(:db_groups, Shapes::ShapeRef.new(shape: DbGroupList, location_name: "DbGroups")) ExecuteStatementOutput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) - ExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, location_name: "Id")) + ExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "Id")) ExecuteStatementOutput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn")) + ExecuteStatementOutput.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId")) ExecuteStatementOutput.add_member(:workgroup_name, Shapes::ShapeRef.new(shape: WorkgroupNameString, location_name: "WorkgroupName")) ExecuteStatementOutput.struct_class = Types::ExecuteStatementOutput @@ -223,7 +241,7 @@ module ClientApi FieldList.member = Shapes::ShapeRef.new(shape: Field) - GetStatementResultRequest.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id")) + GetStatementResultRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id")) GetStatementResultRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken")) GetStatementResultRequest.struct_class = Types::GetStatementResultRequest @@ -236,7 +254,7 @@ module ClientApi InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Message")) InternalServerException.struct_class = Types::InternalServerException - ListDatabasesRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) + ListDatabasesRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) ListDatabasesRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database")) ListDatabasesRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) ListDatabasesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: PageSize, location_name: "MaxResults")) @@ -249,7 +267,7 @@ module ClientApi ListDatabasesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken")) ListDatabasesResponse.struct_class = Types::ListDatabasesResponse - ListSchemasRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) + ListSchemasRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) ListSchemasRequest.add_member(:connected_database, Shapes::ShapeRef.new(shape: String, location_name: "ConnectedDatabase")) ListSchemasRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database")) ListSchemasRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) @@ -275,7 +293,7 @@ module ClientApi ListStatementsResponse.add_member(:statements, Shapes::ShapeRef.new(shape: StatementList, required: true, location_name: "Statements")) ListStatementsResponse.struct_class = Types::ListStatementsResponse - ListTablesRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier")) + ListTablesRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: ClusterIdentifierString, location_name: "ClusterIdentifier")) ListTablesRequest.add_member(:connected_database, Shapes::ShapeRef.new(shape: String, location_name: "ConnectedDatabase")) ListTablesRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database")) ListTablesRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser")) @@ -291,6 +309,9 @@ module ClientApi ListTablesResponse.add_member(:tables, Shapes::ShapeRef.new(shape: TableList, location_name: "Tables")) ListTablesResponse.struct_class = Types::ListTablesResponse + QueryTimeoutException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message")) + QueryTimeoutException.struct_class = Types::QueryTimeoutException + ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Message")) ResourceNotFoundException.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ResourceId")) ResourceNotFoundException.struct_class = Types::ResourceNotFoundException @@ -308,12 +329,13 @@ module ClientApi SqlRecords.member = Shapes::ShapeRef.new(shape: FieldList) StatementData.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt")) - StatementData.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id")) + StatementData.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id")) StatementData.add_member(:is_batch_statement, Shapes::ShapeRef.new(shape: Boolean, location_name: "IsBatchStatement")) StatementData.add_member(:query_parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "QueryParameters")) StatementData.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString")) StatementData.add_member(:query_strings, Shapes::ShapeRef.new(shape: StatementStringList, location_name: "QueryStrings")) StatementData.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn")) + StatementData.add_member(:session_id, Shapes::ShapeRef.new(shape: UUID, location_name: "SessionId")) StatementData.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName")) StatementData.add_member(:status, Shapes::ShapeRef.new(shape: StatusString, location_name: "Status")) StatementData.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt")) @@ -327,7 +349,7 @@ module ClientApi SubStatementData.add_member(:duration, Shapes::ShapeRef.new(shape: Long, location_name: "Duration")) SubStatementData.add_member(:error, Shapes::ShapeRef.new(shape: String, location_name: "Error")) SubStatementData.add_member(:has_result_set, Shapes::ShapeRef.new(shape: Boolean, location_name: "HasResultSet")) - SubStatementData.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id")) + SubStatementData.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id")) SubStatementData.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString")) SubStatementData.add_member(:redshift_query_id, Shapes::ShapeRef.new(shape: Long, location_name: "RedshiftQueryId")) SubStatementData.add_member(:result_rows, Shapes::ShapeRef.new(shape: Long, location_name: "ResultRows")) @@ -359,6 +381,7 @@ module ClientApi "endpointPrefix" => "redshift-data", "jsonVersion" => "1.1", "protocol" => "json", + "protocols" => ["json"], "serviceFullName" => "Redshift Data API Service", "serviceId" => "Redshift Data", "signatureVersion" => "v4", @@ -374,8 +397,10 @@ module ClientApi o.input = Shapes::ShapeRef.new(shape: BatchExecuteStatementInput) o.output = Shapes::ShapeRef.new(shape: BatchExecuteStatementOutput) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: ActiveSessionsExceededException) o.errors << Shapes::ShapeRef.new(shape: ActiveStatementsExceededException) o.errors << Shapes::ShapeRef.new(shape: BatchExecuteStatementException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) api.add_operation(:cancel_statement, Seahorse::Model::Operation.new.tap do |o| @@ -408,6 +433,7 @@ module ClientApi o.input = Shapes::ShapeRef.new(shape: DescribeTableRequest) o.output = Shapes::ShapeRef.new(shape: DescribeTableResponse) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: QueryTimeoutException) o.errors << Shapes::ShapeRef.new(shape: InternalServerException) o.errors << Shapes::ShapeRef.new(shape: DatabaseConnectionException) o[:pager] = Aws::Pager.new( @@ -425,8 +451,10 @@ module ClientApi o.input = Shapes::ShapeRef.new(shape: ExecuteStatementInput) o.output = Shapes::ShapeRef.new(shape: ExecuteStatementOutput) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: ActiveSessionsExceededException) o.errors << Shapes::ShapeRef.new(shape: ExecuteStatementException) o.errors << Shapes::ShapeRef.new(shape: ActiveStatementsExceededException) + o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) api.add_operation(:get_statement_result, Seahorse::Model::Operation.new.tap do |o| @@ -452,6 +480,7 @@ module ClientApi o.input = Shapes::ShapeRef.new(shape: ListDatabasesRequest) o.output = Shapes::ShapeRef.new(shape: ListDatabasesResponse) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: QueryTimeoutException) o.errors << Shapes::ShapeRef.new(shape: InternalServerException) o.errors << Shapes::ShapeRef.new(shape: DatabaseConnectionException) o[:pager] = Aws::Pager.new( @@ -469,6 +498,7 @@ module ClientApi o.input = Shapes::ShapeRef.new(shape: ListSchemasRequest) o.output = Shapes::ShapeRef.new(shape: ListSchemasResponse) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: QueryTimeoutException) o.errors << Shapes::ShapeRef.new(shape: InternalServerException) o.errors << Shapes::ShapeRef.new(shape: DatabaseConnectionException) o[:pager] = Aws::Pager.new( @@ -502,6 +532,7 @@ module ClientApi o.input = Shapes::ShapeRef.new(shape: ListTablesRequest) o.output = Shapes::ShapeRef.new(shape: ListTablesResponse) o.errors << Shapes::ShapeRef.new(shape: ValidationException) + o.errors << Shapes::ShapeRef.new(shape: QueryTimeoutException) o.errors << Shapes::ShapeRef.new(shape: InternalServerException) o.errors << Shapes::ShapeRef.new(shape: DatabaseConnectionException) o[:pager] = Aws::Pager.new( diff --git a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/endpoint_provider.rb b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/endpoint_provider.rb index c994f1f6bef..48b2c1520da 100644 --- a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/endpoint_provider.rb +++ b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/endpoint_provider.rb @@ -32,7 +32,7 @@ def resolve_endpoint(parameters) raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both" end if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) - if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) + if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true) return Aws::Endpoints::Endpoint.new(url: "https://redshift-data-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {}) end raise ArgumentError, "FIPS is enabled but this partition does not support FIPS" diff --git a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/errors.rb b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/errors.rb index 0aefc6e4206..378967c9e62 100644 --- a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/errors.rb +++ b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/errors.rb @@ -27,11 +27,13 @@ module Aws::RedshiftDataAPIService # See {Seahorse::Client::RequestContext} for more information. # # ## Error Classes + # * {ActiveSessionsExceededException} # * {ActiveStatementsExceededException} # * {BatchExecuteStatementException} # * {DatabaseConnectionException} # * {ExecuteStatementException} # * {InternalServerException} + # * {QueryTimeoutException} # * {ResourceNotFoundException} # * {ValidationException} # @@ -41,6 +43,21 @@ module Errors extend Aws::Errors::DynamicErrors + class ActiveSessionsExceededException < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::RedshiftDataAPIService::Types::ActiveSessionsExceededException] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + + # @return [String] + def message + @message || @data[:message] + end + end + class ActiveStatementsExceededException < ServiceError # @param [Seahorse::Client::RequestContext] context @@ -126,6 +143,21 @@ def message end end + class QueryTimeoutException < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::RedshiftDataAPIService::Types::QueryTimeoutException] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + + # @return [String] + def message + @message || @data[:message] + end + end + class ResourceNotFoundException < ServiceError # @param [Seahorse::Client::RequestContext] context diff --git a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb index 03f7473e927..1a1a694d14b 100644 --- a/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb +++ b/gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb @@ -10,6 +10,20 @@ module Aws::RedshiftDataAPIService module Types + # The Amazon Redshift Data API operation failed because the maximum + # number of active sessions exceeded. + # + # @!attribute [rw] message + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ActiveSessionsExceededException AWS API Documentation + # + class ActiveSessionsExceededException < Struct.new( + :message) + SENSITIVE = [] + include Aws::Structure + end + # The number of active statements exceeds the limit. # # @!attribute [rw] message @@ -73,6 +87,17 @@ class BatchExecuteStatementException < Struct.new( # Manager. # @return [String] # + # @!attribute [rw] session_id + # The session identifier of the query. + # @return [String] + # + # @!attribute [rw] session_keep_alive_seconds + # The number of seconds to keep the session alive after the query + # finishes. The maximum time a session can keep alive is 24 hours. + # After 24 hours, the session is forced closed and the query is + # terminated. + # @return [Integer] + # # @!attribute [rw] sqls # One or more SQL statements to run. The SQL statements are run # as a single transaction. They run serially in the order of the @@ -107,6 +132,8 @@ class BatchExecuteStatementInput < Struct.new( :database, :db_user, :secret_arn, + :session_id, + :session_keep_alive_seconds, :sqls, :statement_name, :with_event, @@ -128,6 +155,10 @@ class BatchExecuteStatementInput < Struct.new( # The name of the database. # @return [String] # + # @!attribute [rw] db_groups + # A list of colon (:) separated names of database groups. + # @return [Array] + # # @!attribute [rw] db_user # The database user name. # @return [String] @@ -143,6 +174,10 @@ class BatchExecuteStatementInput < Struct.new( # The name or ARN of the secret that enables access to the database. # @return [String] # + # @!attribute [rw] session_id + # The session identifier of the query. + # @return [String] + # # @!attribute [rw] workgroup_name # The serverless workgroup name or Amazon Resource Name (ARN). This # element is not returned when connecting to a provisioned cluster. @@ -154,9 +189,11 @@ class BatchExecuteStatementOutput < Struct.new( :cluster_identifier, :created_at, :database, + :db_groups, :db_user, :id, :secret_arn, + :session_id, :workgroup_name) SENSITIVE = [] include Aws::Structure @@ -369,6 +406,10 @@ class DescribeStatementRequest < Struct.new( # access to the database. # @return [String] # + # @!attribute [rw] session_id + # The session identifier of the query. + # @return [String] + # # @!attribute [rw] status # The status of the SQL statement being described. Status values are # defined as follows: @@ -420,6 +461,7 @@ class DescribeStatementResponse < Struct.new( :result_rows, :result_size, :secret_arn, + :session_id, :status, :sub_statements, :updated_at, @@ -590,6 +632,17 @@ class ExecuteStatementException < Struct.new( # Manager. # @return [String] # + # @!attribute [rw] session_id + # The session identifier of the query. + # @return [String] + # + # @!attribute [rw] session_keep_alive_seconds + # The number of seconds to keep the session alive after the query + # finishes. The maximum time a session can keep alive is 24 hours. + # After 24 hours, the session is forced closed and the query is + # terminated. + # @return [Integer] + # # @!attribute [rw] sql # The SQL statement text to run. # @return [String] @@ -620,6 +673,8 @@ class ExecuteStatementInput < Struct.new( :db_user, :parameters, :secret_arn, + :session_id, + :session_keep_alive_seconds, :sql, :statement_name, :with_event, @@ -641,6 +696,10 @@ class ExecuteStatementInput < Struct.new( # The name of the database. # @return [String] # + # @!attribute [rw] db_groups + # A list of colon (:) separated names of database groups. + # @return [Array] + # # @!attribute [rw] db_user # The database user name. # @return [String] @@ -655,6 +714,10 @@ class ExecuteStatementInput < Struct.new( # The name or ARN of the secret that enables access to the database. # @return [String] # + # @!attribute [rw] session_id + # The session identifier of the query. + # @return [String] + # # @!attribute [rw] workgroup_name # The serverless workgroup name or Amazon Resource Name (ARN). This # element is not returned when connecting to a provisioned cluster. @@ -666,9 +729,11 @@ class ExecuteStatementOutput < Struct.new( :cluster_identifier, :created_at, :database, + :db_groups, :db_user, :id, :secret_arn, + :session_id, :workgroup_name) SENSITIVE = [] include Aws::Structure @@ -1175,6 +1240,19 @@ class ListTablesResponse < Struct.new( include Aws::Structure end + # The Amazon Redshift Data API operation failed due to timeout. + # + # @!attribute [rw] message + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/QueryTimeoutException AWS API Documentation + # + class QueryTimeoutException < Struct.new( + :message) + SENSITIVE = [] + include Aws::Structure + end + # The Amazon Redshift Data API operation failed due to a missing # resource. # @@ -1254,6 +1332,10 @@ class SqlParameter < Struct.new( # access to the database. # @return [String] # + # @!attribute [rw] session_id + # The session identifier of the query. + # @return [String] + # # @!attribute [rw] statement_name # The name of the SQL statement. # @return [String] @@ -1278,6 +1360,7 @@ class StatementData < Struct.new( :query_string, :query_strings, :secret_arn, + :session_id, :statement_name, :status, :updated_at) diff --git a/gems/aws-sdk-redshiftdataapiservice/sig/client.rbs b/gems/aws-sdk-redshiftdataapiservice/sig/client.rbs index 0296cb06117..2617721ce15 100644 --- a/gems/aws-sdk-redshiftdataapiservice/sig/client.rbs +++ b/gems/aws-sdk-redshiftdataapiservice/sig/client.rbs @@ -79,18 +79,22 @@ module Aws def cluster_identifier: () -> ::String def created_at: () -> ::Time def database: () -> ::String + def db_groups: () -> ::Array[::String] def db_user: () -> ::String def id: () -> ::String def secret_arn: () -> ::String + def session_id: () -> ::String def workgroup_name: () -> ::String end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#batch_execute_statement-instance_method def batch_execute_statement: ( ?client_token: ::String, ?cluster_identifier: ::String, - database: ::String, + ?database: ::String, ?db_user: ::String, ?secret_arn: ::String, + ?session_id: ::String, + ?session_keep_alive_seconds: ::Integer, sqls: Array[::String], ?statement_name: ::String, ?with_event: bool, @@ -124,6 +128,7 @@ module Aws def result_rows: () -> ::Integer def result_size: () -> ::Integer def secret_arn: () -> ::String + def session_id: () -> ::String def status: () -> ("SUBMITTED" | "PICKED" | "STARTED" | "FINISHED" | "ABORTED" | "FAILED" | "ALL") def sub_statements: () -> ::Array[Types::SubStatementData] def updated_at: () -> ::Time @@ -161,16 +166,18 @@ module Aws def cluster_identifier: () -> ::String def created_at: () -> ::Time def database: () -> ::String + def db_groups: () -> ::Array[::String] def db_user: () -> ::String def id: () -> ::String def secret_arn: () -> ::String + def session_id: () -> ::String def workgroup_name: () -> ::String end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RedshiftDataAPIService/Client.html#execute_statement-instance_method def execute_statement: ( ?client_token: ::String, ?cluster_identifier: ::String, - database: ::String, + ?database: ::String, ?db_user: ::String, ?parameters: Array[ { @@ -179,6 +186,8 @@ module Aws }, ], ?secret_arn: ::String, + ?session_id: ::String, + ?session_keep_alive_seconds: ::Integer, sql: ::String, ?statement_name: ::String, ?with_event: bool, diff --git a/gems/aws-sdk-redshiftdataapiservice/sig/errors.rbs b/gems/aws-sdk-redshiftdataapiservice/sig/errors.rbs index e98e2a53488..3715ee0d9e9 100644 --- a/gems/aws-sdk-redshiftdataapiservice/sig/errors.rbs +++ b/gems/aws-sdk-redshiftdataapiservice/sig/errors.rbs @@ -11,6 +11,9 @@ module Aws class ServiceError < ::Aws::Errors::ServiceError end + class ActiveSessionsExceededException < ::Aws::Errors::ServiceError + def message: () -> ::String + end class ActiveStatementsExceededException < ::Aws::Errors::ServiceError def message: () -> ::String end @@ -28,6 +31,9 @@ module Aws class InternalServerException < ::Aws::Errors::ServiceError def message: () -> ::String end + class QueryTimeoutException < ::Aws::Errors::ServiceError + def message: () -> ::String + end class ResourceNotFoundException < ::Aws::Errors::ServiceError def message: () -> ::String def resource_id: () -> ::String diff --git a/gems/aws-sdk-redshiftdataapiservice/sig/types.rbs b/gems/aws-sdk-redshiftdataapiservice/sig/types.rbs index 3017e9501f8..b03dc5be115 100644 --- a/gems/aws-sdk-redshiftdataapiservice/sig/types.rbs +++ b/gems/aws-sdk-redshiftdataapiservice/sig/types.rbs @@ -8,6 +8,11 @@ module Aws::RedshiftDataAPIService module Types + class ActiveSessionsExceededException + attr_accessor message: ::String + SENSITIVE: [] + end + class ActiveStatementsExceededException attr_accessor message: ::String SENSITIVE: [] @@ -25,6 +30,8 @@ module Aws::RedshiftDataAPIService attr_accessor database: ::String attr_accessor db_user: ::String attr_accessor secret_arn: ::String + attr_accessor session_id: ::String + attr_accessor session_keep_alive_seconds: ::Integer attr_accessor sqls: ::Array[::String] attr_accessor statement_name: ::String attr_accessor with_event: bool @@ -36,9 +43,11 @@ module Aws::RedshiftDataAPIService attr_accessor cluster_identifier: ::String attr_accessor created_at: ::Time attr_accessor database: ::String + attr_accessor db_groups: ::Array[::String] attr_accessor db_user: ::String attr_accessor id: ::String attr_accessor secret_arn: ::String + attr_accessor session_id: ::String attr_accessor workgroup_name: ::String SENSITIVE: [] end @@ -96,6 +105,7 @@ module Aws::RedshiftDataAPIService attr_accessor result_rows: ::Integer attr_accessor result_size: ::Integer attr_accessor secret_arn: ::String + attr_accessor session_id: ::String attr_accessor status: ("SUBMITTED" | "PICKED" | "STARTED" | "FINISHED" | "ABORTED" | "FAILED" | "ALL") attr_accessor sub_statements: ::Array[Types::SubStatementData] attr_accessor updated_at: ::Time @@ -137,6 +147,8 @@ module Aws::RedshiftDataAPIService attr_accessor db_user: ::String attr_accessor parameters: ::Array[Types::SqlParameter] attr_accessor secret_arn: ::String + attr_accessor session_id: ::String + attr_accessor session_keep_alive_seconds: ::Integer attr_accessor sql: ::String attr_accessor statement_name: ::String attr_accessor with_event: bool @@ -148,9 +160,11 @@ module Aws::RedshiftDataAPIService attr_accessor cluster_identifier: ::String attr_accessor created_at: ::Time attr_accessor database: ::String + attr_accessor db_groups: ::Array[::String] attr_accessor db_user: ::String attr_accessor id: ::String attr_accessor secret_arn: ::String + attr_accessor session_id: ::String attr_accessor workgroup_name: ::String SENSITIVE: [] end @@ -271,6 +285,11 @@ module Aws::RedshiftDataAPIService SENSITIVE: [] end + class QueryTimeoutException + attr_accessor message: ::String + SENSITIVE: [] + end + class ResourceNotFoundException attr_accessor message: ::String attr_accessor resource_id: ::String @@ -291,6 +310,7 @@ module Aws::RedshiftDataAPIService attr_accessor query_string: ::String attr_accessor query_strings: ::Array[::String] attr_accessor secret_arn: ::String + attr_accessor session_id: ::String attr_accessor statement_name: ::String attr_accessor status: ("SUBMITTED" | "PICKED" | "STARTED" | "FINISHED" | "ABORTED" | "FAILED" | "ALL") attr_accessor updated_at: ::Time diff --git a/gems/aws-sdk-resources/CHANGELOG.md b/gems/aws-sdk-resources/CHANGELOG.md index 18c0d12d68f..31ce6bde7d9 100644 --- a/gems/aws-sdk-resources/CHANGELOG.md +++ b/gems/aws-sdk-resources/CHANGELOG.md @@ -1,6 +1,15 @@ Unreleased Changes ------------------ +3.204.0 (2024-08-30) +------------------ + +* Feature - Added a dependency on the new `aws-sdk-core` gem. + +* Feature - Added a dependency on the new `aws-sdk-core` gem. + +* Feature - Added a dependency on the new `aws-sdk-core` gem. + 3.203.0 (2024-08-28) ------------------ diff --git a/gems/aws-sdk-resources/VERSION b/gems/aws-sdk-resources/VERSION index e1d37b54bfe..f83c8a3abce 100644 --- a/gems/aws-sdk-resources/VERSION +++ b/gems/aws-sdk-resources/VERSION @@ -1 +1 @@ -3.203.0 +3.204.0 diff --git a/gems/aws-sdk-resources/lib/aws-sdk-resources.rb b/gems/aws-sdk-resources/lib/aws-sdk-resources.rb index a6477ba58ff..ec60c23add5 100644 --- a/gems/aws-sdk-resources/lib/aws-sdk-resources.rb +++ b/gems/aws-sdk-resources/lib/aws-sdk-resources.rb @@ -333,7 +333,10 @@ module Aws autoload :SSMContacts, 'aws-sdk-ssmcontacts' autoload :SSMIncidents, 'aws-sdk-ssmincidents' autoload :SSMQuickSetup, 'aws-sdk-ssmquicksetup' + autoload :SSO, 'aws-sdk-core' autoload :SSOAdmin, 'aws-sdk-ssoadmin' + autoload :SSOOIDC, 'aws-sdk-core' + autoload :STS, 'aws-sdk-core' autoload :SWF, 'aws-sdk-swf' autoload :SageMaker, 'aws-sdk-sagemaker' autoload :SageMakerFeatureStoreRuntime, 'aws-sdk-sagemakerfeaturestoreruntime'