diff --git a/codegen/sdk-codegen/aws-models/omics.json b/codegen/sdk-codegen/aws-models/omics.json index 6197c459506..43a9fce846c 100644 --- a/codegen/sdk-codegen/aws-models/omics.json +++ b/codegen/sdk-codegen/aws-models/omics.json @@ -36,6 +36,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to abort multipart read set uploads", "smithy.api#documentation": "

\n Stops a multipart upload.\n

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -820,6 +821,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to batch delete Read Sets in the given Sequence Store", "smithy.api#documentation": "

Deletes one or more read sets.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -1106,6 +1108,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to complete a multipart read set upload", "smithy.api#documentation": "

\n Concludes a multipart upload once you have uploaded all the components.\n

", "smithy.api#endpoint": { "hostPrefix": "storage-" @@ -1559,6 +1562,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a multipart read set upload", "smithy.api#documentation": "

\n Begins a multipart read set upload. \n

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -1755,6 +1759,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Reference Store", "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" @@ -2025,6 +2030,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Sequence Store", "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" @@ -2737,6 +2743,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a Reference in the given Reference Store", "smithy.api#documentation": "

Deletes a genome reference.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -2812,6 +2819,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a Reference Store", "smithy.api#documentation": "

Deletes a genome reference store.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -3005,6 +3013,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete a Sequence Store", "smithy.api#documentation": "

Deletes a sequence store.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -3266,6 +3275,51 @@ } } }, + "com.amazonaws.omics#ETag": { + "type": "structure", + "members": { + "algorithm": { + "target": "com.amazonaws.omics#ETagAlgorithm", + "traits": { + "smithy.api#documentation": "

\n The algorithm used to calculate the read set’s ETag(s).

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

\n The ETag hash calculated on Source1 of the read set.\n

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

\n The ETag hash calculated on Source2 of the read set.\n

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

\n The entity tag (ETag) is a hash of the object representing its semantic content.\n

" + } + }, + "com.amazonaws.omics#ETagAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FASTQ_MD5up", + "name": "FASTQ_MD5UP" + }, + { + "value": "BAM_MD5up", + "name": "BAM_MD5UP" + }, + { + "value": "CRAM_MD5up", + "name": "CRAM_MD5UP" + } + ] + } + }, "com.amazonaws.omics#Encoding": { "type": "string", "traits": { @@ -4340,6 +4394,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get a Read Set in the given Sequence Store", "smithy.api#documentation": "

Gets a file from a read set.

", "smithy.api#endpoint": { "hostPrefix": "storage-" @@ -4380,6 +4435,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set activation job for the given Sequence Store", "smithy.api#documentation": "

Gets information about a read set activation job.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -4579,6 +4635,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set export job for the given Sequence Store", "smithy.api#documentation": "

Gets information about a read set export job.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -4785,6 +4842,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set import job for the given Sequence Store", "smithy.api#documentation": "

Gets information about a read set import job.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -4992,6 +5050,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set in the given Sequence Store", "smithy.api#documentation": "

Gets details about a read set.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -5127,6 +5186,12 @@ "traits": { "smithy.api#documentation": "

\n The creation type of the read set.\n

" } + }, + "etag": { + "target": "com.amazonaws.omics#ETag", + "traits": { + "smithy.api#documentation": "

\n The entity tag (ETag) is a hash of the object meant to represent its semantic content.\n

" + } } }, "traits": { @@ -5225,6 +5290,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get a Reference in the given Reference Store", "smithy.api#documentation": "

Gets a reference file.

", "smithy.api#endpoint": { "hostPrefix": "storage-" @@ -5265,6 +5331,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference import job for the given Reference Store", "smithy.api#documentation": "

Gets information about a reference import job.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -5472,6 +5539,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference in the given Reference Store", "smithy.api#documentation": "

Gets information about a genome reference's metadata.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -5680,6 +5748,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference Store", "smithy.api#documentation": "

Gets information about a reference store.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -6574,6 +6643,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get details about a Sequence Store", "smithy.api#documentation": "

Gets information about a sequence store.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8213,6 +8283,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list multipart read set uploads", "smithy.api#documentation": "

\n Lists all multipart read set uploads and their statuses. \n

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8313,6 +8384,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Set activation jobs for the given Sequence Store", "smithy.api#documentation": "

Retrieves a list of read set activation jobs.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8419,6 +8491,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Set export jobs for the given Sequence Store", "smithy.api#documentation": "

Retrieves a list of read set export jobs.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8525,6 +8598,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Set import jobs for the given Sequence Store", "smithy.api#documentation": "

Retrieves a list of read set import jobs.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8637,6 +8711,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list read set upload parts", "smithy.api#documentation": "

\n This operation will list all parts in a requested multipart upload for a sequence store.\n

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8758,6 +8833,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Read Sets in the given Sequence Store", "smithy.api#documentation": "

Retrieves a list of read sets.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8865,6 +8941,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Reference import jobs for the given Reference Store", "smithy.api#documentation": "

Retrieves a list of reference import jobs.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -8968,6 +9045,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Reference Stores", "smithy.api#documentation": "

Retrieves a list of reference stores.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -9067,6 +9145,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list References in the given Reference Store", "smithy.api#documentation": "

Retrieves a list of references.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -9511,6 +9590,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list Sequence Stores", "smithy.api#documentation": "

Retrieves a list of sequence stores.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -11562,6 +11642,12 @@ "traits": { "smithy.api#documentation": "

\n The creation type of the read set.\n

" } + }, + "etag": { + "target": "com.amazonaws.omics#ETag", + "traits": { + "smithy.api#documentation": "

\n The entity tag (ETag) is a hash of the object representing its semantic content.\n

" + } } }, "traits": { @@ -11639,7 +11725,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "readSet" - } + }, + "smithy.api#documentation": "Represents a resource that stores a single genomic sequence file" } }, "com.amazonaws.omics#ReadSetStatus": { @@ -12073,7 +12160,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "reference" - } + }, + "smithy.api#documentation": "Represents a resource that stores a single genomic reference file" } }, "com.amazonaws.omics#ReferenceStatus": { @@ -12265,7 +12353,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "referenceStore" - } + }, + "smithy.api#documentation": "Represents a resource that stores genomic reference data" } }, "com.amazonaws.omics#ReferenceStreamingBlob": { @@ -13225,7 +13314,8 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "sequenceStore" - } + }, + "smithy.api#documentation": "Represents a resource that stores genomic sequence data" } }, "com.amazonaws.omics#ServiceQuotaExceededException": { @@ -13570,6 +13660,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set activation job from the given Sequence Store", "smithy.api#documentation": "

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read\n sets after 30 days.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -13703,6 +13794,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set export job from the given Sequence Store", "smithy.api#documentation": "

Exports a read set to Amazon S3.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -13836,6 +13928,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set import job into the given Sequence Store", "smithy.api#documentation": "

Starts a read set import job.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -14035,6 +14128,7 @@ } ], "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to start a Reference import job into the given Reference Store", "smithy.api#documentation": "

Starts a reference import job.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" @@ -15682,6 +15776,7 @@ ], "traits": { "aws.auth#unsignedPayload": {}, + "aws.iam#actionPermissionDescription": "Grants permission to upload read set parts", "smithy.api#documentation": "

\n This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten. \n

", "smithy.api#endpoint": { "hostPrefix": "storage-" diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 53241d63217..4c2dc0a8f22 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -2009,14 +2009,14 @@ "ApplyAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

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

The pending maintenance action to apply to this resource.

\n

Valid Values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

", "smithy.api#required": {} } }, "OptInType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid values:

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

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid Values:

\n ", "smithy.api#required": {} } } @@ -2349,13 +2349,13 @@ "Force": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

" + "smithy.api#documentation": "

Specifies whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

" } }, "UseEarliestTimeOnPointInTimeUnavailable": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

" + "smithy.api#documentation": "

Specifies whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

" } } }, @@ -2675,7 +2675,7 @@ "CustomerOverride": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Whether there is an override for the default certificate identifier.

" + "smithy.api#documentation": "

Indicates whether there is an override for the default certificate identifier.

" } }, "CustomerOverrideValidTill": { @@ -2852,7 +2852,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "EngineVersion": { @@ -2896,19 +2896,19 @@ "MaxConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints: Must be between 1 and 100.

" + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints:

\n " } }, "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

" + "smithy.api#documentation": "

A value that controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints:

\n " } }, "ConnectionBorrowTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120

\n

Constraints: between 1 and 3600, or 0 representing unlimited

" + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. This setting only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions. For an unlimited wait time, specify 0.

\n

Default: 120\n

\n

Constraints:

\n " } }, "SessionPinningFilters": { @@ -3156,7 +3156,7 @@ "CopyTags": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

" } }, "Tags": { @@ -3365,7 +3365,7 @@ "CopyTags": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" } }, "PreSignedUrl": { @@ -3389,7 +3389,7 @@ "CopyOptionGroup": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" + "smithy.api#documentation": "

Specifies whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" } } }, @@ -4695,7 +4695,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n \n

Length Constraints:

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

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n \n

Length Constraints:

\n " } }, "DBSecurityGroups": { @@ -5099,7 +5099,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

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

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.

\n

All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n
", "smithy.api#examples": [ { "title": "To create a DB instance read replica", @@ -5140,7 +5140,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: Inherits from the source DB instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

\n

Default: Inherits the value from the source DB instance.

" } }, "AvailabilityZone": { @@ -5152,43 +5152,43 @@ "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Valid Values: 1150-65535\n

\n

Default: Inherits the value from the source DB instance.

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Inherits from the source DB instance

" + "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Inherits the value from the source DB instance.

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

" } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The option group the DB instance is associated with. If omitted, the option group\n associated with the source instance or cluster is used.

\n \n

For SQL Server, you must use the option group associated with the source.

\n
\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The option group to associate the DB instance with. If not specified, RDS uses the option group\n associated with the source DB instance or cluster.

\n \n

For SQL Server, you must use the option group associated with the source.

\n
\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.

\n

Constraints:

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

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of the source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom.

\n

Constraints:

\n " } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "Tags": { @@ -5197,37 +5197,37 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" } }, "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the read replica.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

The storage type to associate with the read replica.

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

Default: io1 if the Iops parameter\n is specified. Otherwise, gp2.

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags aren't copied.

" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collection of Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Default: 0\n

" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "KmsKeyId": { @@ -5239,67 +5239,67 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n
\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n
\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n \n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory\n Service.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory\n Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "DomainFqdn": { @@ -5341,25 +5341,25 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom DB instances.

" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n \n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.

" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "AllocatedStorage": { @@ -5572,7 +5572,7 @@ "TargetRole": { "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.

" + "smithy.api#documentation": "

The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write\n or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.

" } }, "Tags": { @@ -5645,7 +5645,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

" + "smithy.api#documentation": "

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

" } }, "IdleClientTimeout": { @@ -5658,7 +5658,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + "smithy.api#documentation": "

Specifies whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" } }, "Tags": { @@ -6071,7 +6071,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" } }, "EventCategories": { @@ -6089,7 +6089,7 @@ "Enabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" + "smithy.api#documentation": "

Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" } }, "Tags": { @@ -6791,7 +6791,7 @@ "GlobalWriteForwardingRequested": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" + "smithy.api#documentation": "

Indicates whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" } }, "PendingModifiedValues": { @@ -6891,7 +6891,7 @@ "LocalWriteForwardingStatus": { "target": "com.amazonaws.rds#LocalWriteForwardingStatus", "traits": { - "smithy.api#documentation": "

Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.

" + "smithy.api#documentation": "

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.

" } }, "AwsBackupRecoveryPointArn": { @@ -6986,7 +6986,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and \n otherwise false.

" + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "ClusterCreateTime": { @@ -6999,7 +6999,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the source DB cluster is encrypted.

" + "smithy.api#documentation": "

Indicates whether the source DB cluster is encrypted.

" } }, "AllocatedStorage": { @@ -7444,7 +7444,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" + "smithy.api#documentation": "

Indicates whether the cluster member is the primary DB instance for the DB cluster.

" } }, "DBClusterParameterGroupStatus": { @@ -7762,107 +7762,107 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

" + "smithy.api#documentation": "

The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

" } }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the identifier for the DB cluster snapshot.

" + "smithy.api#documentation": "

The identifier for the DB cluster snapshot.

" } }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" } }, "SnapshotCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" + "smithy.api#documentation": "

The time when the snapshot was taken, in Universal Coordinated Time (UTC).

" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the database engine for this DB cluster snapshot.

" + "smithy.api#documentation": "

The name of the database engine for this DB cluster snapshot.

" } }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the engine mode of the database engine for this DB cluster snapshot.

" + "smithy.api#documentation": "

The engine mode of the database engine for this DB cluster snapshot.

" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + "smithy.api#documentation": "

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

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

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

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

The status of this DB cluster snapshot. Valid statuses are the following:

\n " } }, "Port": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" + "smithy.api#documentation": "

The port that the DB cluster was listening on at the time of the snapshot.

" } }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB cluster snapshot.

" + "smithy.api#documentation": "

The VPC ID associated with the DB cluster snapshot.

" } }, "ClusterCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" } }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the master username for this DB cluster snapshot.

" + "smithy.api#documentation": "

The master username for this DB cluster snapshot.

" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the version of the database engine for this DB cluster snapshot.

" + "smithy.api#documentation": "

The version of the database engine for this DB cluster snapshot.

" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the license model information for this DB cluster snapshot.

" + "smithy.api#documentation": "

The license model information for this DB cluster snapshot.

" } }, "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the type of the DB cluster snapshot.

" + "smithy.api#documentation": "

The type of the DB cluster snapshot.

" } }, "PercentProgress": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" + "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB cluster snapshot is encrypted.

" + "smithy.api#documentation": "

Indicates whether the DB cluster snapshot is encrypted.

" } }, "KmsKeyId": { @@ -7874,7 +7874,7 @@ "DBClusterSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" } }, "SourceDBClusterSnapshotArn": { @@ -7887,7 +7887,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "TagList": { @@ -7908,7 +7908,7 @@ "DbClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.

" + "smithy.api#documentation": "

The resource ID of the DB cluster that this DB cluster snapshot was created from.

" } } }, @@ -8114,7 +8114,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" + "smithy.api#documentation": "

Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" } }, "SupportsReadReplica": { @@ -8146,14 +8146,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

" + "smithy.api#documentation": "

Indicates whether you can use Aurora parallel query with a specific DB engine version.

" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

" + "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with a specific DB engine version.

" } }, "MajorEngineVersion": { @@ -8199,7 +8199,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" + "smithy.api#documentation": "

Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" } }, "CustomDBEngineVersionManifest": { @@ -8211,7 +8211,7 @@ "SupportsCertificateRotationWithoutRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.

" + "smithy.api#documentation": "

Indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.

" } }, "SupportedCACertificateIdentifiers": { @@ -8223,7 +8223,7 @@ "SupportsLocalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" } } }, @@ -8815,20 +8815,20 @@ "RestoreWindow": { "target": "com.amazonaws.rds#RestoreWindow", "traits": { - "smithy.api#documentation": "

Earliest and latest time an instance can be restored to.

" + "smithy.api#documentation": "

The earliest and latest time a DB instance can be restored to.

" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + "smithy.api#documentation": "

The allocated storage size for the the automated backup in gibibytes (GiB).

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

Provides a list of status information for an automated backup:

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

A list of status information for an automated backup:

\n " } }, "Port": { @@ -8847,13 +8847,13 @@ "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB instance.

" + "smithy.api#documentation": "

The VPC ID associated with the DB instance.

" } }, "InstanceCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Provides the date and time that the DB instance was created.

" + "smithy.api#documentation": "

The date and time when the DB instance was created.

" } }, "MasterUsername": { @@ -8877,7 +8877,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for the automated backup.

" + "smithy.api#documentation": "

The license model information for the automated backup.

" } }, "Iops": { @@ -8902,13 +8902,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the automated backup is encrypted.

" + "smithy.api#documentation": "

Indicates whether the automated backup is encrypted.

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type associated with the automated backup.

" + "smithy.api#documentation": "

The storage type associated with the automated backup.

" } }, "KmsKeyId": { @@ -8951,13 +8951,13 @@ "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + "smithy.api#documentation": "

The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the automated backup.

" + "smithy.api#documentation": "

The storage throughput for the automated backup.

" } }, "AwsBackupRecoveryPointArn": { @@ -9123,12 +9123,12 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

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

Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

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

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" + "smithy.api#documentation": "

Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" } }, "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { @@ -9204,13 +9204,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" + "smithy.api#documentation": "

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

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

Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

" + "smithy.api#documentation": "

The status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

" } }, "Message": { @@ -9507,7 +9507,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + "smithy.api#documentation": "

Indicates whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" } }, "CreatedDate": { @@ -9611,7 +9611,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" + "smithy.api#documentation": "

Indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" } } }, @@ -9952,7 +9952,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

" + "smithy.api#documentation": "

Indicates whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

" } }, "Status": { @@ -10340,7 +10340,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB snapshot is encrypted.

" + "smithy.api#documentation": "

Indicates whether the DB snapshot is encrypted.

" } }, "KmsKeyId": { @@ -10365,7 +10365,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "ProcessorFeatures": { @@ -11015,7 +11015,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

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

Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

\n
" } }, "FinalDBSnapshotIdentifier": { @@ -11027,7 +11027,7 @@ "DeleteAutomatedBackups": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.

" + "smithy.api#documentation": "

Specifies whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.

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

The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

\n

If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n \n

To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

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

Deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n However, manual DB snapshots of the DB instance aren't deleted.

\n

If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. \n This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n \n

To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. \n After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.

\n \n

For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete \n these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.

\n
", "smithy.api#examples": [ { "title": "To delete a DB instance", @@ -11324,7 +11324,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n
\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n
\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" } }, "FinalDBSnapshotIdentifier": { @@ -11336,7 +11336,7 @@ "DeleteAutomatedBackups": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

" + "smithy.api#documentation": "

Specifies whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

" } } }, @@ -12589,7 +12589,7 @@ "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.

" + "smithy.api#documentation": "

A specific source to return parameters for.

\n

Valid Values:

\n " } }, "Filters": { @@ -12939,14 +12939,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" + "smithy.api#documentation": "

Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + "smithy.api#documentation": "

Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" } }, "DbClusterResourceId": { @@ -13255,7 +13255,7 @@ "target": "com.amazonaws.rds#DBEngineVersionMessage" }, "traits": { - "smithy.api#documentation": "

Returns a list of the available DB engines.

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

Describes the properties of specific versions of DB engines.

", "smithy.api#examples": [ { "title": "To describe the DB engine versions for the MySQL DB engine", @@ -13306,19 +13306,19 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:

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

The database engine to return version details for.

\n

Valid Values:

\n " } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" + "smithy.api#documentation": "

A specific database engine version to return details for.

\n

Example: 5.1.49\n

" } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

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

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n " } }, "Filters": { @@ -13343,25 +13343,25 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

" + "smithy.api#documentation": "

Specifies whether to return only the default version of the specified engine or the engine and major version combination.

" } }, "ListSupportedCharacterSets": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.

" + "smithy.api#documentation": "

Specifies whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.

" } }, "ListSupportedTimezones": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.

" + "smithy.api#documentation": "

Specifies whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.

" } }, "IncludeAll": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

" + "smithy.api#documentation": "

Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.

" } } }, @@ -14754,14 +14754,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" } }, "DbiResourceId": { @@ -15136,7 +15136,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" } }, "Filters": { @@ -15819,7 +15819,7 @@ "Vpc": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" + "smithy.api#documentation": "

Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" } }, "Filters": { @@ -16019,7 +16019,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" + "smithy.api#documentation": "

Specifies whether to show only those reservations that support Multi-AZ.

" } }, "LeaseId": { @@ -16141,7 +16141,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" + "smithy.api#documentation": "

Specifies whether to show only those reservations that support Multi-AZ.

" } }, "Filters": { @@ -16616,7 +16616,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value that if true, indicates there is more data to be downloaded.

" + "smithy.api#documentation": "

A Boolean value that, if true, indicates there is more data to be downloaded.

" } } }, @@ -17081,31 +17081,31 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

The data exported from the snapshot or cluster. Valid values are the following:

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

The data exported from the snapshot or cluster.

\n

Valid Values:

\n " } }, "SnapshotTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The time that the snapshot was created.

" + "smithy.api#documentation": "

The time when the snapshot was created.

" } }, "TaskStartTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The time that the snapshot or cluster export task started.

" + "smithy.api#documentation": "

The time when the snapshot or cluster export task started.

" } }, "TaskEndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The time that the snapshot or cluster export task ended.

" + "smithy.api#documentation": "

The time when the snapshot or cluster export task ended.

" } }, "S3Bucket": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that the snapshot or cluster is exported to.

" + "smithy.api#documentation": "

The Amazon S3 bucket where the snapshot or cluster is exported to.

" } }, "S3Prefix": { @@ -17166,7 +17166,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of a snapshot or cluster export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks action.

" + "smithy.api#documentation": "

Contains the details of a snapshot or cluster export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks operation.

" } }, "com.amazonaws.rds#ExportTaskAlreadyExistsFault": { @@ -17274,7 +17274,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

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

The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -17603,13 +17603,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated.

" + "smithy.api#documentation": "

Indicates whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated.

" } }, "GlobalWriteForwardingStatus": { "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { - "smithy.api#documentation": "

Specifies whether a secondary cluster in the global cluster has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" + "smithy.api#documentation": "

The status of write forwarding for a secondary cluster in the global cluster.

" } }, "SynchronizationStatus": { @@ -17732,13 +17732,13 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + "smithy.api#documentation": "

The status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" } }, "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the IP range.

" + "smithy.api#documentation": "

The IP range.

" } } }, @@ -18701,7 +18701,7 @@ "RemoveCustomerOverride": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

" + "smithy.api#documentation": "

Specifies whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

" } } }, @@ -20677,7 +20677,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" } }, "EventCategories": { @@ -20689,7 +20689,7 @@ "Enabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to activate the subscription.

" + "smithy.api#documentation": "

Specifies whether to activate the subscription.

" } } }, @@ -20874,7 +20874,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

" + "smithy.api#documentation": "

Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

" } } }, @@ -20930,14 +20930,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicate if this option is persistent.

" + "smithy.api#documentation": "

Indicates whether this option is persistent.

" } }, "Permanent": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicate if this option is permanent.

" + "smithy.api#documentation": "

Indicates whether this option is permanent.

" } }, "Port": { @@ -20972,7 +20972,7 @@ } }, "traits": { - "smithy.api#documentation": "

Option details.

" + "smithy.api#documentation": "

The details of an option.

" } }, "com.amazonaws.rds#OptionConfiguration": { @@ -21204,7 +21204,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the option requires a port.

" + "smithy.api#documentation": "

Indicates whether the option requires a port.

" } }, "DefaultPort": { @@ -21274,7 +21274,7 @@ "CopyableCrossAccount": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the option can be copied across Amazon Web Services accounts.

" + "smithy.api#documentation": "

Indicates whether the option can be copied across Amazon Web Services accounts.

" } } }, @@ -21319,14 +21319,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value where true indicates that this option group option can be changed from the default value.

" + "smithy.api#documentation": "

Indicates whether this option group option can be changed from the default value.

" } }, "IsRequired": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

" + "smithy.api#documentation": "

Indicates whether a value must be specified for this option setting of the option group option.

" } }, "MinimumEngineVersionPerAllowedValue": { @@ -21489,14 +21489,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that, when true, indicates the option setting can be modified from the default.

" + "smithy.api#documentation": "

Indicates whether the option setting can be modified from the default.

" } }, "IsCollection": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the option setting is part of a collection.

" + "smithy.api#documentation": "

Indicates whether the option setting is part of a collection.

" } } }, @@ -21535,7 +21535,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

True if the version is the default version of the option, and otherwise false.

" + "smithy.api#documentation": "

Indicates whether the version is the default version of the option.

" } } }, @@ -21640,7 +21640,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Indicates the storage type for a DB instance.

" + "smithy.api#documentation": "

The storage type for a DB instance.

" } }, "SupportsIops": { @@ -21668,7 +21668,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

True if a DB instance supports Performance Insights, otherwise false.

" + "smithy.api#documentation": "

Indicates whether a DB instance supports Performance Insights.

" } }, "MinStorageSize": { @@ -21722,20 +21722,20 @@ "SupportsStorageAutoscaling": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

" + "smithy.api#documentation": "

Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

" } }, "SupportsKerberosAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Whether a DB instance supports Kerberos Authentication.

" + "smithy.api#documentation": "

Indicates whether a DB instance supports Kerberos Authentication.

" } }, "OutpostCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Indicates whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" } }, "SupportedActivityStreamModes": { @@ -21748,14 +21748,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" + "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" } }, "SupportsClusters": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "SupportedNetworkTypes": { @@ -21850,13 +21850,13 @@ "ParameterName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the parameter.

" + "smithy.api#documentation": "

The name of the parameter.

" } }, "ParameterValue": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" + "smithy.api#documentation": "

The value of the parameter.

" } }, "Description": { @@ -21868,7 +21868,7 @@ "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Indicates the source of the parameter value.

" + "smithy.api#documentation": "

The source of the parameter value.

" } }, "ApplyType": { @@ -22067,7 +22067,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

" + "smithy.api#documentation": "

Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

" } }, "EngineVersion": { @@ -22124,7 +22124,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "AutomationMode": { @@ -22616,7 +22616,7 @@ "ForceFailover": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" + "smithy.api#documentation": "

Specifies whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" } } }, @@ -23203,7 +23203,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the reservation applies to Multi-AZ deployments.

" + "smithy.api#documentation": "

Indicates whether the reservation applies to Multi-AZ deployments.

" } }, "State": { @@ -23374,7 +23374,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the offering applies to Multi-AZ deployments.

" + "smithy.api#documentation": "

Indicates whether the offering applies to Multi-AZ deployments.

" } }, "RecurringCharges": { @@ -23482,7 +23482,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.

" + "smithy.api#documentation": "

Specifies whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.

" } }, "Parameters": { @@ -23544,7 +23544,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" + "smithy.api#documentation": "

Specifies whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" } }, "Parameters": { @@ -23825,7 +23825,7 @@ "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the restored DB cluster is encrypted.

" + "smithy.api#documentation": "

Specifies whether the restored DB cluster is encrypted.

" } }, "KmsKeyId": { @@ -23837,13 +23837,13 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" } }, "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid values: mysql\n

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

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid Values: mysql\n

", "smithy.api#required": {} } }, @@ -23889,13 +23889,13 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

" } }, "Domain": { @@ -23916,13 +23916,13 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" } }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

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

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " } }, "MasterUserSecretKmsKeyId": { @@ -23934,7 +23934,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid values: aurora, aurora-iopt1\n

\n

Default: aurora\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid Values: aurora, aurora-iopt1\n

\n

Default: aurora\n

\n

Valid for: Aurora DB clusters only

" } } }, @@ -24164,7 +24164,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "BacktrackWindow": { @@ -24200,25 +24200,25 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" } }, "DBClusterInstanceClass": { @@ -24230,7 +24230,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Iops": { @@ -24242,7 +24242,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "ServerlessV2ScalingConfiguration": { @@ -24251,7 +24251,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" } } }, @@ -24433,7 +24433,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { @@ -24472,7 +24472,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "BacktrackWindow": { @@ -24496,25 +24496,25 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB cluster. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" } }, "ScalingConfiguration": { @@ -24538,13 +24538,13 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" } }, "Iops": { @@ -24559,7 +24559,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" } }, "SourceDbClusterResourceId": { @@ -24739,25 +24739,25 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" } }, "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" + "smithy.api#documentation": "

Specifies whether to automatically apply minor version upgrades to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" + "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid Values: license-included | bring-your-own-license | general-public-license\n

" } }, "DBName": { @@ -24790,7 +24790,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" } }, "TdeCredentialArn": { @@ -24832,7 +24832,7 @@ "DomainAuthSecretArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n \n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" } }, "DomainDnsIps": { @@ -24844,7 +24844,7 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" } }, "DomainIAMRoleName": { @@ -24856,7 +24856,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableCloudwatchLogsExports": { @@ -24874,7 +24874,7 @@ "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" } }, "DBParameterGroupName": { @@ -24886,13 +24886,13 @@ "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "CustomIamInstanceProfile": { @@ -24910,7 +24910,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { @@ -25121,7 +25121,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" } }, "EngineVersion": { @@ -25133,7 +25133,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" + "smithy.api#documentation": "

Specifies whether to automatically apply minor engine upgrades \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" } }, "LicenseModel": { @@ -25157,7 +25157,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" } }, "Tags": { @@ -25169,13 +25169,13 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the new DB instance is encrypted or not.

" + "smithy.api#documentation": "

Specifies whether the new DB instance is encrypted or not.

" } }, "KmsKeyId": { @@ -25187,7 +25187,7 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" } }, "MonitoringInterval": { @@ -25205,7 +25205,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "SourceEngine": { @@ -25245,7 +25245,7 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" } }, "PerformanceInsightsKMSKeyId": { @@ -25275,13 +25275,13 @@ "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

" + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

" } }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the DB instance. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" } }, "MaxAllocatedStorage": { @@ -25293,7 +25293,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { @@ -25305,7 +25305,7 @@ "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

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

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " } }, "MasterUserSecretKmsKeyId": { @@ -25694,7 +25694,7 @@ "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" } }, "DBParameterGroupName": { @@ -25956,7 +25956,7 @@ "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

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

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n
" } }, "SecondsUntilAutoPause": { @@ -26000,7 +26000,7 @@ "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" + "smithy.api#documentation": "

Indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" } }, "SecondsUntilAutoPause": { @@ -26185,7 +26185,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" + "smithy.api#documentation": "

Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" } } }, @@ -26798,7 +26798,7 @@ "ExportOnly": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following:

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

The data to be exported from the snapshot or cluster. \n If this parameter isn't provided, all of the data is exported.

\n

Valid Values:

\n " } } }, @@ -27788,14 +27788,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" + "smithy.api#documentation": "

Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" } }, "IsMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

" + "smithy.api#documentation": "

Indicates whether upgrading to the target version requires upgrading the major version of the database engine.

" } }, "SupportedEngineModes": { @@ -27807,25 +27807,25 @@ "SupportsParallelQuery": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with the target engine version.

" + "smithy.api#documentation": "

Indicates whether you can use Aurora parallel query with the target engine version.

" } }, "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with the target engine version.

" + "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with the target engine version.

" } }, "SupportsBabelfish": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

" + "smithy.api#documentation": "

Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

" } }, "SupportsLocalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" } } }, @@ -27863,7 +27863,7 @@ "IAMAuth": { "target": "com.amazonaws.rds#IAMAuthMode", "traits": { - "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" + "smithy.api#documentation": "

A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" } }, "ClientPasswordAuthType": { @@ -27984,7 +27984,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" + "smithy.api#documentation": "

Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" } }, "ProvisionedStorageThroughput": { diff --git a/codegen/sdk-codegen/aws-models/route-53.json b/codegen/sdk-codegen/aws-models/route-53.json index cb171eb7c42..d5fbce4bb35 100644 --- a/codegen/sdk-codegen/aws-models/route-53.json +++ b/codegen/sdk-codegen/aws-models/route-53.json @@ -2010,7 +2010,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.

\n

\n Deleting Resource Record Sets\n

\n

To delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.

\n

\n Change Batches and Transactional Changes\n

\n

The request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.

\n

For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.

\n \n

If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.

\n
\n

\n Traffic Flow\n

\n

To create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

\n Create, Delete, and Upsert\n

\n

Use ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:

\n \n

\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n

\n

The syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.

\n

For an example for each type of resource record set, see \"Examples.\"

\n

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.

\n

\n Change Propagation to Route 53 DNS Servers\n

\n

When you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.

\n

\n Limits on ChangeResourceRecordSets Requests\n

\n

For information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.

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

Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.

\n

\n Deleting Resource Record Sets\n

\n

To delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.

\n

\n Change Batches and Transactional Changes\n

\n

The request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.

\n

For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.

\n \n

If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.

\n
\n

\n Traffic Flow\n

\n

To create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

\n Create, Delete, and Upsert\n

\n

Use ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:

\n \n

\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n

\n

The syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.

\n

For an example for each type of resource record set, see \"Examples.\"

\n

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.

\n

\n Change Propagation to Route 53 DNS Servers\n

\n

When you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.

\n

\n Limits on ChangeResourceRecordSets Requests\n

\n

For information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.

", "smithy.api#examples": [ { "title": "To create a basic resource record set", @@ -3016,7 +3016,7 @@ "CallerReference": { "target": "com.amazonaws.route53#HealthCheckNonce", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:

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

A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:

\n \n

Route 53 does not store the CallerReference for a deleted health check indefinitely. \n\t\t\tThe CallerReference for a deleted health check will be deleted after a number of days.

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

Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

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

Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

\n \n

After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.

\n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicyinstance", @@ -4951,7 +4951,7 @@ "CountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

" + "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

\n

Route 53 also supports the contry code UA forr Ukraine.

" } }, "SubdivisionCode": { @@ -5355,7 +5355,7 @@ "CountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

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

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

\n

Route 53 also supports the contry code UA forr Ukraine.

", "smithy.api#httpQuery": "countrycode" } }, @@ -6060,7 +6060,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n
\n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

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

Gets information about a specified traffic policy instance.

\n \n

\n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.

\n
\n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n
", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstance/{Id}", @@ -6858,6 +6858,17 @@ "smithy.api#documentation": "

In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.

" } }, + "com.amazonaws.route53#HostedZoneType": { + "type": "enum", + "members": { + "PRIVATE_HOSTED_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrivateHostedZone" + } + } + } + }, "com.amazonaws.route53#HostedZones": { "type": "list", "member": { @@ -7716,7 +7727,7 @@ "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 100\n\t\t\titems. If you set MaxItems to a value greater than 100, Route 53 returns\n\t\t\tonly the first 100 health checks.

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

The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 1000\n\t\t\titems. If you set MaxItems to a value greater than 1000, Route 53 returns\n\t\t\tonly the first 1000 health checks.

", "smithy.api#httpQuery": "maxitems" } } @@ -8029,6 +8040,13 @@ "smithy.api#documentation": "

If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.

", "smithy.api#httpQuery": "delegationsetid" } + }, + "HostedZoneType": { + "target": "com.amazonaws.route53#HostedZoneType", + "traits": { + "smithy.api#documentation": "

\n\t\t\t(Optional) Specifies if the hosted zone is private.\n\t\t

", + "smithy.api#httpQuery": "hostedzonetype" + } } }, "traits": { @@ -11317,7 +11335,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

\n

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

\n
    \n
  1. \n

    Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

    \n
  2. \n
  3. \n

    When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

    \n
  4. \n
  5. \n

    Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

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

After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.

\n
\n

Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

\n

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

\n
    \n
  1. \n

    Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

    \n
  2. \n
  3. \n

    When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

    \n
  4. \n
  5. \n

    Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

    \n
  6. \n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicyinstance/{Id}", diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index 17bc5221df4..ba5b8987ae6 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -4877,6 +4877,297 @@ "smithy.api#documentation": "

Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is\n only supported for HTTP APIs.

" } }, + "com.amazonaws.securityhub#AwsDmsEndpointDetails": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections between the DMS endpoint and the \n replication instance.\n

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the endpoint database.

" + } + }, + "EndpointArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the endpoint.\n

" + } + }, + "EndpointIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The database endpoint identifier.\n

" + } + }, + "EndpointType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of endpoint. Valid values are source and target.\n

" + } + }, + "EngineName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of engine for the endpoint, depending on the EndpointType value.\n

" + } + }, + "ExternalId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A value that can be used for cross-account validation.\n

" + } + }, + "ExtraConnectionAttributes": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Additional attributes associated with the connection.\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n An DMS key identifier that is used to encrypt the connection parameters for the endpoint.\n If you don't specify a value for the KmsKeyId parameter, then DMS uses your default \n encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your \n Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

" + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The port used to access the endpoint.\n

" + } + }, + "ServerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the server where the endpoint database resides.

" + } + }, + "SslMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The SSL mode used to connect to the endpoint. The default is none.

" + } + }, + "Username": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The user name to be used to log in to the endpoint database.\n

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

\n Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data \n store type, and location information about your data store.\n

" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceDetails": { + "type": "structure", + "members": { + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The amount of storage (in gigabytes) that is allocated for the replication instance.\n

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance \n window.\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Availability Zone that the replication instance is created in. The default value is a random, system-chosen \n Availability Zone in the endpoint's Amazon Web Services Region, such as us-east-1d.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The engine version number of the replication instance. If an engine version number is not specified when a \n replication instance is created, the default is the latest engine version available.\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n An KMS key identifier that is used to encrypt the data on the replication instance. If you don't \n specify a value for the KmsKeyId parameter, DMS uses your default encryption key. \n KMS creates the default encryption key for your Amazon Web Services account. Your \n Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Specifies whether the replication instance is deployed across multiple Availability Zones (AZs). You can't set the \n AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The maintenance window times for the replication instance. Upgrades to the replication instance are performed during \n this time.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Specifies the accessibility options for the replication instance. A value of true represents an instance \n with a public IP address. A value of false represents an instance with a private IP address. The default \n value is true.

" + } + }, + "ReplicationInstanceClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The compute and memory capacity of the replication instance as defined for the specified replication instance class.

" + } + }, + "ReplicationInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The replication instance identifier.

" + } + }, + "ReplicationSubnetGroup": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceReplicationSubnetGroupDetails", + "traits": { + "smithy.api#documentation": "

\n The subnet group for the replication instance.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsList", + "traits": { + "smithy.api#documentation": "

\n The virtual private cloud (VPC) security group for the replication instance.

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

\n Provides details about an Database Migration Service (DMS) replication instance. DMS uses a replication instance to connect to \n your source data store, read the source data, and format the data for consumption by the target data store.\n

" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceReplicationSubnetGroupDetails": { + "type": "structure", + "members": { + "ReplicationSubnetGroupIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identifier of the replication subnet group.\n

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

\n Provides details about the replication subnet group.

" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsDetails": { + "type": "structure", + "members": { + "VpcSecurityGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identifier of the VPC security group that’s associated with the replication instance.\n

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

\n Provides details about the virtual private cloud (VPC) security group that’s associated with the replication instance.

" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceVpcSecurityGroupsDetails" + } + }, + "com.amazonaws.securityhub#AwsDmsReplicationTaskDetails": { + "type": "structure", + "members": { + "CdcStartPosition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition or \n CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields \n is included.

" + } + }, + "CdcStartTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime specifies \n when you want a CDC operation to start. Only a value for one of these fields is included.

" + } + }, + "CdcStopPosition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates when you want a CDC operation to stop. The value can be either server time or commit time.

" + } + }, + "MigrationType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The migration type.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identifier of the replication task.

" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A display name for the resource identifier at the end of the EndpointArn response parameter. \n If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for \n the end of EndpointArn.

" + } + }, + "ReplicationInstanceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of a replication instance.\n

" + } + }, + "ReplicationTaskIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The user-defined replication task identifier or name.

" + } + }, + "ReplicationTaskSettings": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The settings for the replication task.

" + } + }, + "SourceEndpointArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN of the source endpoint.

" + } + }, + "TableMappings": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The table mappings for the replication task, in JSON format.

" + } + }, + "TargetEndpointArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN of the target endpoint.

" + } + }, + "TaskData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Supplemental information that the task requires to migrate the data for certain source and target endpoints.

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

\n Provides details about an Database Migration Service (DMS) replication task. A replication task moves a set of data from the \n source endpoint to the target endpoint.

" + } + }, "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition": { "type": "structure", "members": { @@ -10015,6 +10306,12 @@ "traits": { "smithy.api#documentation": "

The data volume definitions for the task.

" } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The status of the task definition.\n

" + } } }, "traits": { @@ -11797,55 +12094,251 @@ "smithy.api#documentation": "

\n A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for \n schemas. They collect and organize schemas so that your schemas are in logical groups. \n

" } }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { + "com.amazonaws.securityhub#AwsEventsEndpointDetails": { "type": "structure", "members": { - "Status": { + "Arn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n Specifies whether CloudTrail is activated as a data source for the detector. \n

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the endpoint.\n

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

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" - } - }, - "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails": { - "type": "structure", - "members": { - "CloudTrail": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails", + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" + "smithy.api#documentation": "

\n A description of the endpoint.\n

" } }, - "DnsLogs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails", + "EndpointId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of DNS logs as a data source for the detector.\n

" + "smithy.api#documentation": "

\n The URL subdomain of the endpoint. For example, if EndpointUrl is \n https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

" } }, - "FlowLogs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesFlowLogsDetails", + "EndpointUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n

" + "smithy.api#documentation": "

\n The URL of the endpoint.

" } }, - "Kubernetes": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails", + "EventBuses": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointEventBusesList", "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes data sources for the detector.\n

" + "smithy.api#documentation": "

\n The event buses being used by the endpoint.

" } }, - "MalwareProtection": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails", + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n An object that contains information on the status of Malware Protection as a data source for the detector.\n

" + "smithy.api#documentation": "

\n The name of the endpoint.

" } }, - "S3Logs": { - "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails", + "ReplicationConfig": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointReplicationConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED, which \n means you must supply a RoleArn. If you don't have a RoleArn or you don't want event \n replication enabled, set the state to DISABLED.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN of the role used by event replication for the endpoint.

" + } + }, + "RoutingConfig": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigDetails", + "traits": { + "smithy.api#documentation": "

\n The routing configuration of the endpoint.

" + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The current state of the endpoint.

" + } + }, + "StateReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The reason the endpoint is in its current state.

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

\n Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s \n availability by making it Regional-fault tolerant.\n

" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointEventBusesDetails": { + "type": "structure", + "members": { + "EventBusArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the event bus that the endpoint is associated with.

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

\n Provides details about the Amazon EventBridge event buses that the endpoint is associated with.

" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointEventBusesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointEventBusesDetails" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointReplicationConfigDetails": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The state of event replication.

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

\n Indicates whether replication is enabled or disabled for the endpoint. If enabled, the endpoint can replicate all \n events to a secondary Amazon Web Services Region.

" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigDetails": { + "type": "structure", + "members": { + "FailoverConfig": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigDetails", + "traits": { + "smithy.api#documentation": "

\n The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

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

\n Provides details about the routing configuration of the endpoint.

" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigDetails": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails", + "traits": { + "smithy.api#documentation": "

\n The main Region of the endpoint.

" + } + }, + "Secondary": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails", + "traits": { + "smithy.api#documentation": "

\n The Region that events are routed to when failover is triggered or event replication is enabled.

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

\n The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the health check used by the endpoint to determine whether failover is triggered.

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

\n Provides details about the primary Amazon Web Services Region of the endpoint.

" + } + }, + "com.amazonaws.securityhub#AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails": { + "type": "structure", + "members": { + "Route": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Defines the secondary Region.

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

\n The Amazon Web Services Region that events are routed to when failover is triggered or event replication is enabled.

" + } + }, + "com.amazonaws.securityhub#AwsEventsEventbusDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the event bus.

" + } + }, + "Policy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The policy that enables the external account to send events to your account.

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

\n Provides details about Amazon EventBridge event bus. An event bus is a router that receives events and delivers \n them to zero or more destinations, or targets. This can be a custom event bus which you can use to receive events \n from your custom applications and services, or it can be a partner event bus which can be matched to a partner event \n source.

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Specifies whether CloudTrail is activated as a data source for the detector. \n

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

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" + } + }, + "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDetails": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesCloudTrailDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of CloudTrail as a data source for the detector. \n

" + } + }, + "DnsLogs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesDnsLogsDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of DNS logs as a data source for the detector.\n

" + } + }, + "FlowLogs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesFlowLogsDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of VPC Flow Logs as a data source for the detector.\n

" + } + }, + "Kubernetes": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesKubernetesDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of Kubernetes data sources for the detector.\n

" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information on the status of Malware Protection as a data source for the detector.\n

" + } + }, + "S3Logs": { + "target": "com.amazonaws.securityhub#AwsGuardDutyDetectorDataSourcesS3LogsDetails", "traits": { "smithy.api#documentation": "

\n An object that contains information on the status of S3 Data event logs as a data source for the detector.\n

" } @@ -12982,178 +13475,398 @@ "PackageType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.\n

" + "smithy.api#documentation": "

The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.\n

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

Details about an Lambda function's configuration.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Environment variable key-value pairs.

" + } + }, + "Error": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", + "traits": { + "smithy.api#documentation": "

An AwsLambdaFunctionEnvironmentError object.

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

A function's environment variable settings.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message.

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

Error messages for environment variables that could not be applied.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the function layer.

" + } + }, + "CodeSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size of the layer archive in bytes.

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

An Lambda layer.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tracing mode.

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

The function's X-Ray tracing configuration.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups IDs.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs.

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

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

The VPC security groups and subnets that are attached to a Lambda function.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The version number.

" + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The layer's compatible runtimes. Maximum number of five items.

\n

Valid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates when the version was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

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

Details about a Lambda layer version.

" + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.securityhub#AwsMountPoint": { + "type": "structure", + "members": { + "SourceVolume": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the volume to mount. Must be a volume name referenced in the name parameter \nof task definition volume.\n

" + } + }, + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path on the container to mount the host volume at.\n

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

Details for a volume mount point that's used in a container definition.\n

" + } + }, + "com.amazonaws.securityhub#AwsMountPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsMountPoint" + } + }, + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationDetails": { + "type": "structure", + "members": { + "Sasl": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details for client authentication using SASL.

" + } + }, + "Unauthenticated": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details for allowing no client authentication.

" + } + }, + "Tls": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationTlsDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details for client authentication using TLS.

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

Details about an Lambda function's configuration.

" + "smithy.api#documentation": "

\n Provides details about different modes of client authentication.

" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslDetails": { "type": "structure", "members": { - "Variables": { - "target": "com.amazonaws.securityhub#FieldMap", + "Iam": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails", "traits": { - "smithy.api#documentation": "

Environment variable key-value pairs.

" + "smithy.api#documentation": "

\n Provides details for SASL client authentication using IAM.

" } }, - "Error": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", + "Scram": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails", "traits": { - "smithy.api#documentation": "

An AwsLambdaFunctionEnvironmentError object.

" + "smithy.api#documentation": "

\n Details for SASL client authentication using SCRAM.

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

A function's environment variable settings.

" + "smithy.api#documentation": "

\n Provides details for client authentication using SASL.

" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The error code.

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

\n Indicates whether SASL/IAM authentication is enabled or not.

" } - }, - "Message": { - "target": "com.amazonaws.securityhub#NonEmptyString", + } + }, + "traits": { + "smithy.api#documentation": "

\n Details for SASL/IAM client authentication.

" + } + }, + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The error message.

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

\n Indicates whether SASL/SCRAM authentication is enabled or not.

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

Error messages for environment variables that could not be applied.

" + "smithy.api#documentation": "

\n Details for SASL/SCRAM client authentication.

" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationTlsDetails": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "CertificateAuthorityArnList": { + "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "

The ARN of the function layer.

" + "smithy.api#documentation": "

\n List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon Web Services Private CA enables creation of \nprivate certificate authority (CA) hierarchies, including root and subordinate CAs, without the investment and maintenance costs \nof operating an on-premises CA.

" } }, - "CodeSize": { - "target": "com.amazonaws.securityhub#Integer", + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the layer archive in bytes.

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

\n Indicates whether TLS authentication is enabled or not.

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

An Lambda layer.

" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" + "smithy.api#documentation": "

\n Provides details for client authentication using TLS.

" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails": { "type": "structure", "members": { - "Mode": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The tracing mode.

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

\n Indicates whether unauthenticated is allowed or not.

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

The function's X-Ray tracing configuration.

" + "smithy.api#documentation": "

\n Provides details for allowing no client authentication.\n

" } }, - "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoDetails": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "EncryptionInfo": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoDetails", "traits": { - "smithy.api#documentation": "

A list of VPC security groups IDs.

" + "smithy.api#documentation": "

\n Includes encryption-related information, such as the KMS key used for encrypting data at rest and \nwhether you want Amazon MSK to encrypt your data in transit.

" } }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "CurrentVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A list of VPC subnet IDs.

" + "smithy.api#documentation": "

\n The current version of the MSK cluster.

" } }, - "VpcId": { + "NumberOfBrokerNodes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of broker nodes in the cluster.

" + } + }, + "ClusterName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the VPC.

" + "smithy.api#documentation": "

\n The name of the cluster.

" + } + }, + "ClientAuthentication": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoClientAuthenticationDetails", + "traits": { + "smithy.api#documentation": "

\n Provides information for different modes of client authentication.

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

The VPC security groups and subnets that are attached to a Lambda function.

" + "smithy.api#documentation": "

\n Provide details about an Amazon MSK cluster.

" } }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoDetails": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The version number.

" - } - }, - "CompatibleRuntimes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "EncryptionInTransit": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails", "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes. Maximum number of five items.

\n

Valid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n

" + "smithy.api#documentation": "

\n The settings for encrypting data in transit.

" } }, - "CreatedDate": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "EncryptionAtRest": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails", "traits": { - "smithy.api#documentation": "

Indicates when the version was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.

" + "smithy.api#documentation": "

\n The data-volume encryption details. You can't update encryption at rest settings for existing clusters.

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

Details about a Lambda layer version.

" + "smithy.api#documentation": "

\n Includes encryption-related information, such as the KMS key used for encrypting data at rest and \nwhether you want MSK to encrypt your data in transit.

" } }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { - "type": "long", + "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails": { + "type": "structure", + "members": { + "DataVolumeKMSKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If you don't specify a \nKMS key, MSK creates one for you and uses it.

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

\n The data-volume encryption details. You can't update encryption at rest settings for existing clusters.

" } }, - "com.amazonaws.securityhub#AwsMountPoint": { + "com.amazonaws.securityhub#AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails": { "type": "structure", "members": { - "SourceVolume": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "InCluster": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The name of the volume to mount. Must be a volume name referenced in the name parameter \nof task definition volume.\n

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

\n When set to true, it indicates that data communication among the broker nodes of the cluster is \n encrypted. When set to false, the communication happens in plain text. The default value is \n true.

" } }, - "ContainerPath": { + "ClientBroker": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The path on the container to mount the host volume at.\n

" + "smithy.api#documentation": "

\n Indicates the encryption setting for data in transit between clients and brokers.

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

Details for a volume mount point that's used in a container definition.\n

" + "smithy.api#documentation": "

\n The settings for encrypting data in transit.

" } }, - "com.amazonaws.securityhub#AwsMountPointList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsMountPoint" + "com.amazonaws.securityhub#AwsMskClusterDetails": { + "type": "structure", + "members": { + "ClusterInfo": { + "target": "com.amazonaws.securityhub#AwsMskClusterClusterInfoDetails", + "traits": { + "smithy.api#documentation": "

\n Provides information about a cluster.

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

\n Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster. \n

" } }, "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { @@ -14039,6 +14752,13 @@ "smithy.api#default": false, "smithy.api#documentation": "

Whether the mapping of IAM accounts to database accounts is enabled.

" } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates if minor version upgrades are automatically applied to the cluster.

" + } } }, "traits": { @@ -16218,6 +16938,124 @@ "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup" } }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneConfigDetails": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Any comments that you include about the hosted zone.\n

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

\n An object that contains an optional comment about your Amazon Route 53 hosted zone.

" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneDetails": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneObjectDetails", + "traits": { + "smithy.api#documentation": "

\n An object that contains information about the specified hosted zone.

" + } + }, + "Vpcs": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcsList", + "traits": { + "smithy.api#documentation": "

\n An object that contains information about the Amazon Virtual Private Clouds (Amazon VPCs) that are associated with \nthe specified hosted zone.

" + } + }, + "NameServers": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneNameServersList", + "traits": { + "smithy.api#documentation": "

\n An object that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

" + } + }, + "QueryLoggingConfig": { + "target": "com.amazonaws.securityhub#AwsRoute53QueryLoggingConfigDetails", + "traits": { + "smithy.api#documentation": "

\n An array that contains one QueryLoggingConfig element for each DNS query logging configuration that is \nassociated with the current Amazon Web Services account.

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

\n Provides details about a specified Amazon Route 53 hosted zone, including the four name servers assigned to \nthe hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent \ndomain name.

" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneNameServersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneObjectDetails": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID that Route 53 assigns to the hosted zone when you create it.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

" + } + }, + "Config": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneConfigDetails", + "traits": { + "smithy.api#documentation": "

\n An object that includes the Comment element.

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

\n An object that contains information about an Amazon Route 53 hosted zone.

" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcDetails": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identifier of an Amazon VPC.\n

" + } + }, + "Region": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services Region that an Amazon VPC was created in.

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

\n For private hosted zones, this is a complex type that contains information about an Amazon VPC.

" + } + }, + "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneVpcDetails" + } + }, + "com.amazonaws.securityhub#AwsRoute53QueryLoggingConfigDetails": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#CloudWatchLogsLogGroupArnConfigDetails", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that Route 53 is publishing logs to.

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

\n Provides details about a specified Amazon Route 53 configuration for DNS query logging.

" + } + }, "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails": { "type": "structure", "members": { @@ -21030,6 +21868,32 @@ "smithy.api#documentation": "

Provides details about the current status of the sensitive data detection.

" } }, + "com.amazonaws.securityhub#CloudWatchLogsLogGroupArnConfigDetails": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN of the CloudWatch Logs log group that Route 53 is publishing logs to.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the hosted zone that CloudWatch Logs is logging queries for.

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID for a DNS query logging configuration.\n

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

\n The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch Logs log group that Amazon Route 53 is \npublishing logs to.

" + } + }, "com.amazonaws.securityhub#CodeVulnerabilitiesFilePath": { "type": "structure", "members": { @@ -28189,6 +29053,48 @@ "traits": { "smithy.api#documentation": "

\n Provides information about an Amazon Athena workgroup. A workgroup helps you separate users, teams, \n applications, or workloads. It also helps you set limits on data processing and track costs.\n

" } + }, + "AwsEventsEventbus": { + "target": "com.amazonaws.securityhub#AwsEventsEventbusDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events \nand delivers them to zero or more destinations, or targets.

" + } + }, + "AwsDmsEndpoint": { + "target": "com.amazonaws.securityhub#AwsDmsEndpointDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data \nstore type, and location information about your data store.

" + } + }, + "AwsEventsEndpoint": { + "target": "com.amazonaws.securityhub#AwsEventsEndpointDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s \navailability by making it Regional-fault tolerant.

" + } + }, + "AwsDmsReplicationTask": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationTaskDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an DMS replication task. A replication task moves a set of data from the source \nendpoint to the target endpoint.

" + } + }, + "AwsDmsReplicationInstance": { + "target": "com.amazonaws.securityhub#AwsDmsReplicationInstanceDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an DMS replication instance. DMS uses a replication instance to connect to your \nsource data store, read the source data, and format the data for consumption by the target data store.

" + } + }, + "AwsRoute53HostedZone": { + "target": "com.amazonaws.securityhub#AwsRoute53HostedZoneDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted \nzone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.

" + } + }, + "AwsMskCluster": { + "target": "com.amazonaws.securityhub#AwsMskClusterDetails", + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/storage-gateway.json b/codegen/sdk-codegen/aws-models/storage-gateway.json index 067147d1b51..dfbfda5e9b3 100644 --- a/codegen/sdk-codegen/aws-models/storage-gateway.json +++ b/codegen/sdk-codegen/aws-models/storage-gateway.json @@ -890,7 +890,7 @@ "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { - "smithy.api#documentation": "

The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.\n

" + "smithy.api#documentation": "

The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.

\n \n

For Tape Gateway and Volume Gateway, the minimum value is 51200.

\n

For S3 File Gateway and FSx File Gateway, the minimum value is\n 104857600.

\n
" } }, "AverageDownloadRateLimitInBitsPerSec": { @@ -3592,7 +3592,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata about a gateway such as its name, network interfaces, configured time\n zone, and the state (whether the gateway is running or not). To specify which gateway to\n describe, use the Amazon Resource Name (ARN) of the gateway in your request.

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

Returns metadata about a gateway such as its name, network interfaces, time zone,\n status, and software version. To specify which gateway to describe, use the Amazon Resource\n Name (ARN) of the gateway in your request.

", "smithy.api#examples": [ { "title": "To describe metadata about the gateway", @@ -3759,6 +3759,12 @@ "traits": { "smithy.api#documentation": "

A unique identifier for the specific instance of the host platform running the gateway.\n This value is only available for certain host environments, and its format depends on the\n host environment type.

" } + }, + "SoftwareVersion": { + "target": "com.amazonaws.storagegateway#SoftwareVersion", + "traits": { + "smithy.api#documentation": "

The version number of the software running on the gateway appliance.

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

Adds a file gateway to an Active Directory domain. This operation is only supported for\n file gateways that support the SMB file protocol.

" + "smithy.api#documentation": "

Adds a file gateway to an Active Directory domain. This operation is only supported for\n file gateways that support the SMB file protocol.

\n \n

Joining a domain creates an Active Directory computer account in the default\n organizational unit, using the gateway's Gateway ID as\n the account name (for example, SGW-1234ADE). If your Active Directory environment\n requires that you pre-stage accounts to facilitate the join domain process, you will\n need to create this account ahead of time.

\n

To create the gateway's computer account in an organizational unit other than the\n default, you must specify the organizational unit when joining the domain.

\n
" } }, "com.amazonaws.storagegateway#JoinDomainInput": { @@ -6298,7 +6304,7 @@ "min": 7, "max": 2048 }, - "smithy.api#pattern": "^(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)$" + "smithy.api#pattern": "^(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)$" } }, "com.amazonaws.storagegateway#LastSoftwareUpdate": { @@ -6372,7 +6378,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of the file shares for a specific S3 File Gateway, or the list of file\n shares that belong to the calling user account. This operation is only supported for S3\n File Gateways.

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

Gets a list of the file shares for a specific S3 File Gateway, or the list of file\n shares that belong to the calling Amazon Web Services account. This operation is only\n supported for S3 File Gateways.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -7386,7 +7392,8 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a gateway's network interface.

" + "smithy.api#documentation": "

Describes a gateway's network interface.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.storagegateway#NetworkInterfaceId": { @@ -7441,7 +7448,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.

\n

Storage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

\n

For more information, see Getting file upload notification in the Storage Gateway User\n Guide.

" + "smithy.api#documentation": "

Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.

\n

Storage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

\n

For more information, see Getting\n file upload notification in the Amazon S3 File Gateway User\n Guide.

" } }, "com.amazonaws.storagegateway#NotifyWhenUploadedInput": { @@ -7700,7 +7707,7 @@ } ], "traits": { - "smithy.api#documentation": "

Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.

\n

You can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.

\n

When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.

\n

Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

\n \n \n \n \n

The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.

\n
\n

For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

" + "smithy.api#documentation": "

Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.

\n

You can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.

\n

When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.

\n

Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

\n \n \n \n \n

The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.

\n
\n

For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

" } }, "com.amazonaws.storagegateway#RefreshCacheInput": { @@ -8076,7 +8083,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\\S+)$" + "smithy.api#pattern": "^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\\S+)$" } }, "com.amazonaws.storagegateway#SMBFileShareInfo": { @@ -8514,6 +8521,9 @@ } } }, + "com.amazonaws.storagegateway#SoftwareVersion": { + "type": "string" + }, "com.amazonaws.storagegateway#Squash": { "type": "string", "traits": { @@ -10198,7 +10208,7 @@ "min": 50, "max": 500 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" + "smithy.api#pattern": "^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" } }, "com.amazonaws.storagegateway#TapeARNs": { @@ -10643,7 +10653,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways\n do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in\n effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This\n operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not\n support bandwidth rate limits.

" + "smithy.api#documentation": "

Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways\n do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in\n effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This\n operation is supported for volume, tape, and S3 file gateways. S3 file gateways support\n bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate\n limits.

" } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleInput": { diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json index ec356301e00..42f55cc09a2 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.json @@ -164,6 +164,35 @@ } } }, + "com.amazonaws.workspaces#ApplicationAssociatedResourceType": { + "type": "enum", + "members": { + "WORKSPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKSPACE" + } + }, + "BUNDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUNDLE" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + } + } + }, + "com.amazonaws.workspaces#ApplicationAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ApplicationAssociatedResourceType" + } + }, "com.amazonaws.workspaces#ApplicationList": { "type": "list", "member": { @@ -176,6 +205,70 @@ } } }, + "com.amazonaws.workspaces#ApplicationNotSupportedException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified application is not supported.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workspaces#ApplicationResourceAssociation": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

" + } + }, + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the associated resource.

" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#ApplicationAssociatedResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the associated resource.

" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association status was last updated.

" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "

The status of the application resource association.

" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "

The reason the association deployment failed.

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

Describes the association between an application and an application resource.

" + } + }, + "com.amazonaws.workspaces#ApplicationResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ApplicationResourceAssociation" + } + }, "com.amazonaws.workspaces#AssociateConnectionAlias": { "type": "operation", "input": { @@ -305,6 +398,200 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#AssociateWorkspaceApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#AssociateWorkspaceApplicationRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#AssociateWorkspaceApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ApplicationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ComputeNotCompatibleException" + }, + { + "target": "com.amazonaws.workspaces#IncompatibleApplicationsException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperatingSystemNotCompatibleException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceInUseException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates the specified application to the specified WorkSpace.

" + } + }, + "com.amazonaws.workspaces#AssociateWorkspaceApplicationRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace.

", + "smithy.api#required": {} + } + }, + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#AssociateWorkspaceApplicationResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociation", + "traits": { + "smithy.api#documentation": "

Information about the association between the specified WorkSpace and the specified application.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#AssociationErrorCode": { + "type": "enum", + "members": { + "INSUFFICIENT_DISKSPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError.InsufficientDiskSpace" + } + }, + "INSUFFICIENT_MEMORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError.InsufficientMemory" + } + }, + "UNSUPPORTED_OPERATING_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError.UnsupportedOperatingSystem" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentError.InternalServerError" + } + }, + "WORKSPACE_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeploymentError.WorkspaceUnreachable" + } + } + } + }, + "com.amazonaws.workspaces#AssociationState": { + "type": "enum", + "members": { + "PENDING_INSTALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_INSTALL" + } + }, + "PENDING_INSTALL_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_INSTALL_DEPLOYMENT" + } + }, + "PENDING_UNINSTALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_UNINSTALL" + } + }, + "PENDING_UNINSTALL_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_UNINSTALL_DEPLOYMENT" + } + }, + "INSTALLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTALLING" + } + }, + "UNINSTALLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNINSTALLING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVED" + } + } + } + }, + "com.amazonaws.workspaces#AssociationStateReason": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.workspaces#AssociationErrorCode", + "traits": { + "smithy.api#documentation": "

The error code of the association deployment failure.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#String2048", + "traits": { + "smithy.api#documentation": "

The error message of the association deployment failure.

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

Indicates the reason that the association deployment failed, including the error code and error message.

" + } + }, "com.amazonaws.workspaces#AssociationStatus": { "type": "enum", "members": { @@ -407,6 +694,23 @@ "com.amazonaws.workspaces#BooleanObject": { "type": "boolean" }, + "com.amazonaws.workspaces#BundleAssociatedResourceType": { + "type": "enum", + "members": { + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, + "com.amazonaws.workspaces#BundleAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#BundleAssociatedResourceType" + } + }, "com.amazonaws.workspaces#BundleId": { "type": "string", "traits": { @@ -434,6 +738,62 @@ "com.amazonaws.workspaces#BundleOwner": { "type": "string" }, + "com.amazonaws.workspaces#BundleResourceAssociation": { + "type": "structure", + "members": { + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the associated resource.

" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#BundleAssociatedResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the associated resources.

" + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "

The identifier of the bundle.

" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association is created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association status was last updated.

" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "

The status of the bundle resource association.

" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "

The reason the association deployment failed.

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

Describes the association between an application and a bundle resource.

" + } + }, + "com.amazonaws.workspaces#BundleResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#BundleResourceAssociation" + } + }, "com.amazonaws.workspaces#BundleType": { "type": "enum", "members": { @@ -696,6 +1056,20 @@ } } }, + "com.amazonaws.workspaces#ComputeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#Compute" + } + }, + "com.amazonaws.workspaces#ComputeNotCompatibleException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The compute type of the WorkSpace is not compatible with the application.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.workspaces#ComputeType": { "type": "structure", "members": { @@ -2324,24 +2698,237 @@ } } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.workspaces#DeleteWorkspaceImageResult": { - "type": "structure", - "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DeleteWorkspaceImageResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DeployWorkspaceApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeployWorkspaceApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeployWorkspaceApplicationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#IncompatibleApplicationsException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceInUseException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deploys associated applications to the specified WorkSpace

" + } + }, + "com.amazonaws.workspaces#DeployWorkspaceApplicationsRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace.

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, \n it allows previously failed deployments to be retried.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DeployWorkspaceApplicationsResult": { + "type": "structure", + "members": { + "Deployment": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationDeployment", + "traits": { + "smithy.api#documentation": "

The list of deployed associations and information about them.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectory": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deregisters the specified directory. This operation is asynchronous and returns before\n the WorkSpace directory is deregistered. If any WorkSpaces are registered to this\n directory, you must remove them before you can deregister the directory.

\n \n

Simple AD and AD Connector are made available to you free of charge to use with\n WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector\n directory for 30 consecutive days, this directory will be automatically deregistered for\n use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing\n terms.

\n

To delete empty directories, see Delete the\n Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector\n directory, you can always create a new one when you want to start using WorkSpaces\n again.

\n
" + } + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory. If any WorkSpaces are registered to this directory, you\n must remove them before you deregister the directory, or you will receive an\n OperationNotSupportedException error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DescribeAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeAccountRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeAccountResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for\n the specified account.

" + } + }, + "com.amazonaws.workspaces#DescribeAccountModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeAccountModificationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeAccountModificationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list that describes modifications to the configuration of Bring Your Own\n License (BYOL) for the specified account.

" + } + }, + "com.amazonaws.workspaces#DescribeAccountModificationsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeAccountModificationsResult": { + "type": "structure", + "members": { + "AccountModifications": { + "target": "com.amazonaws.workspaces#AccountModificationList", + "traits": { + "smithy.api#documentation": "

The list of modifications to the configuration of BYOL.

" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DescribeAccountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeAccountResult": { + "type": "structure", + "members": { + "DedicatedTenancySupport": { + "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", + "traits": { + "smithy.api#documentation": "

The status of BYOL (whether BYOL is enabled or disabled).

" + } + }, + "DedicatedTenancyManagementCidrRange": { + "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "traits": { + "smithy.api#documentation": "

The IP address range, specified as an IPv4 CIDR block, used for the management network\n interface.

\n

The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

" + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectory": { + "com.amazonaws.workspaces#DescribeApplicationAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest" + "target": "com.amazonaws.workspaces#DescribeApplicationAssociationsRequest" }, "output": { - "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult" + "target": "com.amazonaws.workspaces#DescribeApplicationAssociationsResult" }, "errors": [ { @@ -2350,9 +2937,6 @@ { "target": "com.amazonaws.workspaces#InvalidParameterValuesException" }, - { - "target": "com.amazonaws.workspaces#InvalidResourceStateException" - }, { "target": "com.amazonaws.workspaces#OperationNotSupportedException" }, @@ -2361,16 +2945,40 @@ } ], "traits": { - "smithy.api#documentation": "

Deregisters the specified directory. This operation is asynchronous and returns before\n the WorkSpace directory is deregistered. If any WorkSpaces are registered to this\n directory, you must remove them before you can deregister the directory.

\n \n

Simple AD and AD Connector are made available to you free of charge to use with\n WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector\n directory for 30 consecutive days, this directory will be automatically deregistered for\n use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing\n terms.

\n

To delete empty directories, see Delete the\n Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector\n directory, you can always create a new one when you want to start using WorkSpaces\n again.

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

Describes the associations between the application and the specified associated resources.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryRequest": { + "com.amazonaws.workspaces#DescribeApplicationAssociationsRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", "traits": { - "smithy.api#documentation": "

The identifier of the directory. If any WorkSpaces are registered to this directory, you\n must remove them before you deregister the directory, or you will receive an\n OperationNotSupportedException error.

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

The maximum number of associations to return.

" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

" + } + }, + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the specified application.

", + "smithy.api#required": {} + } + }, + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#ApplicationAssociatedResourceTypeList", + "traits": { + "smithy.api#documentation": "

The resource type of the associated resources.

", "smithy.api#required": {} } } @@ -2379,54 +2987,100 @@ "smithy.api#input": {} } }, - "com.amazonaws.workspaces#DeregisterWorkspaceDirectoryResult": { + "com.amazonaws.workspaces#DescribeApplicationAssociationsResult": { "type": "structure", - "members": {}, + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#ApplicationResourceAssociationList", + "traits": { + "smithy.api#documentation": "

List of associations and information about them.

" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

" + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.workspaces#DescribeAccount": { + "com.amazonaws.workspaces#DescribeApplications": { "type": "operation", "input": { - "target": "com.amazonaws.workspaces#DescribeAccountRequest" + "target": "com.amazonaws.workspaces#DescribeApplicationsRequest" }, "output": { - "target": "com.amazonaws.workspaces#DescribeAccountResult" + "target": "com.amazonaws.workspaces#DescribeApplicationsResult" }, "errors": [ { "target": "com.amazonaws.workspaces#AccessDeniedException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for\n the specified account.

" - } - }, - "com.amazonaws.workspaces#DescribeAccountModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.workspaces#DescribeAccountModificationsRequest" - }, - "output": { - "target": "com.amazonaws.workspaces#DescribeAccountModificationsResult" - }, - "errors": [ + }, { - "target": "com.amazonaws.workspaces#AccessDeniedException" + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "

Retrieves a list that describes modifications to the configuration of Bring Your Own\n License (BYOL) for the specified account.

" + "smithy.api#documentation": "

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.workspaces#DescribeAccountModificationsRequest": { + "com.amazonaws.workspaces#DescribeApplicationsRequest": { "type": "structure", "members": { + "ApplicationIds": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of one or more applications.

" + } + }, + "ComputeTypeNames": { + "target": "com.amazonaws.workspaces#ComputeList", + "traits": { + "smithy.api#documentation": "

The compute types supported by the applications.

" + } + }, + "LicenseType": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationLicenseType", + "traits": { + "smithy.api#documentation": "

The license availability for the applications.

" + } + }, + "OperatingSystemNames": { + "target": "com.amazonaws.workspaces#OperatingSystemNameList", + "traits": { + "smithy.api#documentation": "

The operating systems supported by the applications.

" + } + }, + "Owner": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationOwner", + "traits": { + "smithy.api#documentation": "

The owner of the applications.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

The maximum number of applications to return.

" + } + }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { - "smithy.api#documentation": "

If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

" + "smithy.api#documentation": "

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

" } } }, @@ -2434,19 +3088,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.workspaces#DescribeAccountModificationsResult": { + "com.amazonaws.workspaces#DescribeApplicationsResult": { "type": "structure", "members": { - "AccountModifications": { - "target": "com.amazonaws.workspaces#AccountModificationList", + "Applications": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationList", "traits": { - "smithy.api#documentation": "

The list of modifications to the configuration of BYOL.

" + "smithy.api#documentation": "

List of information about the specified applications.

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

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

" } } }, @@ -2454,26 +3108,61 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspaces#DescribeAccountRequest": { - "type": "structure", - "members": {}, + "com.amazonaws.workspaces#DescribeBundleAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeBundleAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeBundleAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

Describes the associations between the applications and the specified bundle.

" } }, - "com.amazonaws.workspaces#DescribeAccountResult": { + "com.amazonaws.workspaces#DescribeBundleAssociationsRequest": { "type": "structure", "members": { - "DedicatedTenancySupport": { - "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", "traits": { - "smithy.api#documentation": "

The status of BYOL (whether BYOL is enabled or disabled).

" + "smithy.api#documentation": "

The identifier of the bundle.

", + "smithy.api#required": {} } }, - "DedicatedTenancyManagementCidrRange": { - "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#BundleAssociatedResourceTypeList", "traits": { - "smithy.api#documentation": "

The IP address range, specified as an IPv4 CIDR block, used for the management network\n interface.

\n

The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

" + "smithy.api#documentation": "

The resource types of the associated resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeBundleAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#BundleResourceAssociationList", + "traits": { + "smithy.api#documentation": "

List of information about the specified associations.

" } } }, @@ -2839,6 +3528,68 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#DescribeImageAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeImageAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeImageAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the associations between the applications and the specified image.

" + } + }, + "com.amazonaws.workspaces#DescribeImageAssociationsRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

The identifier of the image.

", + "smithy.api#required": {} + } + }, + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#ImageAssociatedResourceTypeList", + "traits": { + "smithy.api#documentation": "

The resource types of the associated resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeImageAssociationsResult": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#ImageResourceAssociationList", + "traits": { + "smithy.api#documentation": "

List of information about the specified associations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#DescribeIpGroups": { "type": "operation", "input": { @@ -2877,7 +3628,59 @@ "MaxResults": { "target": "com.amazonaws.workspaces#Limit", "traits": { - "smithy.api#documentation": "

The maximum number of items to return.

" + "smithy.api#documentation": "

The maximum number of items to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeIpGroupsResult": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.workspaces#WorkspacesIpGroupsList", + "traits": { + "smithy.api#documentation": "

Information about the IP access control groups.

" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#DescribeTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeTagsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified tags for the specified WorkSpaces resource.

" + } + }, + "com.amazonaws.workspaces#DescribeTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection\n aliases.

", + "smithy.api#required": {} } } }, @@ -2885,19 +3688,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.workspaces#DescribeIpGroupsResult": { + "com.amazonaws.workspaces#DescribeTagsResult": { "type": "structure", "members": { - "Result": { - "target": "com.amazonaws.workspaces#WorkspacesIpGroupsList", - "traits": { - "smithy.api#documentation": "

Information about the IP access control groups.

" - } - }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", + "TagList": { + "target": "com.amazonaws.workspaces#TagList", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

The tags.

" } } }, @@ -2905,30 +3702,46 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspaces#DescribeTags": { + "com.amazonaws.workspaces#DescribeWorkspaceAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.workspaces#DescribeTagsRequest" + "target": "com.amazonaws.workspaces#DescribeWorkspaceAssociationsRequest" }, "output": { - "target": "com.amazonaws.workspaces#DescribeTagsResult" + "target": "com.amazonaws.workspaces#DescribeWorkspaceAssociationsResult" }, "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, { "target": "com.amazonaws.workspaces#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "

Describes the specified tags for the specified WorkSpaces resource.

" + "smithy.api#documentation": "

Describes the associations betweens applications and the specified WorkSpace.

" } }, - "com.amazonaws.workspaces#DescribeTagsRequest": { + "com.amazonaws.workspaces#DescribeWorkspaceAssociationsRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#NonEmptyString", + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection\n aliases.

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

The identifier of the WorkSpace.

", + "smithy.api#required": {} + } + }, + "AssociatedResourceTypes": { + "target": "com.amazonaws.workspaces#WorkSpaceAssociatedResourceTypeList", + "traits": { + "smithy.api#documentation": "

The resource types of the associated resources.

", "smithy.api#required": {} } } @@ -2937,13 +3750,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.workspaces#DescribeTagsResult": { + "com.amazonaws.workspaces#DescribeWorkspaceAssociationsResult": { "type": "structure", "members": { - "TagList": { - "target": "com.amazonaws.workspaces#TagList", + "Associations": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociationList", "traits": { - "smithy.api#documentation": "

The tags.

" + "smithy.api#documentation": "

List of information about the specified associations.

" } } }, @@ -3577,6 +4390,71 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#DisassociateWorkspaceApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DisassociateWorkspaceApplicationRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DisassociateWorkspaceApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceInUseException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the specified application from a WorkSpace.

" + } + }, + "com.amazonaws.workspaces#DisassociateWorkspaceApplicationRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace.

", + "smithy.api#required": {} + } + }, + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DisassociateWorkspaceApplicationResult": { + "type": "structure", + "members": { + "Association": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociation", + "traits": { + "smithy.api#documentation": "

Information about the targeted association.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#DnsIpAddresses": { "type": "list", "member": { @@ -3606,7 +4484,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides in-depth details about the error. These details include the \n possible causes of the errors and troubleshooting information.

" + "smithy.api#documentation": "

Describes in-depth details about the error. These details include the \n possible causes of the error and troubleshooting information.

" } }, "com.amazonaws.workspaces#ErrorDetailsList": { @@ -3744,6 +4622,23 @@ "smithy.api#documentation": "

Describes a WorkSpace that could not be rebooted. (RebootWorkspaces),\n rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

" } }, + "com.amazonaws.workspaces#ImageAssociatedResourceType": { + "type": "enum", + "members": { + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, + "com.amazonaws.workspaces#ImageAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ImageAssociatedResourceType" + } + }, "com.amazonaws.workspaces#ImagePermission": { "type": "structure", "members": { @@ -3764,6 +4659,62 @@ "target": "com.amazonaws.workspaces#ImagePermission" } }, + "com.amazonaws.workspaces#ImageResourceAssociation": { + "type": "structure", + "members": { + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the associated resource.

" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#ImageAssociatedResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the associated resources.

" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association is created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association status was last updated.

" + } + }, + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

The identifier of the image.

" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "

The status of the image resource association.

" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "

The reason the association deployment failed.

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

Describes the association between an application and an image resource.

" + } + }, + "com.amazonaws.workspaces#ImageResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ImageResourceAssociation" + } + }, "com.amazonaws.workspaces#ImageType": { "type": "enum", "members": { @@ -3996,6 +4947,14 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#IncompatibleApplicationsException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified application is not compatible with the resource.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.workspaces#InvalidParameterValuesException": { "type": "structure", "members": { @@ -4932,63 +5891,148 @@ { "target": "com.amazonaws.workspaces#OperationNotSupportedException" }, - { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the state of the specified WorkSpace.

\n

To maintain a WorkSpace without being interrupted, set the WorkSpace state to\n ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to\n reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not\n stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE\n state.

" - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceStateRequest": { - "type": "structure", - "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the state of the specified WorkSpace.

\n

To maintain a WorkSpace without being interrupted, set the WorkSpace state to\n ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to\n reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not\n stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE\n state.

" + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceStateRequest": { + "type": "structure", + "members": { + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace.

", + "smithy.api#required": {} + } + }, + "WorkspaceState": { + "target": "com.amazonaws.workspaces#TargetWorkspaceState", + "traits": { + "smithy.api#documentation": "

The WorkSpace state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceStateResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.workspaces#OperatingSystem": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.workspaces#OperatingSystemType", + "traits": { + "smithy.api#documentation": "

The operating system.

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

The operating system that the image is running.

" + } + }, + "com.amazonaws.workspaces#OperatingSystemName": { + "type": "enum", + "members": { + "AMAZON_LINUX_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_LINUX_2" + } + }, + "UBUNTU_18_04": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UBUNTU_18_04" + } + }, + "UBUNTU_20_04": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UBUNTU_20_04" + } + }, + "UBUNTU_22_04": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UBUNTU_22_04" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "WINDOWS_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_10" + } + }, + "WINDOWS_11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_11" + } + }, + "WINDOWS_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_7" + } + }, + "WINDOWS_SERVER_2016": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2016" + } + }, + "WINDOWS_SERVER_2019": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The identifier of the WorkSpace.

", - "smithy.api#required": {} + "smithy.api#enumValue": "WINDOWS_SERVER_2019" } }, - "WorkspaceState": { - "target": "com.amazonaws.workspaces#TargetWorkspaceState", + "WINDOWS_SERVER_2022": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The WorkSpace state.

", - "smithy.api#required": {} + "smithy.api#enumValue": "WINDOWS_SERVER_2022" } } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.workspaces#ModifyWorkspaceStateResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} } }, - "com.amazonaws.workspaces#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } + "com.amazonaws.workspaces#OperatingSystemNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#OperatingSystemName" } }, - "com.amazonaws.workspaces#OperatingSystem": { + "com.amazonaws.workspaces#OperatingSystemNotCompatibleException": { "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.workspaces#OperatingSystemType", - "traits": { - "smithy.api#documentation": "

The operating system.

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

The operating system that the image is running.

" + "smithy.api#documentation": "

The operating system of the WorkSpace is not compatible with the application.

", + "smithy.api#error": "client" } }, "com.amazonaws.workspaces#OperatingSystemType": { @@ -5470,6 +6514,24 @@ } } }, + "com.amazonaws.workspaces#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.workspaces#ExceptionMessage" + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the resource that is in use.

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

The specified resource is currently in use.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.workspaces#ResourceLimitExceededException": { "type": "structure", "members": { @@ -5991,6 +7053,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.workspaces#SubnetId": { "type": "string", "traits": { @@ -6559,6 +7630,175 @@ "com.amazonaws.workspaces#VolumeEncryptionKey": { "type": "string" }, + "com.amazonaws.workspaces#WorkSpaceApplication": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the application is created.

" + } + }, + "Description": { + "target": "com.amazonaws.workspaces#String2048", + "traits": { + "smithy.api#documentation": "

The description of the WorkSpace application.

" + } + }, + "LicenseType": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationLicenseType", + "traits": { + "smithy.api#documentation": "

The license availability for the applications.

" + } + }, + "Name": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the WorkSpace application.

" + } + }, + "Owner": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationOwner", + "traits": { + "smithy.api#documentation": "

The owner of the WorkSpace application.

" + } + }, + "State": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationState", + "traits": { + "smithy.api#documentation": "

The status of WorkSpace application.

" + } + }, + "SupportedComputeTypeNames": { + "target": "com.amazonaws.workspaces#ComputeList", + "traits": { + "smithy.api#documentation": "

The supported compute types of the WorkSpace application.

" + } + }, + "SupportedOperatingSystemNames": { + "target": "com.amazonaws.workspaces#OperatingSystemNameList", + "traits": { + "smithy.api#documentation": "

The supported operating systems of the WorkSpace application.

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

Describes the WorkSpace application.

" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationDeployment": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociationList", + "traits": { + "smithy.api#documentation": "

The associations between the applications and the associated resources.

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

Describes the WorkSpace application deployment.

" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^wsa-[0-9a-z]{8,63}$" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkSpaceApplicationId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationLicenseType": { + "type": "enum", + "members": { + "LICENSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSED" + } + }, + "UNLICENSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNLICENSED" + } + } + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkSpaceApplication" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationOwner": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}|AMAZON$" + } + }, + "com.amazonaws.workspaces#WorkSpaceApplicationState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNINSTALL_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNINSTALL_ONLY" + } + } + } + }, + "com.amazonaws.workspaces#WorkSpaceAssociatedResourceType": { + "type": "enum", + "members": { + "APPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLICATION" + } + } + } + }, + "com.amazonaws.workspaces#WorkSpaceAssociatedResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkSpaceAssociatedResourceType" + } + }, "com.amazonaws.workspaces#Workspace": { "type": "structure", "members": { @@ -7185,7 +8425,7 @@ "ErrorDetails": { "target": "com.amazonaws.workspaces#ErrorDetailsList", "traits": { - "smithy.api#documentation": "

The details of the error returned for the image.

" + "smithy.api#documentation": "

Additional details of the error returned for the image, including the \n possible causes of the errors and troubleshooting information.

" } } }, @@ -7532,6 +8772,12 @@ "traits": { "smithy.api#documentation": "

The protocol. For more information, see \n \n Protocols for Amazon WorkSpaces.

\n \n \n " } + }, + "OperatingSystemName": { + "target": "com.amazonaws.workspaces#OperatingSystemName", + "traits": { + "smithy.api#documentation": "

The name of the operating system.

" + } } }, "traits": { @@ -7609,6 +8855,62 @@ } } }, + "com.amazonaws.workspaces#WorkspaceResourceAssociation": { + "type": "structure", + "members": { + "AssociatedResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the associated resource.

" + } + }, + "AssociatedResourceType": { + "target": "com.amazonaws.workspaces#WorkSpaceAssociatedResourceType", + "traits": { + "smithy.api#documentation": "

The resource types of the associated resource.

" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association is created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the association status was last updated.

" + } + }, + "State": { + "target": "com.amazonaws.workspaces#AssociationState", + "traits": { + "smithy.api#documentation": "

The status of the WorkSpace resource association.

" + } + }, + "StateReason": { + "target": "com.amazonaws.workspaces#AssociationStateReason", + "traits": { + "smithy.api#documentation": "

The reason the association deployment failed.

" + } + }, + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace.

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

Describes the association between an application and a WorkSpace resource.

" + } + }, + "com.amazonaws.workspaces#WorkspaceResourceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceResourceAssociation" + } + }, "com.amazonaws.workspaces#WorkspaceState": { "type": "enum", "members": { @@ -7776,6 +9078,9 @@ { "target": "com.amazonaws.workspaces#AssociateIpGroups" }, + { + "target": "com.amazonaws.workspaces#AssociateWorkspaceApplication" + }, { "target": "com.amazonaws.workspaces#AuthorizeIpRules" }, @@ -7830,6 +9135,9 @@ { "target": "com.amazonaws.workspaces#DeleteWorkspaceImage" }, + { + "target": "com.amazonaws.workspaces#DeployWorkspaceApplications" + }, { "target": "com.amazonaws.workspaces#DeregisterWorkspaceDirectory" }, @@ -7839,6 +9147,15 @@ { "target": "com.amazonaws.workspaces#DescribeAccountModifications" }, + { + "target": "com.amazonaws.workspaces#DescribeApplicationAssociations" + }, + { + "target": "com.amazonaws.workspaces#DescribeApplications" + }, + { + "target": "com.amazonaws.workspaces#DescribeBundleAssociations" + }, { "target": "com.amazonaws.workspaces#DescribeClientBranding" }, @@ -7854,12 +9171,18 @@ { "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissions" }, + { + "target": "com.amazonaws.workspaces#DescribeImageAssociations" + }, { "target": "com.amazonaws.workspaces#DescribeIpGroups" }, { "target": "com.amazonaws.workspaces#DescribeTags" }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspaceAssociations" + }, { "target": "com.amazonaws.workspaces#DescribeWorkspaceBundles" }, @@ -7887,6 +9210,9 @@ { "target": "com.amazonaws.workspaces#DisassociateIpGroups" }, + { + "target": "com.amazonaws.workspaces#DisassociateWorkspaceApplication" + }, { "target": "com.amazonaws.workspaces#ImportClientBranding" },