From 92df7d85f1bee48d514ab8dae46b7b45bae9ee7e Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Fri, 30 Aug 2024 18:12:57 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/backup.json | 538 ++-- .../aws-models/cloudwatch-logs.json | 178 +- codegen/sdk-codegen/aws-models/datazone.json | 2864 +++++++++++++++-- .../sdk-codegen/aws-models/redshift-data.json | 288 +- 4 files changed, 3193 insertions(+), 675 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/backup.json b/codegen/sdk-codegen/aws-models/backup.json index c353978e9db..b99cf3683b7 100644 --- a/codegen/sdk-codegen/aws-models/backup.json +++ b/codegen/sdk-codegen/aws-models/backup.json @@ -55,7 +55,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of backup options for each resource type.

" + "smithy.api#documentation": "

The backup options for each resource type.

" } }, "com.amazonaws.backup#AdvancedBackupSettings": { @@ -144,13 +144,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } }, "RecoveryPointArn": { @@ -265,13 +265,13 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

This is the date on which the backup \n job was initiated.

" + "smithy.api#documentation": "

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

" } }, "MessageCategory": { @@ -520,7 +520,7 @@ "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

\n

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

", "smithy.api#required": {} } }, @@ -659,7 +659,7 @@ "LastExecutionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "AdvancedBackupSettings": { @@ -686,7 +686,7 @@ "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -711,13 +711,13 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

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

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

" + "smithy.api#documentation": "

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

" } }, "RuleId": { @@ -741,7 +741,7 @@ "ScheduleExpressionTimezone": { "target": "com.amazonaws.backup#Timezone", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -762,7 +762,7 @@ "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -787,13 +787,13 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

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

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

" + "smithy.api#documentation": "

The tags to assign to the resources.

" } }, "CopyActions": { @@ -811,7 +811,7 @@ "ScheduleExpressionTimezone": { "target": "com.amazonaws.backup#Timezone", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -857,30 +857,30 @@ "Resources": { "target": "com.amazonaws.backup#ResourceArns", "traits": { - "smithy.api#documentation": "

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

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

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

\n

\n ListOfTags differs from Conditions as follows:

\n " + "smithy.api#documentation": "

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

\n

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

\n

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

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

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

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

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

\n

\n Conditions differs from ListOfTags as follows:

\n " + "smithy.api#documentation": "

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

\n

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

\n

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

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

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

For more information, see Assigning resources programmatically.

" } }, "com.amazonaws.backup#BackupSelectionName": { @@ -1064,13 +1064,25 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

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

The current state of the vault.

" } }, "CreationDate": { @@ -1159,7 +1171,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

" } }, "com.amazonaws.backup#CancelLegalHold": { @@ -1188,7 +1200,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "DELETE", "uri": "/legal-holds/{LegalHoldId}", @@ -1203,7 +1215,7 @@ "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The ID of the legal hold.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1211,7 +1223,7 @@ "CancelDescription": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

String describing the reason for removing the legal hold.

", + "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "cancelDescription", "smithy.api#required": {} } @@ -1219,7 +1231,7 @@ "RetainRecordInDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "retainRecordInDays" } } @@ -1296,7 +1308,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

\n

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

" } }, "com.amazonaws.backup#ConditionParameters": { @@ -1400,7 +1412,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "com.amazonaws.backup#ControlInputParameters": { @@ -1430,7 +1442,7 @@ "Tags": { "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#documentation": "

The tag key-value pair applied to those Amazon Web Services resources that you want to\n trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag\n value is optional, but it cannot be an empty string. The structure to assign a tag is:\n [{\"Key\":\"string\",\"Value\":\"string\"}].

" + "smithy.api#documentation": "

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

\n

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

" } } }, @@ -1447,7 +1459,7 @@ "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } } @@ -1480,7 +1492,7 @@ "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "SourceRecoveryPointArn": { @@ -1492,7 +1504,7 @@ "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "DestinationRecoveryPointArn": { @@ -1568,13 +1580,13 @@ "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

The number of child (nested) copy jobs.

" } }, "ChildJobsInState": { @@ -1586,7 +1598,7 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "MessageCategory": { @@ -1721,7 +1733,7 @@ "Region": { "target": "com.amazonaws.backup#Region", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" } }, "AccountId": { @@ -1825,14 +1837,14 @@ "BackupPlan": { "target": "com.amazonaws.backup#BackupPlanInput", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

The tags to assign to the backup plan.

" } }, "CreatorRequestId": { @@ -1852,7 +1864,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

The ID of the backup plan.

" } }, "BackupPlanArn": { @@ -1876,7 +1888,7 @@ "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -1925,7 +1937,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The ID of the backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1933,7 +1945,7 @@ "BackupSelection": { "target": "com.amazonaws.backup#BackupSelection", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -1960,7 +1972,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

The ID of the backup plan.

" } }, "CreationDate": { @@ -2023,7 +2035,7 @@ "BackupVaultTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The tags to assign to the backup vault.

" } }, "EncryptionKeyArn": { @@ -2055,7 +2067,7 @@ "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "CreationDate": { @@ -2123,7 +2135,7 @@ "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -2137,7 +2149,7 @@ "FrameworkTags": { "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The tags to assign to the framework.

" } } }, @@ -2188,7 +2200,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/legal-holds", @@ -2203,14 +2215,14 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the string title of the legal hold.

", + "smithy.api#documentation": "

The title of the legal hold.

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

This is the string description of the legal hold.

", + "smithy.api#documentation": "

The description of the legal hold.

", "smithy.api#required": {} } }, @@ -2223,7 +2235,7 @@ "RecoveryPointSelection": { "target": "com.amazonaws.backup#RecoveryPointSelection", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "Tags": { @@ -2243,43 +2255,43 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The title of the legal hold.

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

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

" + "smithy.api#documentation": "

The status of the legal hold.

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

This is the returned string description of the legal hold.

" + "smithy.api#documentation": "

The description of the legal hold.

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

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

" + "smithy.api#documentation": "

The ID of the legal hold.

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

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

" + "smithy.api#documentation": "

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

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

Time in number format when legal hold was created.

" + "smithy.api#documentation": "

The time when the legal hold was created.

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

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

" + "smithy.api#documentation": "

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

" } } }, @@ -2316,7 +2328,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

\n \n

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

\n ", + "smithy.api#documentation": "

Creates a logical container to where backups may be copied.

\n

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

\n \n

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

\n ", "smithy.api#http": { "method": "PUT", "uri": "/logically-air-gapped-backup-vaults/{BackupVaultName}", @@ -2331,7 +2343,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2339,26 +2351,26 @@ "BackupVaultTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The tags to assign to the vault.

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

This is the ID of the creation request.

\n

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

" + "smithy.api#documentation": "

The ID of the creation request.

\n

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

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

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

\n

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

", + "smithy.api#documentation": "

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

\n

The minimum value accepted is 7 days.

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

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

\n

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } } @@ -2373,13 +2385,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the vault.

" } }, "CreationDate": { @@ -2391,7 +2403,7 @@ "VaultState": { "target": "com.amazonaws.backup#VaultState", "traits": { - "smithy.api#documentation": "

This is the current state of the vault.

" + "smithy.api#documentation": "

The current state of the vault.

" } } }, @@ -2467,7 +2479,7 @@ "ReportPlanTags": { "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#documentation": "

Metadata that you can assign to help organize the report plans that you create. Each tag\n is a key-value pair.

" + "smithy.api#documentation": "

The tags to assign to the report plan.

" } }, "IdempotencyToken": { @@ -2537,7 +2549,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

", + "smithy.api#documentation": "

Creates a restore testing plan.

\n

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

", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans", @@ -2565,7 +2577,7 @@ "Tags": { "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The tags to assign to the restore testing plan.

" } } }, @@ -2675,28 +2687,28 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The time that the resource testing selection was created.

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

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

", + "smithy.api#documentation": "

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

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

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

\n

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

", + "smithy.api#documentation": "

The name of the restore testing plan.

\n

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

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

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } } @@ -4176,7 +4188,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4275,7 +4287,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4379,7 +4391,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4636,13 +4648,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } }, "RecoveryPointArn": { @@ -4769,19 +4781,19 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

This is the date a backup job was initiated.

" + "smithy.api#documentation": "

The date a backup job was initiated.

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

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

\n

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

" + "smithy.api#documentation": "

The job count for the specified \n message category.

\n

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

" } } }, @@ -4827,7 +4839,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4835,7 +4847,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the account ID of the specified backup vault.

", + "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "backupVaultAccountId" } } @@ -4850,19 +4862,25 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

This is the type of vault described.

" + "smithy.api#documentation": "

The type of vault described.

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

The current state of the vault.->

" } }, "EncryptionKeyArn": { @@ -4899,7 +4917,7 @@ "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

" } }, "MaxRetentionDays": { @@ -5052,7 +5070,7 @@ "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "CreationTime": { @@ -5208,37 +5226,37 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The name of the resource that belongs to the specified backup.

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

This is the creation date of the most recent restore job.

" + "smithy.api#documentation": "

The creation date of the most recent restore job.

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

This is the date the most recent recovery point was created.

" + "smithy.api#documentation": "

The date the most recent recovery point was created.

" } } }, @@ -5284,7 +5302,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5300,7 +5318,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

This is the account ID of the specified backup vault.

", + "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "backupVaultAccountId" } } @@ -5321,19 +5339,19 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } }, "ResourceArn": { @@ -5363,7 +5381,7 @@ "Status": { "target": "com.amazonaws.backup#RecoveryPointStatus", "traits": { - "smithy.api#documentation": "

A status code specifying the state of the recovery point.

\n

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

\n

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

\n

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

\n

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

\n

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

" + "smithy.api#documentation": "

A status code specifying the state of the recovery point.

\n

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

\n

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

\n

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

\n

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

\n

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

" } }, "StatusMessage": { @@ -5399,7 +5417,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

" } }, "EncryptionKeyArn": { @@ -5436,7 +5454,7 @@ "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "IsParent": { @@ -5449,13 +5467,13 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The name of the resource that belongs to the specified backup.

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

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

" + "smithy.api#documentation": "

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

" } } }, @@ -5498,13 +5516,13 @@ "ResourceTypeOptInPreference": { "target": "com.amazonaws.backup#ResourceTypeOptInPreference", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

\n

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

" } } }, @@ -5562,7 +5580,7 @@ "ReportJob": { "target": "com.amazonaws.backup#ReportJob", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -5754,7 +5772,7 @@ "CreatedResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

\n

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

" } }, "ResourceType": { @@ -5766,7 +5784,7 @@ "RecoveryPointCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

This is the creation date of the recovery point made by the specifed restore job.

" + "smithy.api#documentation": "

The creation date of the recovery point made by the specifed restore job.

" } }, "CreatedBy": { @@ -5778,19 +5796,19 @@ "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The status of validation run on the indicated \n restore job.

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

This describes the status of validation run on the \n indicated restore job.

" + "smithy.api#documentation": "

The status message.

" } }, "DeletionStatus": { "target": "com.amazonaws.backup#RestoreDeletionStatus", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The status of the data generated by the restore test.

" } }, "DeletionStatusMessage": { @@ -5881,7 +5899,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5889,7 +5907,7 @@ "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6048,7 +6066,7 @@ "ControlInputParameters": { "target": "com.amazonaws.backup#ControlInputParameters", "traits": { - "smithy.api#documentation": "

A list of ParameterName and ParameterValue pairs.

" + "smithy.api#documentation": "

The name/value pairs.

" } }, "ControlScope": { @@ -6321,7 +6339,7 @@ "LastExecutionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "AdvancedBackupSettings": { @@ -6467,7 +6485,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6483,13 +6501,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } }, "Policy": { @@ -6541,7 +6559,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6557,13 +6575,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } }, "SNSTopicArn": { @@ -6621,7 +6639,7 @@ "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the ID required to use GetLegalHold. This unique ID \n is associated with a specific legal hold.

", + "smithy.api#documentation": "

The ID of the legal hold.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6637,61 +6655,61 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the string title of the legal hold.

" + "smithy.api#documentation": "

The title of the legal hold.

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

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

" + "smithy.api#documentation": "

The status of the legal hold.

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

This is the returned string description of the legal hold.

" + "smithy.api#documentation": "

The description of the legal hold.

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

String describing the reason for removing the legal hold.

" + "smithy.api#documentation": "

The reason for removing the legal hold.

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

This is the returned ID associated with a specified legal hold.

" + "smithy.api#documentation": "

The ID of the legal hold.

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

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

" + "smithy.api#documentation": "

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

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

Time in number format when legal hold was created.

" + "smithy.api#documentation": "

The time when the legal hold was created.

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

Time in number when legal hold was cancelled.

" + "smithy.api#documentation": "

The time when the legal hold was cancelled.

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

This is the date and time until which the legal hold record will \n be retained.

" + "smithy.api#documentation": "

The date and time until which the legal hold record is retained.

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

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

" + "smithy.api#documentation": "

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

" } } }, @@ -6737,7 +6755,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6753,7 +6771,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

This is the account ID of the specified backup vault.

", + "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "backupVaultAccountId" } } @@ -6768,7 +6786,7 @@ "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "RecoveryPointArn": { @@ -6786,7 +6804,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

This is the resource type associated with the recovery point.

" + "smithy.api#documentation": "

The resource type of the recovery point.

" } } }, @@ -6898,7 +6916,7 @@ "BackupVaultAccountId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This is the account ID of the specified backup vault.

", + "smithy.api#documentation": "

The account ID of the specified backup vault.

", "smithy.api#httpQuery": "BackupVaultAccountId" } }, @@ -7086,7 +7104,7 @@ "ResourceTypes": { "target": "com.amazonaws.backup#ResourceTypes", "traits": { - "smithy.api#documentation": "

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

\n " + "smithy.api#documentation": "

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

\n " } } }, @@ -7236,43 +7254,43 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the title of a legal hold.

" + "smithy.api#documentation": "

The title of a legal hold.

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

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

" + "smithy.api#documentation": "

The status of the legal hold.

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

This is the description of a legal hold.

" + "smithy.api#documentation": "

The description of a legal hold.

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

ID of specific legal hold on one or more recovery points.

" + "smithy.api#documentation": "

The ID of the legal hold.

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

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

" + "smithy.api#documentation": "

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

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

This is the time in number format when legal hold was created.

" + "smithy.api#documentation": "

The time when the legal hold was created.

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

This is the time in number format when legal hold was cancelled.

" + "smithy.api#documentation": "

The time when the legal hold was cancelled.

" } } }, @@ -7321,24 +7339,24 @@ "MoveToColdStorageAfterDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

\n

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

\n

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

" + "smithy.api#documentation": "

Specifies the time period, in days, before a recovery point transitions to cold storage \n or is deleted.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the retention setting must be 90 days greater than the\n transition to cold after days setting. The transition to cold after days setting can't\n be changed after a backup has been transitioned to cold.

\n

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

\n

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

" } }, "com.amazonaws.backup#LimitExceededException": { @@ -7432,14 +7450,14 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

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

\n

Acceptable values include

\n ", + "smithy.api#documentation": "

The period for the returned results.

\n ", "smithy.api#httpQuery": "AggregationPeriod" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

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

\n

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

", + "smithy.api#documentation": "

The maximum number of items to be returned.

\n

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

", "smithy.api#httpQuery": "MaxResults" } }, @@ -7461,13 +7479,13 @@ "BackupJobSummaries": { "target": "com.amazonaws.backup#BackupJobSummaryList", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The summary information.

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

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

\n " + "smithy.api#documentation": "

The period for the returned results.

\n " } }, "NextToken": { @@ -7547,7 +7565,7 @@ "ByBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "backupVaultName" } }, @@ -7568,7 +7586,7 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", + "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, @@ -7655,7 +7673,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

Lists the backup plan templates.

", "smithy.api#http": { "method": "GET", "uri": "/backup/template/plans", @@ -7682,7 +7700,7 @@ "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#documentation": "

The maximum number of items to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -7822,7 +7840,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

Lists the active backup plans for the account.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans", @@ -7878,7 +7896,7 @@ "BackupPlansList": { "target": "com.amazonaws.backup#BackupPlansList", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

Information about the backup plans.

" } } }, @@ -8133,7 +8151,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

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

\n ", + "smithy.api#documentation": "

The period for the returned results.

\n ", "smithy.api#httpQuery": "AggregationPeriod" } }, @@ -8168,7 +8186,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

\n " + "smithy.api#documentation": "

The period for the returned results.

\n " } }, "NextToken": { @@ -8261,14 +8279,14 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", + "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, "ByDestinationVaultArn": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "destinationVaultArn" } }, @@ -8390,7 +8408,7 @@ "Frameworks": { "target": "com.amazonaws.backup#FrameworkList", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "NextToken": { @@ -8556,7 +8574,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8564,7 +8582,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "backupVaultAccountId" } }, @@ -8693,7 +8711,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n ", + "smithy.api#documentation": "

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

\n \n

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

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8729,7 +8747,7 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

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

\n ", + "smithy.api#documentation": "

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

\n ", "smithy.api#httpQuery": "resourceType" } }, @@ -8827,7 +8845,7 @@ "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the ID of the legal hold.

", + "smithy.api#documentation": "

The ID of the legal hold.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8835,14 +8853,14 @@ "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The maximum number of resource list items to be returned.

", "smithy.api#httpQuery": "maxResults" } } @@ -8857,13 +8875,13 @@ "RecoveryPoints": { "target": "com.amazonaws.backup#RecoveryPointsList", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The recovery points.

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

This return is the next item following a partial list of returned resources.

" + "smithy.api#documentation": "

The next item following a partial list of returned resources.

" } } }, @@ -8894,7 +8912,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n ", + "smithy.api#documentation": "

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

\n \n

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

\n ", "smithy.api#http": { "method": "GET", "uri": "/resources/{ResourceArn}/recovery-points", @@ -9128,7 +9146,7 @@ "ReportPlans": { "target": "com.amazonaws.backup#ReportPlanList", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "NextToken": { @@ -9199,7 +9217,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

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

\n

Acceptable values include

\n ", + "smithy.api#documentation": "

The period for the returned results.

\n ", "smithy.api#httpQuery": "AggregationPeriod" } }, @@ -9234,7 +9252,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

\n " + "smithy.api#documentation": "

The period for the returned results.

\n " } }, "NextToken": { @@ -9421,7 +9439,7 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

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

\n ", + "smithy.api#documentation": "

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

\n ", "smithy.api#httpQuery": "resourceType" } }, @@ -9692,7 +9710,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -9748,7 +9766,7 @@ "Tags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

Information about the tags.

" } } }, @@ -9861,19 +9879,19 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } } }, @@ -9898,7 +9916,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

\n

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

" + "smithy.api#documentation": "

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

" } }, "com.amazonaws.backup#ProtectedResourcesList": { @@ -9945,7 +9963,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9987,7 +10005,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n ", + "smithy.api#documentation": "

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

\n \n

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

\n \n

For more information, see Backup Vault Lock.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}/vault-lock", @@ -10010,7 +10028,7 @@ "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

" } }, "MaxRetentionDays": { @@ -10068,7 +10086,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10083,7 +10101,7 @@ "BackupVaultEvents": { "target": "com.amazonaws.backup#BackupVaultEvents", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

The following events are supported:

\n \n \n

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

\n ", + "smithy.api#documentation": "

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

\n

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

\n

The following events are supported:

\n \n \n

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

\n ", "smithy.api#required": {} } } @@ -10141,7 +10159,7 @@ "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { - "smithy.api#documentation": "

This is the status of your restore validation.

", + "smithy.api#documentation": "

The status of your restore validation.

", "smithy.api#required": {} } }, @@ -10168,13 +10186,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } }, "SourceBackupVaultArn": { @@ -10216,7 +10234,7 @@ "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + "smithy.api#documentation": "

A message explaining the current status of the recovery point.

" } }, "CreationDate": { @@ -10246,7 +10264,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

" } }, "EncryptionKeyArn": { @@ -10271,13 +10289,13 @@ "ParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } }, "IsParent": { @@ -10290,13 +10308,13 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } } }, @@ -10334,7 +10352,7 @@ "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + "smithy.api#documentation": "

A message explaining the current status of the recovery point.

" } }, "EncryptionKeyArn": { @@ -10352,7 +10370,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "IsParent": { @@ -10365,19 +10383,19 @@ "ParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } } }, @@ -10429,25 +10447,25 @@ "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

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

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

" + "smithy.api#documentation": "

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

" } } }, @@ -10535,7 +10553,7 @@ "Formats": { "target": "com.amazonaws.backup#FormatList", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -10742,7 +10760,7 @@ "Accounts": { "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#documentation": "

These are the accounts to be included in the report.

" + "smithy.api#documentation": "

These are the accounts to be included in the report.

\n

Use string value of ROOT to include all organizational units.

" } }, "OrganizationUnits": { @@ -10754,7 +10772,7 @@ "Regions": { "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#documentation": "

These are the Regions to be included in the report.

" + "smithy.api#documentation": "

These are the Regions to be included in the report.

\n

Use the wildcard as the string value to include all Regions.

" } } }, @@ -11088,7 +11106,7 @@ "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "ExpectedCompletionTimeMinutes": { @@ -11124,7 +11142,7 @@ "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The status of validation run on the indicated \n restore job.

" } }, "ValidationStatusMessage": { @@ -11156,7 +11174,7 @@ "RecoveryPointSelection": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

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

\n

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

", "smithy.api#required": {} } }, @@ -11237,7 +11255,7 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This is the restore testing plan name.

", + "smithy.api#documentation": "

The restore testing plan name.

", "smithy.api#required": {} } }, @@ -11298,7 +11316,7 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This is the restore testing plan name.

", + "smithy.api#documentation": "

The restore testing plan name.

", "smithy.api#required": {} } }, @@ -11390,7 +11408,7 @@ "RecoveryPointTypes": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointTypeList", "traits": { - "smithy.api#documentation": "

These are the types of recovery points.

" + "smithy.api#documentation": "

These are the types of recovery points.

\n

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

" } }, "SelectionWindowDays": { @@ -11402,7 +11420,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n

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

\n

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

" } }, "com.amazonaws.backup#RestoreTestingRecoveryPointSelectionAlgorithm": { @@ -11470,7 +11488,7 @@ "ProtectedResourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

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

\n

Supported resource types accepted include:

\n ", + "smithy.api#documentation": "

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

\n

Supported resource types accepted include:

\n ", "smithy.api#required": {} } }, @@ -11483,7 +11501,7 @@ "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -11557,7 +11575,7 @@ "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -11579,7 +11597,7 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -11641,7 +11659,7 @@ "ProtectedResourceConditions": { "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { - "smithy.api#documentation": "

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

\n

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

" + "smithy.api#documentation": "

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

" } }, "RestoreMetadataOverrides": { @@ -11780,7 +11798,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -11819,19 +11837,19 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

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

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

" + "smithy.api#documentation": "

The tags to assign to the resources.

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

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

" } } }, @@ -11923,14 +11941,14 @@ "SourceBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

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

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, @@ -12099,7 +12117,7 @@ "Metadata": { "target": "com.amazonaws.backup#Metadata", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n ", + "smithy.api#documentation": "

A set of metadata key-value pairs.

\n

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

\n

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

\n ", "smithy.api#required": {} } }, @@ -12118,7 +12136,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

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

\n " + "smithy.api#documentation": "

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

\n " } }, "CopySourceTagsToRestoredResource": { @@ -12173,7 +12191,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

", + "smithy.api#documentation": "

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

\n

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

", "smithy.api#http": { "method": "POST", "uri": "/backup-jobs/{BackupJobId}", @@ -12258,7 +12276,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

\n

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

", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", @@ -12273,7 +12291,7 @@ "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

\n

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12331,7 +12349,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

\n

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

", "smithy.api#http": { "method": "POST", "uri": "/untag/{ResourceArn}", @@ -12346,7 +12364,7 @@ "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

\n

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12354,7 +12372,7 @@ "TagKeyList": { "target": "com.amazonaws.backup#TagKeyList", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } } @@ -12386,7 +12404,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/backup/plans/{BackupPlanId}", @@ -12401,7 +12419,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

", + "smithy.api#documentation": "

The ID of the backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12409,7 +12427,7 @@ "BackupPlan": { "target": "com.amazonaws.backup#BackupPlanInput", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } } @@ -12488,7 +12506,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

Updates the specified framework.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/frameworks/{FrameworkName}", @@ -12517,7 +12535,7 @@ "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "IdempotencyToken": { @@ -12629,7 +12647,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the transition lifecycle of a recovery point.

\n

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

\n

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

\n

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

\n

This operation does not support continuous backups.

", + "smithy.api#documentation": "

Sets the transition lifecycle of a recovery point.

\n

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

\n

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

\n

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

\n \n

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

\n \n

This operation does not support continuous backups.

", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", @@ -12644,7 +12662,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12674,7 +12692,7 @@ "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "RecoveryPointArn": { @@ -12686,7 +12704,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

" } }, "CalculatedLifecycle": { @@ -12774,7 +12792,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

Updates the specified report plan.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/report-plans/{ReportPlanName}", @@ -12803,13 +12821,13 @@ "ReportDeliveryChannel": { "target": "com.amazonaws.backup#ReportDeliveryChannel", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

\n

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

\n

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

" } }, "IdempotencyToken": { @@ -12898,7 +12916,7 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The name of the restore testing plan name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12914,7 +12932,7 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

This is the time the resource testing plan was \n created.

", + "smithy.api#documentation": "

The time the resource testing plan was \n created.

", "smithy.api#required": {} } }, @@ -12935,7 +12953,7 @@ "UpdateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The time the update completed for the restore \n testing plan.

", "smithy.api#required": {} } } @@ -12970,7 +12988,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

", + "smithy.api#documentation": "

Updates the specified restore testing selection.

\n

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

\n

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

", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", @@ -13000,7 +13018,7 @@ "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13016,7 +13034,7 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The time the resource testing selection was \n updated successfully.

", "smithy.api#required": {} } }, @@ -13030,21 +13048,21 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

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

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

This is the returned restore testing selection name.

", + "smithy.api#documentation": "

The returned restore testing selection name.

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

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

", + "smithy.api#documentation": "

The time the update completed for the restore \n testing selection.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-logs.json b/codegen/sdk-codegen/aws-models/cloudwatch-logs.json index 27633f61b94..c707644896c 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-logs.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-logs.json @@ -3057,6 +3057,139 @@ } } }, + "com.amazonaws.cloudwatchlogs#Entity": { + "type": "structure", + "members": { + "keyAttributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributes", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "attributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributes", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Reserved for future use.

" + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType": { + "type": "enum", + "members": { + "INVALID_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidEntity" + } + }, + "INVALID_TYPE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidTypeValue" + } + }, + "INVALID_KEY_ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidKeyAttributes" + } + }, + "INVALID_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidAttributes" + } + }, + "ENTITY_SIZE_TOO_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntitySizeTooLarge" + } + }, + "UNSUPPORTED_LOG_GROUP_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedLogGroupType" + } + }, + "MISSING_REQUIRED_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingRequiredFields" + } + } + } + }, "com.amazonaws.cloudwatchlogs#Enumerations": { "type": "map", "key": { @@ -3385,13 +3518,13 @@ "logStreamNames": { "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", "traits": { - "smithy.api#documentation": "

Filters the results to only logs from the log streams in this list.

\n

If you specify a value for both logStreamNamePrefix and logStreamNames, the action\n returns an InvalidParameterException error.

" + "smithy.api#documentation": "

Filters the results to only logs from the log streams in this list.

\n

If you specify a value for both logStreamNames and logStreamNamePrefix, the action\n returns an InvalidParameterException error.

" } }, "logStreamNamePrefix": { "target": "com.amazonaws.cloudwatchlogs#LogStreamName", "traits": { - "smithy.api#documentation": "

Filters the results to include only events from log streams that have names starting with this prefix.

\n

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for\n logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action\n returns an InvalidParameterException error.

" + "smithy.api#documentation": "

Filters the results to include only events from log streams that have names starting with this prefix.

\n

If you specify a value for both logStreamNamePrefix and logStreamNames, the action\n returns an InvalidParameterException error.

" } }, "startTime": { @@ -6744,7 +6877,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tructures that contains information about one pattern token related to \n an anomaly.

\n

For more information about patterns and tokens, see CreateLogAnomalyDetector.\n

" + "smithy.api#documentation": "

A structure that contains information about one pattern token related to \n an anomaly.

\n

For more information about patterns and tokens, see CreateLogAnomalyDetector.\n

" } }, "com.amazonaws.cloudwatchlogs#PatternTokens": { @@ -6837,7 +6970,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an account-level data protection policy or subscription filter policy that applies to all log groups \n or a subset of log groups in the account.

\n

\n Data protection policy\n

\n

A data protection policy can help safeguard sensitive \n data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only\n one account-level data protection policy.

\n \n

Sensitive data is detected and masked when it is ingested into a log group. When you set a \n data protection policy, log events ingested into the log groups before that time are not masked.

\n \n

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups\n and all log groups that are created later in this account. The account-level policy is applied to existing log groups\n with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

\n

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.

\n

To use the PutAccountPolicy operation for a data protection policy, you must be signed on with \n the logs:PutDataProtectionPolicy\n and logs:PutAccountPolicy permissions.

\n

The PutAccountPolicy operation applies to all log groups in the account. You can use \n PutDataProtectionPolicy\n to create a data protection policy that applies to just one log group. \n If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

\n

\n Subscription filter policy\n

\n

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services.\n Account-level subscription filter policies apply to both existing log groups and log groups that are created later in \n this account. Supported destinations are Kinesis Data Streams, Firehose, and \n Lambda. When log events are sent to the receiving service, they are Base64 encoded and \n compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n \n

Each account can have one account-level subscription filter policy. \n If you are updating an existing filter, you must specify the correct name in PolicyName.\n To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda \n function, you must also have the iam:PassRole permission.

" + "smithy.api#documentation": "

Creates an account-level data protection policy or subscription filter policy that applies to all log groups \n or a subset of log groups in the account.

\n

\n Data protection policy\n

\n

A data protection policy can help safeguard sensitive \n data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only\n one account-level data protection policy.

\n \n

Sensitive data is detected and masked when it is ingested into a log group. When you set a \n data protection policy, log events ingested into the log groups before that time are not masked.

\n \n

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups\n and all log groups that are created later in this account. The account-level policy is applied to existing log groups\n with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

\n

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.

\n

To use the PutAccountPolicy operation for a data protection policy, you must be signed on with \n the logs:PutDataProtectionPolicy\n and logs:PutAccountPolicy permissions.

\n

The PutAccountPolicy operation applies to all log groups in the account. You can use \n PutDataProtectionPolicy\n to create a data protection policy that applies to just one log group. \n If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

\n

\n Subscription filter policy\n

\n

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services.\n Account-level subscription filter policies apply to both existing log groups and log groups that are created later in \n this account. Supported destinations are Kinesis Data Streams, Firehose, and \n Lambda. When log events are sent to the receiving service, they are Base64 encoded and \n compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n \n

Each account can have one account-level subscription filter policy per Region. \n If you are updating an existing filter, you must specify the correct name in PolicyName.\n To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda \n function, you must also have the iam:PassRole permission.

" } }, "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest": { @@ -6853,7 +6986,7 @@ "policyDocument": { "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", "traits": { - "smithy.api#documentation": "

Specify the policy, in JSON.

\n

\n Data protection policy\n

\n

A data protection policy must include two JSON blocks:

\n \n

For an example data protection policy, see the Examples section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is different than the \n operation's policyName parameter, and is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.

\n

The JSON specified in policyDocument can be up to 30,720 characters long.

\n

\n Subscription filter policy\n

\n

A subscription filter policy can include the following attributes in a JSON block:

\n ", + "smithy.api#documentation": "

Specify the policy, in JSON.

\n

\n Data protection policy\n

\n

A data protection policy must include two JSON blocks:

\n \n

For an example data protection policy, see the Examples section on this page.

\n \n

The contents of the two DataIdentifer arrays must match exactly.

\n \n

In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is different than the \n operation's policyName parameter, and is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.

\n

The JSON specified in policyDocument can be up to 30,720 characters long.

\n

\n Subscription filter policy\n

\n

A subscription filter policy can include the following attributes in a JSON block:

\n ", "smithy.api#required": {} } }, @@ -7166,7 +7299,7 @@ "logType": { "target": "com.amazonaws.cloudwatchlogs#LogType", "traits": { - "smithy.api#documentation": "

Defines the type of log that the source is sending.

\n ", + "smithy.api#documentation": "

Defines the type of log that the source is sending.

\n ", "smithy.api#required": {} } }, @@ -7379,6 +7512,12 @@ "traits": { "smithy.api#documentation": "

The sequence token obtained from the response of the previous PutLogEvents\n call.

\n \n

The sequenceToken parameter is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are now accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid.

\n " } + }, + "entity": { + "target": "com.amazonaws.cloudwatchlogs#Entity", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } } }, "traits": { @@ -7399,6 +7538,12 @@ "traits": { "smithy.api#documentation": "

The rejected events.

" } + }, + "rejectedEntityInfo": { + "target": "com.amazonaws.cloudwatchlogs#RejectedEntityInfo", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } } }, "traits": { @@ -7431,7 +7576,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a metric filter and associates it with the specified log group. With\n metric filters, you can configure rules to extract metric data from log events ingested\n through PutLogEvents.

\n

The maximum number of metric filters that can be associated with a log group is\n 100.

\n

When you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.

\n \n

Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n

\n

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for\n your specified dimensions within one hour.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " + "smithy.api#documentation": "

Creates or updates a metric filter and associates it with the specified log group. With\n metric filters, you can configure rules to extract metric data from log events ingested\n through PutLogEvents.

\n

The maximum number of metric filters that can be associated with a log group is\n 100.

\n

Using regular expressions to create metric filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in metric filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

\n

When you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.

\n \n

Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n

\n

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for\n your specified dimensions within one hour.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " } }, "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest": { @@ -7681,7 +7826,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n \n

Each log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n

\n

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, \n you must also have the \n iam:PassRole permission.

" + "smithy.api#documentation": "

Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.

\n

The following destinations are supported for subscription filters:

\n \n

Each log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n

\n

Using regular expressions to create subscription filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in subscription filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.

\n

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, \n you must also have the \n iam:PassRole permission.

" } }, "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest": { @@ -7990,6 +8135,21 @@ } } }, + "com.amazonaws.cloudwatchlogs#RejectedEntityInfo": { + "type": "structure", + "members": { + "errorType": { + "target": "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Reserved for future use.

" + } + }, "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo": { "type": "structure", "members": { @@ -8442,7 +8602,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n

\n

The response to this operation is a response stream, over which \n the server sends live log events and the client receives them.

\n

The following objects are sent over the stream:

\n \n \n

You can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.

\n \n

For examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.

", + "smithy.api#documentation": "

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n

\n

The response to this operation is a response stream, over which \n the server sends live log events and the client receives them.

\n

The following objects are sent over the stream:

\n \n \n

You can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.

\n \n

For examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.

", "smithy.api#endpoint": { "hostPrefix": "streaming-" } diff --git a/codegen/sdk-codegen/aws-models/datazone.json b/codegen/sdk-codegen/aws-models/datazone.json index 99f3f6535d4..a576ba63452 100644 --- a/codegen/sdk-codegen/aws-models/datazone.json +++ b/codegen/sdk-codegen/aws-models/datazone.json @@ -390,6 +390,239 @@ "smithy.api#documentation": "

The parameters of the environment action.

" } }, + "com.amazonaws.datazone#AddEntityOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#AddEntityOwnerInput" + }, + "output": { + "target": "com.amazonaws.datazone#AddEntityOwnerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the owner of an entity (a domain unit).

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/addOwner" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#AddEntityOwnerInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain in which you want to add the entity owner.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#DataZoneEntityType", + "traits": { + "smithy.api#documentation": "

The type of an entity.

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

The ID of the entity to which you want to add an owner.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "owner": { + "target": "com.amazonaws.datazone#OwnerProperties", + "traits": { + "smithy.api#documentation": "

The owner that you want to add to the entity.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#AddEntityOwnerOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#AddPolicyGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#AddPolicyGrantInput" + }, + "output": { + "target": "com.amazonaws.datazone#AddPolicyGrantOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a policy grant (an authorization policy) to a specified entity, including domain\n units, environment blueprint configurations, or environment profiles.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/addGrant" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#AddPolicyGrantInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to add a policy grant.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#TargetEntityType", + "traits": { + "smithy.api#documentation": "

The type of entity (resource) to which the grant is added.

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

The ID of the entity (resource) to which you want to add a policy grant.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.datazone#ManagedPolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy that you want to grant.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.datazone#PolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "

The principal to whom the permissions are granted.

", + "smithy.api#required": {} + } + }, + "detail": { + "target": "com.amazonaws.datazone#PolicyGrantDetail", + "traits": { + "smithy.api#documentation": "

The details of the policy grant.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#AddPolicyGrantOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#AddToProjectMemberPoolPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

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

The details of the policy grant.

" + } + }, + "com.amazonaws.datazone#AllDomainUnitsGrantFilter": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The grant filter for all domain units.

" + } + }, + "com.amazonaws.datazone#AllUsersGrantFilter": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The all users grant filter.

" + } + }, "com.amazonaws.datazone#ApplicableAssetTypes": { "type": "list", "member": { @@ -2528,6 +2761,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateAssetTypePolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

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

The details of the policy grant.

" + } + }, "com.amazonaws.datazone#CreateDataProduct": { "type": "operation", "input": { @@ -3304,6 +3551,12 @@ "smithy.api#required": {} } }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the root domain unit.

" + } + }, "name": { "target": "smithy.api#String", "traits": { @@ -3363,13 +3616,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#CreateEnvironment": { + "com.amazonaws.datazone#CreateDomainUnit": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#CreateEnvironmentInput" + "target": "com.amazonaws.datazone#CreateDomainUnitInput" }, "output": { - "target": "com.amazonaws.datazone#CreateEnvironmentOutput" + "target": "com.amazonaws.datazone#CreateDomainUnitOutput" }, "errors": [ { @@ -3382,7 +3635,7 @@ "target": "com.amazonaws.datazone#InternalServerException" }, { - "target": "com.amazonaws.datazone#ResourceNotFoundException" + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" }, { "target": "com.amazonaws.datazone#ThrottlingException" @@ -3392,63 +3645,228 @@ } ], "traits": { - "smithy.api#documentation": "

Create an Amazon DataZone environment.

", + "smithy.api#documentation": "

Creates a domain unit in Amazon DataZone.

", "smithy.api#http": { "code": 201, "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/environments" - } - } - }, - "com.amazonaws.datazone#CreateEnvironmentAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#CreateEnvironmentActionInput" - }, - "output": { - "target": "com.amazonaws.datazone#CreateEnvironmentActionOutput" - }, - "errors": [ - { - "target": "com.amazonaws.datazone#AccessDeniedException" - }, - { - "target": "com.amazonaws.datazone#ConflictException" - }, - { - "target": "com.amazonaws.datazone#InternalServerException" + "uri": "/v2/domains/{domainIdentifier}/domain-units" }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.datazone#ThrottlingException" - }, - { - "target": "com.amazonaws.datazone#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an action for the environment, for example, creates a console link for an\n analytics tool that is available in this environment.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" - } + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] } }, - "com.amazonaws.datazone#CreateEnvironmentActionInput": { + "com.amazonaws.datazone#CreateDomainUnitInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the environment action is created.

", + "smithy.api#documentation": "

The ID of the domain where you want to crate a domain unit.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "environmentIdentifier": { + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", + "traits": { + "smithy.api#documentation": "

The name of the domain unit.

", + "smithy.api#required": {} + } + }, + "parentDomainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the parent domain unit.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "

The description of the domain unit.

" + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateDomainUnitOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the domain unit was created.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", + "traits": { + "smithy.api#documentation": "

The name of the domain unit.

", + "smithy.api#required": {} + } + }, + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the parent domain unit.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "

The description of the domain unit.

" + } + }, + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners", + "traits": { + "smithy.api#documentation": "

The owners of the domain unit.

", + "smithy.api#required": {} + } + }, + "ancestorDomainUnitIds": { + "target": "com.amazonaws.datazone#DomainUnitIds", + "traits": { + "smithy.api#documentation": "

The IDs of the ancestor domain units.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the domain unit was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the domain unit.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateDomainUnitPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

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

The details of the policy grant.

" + } + }, + "com.amazonaws.datazone#CreateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateEnvironmentInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateEnvironmentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an Amazon DataZone environment.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environments" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateEnvironmentActionInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateEnvironmentActionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an action for the environment, for example, creates a console link for an\n analytics tool that is available in this environment.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentActionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the environment action is created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { "smithy.api#documentation": "

The ID of the environment in which the environment action is created.

", @@ -3934,6 +4352,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateEnvironmentProfilePolicyGrantDetail": { + "type": "structure", + "members": { + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

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

The details of the policy grant.

" + } + }, "com.amazonaws.datazone#CreateFormType": { "type": "operation", "input": { @@ -4073,6 +4505,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateFormTypePolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

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

The details of the policy grant.

" + } + }, "com.amazonaws.datazone#CreateGlossary": { "type": "operation", "input": { @@ -4208,6 +4654,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateGlossaryPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

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

The details of the policy grant.

" + } + }, "com.amazonaws.datazone#CreateGlossaryTerm": { "type": "operation", "input": { @@ -4656,6 +5116,12 @@ "traits": { "smithy.api#documentation": "

The glossary terms that can be used in this Amazon DataZone project.

" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit. This parameter is not required and if it is not specified, then\n the project is created at the root domain unit level.

" + } } }, "traits": { @@ -4806,12 +5272,32 @@ "traits": { "smithy.api#documentation": "

The glossary terms that can be used in the project.

" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

" + } } }, "traits": { "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateProjectPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy grant is applied to child domain units.

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

The details of the policy grant.

" + } + }, "com.amazonaws.datazone#CreateSubscriptionGrant": { "type": "operation", "input": { @@ -6734,6 +7220,12 @@ { "target": "com.amazonaws.datazone#AcceptSubscriptionRequest" }, + { + "target": "com.amazonaws.datazone#AddEntityOwner" + }, + { + "target": "com.amazonaws.datazone#AddPolicyGrant" + }, { "target": "com.amazonaws.datazone#AssociateEnvironmentRole" }, @@ -6869,6 +7361,9 @@ { "target": "com.amazonaws.datazone#ListDataSourceRunActivities" }, + { + "target": "com.amazonaws.datazone#ListEntityOwners" + }, { "target": "com.amazonaws.datazone#ListEnvironmentActions" }, @@ -6887,6 +7382,9 @@ { "target": "com.amazonaws.datazone#ListNotifications" }, + { + "target": "com.amazonaws.datazone#ListPolicyGrants" + }, { "target": "com.amazonaws.datazone#ListProjectMemberships" }, @@ -6923,6 +7421,12 @@ { "target": "com.amazonaws.datazone#RejectSubscriptionRequest" }, + { + "target": "com.amazonaws.datazone#RemoveEntityOwner" + }, + { + "target": "com.amazonaws.datazone#RemovePolicyGrant" + }, { "target": "com.amazonaws.datazone#RevokeSubscription" }, @@ -6997,6 +7501,9 @@ { "target": "com.amazonaws.datazone#Domain" }, + { + "target": "com.amazonaws.datazone#DomainUnit" + }, { "target": "com.amazonaws.datazone#EnvironmentBlueprintConfiguration" }, @@ -7440,6 +7947,17 @@ } } }, + "com.amazonaws.datazone#DataZoneEntityType": { + "type": "enum", + "members": { + "DOMAIN_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_UNIT" + } + } + } + }, "com.amazonaws.datazone#DateTime": { "type": "timestamp", "traits": { @@ -8041,18 +8559,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#DeleteEnvironment": { + "com.amazonaws.datazone#DeleteDomainUnit": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#DeleteEnvironmentInput" + "target": "com.amazonaws.datazone#DeleteDomainUnitInput" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.datazone#DeleteDomainUnitOutput" }, "errors": [ { "target": "com.amazonaws.datazone#AccessDeniedException" }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, { "target": "com.amazonaws.datazone#InternalServerException" }, @@ -8067,22 +8588,91 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an environment in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes a domain unit.

", "smithy.api#http": { "code": 204, "method": "DELETE", - "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/domain-units/{identifier}" }, - "smithy.api#idempotent": {} + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] } }, - "com.amazonaws.datazone#DeleteEnvironmentAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#DeleteEnvironmentActionInput" - }, - "output": { - "target": "smithy.api#Unit" + "com.amazonaws.datazone#DeleteDomainUnitInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to delete a domain unit.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteDomainUnitOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an environment in Amazon DataZone.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironmentAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentActionInput" + }, + "output": { + "target": "smithy.api#Unit" }, "errors": [ { @@ -9356,6 +9946,9 @@ "id": { "target": "com.amazonaws.datazone#DomainId" }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, "status": { "target": "com.amazonaws.datazone#DomainStatus" }, @@ -9521,156 +10114,427 @@ "smithy.api#documentation": "

A summary of a Amazon DataZone domain.

" } }, - "com.amazonaws.datazone#EdgeDirection": { - "type": "enum", - "members": { - "UPSTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPSTREAM" - } + "com.amazonaws.datazone#DomainUnit": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#DomainUnitId" + } + }, + "properties": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" }, - "DOWNSTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOWNSTREAM" - } + "parentDomainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName" + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription" + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken" + }, + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "id": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, + "ancestorDomainUnitIds": { + "target": "com.amazonaws.datazone#DomainUnitIds" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy" } + }, + "create": { + "target": "com.amazonaws.datazone#CreateDomainUnit" + }, + "read": { + "target": "com.amazonaws.datazone#GetDomainUnit" + }, + "update": { + "target": "com.amazonaws.datazone#UpdateDomainUnit" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteDomainUnit" + }, + "list": { + "target": "com.amazonaws.datazone#ListDomainUnitsForParent" } }, - "com.amazonaws.datazone#EditedValue": { + "com.amazonaws.datazone#DomainUnitDescription": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 5000 + "max": 2048 }, "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#EnableSetting": { + "com.amazonaws.datazone#DomainUnitDesignation": { "type": "enum", "members": { - "ENABLED": { + "OWNER": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "OWNER" + } + } + } + }, + "com.amazonaws.datazone#DomainUnitFilterForProject": { + "type": "structure", + "members": { + "domainUnit": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The domain unit ID to use in the filter.

", + "smithy.api#required": {} } }, - "DISABLED": { - "target": "smithy.api#Unit", + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#addedDefault": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to include child domain units.

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

The domain unit filter of the project grant filter.

" } }, - "com.amazonaws.datazone#EnabledRegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#RegionName" + "com.amazonaws.datazone#DomainUnitGrantFilter": { + "type": "union", + "members": { + "allDomainUnitsGrantFilter": { + "target": "com.amazonaws.datazone#AllDomainUnitsGrantFilter", + "traits": { + "smithy.api#documentation": "

Specifies a grant filter containing all domain units.

" + } + } }, "traits": { - "smithy.api#length": { - "min": 0 + "smithy.api#documentation": "

The grant filter for the domain unit. In the current release of Amazon DataZone, the only\nsupported filter is the allDomainUnitsGrantFilter.

" + } + }, + "com.amazonaws.datazone#DomainUnitGroupProperties": { + "type": "structure", + "members": { + "groupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit group.

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

The properties of a domain unit group.

" } }, - "com.amazonaws.datazone#EntityId": { + "com.amazonaws.datazone#DomainUnitId": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-z0-9_\\-]+$" } }, - "com.amazonaws.datazone#EntityIdentifier": { + "com.amazonaws.datazone#DomainUnitIds": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DomainUnitId" + } + }, + "com.amazonaws.datazone#DomainUnitName": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#EntityType": { - "type": "enum", + "com.amazonaws.datazone#DomainUnitOwnerProperties": { + "type": "union", "members": { - "ASSET": { - "target": "smithy.api#Unit", + "user": { + "target": "com.amazonaws.datazone#DomainUnitUserProperties", "traits": { - "smithy.api#enumValue": "ASSET" + "smithy.api#documentation": "

Indicates that the domain unit owner is a user.

" } }, - "DATA_PRODUCT": { - "target": "smithy.api#Unit", + "group": { + "target": "com.amazonaws.datazone#DomainUnitGroupProperties", "traits": { - "smithy.api#enumValue": "DATA_PRODUCT" + "smithy.api#documentation": "

Indicates that the domain unit owner is a group.

" } } - } - }, - "com.amazonaws.datazone#EnvironmentActionId": { - "type": "string", + }, "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + "smithy.api#documentation": "

The properties of the domain unit owner.

" } }, - "com.amazonaws.datazone#EnvironmentActionList": { + "com.amazonaws.datazone#DomainUnitOwners": { "type": "list", "member": { - "target": "com.amazonaws.datazone#ConfigurableEnvironmentAction" + "target": "com.amazonaws.datazone#DomainUnitOwnerProperties" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } } }, - "com.amazonaws.datazone#EnvironmentActionSummary": { + "com.amazonaws.datazone#DomainUnitPolicyGrantPrincipal": { "type": "structure", "members": { - "domainId": { - "target": "com.amazonaws.datazone#DomainId", + "domainUnitDesignation": { + "target": "com.amazonaws.datazone#DomainUnitDesignation", "traits": { - "smithy.api#documentation": "

The Amazon DataZone domain ID of the environment action.

", + "smithy.api#documentation": "

Specifes the designation of the domain unit users.

", "smithy.api#required": {} } }, - "environmentId": { - "target": "com.amazonaws.datazone#EnvironmentId", + "domainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "

The environment ID of the environment action.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the domain unit.

" } }, - "id": { - "target": "com.amazonaws.datazone#EnvironmentActionId", + "domainUnitGrantFilter": { + "target": "com.amazonaws.datazone#DomainUnitGrantFilter", "traits": { - "smithy.api#documentation": "

The ID of the environment action.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The grant filter for the domain unit.

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

The domain unit principal to whom the policy is granted.

" + } + }, + "com.amazonaws.datazone#DomainUnitSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DomainUnitSummary" + } + }, + "com.amazonaws.datazone#DomainUnitSummary": { + "type": "structure", + "members": { "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the environment action.

", + "smithy.api#documentation": "

The name of the domain unit summary.

", "smithy.api#required": {} } }, - "parameters": { - "target": "com.amazonaws.datazone#ActionParameters", + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "

The parameters of the environment action.

", + "smithy.api#documentation": "

The ID of the domain unit summary.

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

The summary of the domain unit.

" + } + }, + "com.amazonaws.datazone#DomainUnitUserProperties": { + "type": "structure", + "members": { + "userId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The environment action description.

" + "smithy.api#documentation": "

The ID of teh domain unit user.

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

The details about the specified action configured for an environment. For example, the\n details of the specified console links for an analytics tool that is available in this\n environment.

" + "smithy.api#documentation": "

The properties of the domain unit user.

" } }, - "com.amazonaws.datazone#EnvironmentBlueprintConfiguration": { - "type": "resource", - "identifiers": { - "domainIdentifier": { - "target": "com.amazonaws.datazone#DomainId" + "com.amazonaws.datazone#EdgeDirection": { + "type": "enum", + "members": { + "UPSTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPSTREAM" + } + }, + "DOWNSTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWNSTREAM" + } + } + } + }, + "com.amazonaws.datazone#EditedValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#EnableSetting": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.datazone#EnabledRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RegionName" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.datazone#EntityId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EntityIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EntityOwners": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#OwnerPropertiesOutput" + } + }, + "com.amazonaws.datazone#EntityType": { + "type": "enum", + "members": { + "ASSET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET" + } + }, + "DATA_PRODUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_PRODUCT" + } + } + } + }, + "com.amazonaws.datazone#EnvironmentActionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EnvironmentActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ConfigurableEnvironmentAction" + } + }, + "com.amazonaws.datazone#EnvironmentActionSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The Amazon DataZone domain ID of the environment action.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "

The environment ID of the environment action.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentActionId", + "traits": { + "smithy.api#documentation": "

The ID of the environment action.

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

The name of the environment action.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.datazone#ActionParameters", + "traits": { + "smithy.api#documentation": "

The parameters of the environment action.

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

The environment action description.

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

The details about the specified action configured for an environment. For example, the\n details of the specified console links for an analytics tool that is available in this\n environment.

" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintConfiguration": { + "type": "resource", + "identifiers": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" }, "environmentBlueprintIdentifier": { "target": "com.amazonaws.datazone#EnvironmentBlueprintId" @@ -11884,6 +12748,12 @@ "smithy.api#required": {} } }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the root domain in Amazon Datazone.

" + } + }, "name": { "target": "smithy.api#String", "traits": { @@ -11957,48 +12827,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#GetEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#GetEnvironmentInput" - }, - "output": { - "target": "com.amazonaws.datazone#GetEnvironmentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.datazone#AccessDeniedException" - }, - { - "target": "com.amazonaws.datazone#InternalServerException" - }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.datazone#ThrottlingException" - }, - { - "target": "com.amazonaws.datazone#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an Amazon DataZone environment.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.datazone#GetEnvironmentAction": { + "com.amazonaws.datazone#GetDomainUnit": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#GetEnvironmentActionInput" + "target": "com.amazonaws.datazone#GetDomainUnitInput" }, "output": { - "target": "com.amazonaws.datazone#GetEnvironmentActionOutput" + "target": "com.amazonaws.datazone#GetDomainUnitOutput" }, "errors": [ { @@ -12018,38 +12853,33 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the specified environment action.

", + "smithy.api#documentation": "

Gets the details of the specified domain unit.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/domain-units/{identifier}" }, - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] } }, - "com.amazonaws.datazone#GetEnvironmentActionInput": { + "com.amazonaws.datazone#GetDomainUnitInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is\n invoked.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "environmentIdentifier": { - "target": "com.amazonaws.datazone#EnvironmentId", - "traits": { - "smithy.api#documentation": "

The environment ID of the environment action.

", + "smithy.api#documentation": "

The ID of the domain where you want to get a domain unit.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "identifier": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "

The ID of the environment action

", + "smithy.api#documentation": "

The identifier of the domain unit that you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12059,48 +12889,222 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#GetEnvironmentActionOutput": { + "com.amazonaws.datazone#GetDomainUnitOutput": { "type": "structure", "members": { + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

", + "smithy.api#required": {} + } + }, "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the environment action lives.

", + "smithy.api#documentation": "

The ID of the domain in which the domain unit lives.

", "smithy.api#required": {} } }, - "environmentId": { - "target": "com.amazonaws.datazone#EnvironmentId", + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", "traits": { - "smithy.api#documentation": "

The environment ID of the environment action.

", + "smithy.api#documentation": "

The name of the domain unit.

", "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.datazone#EnvironmentActionId", + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "

The ID of the environment action.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the parent domain unit.

" } }, - "name": { - "target": "smithy.api#String", + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", "traits": { - "smithy.api#documentation": "

The name of the environment action.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the domain unit.

" } }, - "parameters": { - "target": "com.amazonaws.datazone#ActionParameters", + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners", "traits": { - "smithy.api#documentation": "

The parameters of the environment action.

", + "smithy.api#documentation": "

The owners of the domain unit.

", "smithy.api#required": {} } }, - "description": { - "target": "smithy.api#String", + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "

The description of the environment action.

" + "smithy.api#documentation": "

The time stamp at which the domain unit was created.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the domain unit was last updated.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the domain unit.

" + } + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user who last updated the domain unit.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an Amazon DataZone environment.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentActionInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentActionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified environment action.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentActionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is\n invoked.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "

The environment ID of the environment action.

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

The ID of the environment action

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentActionOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the environment action lives.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "

The environment ID of the environment action.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentActionId", + "traits": { + "smithy.api#documentation": "

The ID of the environment action.

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

The name of the environment action.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.datazone#ActionParameters", + "traits": { + "smithy.api#documentation": "

The parameters of the environment action.

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

The description of the environment action.

" } } }, @@ -13920,6 +14924,12 @@ "traits": { "smithy.api#documentation": "

The business glossary terms that can be used in the project.

" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

" + } } }, "traits": { @@ -15317,13 +16327,27 @@ "com.amazonaws.datazone#GroupIdentifier": { "type": "string", "traits": { - "smithy.api#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 ]+)" + "smithy.api#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 ]+)" + } + }, + "com.amazonaws.datazone#GroupPolicyGrantPrincipal": { + "type": "union", + "members": { + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "

The ID Of the group of the group principal.

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

The group principal to whom the policy is granted.

" } }, "com.amazonaws.datazone#GroupProfileId": { "type": "string", "traits": { - "smithy.api#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}$" + "smithy.api#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}$" } }, "com.amazonaws.datazone#GroupProfileName": { @@ -16549,30 +17573,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListDomains": { + "com.amazonaws.datazone#ListDomainUnitsForParent": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListDomainsInput" + "target": "com.amazonaws.datazone#ListDomainUnitsForParentInput" }, "output": { - "target": "com.amazonaws.datazone#ListDomainsOutput" + "target": "com.amazonaws.datazone#ListDomainUnitsForParentOutput" }, "errors": [ { "target": "com.amazonaws.datazone#AccessDeniedException" }, - { - "target": "com.amazonaws.datazone#ConflictException" - }, { "target": "com.amazonaws.datazone#InternalServerException" }, - { - "target": "com.amazonaws.datazone#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.datazone#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -16581,11 +17596,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists Amazon DataZone domains.

", + "smithy.api#documentation": "

Lists child domain units for the specified parent domain unit.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains" + "uri": "/v2/domains/{domainIdentifier}/domain-units" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -16593,30 +17608,42 @@ "pageSize": "maxResults", "items": "items" }, - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] } }, - "com.amazonaws.datazone#ListDomainsInput": { + "com.amazonaws.datazone#ListDomainUnitsForParentInput": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.datazone#DomainStatus", + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The status of the data source.

", - "smithy.api#httpQuery": "status" + "smithy.api#documentation": "

The ID of the domain in which you want to list domain units for a parent domain\n unit.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "parentDomainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the parent domain unit.

", + "smithy.api#httpQuery": "parentDomainUnitIdentifier", + "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "

The maximum number of domains to return in a single call to ListDomains.\n When the number of domains to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListDomains to list the next set of\n domains.

", + "smithy.api#documentation": "

The maximum number of domain units to return in a single call to\n ListDomainUnitsForParent. When the number of domain units to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListDomainUnitsForParent to list the next set of domain units.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.

", + "smithy.api#documentation": "

When the number of domain units is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of domain units, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set\n of domain units.

", "smithy.api#httpQuery": "nextToken" } } @@ -16625,20 +17652,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#ListDomainsOutput": { + "com.amazonaws.datazone#ListDomainUnitsForParentOutput": { "type": "structure", "members": { "items": { - "target": "com.amazonaws.datazone#DomainSummaries", + "target": "com.amazonaws.datazone#DomainUnitSummaries", "traits": { - "smithy.api#documentation": "

The results of the ListDomains action.

", + "smithy.api#documentation": "

The results returned by this action.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.

" + "smithy.api#documentation": "

When the number of domain units is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of domain units, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set\n of domain units.

" } } }, @@ -16646,27 +17673,30 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListEnvironmentActionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#EnvironmentActionSummary" - } - }, - "com.amazonaws.datazone#ListEnvironmentActions": { + "com.amazonaws.datazone#ListDomains": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListEnvironmentActionsInput" + "target": "com.amazonaws.datazone#ListDomainsInput" }, "output": { - "target": "com.amazonaws.datazone#ListEnvironmentActionsOutput" + "target": "com.amazonaws.datazone#ListDomainsOutput" }, "errors": [ { "target": "com.amazonaws.datazone#AccessDeniedException" }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, { "target": "com.amazonaws.datazone#InternalServerException" }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.datazone#ThrottlingException" }, @@ -16675,11 +17705,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists existing environment actions.

", + "smithy.api#documentation": "

Lists Amazon DataZone domains.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" + "uri": "/v2/domains" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -16690,37 +17720,239 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListEnvironmentActionsInput": { + "com.amazonaws.datazone#ListDomainsInput": { "type": "structure", "members": { - "domainIdentifier": { - "target": "com.amazonaws.datazone#DomainId", + "status": { + "target": "com.amazonaws.datazone#DomainStatus", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the environment actions are listed.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The status of the data source.

", + "smithy.api#httpQuery": "status" } }, - "environmentIdentifier": { - "target": "com.amazonaws.datazone#EnvironmentId", + "maxResults": { + "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "

The ID of the envrironment whose environment actions are listed.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of domains to return in a single call to ListDomains.\n When the number of domains to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListDomains to list the next set of\n domains.

", + "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of environment actions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment actions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironmentActions\n to list the next set of environment actions.

", + "smithy.api#documentation": "

When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.

", "smithy.api#httpQuery": "nextToken" } - }, - "maxResults": { - "target": "com.amazonaws.datazone#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of environment actions to return in a single call to\n ListEnvironmentActions. When the number of environment actions to be listed\n is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentActions to list the next set of environment actions.

", - "smithy.api#httpQuery": "maxResults" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListDomainsOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#DomainSummaries", + "traits": { + "smithy.api#documentation": "

The results of the ListDomains action.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListEntityOwners": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListEntityOwnersInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListEntityOwnersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the entity (domain units) owners.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/owners" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "owners" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#ListEntityOwnersInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to list entity owners.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#DataZoneEntityType", + "traits": { + "smithy.api#documentation": "

The type of the entity that you want to list.

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

The ID of the entity that you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResultsForListDomains", + "traits": { + "smithy.api#documentation": "

The maximum number of entities to return in a single call to\n ListEntityOwners. When the number of entities to be listed is greater than\n the value of MaxResults, the response contains a NextToken value\n that you can use in a subsequent call to ListEntityOwners to list the next set\n of entities.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of entities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of entities, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEntityOwners to\n list the next set of entities.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListEntityOwnersOutput": { + "type": "structure", + "members": { + "owners": { + "target": "com.amazonaws.datazone#EntityOwners", + "traits": { + "smithy.api#documentation": "

The owners of the entity.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of entities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of entities, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEntityOwners to\n list the next set of entities.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListEnvironmentActionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#EnvironmentActionSummary" + } + }, + "com.amazonaws.datazone#ListEnvironmentActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListEnvironmentActionsInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListEnvironmentActionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists existing environment actions.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListEnvironmentActionsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the environment actions are listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "

The ID of the envrironment whose environment actions are listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of environment actions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment actions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironmentActions\n to list the next set of environment actions.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of environment actions to return in a single call to\n ListEnvironmentActions. When the number of environment actions to be listed\n is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentActions to list the next set of environment actions.

", + "smithy.api#httpQuery": "maxResults" } } }, @@ -17563,7 +18795,123 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of notifications is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of notifications, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListNotifications to\n list the next set of notifications.

" + "smithy.api#documentation": "

When the number of notifications is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of notifications, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListNotifications to\n list the next set of notifications.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListPolicyGrants": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListPolicyGrantsInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListPolicyGrantsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists policy grants.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/grants" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "grantList" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#ListPolicyGrantsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to list policy grants.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#TargetEntityType", + "traits": { + "smithy.api#documentation": "

The type of entity for which you want to list policy grants.

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

The ID of the entity for which you want to list policy grants.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.datazone#ManagedPolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy that you want to list.

", + "smithy.api#httpQuery": "policyType", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResultsForListDomains", + "traits": { + "smithy.api#documentation": "

The maximum number of grants to return in a single call to\n ListPolicyGrants. When the number of grants to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListPolicyGrants to list the next set of\n grants.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of grants, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListPolicyGrants to list the next set of\n grants.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListPolicyGrantsOutput": { + "type": "structure", + "members": { + "grantList": { + "target": "com.amazonaws.datazone#PolicyGrantList", + "traits": { + "smithy.api#documentation": "

The results of this action - the listed grants.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of grants, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListPolicyGrants to list the next set of\n grants.

" } } }, @@ -18738,6 +20086,77 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#ManagedPolicyType": { + "type": "enum", + "members": { + "CREATE_DOMAIN_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_DOMAIN_UNIT" + } + }, + "OVERRIDE_DOMAIN_UNIT_OWNERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE_DOMAIN_UNIT_OWNERS" + } + }, + "ADD_TO_PROJECT_MEMBER_POOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_TO_PROJECT_MEMBER_POOL" + } + }, + "OVERRIDE_PROJECT_OWNERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE_PROJECT_OWNERS" + } + }, + "CREATE_GLOSSARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_GLOSSARY" + } + }, + "CREATE_FORM_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FORM_TYPE" + } + }, + "CREATE_ASSET_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ASSET_TYPE" + } + }, + "CREATE_PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_PROJECT" + } + }, + "CREATE_ENVIRONMENT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ENVIRONMENT_PROFILE" + } + }, + "DELEGATE_CREATE_ENVIRONMENT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELEGATE_CREATE_ENVIRONMENT_PROFILE" + } + }, + "CREATE_ENVIRONMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ENVIRONMENT" + } + } + } + }, "com.amazonaws.datazone#MaxResults": { "type": "integer", "traits": { @@ -19202,110 +20621,380 @@ "type": { "target": "com.amazonaws.datazone#NotificationResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource mentioned in a notification.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The type of the resource mentioned in a notification.

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

The ID of the resource mentioned in a notification.

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

The name of the resource mentioned in a notification.

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

The details of the resource mentioned in a notification.

" + } + }, + "com.amazonaws.datazone#NotificationResourceType": { + "type": "enum", + "members": { + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT" + } + } + } + }, + "com.amazonaws.datazone#NotificationRole": { + "type": "enum", + "members": { + "PROJECT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_OWNER" + } + }, + "PROJECT_CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CONTRIBUTOR" + } + }, + "PROJECT_VIEWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_VIEWER" + } + }, + "DOMAIN_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_OWNER" + } + }, + "PROJECT_SUBSCRIBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_SUBSCRIBER" + } + } + } + }, + "com.amazonaws.datazone#NotificationSubjects": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.datazone#NotificationType": { + "type": "enum", + "members": { + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + } + } + }, + "com.amazonaws.datazone#NotificationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#NotificationOutput" + } + }, + "com.amazonaws.datazone#OverrideDomainUnitOwnersPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy is inherited by child domain units.

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

The grant details of the override domain unit owners policy.

" + } + }, + "com.amazonaws.datazone#OverrideProjectOwnersPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy is inherited by child domain units.

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

The details of the override project owners policy grant.

" + } + }, + "com.amazonaws.datazone#OwnerGroupProperties": { + "type": "structure", + "members": { + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit owners group.

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

The properties of the domain unit owners group.

" + } + }, + "com.amazonaws.datazone#OwnerGroupPropertiesOutput": { + "type": "structure", + "members": { + "groupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit owners group.

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

The properties of the domain unit owners group.

" + } + }, + "com.amazonaws.datazone#OwnerProperties": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#OwnerUserProperties", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a user.

" + } + }, + "group": { + "target": "com.amazonaws.datazone#OwnerGroupProperties", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a group.

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

The properties of a domain unit's owner.

" + } + }, + "com.amazonaws.datazone#OwnerPropertiesOutput": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#OwnerUserPropertiesOutput", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a user.

" + } + }, + "group": { + "target": "com.amazonaws.datazone#OwnerGroupPropertiesOutput", + "traits": { + "smithy.api#documentation": "

Specifies that the domain unit owner is a group.

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

The ID of the domain unit owners group.

" + } + }, + "com.amazonaws.datazone#OwnerUserProperties": { + "type": "structure", + "members": { + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the owner user.

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

The properties of the owner user.

" + } + }, + "com.amazonaws.datazone#OwnerUserPropertiesOutput": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the owner user.

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

The properties of the owner user.

" + } + }, + "com.amazonaws.datazone#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.datazone#PolicyGrantDetail": { + "type": "union", + "members": { + "createDomainUnit": { + "target": "com.amazonaws.datazone#CreateDomainUnitPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "

Specifies that this is a create domain unit policy.

" + } + }, + "overrideDomainUnitOwners": { + "target": "com.amazonaws.datazone#OverrideDomainUnitOwnersPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "

Specifies whether to override domain unit owners.

" + } + }, + "addToProjectMemberPool": { + "target": "com.amazonaws.datazone#AddToProjectMemberPoolPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "

Specifies that the policy grant is to be added to the members of the project.

" } }, - "id": { - "target": "smithy.api#String", + "overrideProjectOwners": { + "target": "com.amazonaws.datazone#OverrideProjectOwnersPolicyGrantDetail", "traits": { - "smithy.api#documentation": "

The ID of the resource mentioned in a notification.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether to override project owners.

" } }, - "name": { - "target": "smithy.api#String", + "createGlossary": { + "target": "com.amazonaws.datazone#CreateGlossaryPolicyGrantDetail", "traits": { - "smithy.api#documentation": "

The name of the resource mentioned in a notification.

" + "smithy.api#documentation": "

Specifies that this is a create glossary policy.

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

The details of the resource mentioned in a notification.

" - } - }, - "com.amazonaws.datazone#NotificationResourceType": { - "type": "enum", - "members": { - "PROJECT": { - "target": "smithy.api#Unit", + }, + "createFormType": { + "target": "com.amazonaws.datazone#CreateFormTypePolicyGrantDetail", "traits": { - "smithy.api#enumValue": "PROJECT" + "smithy.api#documentation": "

Specifies that this is a create form type policy.

" } - } - } - }, - "com.amazonaws.datazone#NotificationRole": { - "type": "enum", - "members": { - "PROJECT_OWNER": { - "target": "smithy.api#Unit", + }, + "createAssetType": { + "target": "com.amazonaws.datazone#CreateAssetTypePolicyGrantDetail", "traits": { - "smithy.api#enumValue": "PROJECT_OWNER" + "smithy.api#documentation": "

Specifies that this is a create asset type policy.

" } }, - "PROJECT_CONTRIBUTOR": { - "target": "smithy.api#Unit", + "createProject": { + "target": "com.amazonaws.datazone#CreateProjectPolicyGrantDetail", "traits": { - "smithy.api#enumValue": "PROJECT_CONTRIBUTOR" + "smithy.api#documentation": "

Specifies that this is a create project policy.

" } }, - "PROJECT_VIEWER": { - "target": "smithy.api#Unit", + "createEnvironmentProfile": { + "target": "com.amazonaws.datazone#CreateEnvironmentProfilePolicyGrantDetail", "traits": { - "smithy.api#enumValue": "PROJECT_VIEWER" + "smithy.api#documentation": "

Specifies that this is a create environment profile policy.

" } }, - "DOMAIN_OWNER": { - "target": "smithy.api#Unit", + "delegateCreateEnvironmentProfile": { + "target": "com.amazonaws.datazone#Unit", "traits": { - "smithy.api#enumValue": "DOMAIN_OWNER" + "smithy.api#documentation": "

Specifies that this is the delegation of the create environment profile policy.

" } }, - "PROJECT_SUBSCRIBER": { - "target": "smithy.api#Unit", + "createEnvironment": { + "target": "com.amazonaws.datazone#Unit", "traits": { - "smithy.api#enumValue": "PROJECT_SUBSCRIBER" + "smithy.api#documentation": "

Specifies that this is a create environment policy.

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

The details of the policy grant.

" } }, - "com.amazonaws.datazone#NotificationSubjects": { + "com.amazonaws.datazone#PolicyGrantList": { "type": "list", "member": { - "target": "smithy.api#String" + "target": "com.amazonaws.datazone#PolicyGrantMember" } }, - "com.amazonaws.datazone#NotificationType": { - "type": "enum", + "com.amazonaws.datazone#PolicyGrantMember": { + "type": "structure", "members": { - "TASK": { - "target": "smithy.api#Unit", + "principal": { + "target": "com.amazonaws.datazone#PolicyGrantPrincipal", "traits": { - "smithy.api#enumValue": "TASK" + "smithy.api#documentation": "

The principal of the policy grant member.

" } }, - "EVENT": { - "target": "smithy.api#Unit", + "detail": { + "target": "com.amazonaws.datazone#PolicyGrantDetail", "traits": { - "smithy.api#enumValue": "EVENT" + "smithy.api#documentation": "

The details of the policy grant member.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

Specifies the timestamp at which policy grant member was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

Specifies the user who created the policy grant member.

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

A member of the policy grant list.

" } }, - "com.amazonaws.datazone#NotificationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#NotificationOutput" - } - }, - "com.amazonaws.datazone#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 8192 + "com.amazonaws.datazone#PolicyGrantPrincipal": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#UserPolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "

The user of the policy grant principal.

" + } + }, + "group": { + "target": "com.amazonaws.datazone#GroupPolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "

The group of the policy grant principal.

" + } + }, + "project": { + "target": "com.amazonaws.datazone#ProjectPolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "

The project of the policy grant principal.

" + } + }, + "domainUnit": { + "target": "com.amazonaws.datazone#DomainUnitPolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "

The domain unit of the policy grant principal.

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

The policy grant principal.

" } }, "com.amazonaws.datazone#PostLineageEvent": { @@ -19547,6 +21236,37 @@ "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" } }, + "com.amazonaws.datazone#ProjectDesignation": { + "type": "enum", + "members": { + "OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OWNER" + } + }, + "CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTRIBUTOR" + } + } + } + }, + "com.amazonaws.datazone#ProjectGrantFilter": { + "type": "union", + "members": { + "domainUnitFilter": { + "target": "com.amazonaws.datazone#DomainUnitFilterForProject", + "traits": { + "smithy.api#documentation": "

The domain unit filter of the project grant filter.

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

The project grant filter.

" + } + }, "com.amazonaws.datazone#ProjectId": { "type": "string", "traits": { @@ -19592,6 +21312,33 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#ProjectPolicyGrantPrincipal": { + "type": "structure", + "members": { + "projectDesignation": { + "target": "com.amazonaws.datazone#ProjectDesignation", + "traits": { + "smithy.api#documentation": "

The project designation of the project policy grant principal.

", + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "

The project ID of the project policy grant principal.

" + } + }, + "projectGrantFilter": { + "target": "com.amazonaws.datazone#ProjectGrantFilter", + "traits": { + "smithy.api#documentation": "

The project grant filter of the project policy grant principal.

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

The project policy grant principal.

" + } + }, "com.amazonaws.datazone#ProjectStatus": { "type": "enum", "members": { @@ -19683,6 +21430,12 @@ "smithy.api#documentation": "

The timestamp of when the project was updated.

", "smithy.api#timestampFormat": "date-time" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

" + } } }, "traits": { @@ -20440,62 +22193,248 @@ "smithy.api#required": {} } }, - "reviewerId": { - "target": "smithy.api#String", + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the subscription request reviewer.

" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "

The decision comment of the rejected subscription request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#RelationalFilterConfiguration": { + "type": "structure", + "members": { + "databaseName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The database name specified in the relational filter configuration for the data\n source.

", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#required": {} + } + }, + "schemaName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The schema name specified in the relational filter configuration for the data\n source.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "filterExpressions": { + "target": "com.amazonaws.datazone#FilterExpressions", + "traits": { + "smithy.api#documentation": "

The filter expressions specified in the relational filter configuration for the data\n source.

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

The relational filter configuration for the data source.

" + } + }, + "com.amazonaws.datazone#RelationalFilterConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RelationalFilterConfiguration" + } + }, + "com.amazonaws.datazone#RemoveEntityOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#RemoveEntityOwnerInput" + }, + "output": { + "target": "com.amazonaws.datazone#RemoveEntityOwnerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes an owner from an entity.

", + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/removeOwner" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#RemoveEntityOwnerInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to remove an owner from an entity.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#DataZoneEntityType", + "traits": { + "smithy.api#documentation": "

The type of the entity from which you want to remove an owner.

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

The ID of the entity from which you want to remove an owner.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "owner": { + "target": "com.amazonaws.datazone#OwnerProperties", "traits": { - "smithy.api#documentation": "

The identifier of the subscription request reviewer.

" + "smithy.api#documentation": "

The owner that you want to remove from an entity.

", + "smithy.api#required": {} } }, - "decisionComment": { - "target": "com.amazonaws.datazone#DecisionComment", + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

The decision comment of the rejected subscription request.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} } } }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#RemoveEntityOwnerOutput": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.datazone#RelationalFilterConfiguration": { + "com.amazonaws.datazone#RemovePolicyGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#RemovePolicyGrantInput" + }, + "output": { + "target": "com.amazonaws.datazone#RemovePolicyGrantOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a policy grant.

", + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/removeGrant" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#RemovePolicyGrantInput": { "type": "structure", "members": { - "databaseName": { - "target": "smithy.api#String", + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The database name specified in the relational filter configuration for the data\n source.

", - "smithy.api#length": { - "min": 1, - "max": 128 - }, + "smithy.api#documentation": "

The ID of the domain where you want to remove a policy grant.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "schemaName": { + "entityType": { + "target": "com.amazonaws.datazone#TargetEntityType", + "traits": { + "smithy.api#documentation": "

The type of the entity from which you want to remove a policy grant.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The schema name specified in the relational filter configuration for the data\n source.

", - "smithy.api#length": { - "min": 1, - "max": 128 - } + "smithy.api#documentation": "

The ID of the entity from which you want to remove a policy grant.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "filterExpressions": { - "target": "com.amazonaws.datazone#FilterExpressions", + "policyType": { + "target": "com.amazonaws.datazone#ManagedPolicyType", "traits": { - "smithy.api#documentation": "

The filter expressions specified in the relational filter configuration for the data\n source.

" + "smithy.api#documentation": "

The type of the policy that you want to remove.

", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.datazone#PolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "

The principal from which you want to remove a policy grant.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "

The relational filter configuration for the data source.

" + "smithy.api#input": {} } }, - "com.amazonaws.datazone#RelationalFilterConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#RelationalFilterConfiguration" + "com.amazonaws.datazone#RemovePolicyGrantOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.datazone#RequestReason": { @@ -23285,6 +25224,29 @@ "target": "com.amazonaws.datazone#TagValue" } }, + "com.amazonaws.datazone#TargetEntityType": { + "type": "enum", + "members": { + "DOMAIN_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_UNIT" + } + }, + "ENVIRONMENT_BLUEPRINT_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENVIRONMENT_BLUEPRINT_CONFIGURATION" + } + }, + "ENVIRONMENT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENVIRONMENT_PROFILE" + } + } + } + }, "com.amazonaws.datazone#TaskId": { "type": "string", "traits": { @@ -24022,6 +25984,13 @@ "smithy.api#httpError": 401 } }, + "com.amazonaws.datazone#Unit": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The details of the policy of creating an environment.

" + } + }, "com.amazonaws.datazone#UntagResource": { "type": "operation", "input": { @@ -24614,6 +26583,12 @@ "smithy.api#required": {} } }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the root domain unit.

" + } + }, "description": { "target": "smithy.api#String", "traits": { @@ -24649,6 +26624,155 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#UpdateDomainUnit": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateDomainUnitInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateDomainUnitOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the domain unit.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/domain-units/{identifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Administration" + ] + } + }, + "com.amazonaws.datazone#UpdateDomainUnitInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to update a domain unit.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "

The description of the domain unit that you want to update.

" + } + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", + "traits": { + "smithy.api#documentation": "

The name of the domain unit that you want to update.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateDomainUnitOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit that you want to update.

", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to update the domain unit.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", + "traits": { + "smithy.api#documentation": "

The name of the domain unit that you want to update.

", + "smithy.api#required": {} + } + }, + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners", + "traits": { + "smithy.api#documentation": "

The owners of the domain unit that you want to update.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "

The description of the domain unit that you want to update.

" + } + }, + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the parent domain unit.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The time stamp at which the domain unit that you want to update was created.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the domain unit was last updated.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the domain unit that you want to update.

" + } + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user who last updated the domain unit.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#UpdateEnvironment": { "type": "operation", "input": { @@ -25626,7 +27750,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a project is to be updated.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain where a project is being updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -25730,6 +27854,12 @@ "traits": { "smithy.api#documentation": "

The glossary terms of the project that are to be updated.

" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

" + } } }, "traits": { @@ -26457,7 +28587,27 @@ "com.amazonaws.datazone#UserIdentifier": { "type": "string", "traits": { - "smithy.api#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}:.+$)" + "smithy.api#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}:.+$)" + } + }, + "com.amazonaws.datazone#UserPolicyGrantPrincipal": { + "type": "union", + "members": { + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "

The user ID of the user policy grant principal.

" + } + }, + "allUsersGrantFilter": { + "target": "com.amazonaws.datazone#AllUsersGrantFilter", + "traits": { + "smithy.api#documentation": "

The all users grant filter of the user policy grant principal.

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

The user policy grant principal.

" } }, "com.amazonaws.datazone#UserProfileDetails": { @@ -26483,7 +28633,7 @@ "com.amazonaws.datazone#UserProfileId": { "type": "string", "traits": { - "smithy.api#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}$" + "smithy.api#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}$" } }, "com.amazonaws.datazone#UserProfileName": { diff --git a/codegen/sdk-codegen/aws-models/redshift-data.json b/codegen/sdk-codegen/aws-models/redshift-data.json index 61ee5c0fc89..6468cc35399 100644 --- a/codegen/sdk-codegen/aws-models/redshift-data.json +++ b/codegen/sdk-codegen/aws-models/redshift-data.json @@ -1,6 +1,19 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.redshiftdata#ActiveSessionsExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.redshiftdata#String" + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.redshiftdata#ActiveStatementsExceededException": { "type": "structure", "members": { @@ -23,12 +36,18 @@ "target": "com.amazonaws.redshiftdata#BatchExecuteStatementOutput" }, "errors": [ + { + "target": "com.amazonaws.redshiftdata#ActiveSessionsExceededException" + }, { "target": "com.amazonaws.redshiftdata#ActiveStatementsExceededException" }, { "target": "com.amazonaws.redshiftdata#BatchExecuteStatementException" }, + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, { "target": "com.amazonaws.redshiftdata#ValidationException" } @@ -71,7 +90,7 @@ } }, "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" } @@ -91,8 +110,7 @@ "Database": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

" } }, "WithEvent": { @@ -119,14 +137,29 @@ "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } + }, + "SessionKeepAliveSeconds": { + "target": "com.amazonaws.redshiftdata#SessionAliveSeconds", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "SessionId": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

The session identifier of the query.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#BatchExecuteStatementOutput": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

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. \n This identifier is returned by BatchExecuteStatment.

" } @@ -138,7 +171,7 @@ } }, "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

" } @@ -149,6 +182,12 @@ "smithy.api#documentation": "

The database user name.

" } }, + "DbGroups": { + "target": "com.amazonaws.redshiftdata#DbGroupList", + "traits": { + "smithy.api#documentation": "

A list of colon (:) separated names of database groups.

" + } + }, "Database": { "target": "com.amazonaws.redshiftdata#String", "traits": { @@ -166,7 +205,16 @@ "traits": { "smithy.api#documentation": "

The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

" } + }, + "SessionId": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

The session identifier of the query.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#Blob": { @@ -211,12 +259,15 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. \n This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#CancelStatementResponse": { @@ -228,6 +279,9 @@ "smithy.api#documentation": "

A value that indicates whether the cancel statement succeeded (true).

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#ClientToken": { @@ -239,6 +293,16 @@ } } }, + "com.amazonaws.redshiftdata#ClusterIdentifierString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z]([a-z0-9]|-[a-z0-9])*$" + } + }, "com.amazonaws.redshiftdata#ColumnList": { "type": "list", "member": { @@ -366,6 +430,12 @@ "target": "com.amazonaws.redshiftdata#String" } }, + "com.amazonaws.redshiftdata#DbGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#String" + } + }, "com.amazonaws.redshiftdata#DescribeStatement": { "type": "operation", "input": { @@ -394,19 +464,22 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. \n A suffix indicates the number of the SQL statement.\n For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.\n This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#DescribeStatementResponse": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", "smithy.api#required": {} @@ -524,7 +597,16 @@ "traits": { "smithy.api#documentation": "

The serverless workgroup name or Amazon Resource Name (ARN).

" } + }, + "SessionId": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

The session identifier of the query.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#DescribeTable": { @@ -542,6 +624,9 @@ { "target": "com.amazonaws.redshiftdata#InternalServerException" }, + { + "target": "com.amazonaws.redshiftdata#QueryTimeoutException" + }, { "target": "com.amazonaws.redshiftdata#ValidationException" } @@ -561,7 +646,7 @@ "type": "structure", "members": { "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" } @@ -622,6 +707,9 @@ "smithy.api#documentation": "

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#DescribeTableResponse": { @@ -645,6 +733,9 @@ "smithy.api#documentation": "

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.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#ExecuteStatement": { @@ -656,12 +747,18 @@ "target": "com.amazonaws.redshiftdata#ExecuteStatementOutput" }, "errors": [ + { + "target": "com.amazonaws.redshiftdata#ActiveSessionsExceededException" + }, { "target": "com.amazonaws.redshiftdata#ActiveStatementsExceededException" }, { "target": "com.amazonaws.redshiftdata#ExecuteStatementException" }, + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, { "target": "com.amazonaws.redshiftdata#ValidationException" } @@ -705,7 +802,7 @@ } }, "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" } @@ -725,8 +822,7 @@ "Database": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

" } }, "WithEvent": { @@ -759,14 +855,29 @@ "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } + }, + "SessionKeepAliveSeconds": { + "target": "com.amazonaws.redshiftdata#SessionAliveSeconds", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "SessionId": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

The session identifier of the query.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#ExecuteStatementOutput": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

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.

" } @@ -778,7 +889,7 @@ } }, "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

" } @@ -789,6 +900,12 @@ "smithy.api#documentation": "

The database user name.

" } }, + "DbGroups": { + "target": "com.amazonaws.redshiftdata#DbGroupList", + "traits": { + "smithy.api#documentation": "

A list of colon (:) separated names of database groups.

" + } + }, "Database": { "target": "com.amazonaws.redshiftdata#String", "traits": { @@ -806,7 +923,16 @@ "traits": { "smithy.api#documentation": "

The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

" } + }, + "SessionId": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

The session identifier of the query.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#Field": { @@ -892,7 +1018,7 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

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. \n A suffix indicates then number of the SQL statement.\n For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.\n This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

", "smithy.api#required": {} @@ -904,6 +1030,9 @@ "smithy.api#documentation": "

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.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#GetStatementResultResponse": { @@ -935,6 +1064,9 @@ "smithy.api#documentation": "

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.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#Integer": { @@ -975,6 +1107,9 @@ { "target": "com.amazonaws.redshiftdata#InternalServerException" }, + { + "target": "com.amazonaws.redshiftdata#QueryTimeoutException" + }, { "target": "com.amazonaws.redshiftdata#ValidationException" } @@ -994,7 +1129,7 @@ "type": "structure", "members": { "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" } @@ -1037,6 +1172,9 @@ "smithy.api#documentation": "

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#ListDatabasesResponse": { @@ -1054,6 +1192,9 @@ "smithy.api#documentation": "

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.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#ListSchemas": { @@ -1071,6 +1212,9 @@ { "target": "com.amazonaws.redshiftdata#InternalServerException" }, + { + "target": "com.amazonaws.redshiftdata#QueryTimeoutException" + }, { "target": "com.amazonaws.redshiftdata#ValidationException" } @@ -1090,7 +1234,7 @@ "type": "structure", "members": { "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" } @@ -1145,6 +1289,9 @@ "smithy.api#documentation": "

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#ListSchemasResponse": { @@ -1162,6 +1309,9 @@ "smithy.api#documentation": "

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.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#ListStatements": { @@ -1235,6 +1385,9 @@ "smithy.api#documentation": "

A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. \n If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#ListStatementsResponse": { @@ -1253,6 +1406,9 @@ "smithy.api#documentation": "

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.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshiftdata#ListTables": { @@ -1270,6 +1426,9 @@ { "target": "com.amazonaws.redshiftdata#InternalServerException" }, + { + "target": "com.amazonaws.redshiftdata#QueryTimeoutException" + }, { "target": "com.amazonaws.redshiftdata#ValidationException" } @@ -1289,7 +1448,7 @@ "type": "structure", "members": { "ClusterIdentifier": { - "target": "com.amazonaws.redshiftdata#Location", + "target": "com.amazonaws.redshiftdata#ClusterIdentifierString", "traits": { "smithy.api#documentation": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" } @@ -1350,6 +1509,9 @@ "smithy.api#documentation": "

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.redshiftdata#ListTablesResponse": { @@ -1367,11 +1529,11 @@ "smithy.api#documentation": "

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.

" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.redshiftdata#Location": { - "type": "string" - }, "com.amazonaws.redshiftdata#Long": { "type": "long", "traits": { @@ -1402,6 +1564,19 @@ } } }, + "com.amazonaws.redshiftdata#QueryTimeoutException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.redshiftdata#String" + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Redshift Data API operation failed due to timeout.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.redshiftdata#RedshiftData": { "type": "service", "version": "2019-12-20", @@ -1491,7 +1666,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1534,7 +1708,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1547,7 +1722,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1561,7 +1735,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1584,7 +1757,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1619,7 +1791,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1630,14 +1801,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": [ @@ -1651,14 +1824,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -1667,11 +1838,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1682,14 +1853,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1703,7 +1876,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1723,7 +1895,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1734,14 +1905,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1752,9 +1925,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2112,6 +2287,15 @@ "com.amazonaws.redshiftdata#SecretArn": { "type": "string" }, + "com.amazonaws.redshiftdata#SessionAliveSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 86400 + } + } + }, "com.amazonaws.redshiftdata#SqlList": { "type": "list", "member": { @@ -2167,7 +2351,7 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

", "smithy.api#required": {} @@ -2226,18 +2410,18 @@ "traits": { "smithy.api#documentation": "

A value that indicates whether the statement is a batch query request.

" } + }, + "SessionId": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

The session identifier of the query.

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

The SQL statement to run.

" } }, - "com.amazonaws.redshiftdata#StatementId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d+)?$" - } - }, "com.amazonaws.redshiftdata#StatementList": { "type": "list", "member": { @@ -2334,7 +2518,7 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.redshiftdata#StatementId", + "target": "com.amazonaws.redshiftdata#UUID", "traits": { "smithy.api#documentation": "

The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. \n A suffix indicates the number of the SQL statement.\n For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.

", "smithy.api#required": {} @@ -2447,6 +2631,12 @@ "smithy.api#documentation": "

The properties of a table.

" } }, + "com.amazonaws.redshiftdata#UUID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d+)?$" + } + }, "com.amazonaws.redshiftdata#ValidationException": { "type": "structure", "members": {