The name of the queue.
", + "smithy.api#required": {} + } + }, + "queueSize": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The number of jobs or tasks in the queue for a given device.
", + "smithy.api#required": {} + } + }, + "queuePriority": { + "target": "com.amazonaws.braket#QueuePriority", + "traits": { + "smithy.api#documentation": "Optional. Specifies the priority of the queue. Tasks in a priority queue\n are processed before the tasks in a normal queue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about tasks and jobs queued on a device.
" + } + }, + "com.amazonaws.braket#DeviceQueueInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.braket#DeviceQueueInfo" + } + }, "com.amazonaws.braket#DeviceResource": { "type": "resource", "identifiers": { @@ -1504,6 +1538,12 @@ "smithy.api#documentation": "Details about the capabilities of the device.
", "smithy.api#required": {} } + }, + "deviceQueueInfo": { + "target": "com.amazonaws.braket#DeviceQueueInfoList", + "traits": { + "smithy.api#documentation": "List of information about tasks and jobs queued on a device.
" + } } } }, @@ -1551,6 +1591,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "additionalAttributeNames": { + "target": "com.amazonaws.braket#HybridJobAdditionalAttributeNamesList", + "traits": { + "smithy.api#documentation": "A list of attributes to return information for.
", + "smithy.api#httpQuery": "additionalAttributeNames" + } } } }, @@ -1686,6 +1733,12 @@ "traits": { "smithy.api#documentation": "A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.
" } + }, + "queueInfo": { + "target": "com.amazonaws.braket#HybridJobQueueInfo", + "traits": { + "smithy.api#documentation": "Queue information for the requested job. Only returned if \n QueueInfo is specified in the additionalAttributeNames\"\n field in the GetJob API request.
A list of attributes to return information for.
", + "smithy.api#httpQuery": "additionalAttributeNames" + } } } }, @@ -1820,7 +1880,58 @@ "traits": { "smithy.api#documentation": "The ARN of the Amazon Braket job associated with the quantum task.
" } + }, + "queueInfo": { + "target": "com.amazonaws.braket#QuantumTaskQueueInfo", + "traits": { + "smithy.api#documentation": "Queue information for the requested quantum task. Only returned if \n QueueInfo is specified in the additionalAttributeNames\"\n field in the GetQuantumTask API request.
The name of the queue.
", + "smithy.api#required": {} + } + }, + "position": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Current position of the job in the jobs queue.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Optional. Provides more information about the queue position. For example,\n if the job is complete and no longer in the queue, the message field contains\n that information.
" + } } + }, + "traits": { + "smithy.api#documentation": "Information about the queue for a specified job.
" } }, "com.amazonaws.braket#HyperParameters": { @@ -2449,6 +2560,23 @@ } } }, + "com.amazonaws.braket#QuantumTaskAdditionalAttributeName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QueueInfo", + "name": "QUEUE_INFO" + } + ] + } + }, + "com.amazonaws.braket#QuantumTaskAdditionalAttributeNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.braket#QuantumTaskAdditionalAttributeName" + } + }, "com.amazonaws.braket#QuantumTaskArn": { "type": "string", "traits": { @@ -2457,11 +2585,45 @@ "resource": "com.amazonaws.braket#QuantumTaskResource" }, "smithy.api#length": { - "min": 1, + "min": 0, "max": 256 } } }, + "com.amazonaws.braket#QuantumTaskQueueInfo": { + "type": "structure", + "members": { + "queue": { + "target": "com.amazonaws.braket#QueueName", + "traits": { + "smithy.api#documentation": "The name of the queue.
", + "smithy.api#required": {} + } + }, + "position": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Current position of the task in the quantum tasks queue.
", + "smithy.api#required": {} + } + }, + "queuePriority": { + "target": "com.amazonaws.braket#QueuePriority", + "traits": { + "smithy.api#documentation": "Optional. Specifies the priority of the queue. Quantum tasks in a priority queue\n are processed before the tasks in a normal queue.
" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Optional. Provides more information about the queue position. For example,\n if the task is complete and no longer in the queue, the message field contains\n that information.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the queue for the specified quantum task.
" + } + }, "com.amazonaws.braket#QuantumTaskResource": { "type": "resource", "identifiers": { @@ -2600,6 +2762,36 @@ "target": "com.amazonaws.braket#QuantumTaskSummary" } }, + "com.amazonaws.braket#QueueName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUANTUM_TASKS_QUEUE", + "name": "QUANTUM_TASKS_QUEUE" + }, + { + "value": "JOBS_QUEUE", + "name": "JOBS_QUEUE" + } + ] + } + }, + "com.amazonaws.braket#QueuePriority": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Normal", + "name": "NORMAL" + }, + { + "value": "Priority", + "name": "PRIORITY" + } + ] + } + }, "com.amazonaws.braket#ResourceNotFoundException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-events.json b/codegen/sdk-codegen/aws-models/cloudwatch-events.json index e895f22720d..6c406fd137e 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-events.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-events.json @@ -1652,6 +1652,17 @@ "smithy.api#pattern": "^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$" } }, + "com.amazonaws.cloudwatchevents#AuthHeaderParametersSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.cloudwatchevents#AwsVpcConfiguration": { "type": "structure", "members": { @@ -2086,7 +2097,7 @@ } }, "Value": { - "target": "com.amazonaws.cloudwatchevents#String", + "target": "com.amazonaws.cloudwatchevents#SensitiveString", "traits": { "smithy.api#documentation": "The value associated with the key.
" } @@ -2135,7 +2146,7 @@ } }, "Value": { - "target": "com.amazonaws.cloudwatchevents#HeaderValue", + "target": "com.amazonaws.cloudwatchevents#HeaderValueSensitive", "traits": { "smithy.api#documentation": "The value associated with the key.
" } @@ -2279,7 +2290,7 @@ } }, "Value": { - "target": "com.amazonaws.cloudwatchevents#QueryStringValue", + "target": "com.amazonaws.cloudwatchevents#QueryStringValueSensitive", "traits": { "smithy.api#documentation": "The value associated with the key for the query string parameter.
" } @@ -2615,7 +2626,7 @@ } }, "ApiKeyValue": { - "target": "com.amazonaws.cloudwatchevents#AuthHeaderParameters", + "target": "com.amazonaws.cloudwatchevents#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The value for the API key to use for authorization.
", "smithy.api#required": {} @@ -2669,7 +2680,7 @@ } }, "Password": { - "target": "com.amazonaws.cloudwatchevents#AuthHeaderParameters", + "target": "com.amazonaws.cloudwatchevents#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The password associated with the user name to use for Basic authorization.
", "smithy.api#required": {} @@ -2691,7 +2702,7 @@ } }, "ClientSecret": { - "target": "com.amazonaws.cloudwatchevents#AuthHeaderParameters", + "target": "com.amazonaws.cloudwatchevents#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The client secret associated with the client ID to use for OAuth authorization for the\n connection.
", "smithy.api#required": {} @@ -4543,6 +4554,17 @@ "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$" } }, + "com.amazonaws.cloudwatchevents#HeaderValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.cloudwatchevents#HttpParameters": { "type": "structure", "members": { @@ -6499,6 +6521,17 @@ "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$" } }, + "com.amazonaws.cloudwatchevents#QueryStringValueSensitive": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.cloudwatchevents#RedshiftDataParameters": { "type": "structure", "members": { @@ -7263,6 +7296,12 @@ "smithy.api#pattern": "^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]|\\d|\\-)*:([0-9]{12})?:secret:[\\/_+=\\.@\\-A-Za-z0-9]+$" } }, + "com.amazonaws.cloudwatchevents#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.cloudwatchevents#Sql": { "type": "string", "traits": { @@ -8088,7 +8127,7 @@ } }, "ApiKeyValue": { - "target": "com.amazonaws.cloudwatchevents#AuthHeaderParameters", + "target": "com.amazonaws.cloudwatchevents#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The value associated with teh API key to use for authorization.
" } @@ -8140,7 +8179,7 @@ } }, "Password": { - "target": "com.amazonaws.cloudwatchevents#AuthHeaderParameters", + "target": "com.amazonaws.cloudwatchevents#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The password associated with the user name to use for Basic authorization.
" } @@ -8160,7 +8199,7 @@ } }, "ClientSecret": { - "target": "com.amazonaws.cloudwatchevents#AuthHeaderParameters", + "target": "com.amazonaws.cloudwatchevents#AuthHeaderParametersSensitive", "traits": { "smithy.api#documentation": "The client secret assciated with the client ID to use for OAuth authorization.
" } diff --git a/codegen/sdk-codegen/aws-models/database-migration-service.json b/codegen/sdk-codegen/aws-models/database-migration-service.json index a52cd5841bf..3c2f3ad3058 100644 --- a/codegen/sdk-codegen/aws-models/database-migration-service.json +++ b/codegen/sdk-codegen/aws-models/database-migration-service.json @@ -2247,13 +2247,13 @@ "MaxCapacityUnits": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless\n replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value allowed.\n The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value\n that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only\n DCU parameter you are required to specify.
Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless\n replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed.\n The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value\n that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only\n DCU parameter you are required to specify.
Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS\n Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 2 DCUs as the minimum value\n allowed. The list of valid DCU values includes 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU\n value that you can specify for DMS Serverless is 2. You don't have to specify a value for the\n MinCapacityUnits parameter. If you don't set this value, DMS scans the current activity\n of available source tables to identify an optimum setting for this parameter. If there is no current\n source activity or DMS can't otherwise identify a more appropriate value, it sets this parameter to\n the minimum DCU value allowed, 2.
Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS\n Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value\n allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU\n value that you can specify for DMS Serverless is 1. You don't have to specify a value for the\n MinCapacityUnits parameter. If you don't set this value, DMS scans the current activity\n of available source tables to identify an optimum setting for this parameter. If there is no current\n source activity or DMS can't otherwise identify a more appropriate value, it sets this parameter to\n the minimum DCU value allowed, 1.
Creates a data provider using the provided settings. A data provider stores \n a data store type and location information about your database.
" + "smithy.api#documentation": "Creates a data provider using the provided settings. A data provider stores \n a data store type and location information about your database.
", + "smithy.api#examples": [ + { + "title": "Create Data Provider", + "documentation": "Creates the data provider with the specified parameters.", + "input": { + "DataProviderName": "sqlServer-dev", + "Engine": "sqlserver", + "Description": "description", + "Settings": { + "MicrosoftSqlServerSettings": { + "ServerName": "ServerName2", + "Port": 11112, + "DatabaseName": "DatabaseName", + "SslMode": "none" + } + }, + "Tags": [ + { + "Key": "access", + "Value": "authorizedusers" + } + ] + }, + "output": { + "DataProvider": { + "Engine": "postgres", + "Settings": { + "PostgreSqlSettings": { + "SslMode": "none", + "ServerName": "postrgesql.a1b2c3d4e5f6.us-east-1.rds.amazonaws.com", + "Port": 5432, + "DatabaseName": "target" + } + }, + "DataProviderCreationTime": "2023-05-12T10:50:41.988561Z", + "DataProviderName": "my-target-dataprovider", + "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-dataprovider" + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#CreateDataProviderMessage": { @@ -2969,7 +3010,41 @@ } ], "traits": { - "smithy.api#documentation": "Creates the instance profile using the specified parameters.
" + "smithy.api#documentation": "Creates the instance profile using the specified parameters.
", + "smithy.api#examples": [ + { + "title": "Create Instance Profile", + "documentation": "Creates the instance profile using the specified parameters.", + "input": { + "SubnetGroupIdentifier": "my-subnet-group", + "PubliclyAccessible": true, + "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef", + "InstanceProfileName": "my-instance-profile", + "Description": "Description", + "NetworkType": "DUAL", + "Tags": [ + { + "Key": "access", + "Value": "authorizedusers" + } + ] + }, + "output": { + "InstanceProfile": { + "SubnetGroupIdentifier": "public-subnets", + "VpcIdentifier": "vpc-0a1b2c3d4e5f6g7h8", + "VpcSecurityGroups": [ + "sg-0123456" + ], + "PubliclyAccessible": true, + "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef", + "InstanceProfileCreationTime": "2022-12-16T09:44:43.543246Z", + "InstanceProfileName": "my-instance-profile", + "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile" + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#CreateInstanceProfileMessage": { @@ -3077,7 +3152,72 @@ } ], "traits": { - "smithy.api#documentation": "Creates the migration project using the specified parameters.
\nYou can run this action only after you create an instance profile and data providers \n using CreateInstanceProfile and CreateDataProvider.
" + "smithy.api#documentation": "Creates the migration project using the specified parameters.
\nYou can run this action only after you create an instance profile and data providers \n using CreateInstanceProfile and CreateDataProvider.
", + "smithy.api#examples": [ + { + "title": "Create Migration Project", + "documentation": "Creates the migration project with the specified parameters.", + "input": { + "MigrationProjectName": "my-migration-project", + "SourceDataProviderDescriptors": [ + { + "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", + "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/example1/ALL.SOURCE.ORACLE_12-A1B2C3", + "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access" + } + ], + "TargetDataProviderDescriptors": [ + { + "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", + "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/example1/TARGET.postgresql-A1B2C3", + "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/myuser-admin-access" + } + ], + "InstanceProfileIdentifier": "ip-au-17", + "SchemaConversionApplicationAttributes": { + "S3BucketPath": "arn:aws:s3:::mylogin-bucket", + "S3BucketRoleArn": "arn:aws:iam::012345678901:role/Admin" + }, + "Tags": [ + { + "Key": "access", + "Value": "authorizedusers" + } + ], + "Description": "description", + "TransformationRules": "{\"key0\":\"value0\",\"key1\":\"value1\",\"key2\":\"value2\"}" + }, + "output": { + "MigrationProject": { + "SchemaConversionApplicationAttributes": { + "S3BucketPath": "my-s3-bucket/my_folder", + "S3BucketRoleArn": "arn:aws:iam::012345678901:role/my-s3role" + }, + "SourceDataProviderDescriptors": [ + { + "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/my-access-role", + "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/ALL.SOURCE.ORACLE_12-0123456", + "DataProviderName": "source-oracle-12", + "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ], + "MigrationProjectCreationTime": "2023-04-19T11:45:15.805253Z", + "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "MigrationProjectName": "my-migration-project", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "InstanceProfileName": "my-instance-profile", + "TargetDataProviderDescriptors": [ + { + "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/dmytbon-admin-access", + "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:myuser/TARGET.postgresql-0123456", + "DataProviderName": "target-dataprovider-3", + "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#CreateMigrationProjectMessage": { @@ -3322,7 +3462,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates the replication instance using the specified parameters.
\nDMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the CLI and DMS API. For\n information on the required permissions, see \n IAM Permissions Needed to Use DMS.
", + "smithy.api#documentation": "Creates the replication instance using the specified parameters.
\nDMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the CLI and DMS API. For\n information on the required permissions, see \n IAM Permissions Needed to Use DMS.
\nIf you don't specify a version when creating a replication instance, DMS will create the instance using the\n default engine version. For information about the default engine version, see\n Release Notes.
\nA value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.
Default: true\n
When AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you create a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you create a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
A value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.
Default: true\n
Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“
" } }, "Tags": { @@ -3950,6 +4090,9 @@ "com.amazonaws.databasemigrationservice#DataProviderSettings": { "type": "union", "members": { + "RedshiftSettings": { + "target": "com.amazonaws.databasemigrationservice#RedshiftDataProviderSettings" + }, "PostgreSqlSettings": { "target": "com.amazonaws.databasemigrationservice#PostgreSqlDataProviderSettings" }, @@ -3961,6 +4104,21 @@ }, "MicrosoftSqlServerSettings": { "target": "com.amazonaws.databasemigrationservice#MicrosoftSqlServerDataProviderSettings" + }, + "DocDbSettings": { + "target": "com.amazonaws.databasemigrationservice#DocDbDataProviderSettings" + }, + "MariaDbSettings": { + "target": "com.amazonaws.databasemigrationservice#MariaDbDataProviderSettings", + "traits": { + "smithy.api#documentation": "Provides information that defines a MariaDB data provider.
" + } + }, + "MongoDbSettings": { + "target": "com.amazonaws.databasemigrationservice#MongoDbDataProviderSettings", + "traits": { + "smithy.api#documentation": "Provides information that defines a MongoDB data provider.
" + } } }, "traits": { @@ -4370,7 +4528,32 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified data provider.
\nAll migration projects associated with the data provider must be deleted or modified \n before you can delete the data provider.
\nDeletes the specified data provider.
\nAll migration projects associated with the data provider must be deleted or modified \n before you can delete the data provider.
\nDeletes the specified instance profile.
\nAll migration projects associated with the instance profile must be deleted or modified \n before you can delete the instance profile.
\nDeletes the specified instance profile.
\nAll migration projects associated with the instance profile must be deleted or modified \n before you can delete the instance profile.
\nDeletes the specified migration project.
\nThe migration project must be closed before you can delete it.
\nDeletes the specified migration project.
\nThe migration project must be closed before you can delete it.
\nReturns configuration parameters for a schema conversion project.
" + "smithy.api#documentation": "Returns configuration parameters for a schema conversion project.
", + "smithy.api#examples": [ + { + "title": "Describe Conversion Configuration", + "documentation": "Returns configuration parameters for a schema conversion project.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" + }, + "output": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\"},\"ORACLE_TO_POSTGRESQL\" : {\"ToTimeZone\":false,\"LastDayBuiltinFunctionOracle\":false, \"NextDayBuiltinFunctionOracle\":false,\"ConvertProceduresToFunction\":false,\"NvlBuiltinFunctionOracle\":false,\"DbmsAssertBuiltinFunctionOracle\":false}}" + } + } + ] } }, "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationMessage": { @@ -5502,6 +5759,43 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of data providers for your account in the current region.
", + "smithy.api#examples": [ + { + "title": "Describe Data Providers", + "documentation": "", + "input": { + "Filters": [ + { + "Name": "data-provider-identifier", + "Values": [ + "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" + ] + } + ], + "MaxRecords": 20, + "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" + }, + "output": { + "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", + "DataProviders": [ + { + "Engine": "postgres", + "DataProviderCreationTime": "2023-05-12T10:50:41.988561Z", + "DataProviderName": "my-target-data-provider", + "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-data-provider", + "Settings": { + "PostgreSqlSettings": { + "SslMode": "none", + "ServerName": "postrgesql.0a1b2c3d4e5f.us-east-1.rds.amazonaws.com", + "Port": 5432, + "DatabaseName": "target" + } + } + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6126,6 +6420,35 @@ }, "traits": { "smithy.api#documentation": "Returns a paginated list of extension pack associations for the specified migration project.\n An extension pack is an add-on module \n that emulates functions present in a source database that are required when converting objects \n to the target database.
", + "smithy.api#examples": [ + { + "title": "Describe Extension Pack Associations", + "documentation": "Returns a paginated list of extension pack associations for the specified migration project.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "Filters": [ + { + "Name": "instance-profile-identifier", + "Values": [ + "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" + ] + } + ], + "Marker": "0123456789abcdefghijklmnopqrs", + "MaxRecords": 20 + }, + "output": { + "Marker": "0123456789abcdefghijklmnopqrs", + "Requests": [ + { + "Status": "SUCCESS", + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6538,6 +6861,38 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of instance profiles for your account in the current region.
", + "smithy.api#examples": [ + { + "title": "Describe Instance Profiles", + "documentation": "Returns a paginated list of instance profiles for your account in the current region.", + "input": { + "Filters": [ + { + "Name": "instance-profile-identifier", + "Values": [ + "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" + ] + } + ], + "MaxRecords": 20, + "Marker": "0123456789abcdefghijklmnopqrs" + }, + "output": { + "Marker": "0123456789abcdefghijklmnopqrs", + "InstanceProfiles": [ + { + "SubnetGroupIdentifier": "public-subnets", + "VpcIdentifier": "vpc-0a1b2c3d4e5f6g7h8", + "PubliclyAccessible": true, + "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef", + "InstanceProfileCreationTime": "2022-12-16T09:44:43.543246Z", + "InstanceProfileName": "my-instance-profile", + "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6606,6 +6961,35 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of metadata model assessments for your account in the current region.
", + "smithy.api#examples": [ + { + "title": "Describe Metadata Model Assessments", + "documentation": "Returns a paginated list of metadata model assessments for your account in the current region.", + "input": { + "MigrationProjectIdentifier": "", + "Filters": [ + { + "Name": "my-migration-project", + "Values": [ + "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + ] + } + ], + "Marker": "0123456789abcdefghijklmnopqrs", + "MaxRecords": 20 + }, + "output": { + "Marker": "ASDLKJASDJKHDFHGDNBGDASKJHGFK", + "Requests": [ + { + "Status": "SUCCESS", + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6681,6 +7065,35 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of metadata model conversions for a migration project.
", + "smithy.api#examples": [ + { + "title": "Describe Metadata Model Conversions", + "documentation": "Returns a paginated list of metadata model conversions for a migration project.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", + "Filters": [ + { + "Name": "request-id", + "Values": [ + "01234567-89ab-cdef-0123-456789abcdef" + ] + } + ], + "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456", + "MaxRecords": 123 + }, + "output": { + "Marker": "0123456789abcdefghijklmnopqrs", + "Requests": [ + { + "Status": "SUCCESS", + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6756,6 +7169,35 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of metadata model exports.
", + "smithy.api#examples": [ + { + "title": "Describe Metadata Model Exports As Script", + "documentation": "Returns a paginated list of metadata model exports.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "Filters": [ + { + "Name": "request-id", + "Values": [ + "01234567-89ab-cdef-0123-456789abcdef" + ] + } + ], + "Marker": "0123456789abcdefghijklmnopqrs", + "MaxRecords": 20 + }, + "output": { + "Marker": "0123456789abcdefghijklmnopqrs", + "Requests": [ + { + "Status": "SUCCESS", + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6831,6 +7273,35 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of metadata model exports.
", + "smithy.api#examples": [ + { + "title": "Describe Metadata Model Exports To Target", + "documentation": "Returns a paginated list of metadata model exports.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "Filters": [ + { + "Name": "request-id", + "Values": [ + "01234567-89ab-cdef-0123-456789abcdef" + ] + } + ], + "Marker": "0123456789abcdefghijklmnopqrs", + "MaxRecords": 20 + }, + "output": { + "Marker": "0123456789abcdefghijklmnopqrs", + "Requests": [ + { + "Status": "SUCCESS", + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6906,6 +7377,35 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of metadata model imports.
", + "smithy.api#examples": [ + { + "title": "Describe Metadata Model Imports", + "documentation": "Returns a paginated list of metadata model imports.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "Filters": [ + { + "Name": "request-id", + "Values": [ + "01234567-89ab-cdef-0123-456789abcdef" + ] + } + ], + "Marker": "0123456789abcdefghijklmnopqrs", + "MaxRecords": 20 + }, + "output": { + "Marker": "0123456789abcdefghijklmnopqrs", + "Requests": [ + { + "Status": "SUCCESS", + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6984,6 +7484,56 @@ ], "traits": { "smithy.api#documentation": "Returns a paginated list of migration projects for your account in the current region.
", + "smithy.api#examples": [ + { + "title": "Describe Migration Projects", + "documentation": "Returns a paginated list of migration projects for your account in the current region.", + "input": { + "Filters": [ + { + "Name": "migration-project-identifier", + "Values": [ + "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ12345678901" + ] + } + ], + "MaxRecords": 20, + "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456" + }, + "output": { + "Marker": "0123456789abcdefghijklmnopqrs", + "MigrationProjects": [ + { + "SchemaConversionApplicationAttributes": { + "S3BucketPath": "my-s3-bucket/my_folder", + "S3BucketRoleArn": "arn:aws:iam::012345678901:role/my-s3role" + }, + "SourceDataProviderDescriptors": [ + { + "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/my-access-role", + "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/ALL.SOURCE.ORACLE_12-012345", + "DataProviderName": "all-source-oracle-12", + "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ], + "MigrationProjectCreationTime": "2023-04-19T11:45:15.805253Z", + "InstanceProfileArn": "arn:aws:dms:us-east-1:012345678901:instance-profile:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "MigrationProjectName": "my-migration-project", + "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "InstanceProfileName": "my-instance-profile", + "TargetDataProviderDescriptors": [ + { + "SecretsManagerAccessRoleArn": "arn:aws:iam::012345678901:role/dmytbon-admin-access", + "SecretsManagerSecretId": "arn:aws:secretsmanager:us-east-1:012345678901:secret:mygroup/myalias/TARGET.postgresql-012345", + "DataProviderName": "my-data-provider", + "DataProviderArn": "arn:aws:dms:us-east-1:012345678901:data-provider:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8858,6 +9408,44 @@ "smithy.api#documentation": "The settings in JSON format for the DMS Transfer type source endpoint.
" } }, + "com.amazonaws.databasemigrationservice#DocDbDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the source DocumentDB server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the DocumentDB data provider.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database name on the DocumentDB data provider.
" + } + }, + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "traits": { + "smithy.api#documentation": "The SSL mode used to connect to the DocumentDB data provider. \n The default value is none.
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a DocumentDB data provider.
" + } + }, "com.amazonaws.databasemigrationservice#DocDbSettings": { "type": "structure", "members": { @@ -9634,7 +10222,31 @@ } ], "traits": { - "smithy.api#documentation": "Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save \n your assessment report as a comma-separated value (CSV) or a PDF file.
" + "smithy.api#documentation": "Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save \n your assessment report as a comma-separated value (CSV) or a PDF file.
", + "smithy.api#examples": [ + { + "title": "Export Metadata Model Assessment", + "documentation": "Saves a copy of a database migration assessment report to your S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-a1b2c3d4e5f6.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}", + "FileName": "file", + "AssessmentReportTypes": [ + "pdf" + ] + }, + "output": { + "PdfReport": { + "S3ObjectKey": "object-name", + "ObjectURL": "url" + }, + "CsvReport": { + "S3ObjectKey": "object-name", + "ObjectURL": "url" + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentMessage": { @@ -10788,6 +11400,38 @@ } } }, + "com.amazonaws.databasemigrationservice#MariaDbDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the MariaDB server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the MariaDB data provider
" + } + }, + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "traits": { + "smithy.api#documentation": "The SSL mode used to connect to the MariaDB data provider. \n The default value is none.
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a MariaDB data provider.
" + } + }, "com.amazonaws.databasemigrationservice#MessageFormatValue": { "type": "enum", "members": { @@ -10895,7 +11539,7 @@ "TrimSpaceInChar": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.
Use the TrimSpaceInChar source endpoint setting to right-trim data \n on CHAR and NCHAR data types during migration. Setting TrimSpaceInChar\n does not left-trim data. The default value is true.
Modifies the specified schema conversion configuration using the provided parameters.
" + "smithy.api#documentation": "Modifies the specified schema conversion configuration using the provided parameters.
", + "smithy.api#examples": [ + { + "title": "Modify Conversion Configuration", + "documentation": "Modifies the specified schema conversion configuration using the provided parameters.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\"},\"ORACLE_TO_POSTGRESQL\" : {\"ToTimeZone\":false,\"LastDayBuiltinFunctionOracle\":false, \"NextDayBuiltinFunctionOracle\":false,\"ConvertProceduresToFunction\":false,\"NvlBuiltinFunctionOracle\":false,\"DbmsAssertBuiltinFunctionOracle\":false}}" + }, + "output": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + } + ] } }, "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationMessage": { @@ -11129,7 +11786,43 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the specified data provider using the provided settings.
\nYou must remove the data provider from all migration projects before you can modify it.
\nModifies the specified data provider using the provided settings.
\nYou must remove the data provider from all migration projects before you can modify it.
\nModifies the specified instance profile using the provided parameters.
\nAll migration projects associated with the instance profile must be deleted \n or modified before you can modify the instance profile.
\nModifies the specified instance profile using the provided parameters.
\nAll migration projects associated with the instance profile must be deleted \n or modified before you can modify the instance profile.
\nModifies the specified migration project using the provided parameters.
\nThe migration project must be closed before you can modify it.
\nModifies the specified migration project using the provided parameters.
\nThe migration project must be closed before you can modify it.
\nA value that indicates that minor version upgrades are applied automatically to the\n replication instance during the maintenance window. Changing this parameter doesn't result\n in an outage, except in the case described following. The change is asynchronously applied\n as soon as possible.
\nAn outage does result if these factors apply:
\nThis parameter is set to true during the maintenance window.
A newer minor version is available.
\nDMS has enabled automatic patching for the given engine version.
\nWhen AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you modify a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you modify a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
A value that indicates that minor version upgrades are applied automatically to the\n replication instance during the maintenance window. Changing this parameter doesn't result\n in an outage, except in the case described following. The change is asynchronously applied\n as soon as possible.
\nAn outage does result if these factors apply:
\nThis parameter is set to true during the maintenance window.
A newer minor version is available.
\nDMS has enabled automatic patching for the given engine version.
\nIndicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“
" } }, "TaskData": { @@ -12283,6 +13066,62 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#MongoDbDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the MongoDB server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the MongoDB data provider.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database name on the MongoDB data provider.
" + } + }, + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "traits": { + "smithy.api#documentation": "The SSL mode used to connect to the MongoDB data provider. \n The default value is none.
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
" + } + }, + "AuthType": { + "target": "com.amazonaws.databasemigrationservice#AuthTypeValue", + "traits": { + "smithy.api#documentation": "The authentication type for the database connection. Valid values are PASSWORD or NO.
" + } + }, + "AuthSource": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " The MongoDB database name. This setting isn't used when AuthType is\n set to \"no\".
The default is \"admin\".
The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a MongoDB data provider.
" + } + }, "com.amazonaws.databasemigrationservice#MongoDbSettings": { "type": "structure", "members": { @@ -12301,7 +13140,7 @@ "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The name of the server on the MongoDB source endpoint.
" + "smithy.api#documentation": "The name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the \n server name for any of the servers in the replication set.
" } }, "Port": { @@ -12949,7 +13788,7 @@ "SecretsManagerOracleAsmAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN\n of the IAM role that specifies DMS as the trusted entity and grants the required\n permissions to access the SecretsManagerOracleAsmSecret. This\n SecretsManagerOracleAsmSecret has the secret value that allows access to\n the Oracle ASM of the endpoint.
You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerOracleAsmSecretId. Or you can\n specify clear-text values for AsmUserName, AsmPassword, and\n AsmServerName. You can't specify both. For more information on\n creating this SecretsManagerOracleAsmSecret and the\n SecretsManagerOracleAsmAccessRoleArn and\n SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service\n resources in the Database Migration Service User\n Guide.
Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN\n of the IAM role that specifies DMS as the trusted entity and grants the required\n permissions to access the SecretsManagerOracleAsmSecret. This\n SecretsManagerOracleAsmSecret has the secret value that allows access to\n the Oracle ASM of the endpoint.
You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerOracleAsmSecretId. Or you can\n specify clear-text values for AsmUser, AsmPassword, and\n AsmServerName. You can't specify both. For more information on\n creating this SecretsManagerOracleAsmSecret and the\n SecretsManagerOracleAsmAccessRoleArn and\n SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service\n resources in the Database Migration Service User\n Guide.
When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as \n varchar(5).
When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as \n varchar(5). You must set this setting on both the source and target endpoints for it to take effect.
Provides information that defines a Redis target endpoint.
" } }, + "com.amazonaws.databasemigrationservice#RedshiftDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon Redshift server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the Amazon Redshift data provider.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database name on the Amazon Redshift data provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines an Amazon Redshift data provider.
" + } + }, "com.amazonaws.databasemigrationservice#RedshiftSettings": { "type": "structure", "members": { @@ -13958,7 +14823,7 @@ "MapBooleanAsBoolean": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans as \n varchar(1).
When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans as \n varchar(1). You must set this setting on both the source and target endpoints for it to take effect.
Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“
" } }, "RecoveryCheckpoint": { @@ -15728,7 +16593,7 @@ "CsvNullValue": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional parameter that specifies how DMS treats null\n values. While handling the null value, you can use this\n parameter to pass a user-defined string as null when writing to\n the target. For example, when target columns are not nullable,\n you can use this option to differentiate between the empty\n string value and the null value. So, if you set this parameter\n value to the empty string (\"\" or ''), DMS treats the empty\n string as the null value instead of NULL.
The default value is NULL. Valid values include any valid string.
An optional parameter that specifies how DMS treats null\n values. While handling the null value, you can use this\n parameter to pass a user-defined string as null when writing to\n the target. For example, when target columns are nullable,\n you can use this option to differentiate between the empty\n string value and the null value. So, if you set this parameter\n value to the empty string (\"\" or ''), DMS treats the empty\n string as the null value instead of NULL.
The default value is NULL. Valid values include any valid string.
Applies the extension pack to your target database. An extension pack is an add-on \n module that emulates functions present in a source database that are required when \n converting objects to the target database. \n
" + "smithy.api#documentation": "Applies the extension pack to your target database. An extension pack is an add-on \n module that emulates functions present in a source database that are required when \n converting objects to the target database. \n
", + "smithy.api#examples": [ + { + "title": "Start Extension Pack Association", + "documentation": "Applies the extension pack to your target database.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + }, + "output": { + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" + } + } + ] } }, "com.amazonaws.databasemigrationservice#StartExtensionPackAssociationMessage": { @@ -16163,7 +17040,20 @@ } ], "traits": { - "smithy.api#documentation": "Creates a database migration assessment report by assessing the migration complexity for \n your source database. A database migration assessment report summarizes all of the schema \n conversion tasks. It also details the action items for database objects that can't be converted \n to the database engine of your target database instance.
" + "smithy.api#documentation": "Creates a database migration assessment report by assessing the migration complexity for \n your source database. A database migration assessment report summarizes all of the schema \n conversion tasks. It also details the action items for database objects that can't be converted \n to the database engine of your target database instance.
", + "smithy.api#examples": [ + { + "title": "Start Metadata Model Assessment", + "documentation": "Creates a database migration assessment report by assessing the migration complexity for \n your source database.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}" + }, + "output": { + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" + } + } + ] } }, "com.amazonaws.databasemigrationservice#StartMetadataModelAssessmentMessage": { @@ -16237,7 +17127,20 @@ } ], "traits": { - "smithy.api#documentation": "Converts your source database objects to a format compatible with the target database.
" + "smithy.api#documentation": "Converts your source database objects to a format compatible with the target database.
", + "smithy.api#examples": [ + { + "title": "Start Metadata Model Conversion", + "documentation": "Converts your source database objects to a format compatible with the target database. ", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}" + }, + "output": { + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" + } + } + ] } }, "com.amazonaws.databasemigrationservice#StartMetadataModelConversionMessage": { @@ -16311,7 +17214,22 @@ } ], "traits": { - "smithy.api#documentation": "Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
" + "smithy.api#documentation": "Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
", + "smithy.api#examples": [ + { + "title": "Start Metadata Model Export As Script", + "documentation": "Saves your converted code to a file as a SQL script, and stores this file on your S3 bucket.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}", + "Origin": "SOURCE", + "FileName": "FILE" + }, + "output": { + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" + } + } + ] } }, "com.amazonaws.databasemigrationservice#StartMetadataModelExportAsScriptMessage": { @@ -16398,7 +17316,21 @@ } ], "traits": { - "smithy.api#documentation": "Applies converted database objects to your target database.
" + "smithy.api#documentation": "Applies converted database objects to your target database.
", + "smithy.api#examples": [ + { + "title": "Start Metadata Model Export To Target", + "documentation": "Applies converted database objects to your target database.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", + "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-a1b2c3d4e5f6.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}", + "OverwriteExtensionPack": true + }, + "output": { + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" + } + } + ] } }, "com.amazonaws.databasemigrationservice#StartMetadataModelExportToTargetMessage": { @@ -16478,7 +17410,22 @@ } ], "traits": { - "smithy.api#documentation": "Loads the metadata for all the dependent database objects of the parent object.
\nThis operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.
" + "smithy.api#documentation": "Loads the metadata for all the dependent database objects of the parent object.
\nThis operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.
", + "smithy.api#examples": [ + { + "title": "Start Metadata Model Import", + "documentation": "Loads the metadata for all the dependent database objects of the parent object.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"aurora-pg.cluster-0a1b2c3d4e5f.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}", + "Origin": "SOURCE", + "Refresh": false + }, + "output": { + "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" + } + } + ] } }, "com.amazonaws.databasemigrationservice#StartMetadataModelImportMessage": { @@ -16946,7 +17893,7 @@ "CdcStopPosition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“
" } } }, @@ -17713,7 +18660,7 @@ } ], "traits": { - "smithy.api#documentation": "Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules.\n By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher.\n If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you\n to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the Force\n option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be\n available when you use Amazon EventBridge.
To call this operation, make sure that you have certain permissions added to your user account.\n For more information, see Migrating event subscriptions to Amazon EventBridge\n in the Amazon Web Services Database Migration Service User Guide.
" + "smithy.api#documentation": "Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules.\n By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.5 or higher.\n If any replication instances are from versions earlier than 3.4.5, the operation raises an error and tells you\n to upgrade these instances to version 3.4.5 or higher. To enable migration regardless of version, set the Force\n option to true. However, if you don't upgrade instances earlier than version 3.4.5, some types of events might not be\n available when you use Amazon EventBridge.
To call this operation, make sure that you have certain permissions added to your user account.\n For more information, see Migrating event subscriptions to Amazon EventBridge\n in the Amazon Web Services Database Migration Service User Guide.
" } }, "com.amazonaws.databasemigrationservice#UpdateSubscriptionsToEventBridgeMessage": { @@ -17722,7 +18669,7 @@ "ForceMove": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "When set to true, this operation migrates DMS subscriptions for Amazon SNS\n notifications no matter what your replication instance version is. If not set or set to\n false, this operation runs only when all your replication instances are from DMS\n version 3.4.6 or higher.\n
" + "smithy.api#documentation": "When set to true, this operation migrates DMS subscriptions for Amazon SNS\n notifications no matter what your replication instance version is. If not set or set to\n false, this operation runs only when all your replication instances are from DMS\n version 3.4.5 or higher.\n
" } } }, diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 4b666635c22..ee7045e56bf 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -64574,6 +64574,12 @@ "traits": { "smithy.api#enumValue": "c7i.48xlarge" } + }, + "mac2_m2pro_metal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mac2-m2pro.metal" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/efs.json b/codegen/sdk-codegen/aws-models/efs.json index 4b84dddbc18..c0afd3e01ec 100644 --- a/codegen/sdk-codegen/aws-models/efs.json +++ b/codegen/sdk-codegen/aws-models/efs.json @@ -424,7 +424,7 @@ "PerformanceMode": { "target": "com.amazonaws.efs#PerformanceMode", "traits": { - "smithy.api#documentation": "The performance mode of the file system. We recommend generalPurpose\n performance mode for most file systems. File systems using the maxIO performance\n mode can scale to higher levels of aggregate throughput and operations per second with a\n tradeoff of slightly higher latencies for most file operations. The performance mode\n can't be changed after the file system has been created.
The maxIO mode is not supported on file systems using One Zone storage classes.
The performance mode of the file system. We recommend generalPurpose\n performance mode for most file systems. File systems using the maxIO performance\n mode can scale to higher levels of aggregate throughput and operations per second with a\n tradeoff of slightly higher latencies for most file operations. The performance mode\n can't be changed after the file system has been created.
The maxIO mode is not supported on file systems using One Zone storage classes.
Default is generalPurpose.
The throughput, measured in\n MiB/s,\n that you want to provision for a file system that you're creating. Valid values are\n 1-1024. Required if ThroughputMode is set to provisioned. The upper\n limit for throughput is 1024 MiB/s. To increase this limit, contact Amazon Web Services Support. For\n more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
The throughput, measured in mebibytes per second (MiBps), that you want to provision for a\n file system that you're creating. Required if ThroughputMode is set to\n provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on\n Region. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas\n that you can increase in the Amazon EFS User\n Guide.
Creates a replication configuration that replicates an existing EFS file system to a new,\n read-only file system. For more information, see Amazon EFS replication in the\n Amazon EFS User Guide. The replication configuration\n specifies the following:
\n\n Source file system - An existing EFS file system that you\n want replicated. The source file system cannot be a destination file system in an existing\n replication configuration.
\n\n Destination file system configuration - The configuration of\n the destination file system to which the source file system will be replicated. There can\n only be one destination file system in a replication configuration. The destination file\n system configuration consists of the following properties:
\n\n Amazon Web Services Region - The Amazon Web Services Region in\n which the destination file system is created. Amazon EFS replication is\n available in all Amazon Web Services Regions that Amazon EFS is available in,\n except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe\n (Milan), and Middle East (Bahrain).
\n\n Availability Zone - If you want the destination file system\n to use EFS One Zone availability and durability, you must specify the Availability\n Zone to create the file system in. For more information about EFS storage classes, see\n \n Amazon EFS storage classes in the Amazon EFS User\n Guide.
\n\n Encryption - All destination file systems are created with\n encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't\n specify a KMS key, your service-managed KMS key for\n Amazon EFS is used.
\nAfter the file system is created, you cannot change the KMS key.
\nThe following properties are set by default:
\n\n Performance mode - The destination file system's performance\n mode matches that of the source file system, unless the destination file system uses EFS\n One Zone storage. In that case, the General Purpose performance mode is used. The\n performance mode cannot be changed.
\n\n Throughput mode - The destination file system's throughput\n mode matches that of the source file system. After the file system is created, you can modify the\n throughput mode.
\nThe following properties are turned off by default:
\n\n Lifecycle management - EFS lifecycle management and EFS\n Intelligent-Tiering are not enabled on the destination file system. After the destination\n file system is created, you can enable EFS lifecycle management and EFS\n Intelligent-Tiering.
\n\n Automatic backups - Automatic daily backups not enabled on\n the destination file system. After the file system is created, you can change this\n setting.
\nFor more information, see Amazon EFS replication in the\n Amazon EFS User Guide.
", + "smithy.api#documentation": "Creates a replication configuration that replicates an existing EFS file system to a new,\n read-only file system. For more information, see Amazon EFS replication in the\n Amazon EFS User Guide. The replication configuration\n specifies the following:
\n\n Source file system - An existing EFS file system that you\n want replicated. The source file system cannot be a destination file system in an existing\n replication configuration.
\n\n Destination file system configuration - The configuration of\n the destination file system to which the source file system will be replicated. There can\n only be one destination file system in a replication configuration. The destination file\n system configuration consists of the following properties:
\n\n Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is\n available. To use EFS replication in a Region that is disabled by default, you must\n first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference\n Reference Guide\n
\n\n Availability Zone - If you want the destination file system\n to use EFS One Zone availability and durability, you must specify the Availability\n Zone to create the file system in. For more information about EFS storage classes, see\n \n Amazon EFS storage classes in the Amazon EFS User\n Guide.
\n\n Encryption - All destination file systems are created with\n encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't\n specify a KMS key, your service-managed KMS key for\n Amazon EFS is used.
\nAfter the file system is created, you cannot change the KMS key.
\nThe following properties are set by default:
\n\n Performance mode - The destination file system's performance\n mode matches that of the source file system, unless the destination file system uses EFS\n One Zone storage. In that case, the General Purpose performance mode is used. The\n performance mode cannot be changed.
\n\n Throughput mode - The destination file system's throughput\n mode matches that of the source file system. After the file system is created, you can modify the\n throughput mode.
\nThe following properties are turned off by default:
\n\n Lifecycle management - EFS lifecycle management and EFS\n Intelligent-Tiering are not enabled on the destination file system. After the destination\n file system is created, you can enable EFS lifecycle management and EFS\n Intelligent-Tiering.
\n\n Automatic backups - Automatic daily backups are enabled on\n the destination file system. After the file system is created, you can change this\n setting.
\nFor more information, see Amazon EFS replication in the\n Amazon EFS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration", @@ -995,7 +995,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing replication configuration. To delete a replication configuration, you\n must make the request from the Amazon Web Services Region in which the destination file system\n is located. Deleting a replication configuration ends the replication process. After a\n replication configuration is deleted, the destination file system is no longer read-only. You\n can write to the destination file system after its status becomes\n Writeable.
Deletes an existing replication configuration. Deleting a replication configuration ends the replication process. After a\n replication configuration is deleted, the destination file system is no longer read-only. You\n can write to the destination file system after its status becomes\n Writeable.
Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.\n For more information, see Managing Amazon EFS resource IDs.
", + "smithy.api#documentation": "Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
", "smithy.api#http": { "method": "GET", "uri": "/2015-02-01/account-preferences", @@ -2123,7 +2123,7 @@ "ProvisionedThroughputInMibps": { "target": "com.amazonaws.efs#ProvisionedThroughputInMibps", "traits": { - "smithy.api#documentation": "The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for\n file systems using ThroughputMode set to provisioned.
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for\n file systems using ThroughputMode set to provisioned.
Describes the replication configuration for a specific file system.
" } }, "com.amazonaws.efs#ReplicationConfigurationDescriptions": { @@ -5333,7 +5336,7 @@ "ProvisionedThroughputInMibps": { "target": "com.amazonaws.efs#ProvisionedThroughputInMibps", "traits": { - "smithy.api#documentation": "(Optional) Sets the amount of provisioned throughput, in MiB/s, for the file\n system. Valid values are 1-1024. If you are changing the throughput mode to provisioned, you must also \n provide the amount of provisioned throughput. Required if ThroughputMode is changed \n to provisioned on update.
(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to\n provision for a file system that you're creating. Required if ThroughputMode\n is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit\n depending on Region. To increase this limit, contact Amazon Web Services Support. For more information,\n see Amazon EFS\n quotas that you can increase in the Amazon EFS User\n Guide.
An enum value representing possible filter fields.
", + "smithy.api#documentation": "An enum value representing possible filter fields.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
Represents the field name used to sort the coverage details.
", + "smithy.api#documentation": "Represents the field name used to sort the coverage details.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
Removes the existing GuardDuty delegated\n administrator of the organization. Only the organization's management account can run this \n API operation.
", + "smithy.api#documentation": "Removes the existing GuardDuty delegated\n administrator of the organization. Only the organization's management account can run this \n API operation.
", "smithy.api#http": { "method": "POST", "uri": "/admin/disable", @@ -4179,7 +4191,7 @@ "AdminAccountId": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.
", + "smithy.api#documentation": "The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.
", "smithy.api#jsonName": "adminAccountId", "smithy.api#required": {} } @@ -4349,7 +4361,7 @@ "CriterionKey": { "target": "com.amazonaws.guardduty#CriterionKey", "traits": { - "smithy.api#documentation": "An enum value representing possible scan properties to match with given scan\n entries.
", + "smithy.api#documentation": "An enum value representing possible scan properties to match with given scan\n entries.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
Contains information about the finding, which is generated when abnormal or suspicious\n activity is detected.
" + "smithy.api#documentation": "Contains information about the finding that is generated when abnormal or suspicious\n activity is detected.
" } }, "com.amazonaws.guardduty#FindingCriteria": { @@ -7515,7 +7527,7 @@ } ], "traits": { - "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using organizations to manager your GuardDuty environment, this step is not \n needed. For more information, see Managing accounts with organizations.
\nTo invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.
", + "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not\n needed. For more information, see Managing accounts with organizations.
\nTo invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/invite", @@ -8747,7 +8759,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the accounts configured as GuardDuty delegated administrators. \n Only the organization's management account can run this \n API operation.
", + "smithy.api#documentation": "Lists the accounts designated as GuardDuty delegated administrators. \n Only the organization's management account can run this \n API operation.
", "smithy.api#http": { "method": "GET", "uri": "/admin", @@ -8915,7 +8927,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. \n When invoked, this\n operation returns all assigned tags for a given resource.
", + "smithy.api#documentation": "Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. \n When invoked, this\n operation returns all assigned tags for a given resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -9999,7 +10011,7 @@ "AutoEnable": { "target": "com.amazonaws.guardduty#OrgFeatureStatus", "traits": { - "smithy.api#documentation": "The status of the feature that will be configured for the organization. Use one of the following \n values to configure the feature status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the feature will not be automatically enabled for any\n account in the organization. The administrator must manage the feature for each account \n individually.
Describes the status of the feature that is configured for the\n member accounts within the organization. One of the following \n values is the status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the feature will not be \n automatically enabled for any\n account in the organization. The administrator must manage the feature\n for each account individually.
Represents key\n in the map condition.
", + "smithy.api#documentation": "Represents the key in the map condition.
", "smithy.api#jsonName": "key", "smithy.api#required": {} } @@ -11286,13 +11298,13 @@ "Value": { "target": "com.amazonaws.guardduty#TagValue", "traits": { - "smithy.api#documentation": "Represents optional value\n in the map\n condition. If not specified, only key\n will be\n matched.
", + "smithy.api#documentation": "Represents optional value in the map\n condition. If not specified, only the key will be\n matched.
", "smithy.api#jsonName": "value" } } }, "traits": { - "smithy.api#documentation": "Represents key, value pair to be matched against given resource property.
" + "smithy.api#documentation": "Represents the key:value pair to be matched against given resource property.
Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not \n both.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/admin", @@ -13088,7 +13100,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use AutoEnableOrganizationMembers instead" }, - "smithy.api#documentation": "Indicates whether to automatically enable member accounts in the organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results. You must provide the \n value for either autoEnableOrganizationMembers or autoEnable.
Represents whether or not to automatically enable member accounts in the organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results. You must provide a \n value for either autoEnableOrganizationMembers or autoEnable.
Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a \n value for either autoEnableOrganizationMembers or autoEnable.
Use one of the \n following configuration values for autoEnableOrganizationMembers:
\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in the organization\n individually.
Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
Use one of the \n following configuration values for autoEnableOrganizationMembers:
\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in the organization individually.