{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.docdb#AddSourceIdentifierToSubscription": { "type": "operation", "input": { "target": "com.amazonaws.docdb#AddSourceIdentifierToSubscriptionMessage" }, "output": { "target": "com.amazonaws.docdb#AddSourceIdentifierToSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.docdb#SourceNotFoundFault" }, { "target": "com.amazonaws.docdb#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Adds a source identifier to an existing event notification \n subscription.

" } }, "com.amazonaws.docdb#AddSourceIdentifierToSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the Amazon DocumentDB event notification subscription that you \n want to add a source identifier to.

", "smithy.api#required": {} } }, "SourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the event source to be added:

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

Represents the input to AddSourceIdentifierToSubscription.\n

" } }, "com.amazonaws.docdb#AddSourceIdentifierToSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.docdb#EventSubscription" } } }, "com.amazonaws.docdb#AddTagsToResource": { "type": "operation", "input": { "target": "com.amazonaws.docdb#AddTagsToResourceMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags \n with cost allocation reporting to track costs that are associated \n with Amazon DocumentDB resources. or in a Condition statement in \n an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

" } }, "com.amazonaws.docdb#AddTagsToResourceMessage": { "type": "structure", "members": { "ResourceName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon DocumentDB resource that the tags are added to. This value is an\n Amazon Resource Name .

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the Amazon DocumentDB resource.

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

Represents the input to AddTagsToResource.\n

" } }, "com.amazonaws.docdb#AmazonRDSv19": { "type": "service", "version": "2014-10-31", "operations": [ { "target": "com.amazonaws.docdb#AddSourceIdentifierToSubscription" }, { "target": "com.amazonaws.docdb#AddTagsToResource" }, { "target": "com.amazonaws.docdb#ApplyPendingMaintenanceAction" }, { "target": "com.amazonaws.docdb#CopyDBClusterParameterGroup" }, { "target": "com.amazonaws.docdb#CopyDBClusterSnapshot" }, { "target": "com.amazonaws.docdb#CreateDBCluster" }, { "target": "com.amazonaws.docdb#CreateDBClusterParameterGroup" }, { "target": "com.amazonaws.docdb#CreateDBClusterSnapshot" }, { "target": "com.amazonaws.docdb#CreateDBInstance" }, { "target": "com.amazonaws.docdb#CreateDBSubnetGroup" }, { "target": "com.amazonaws.docdb#CreateEventSubscription" }, { "target": "com.amazonaws.docdb#DeleteDBCluster" }, { "target": "com.amazonaws.docdb#DeleteDBClusterParameterGroup" }, { "target": "com.amazonaws.docdb#DeleteDBClusterSnapshot" }, { "target": "com.amazonaws.docdb#DeleteDBInstance" }, { "target": "com.amazonaws.docdb#DeleteDBSubnetGroup" }, { "target": "com.amazonaws.docdb#DeleteEventSubscription" }, { "target": "com.amazonaws.docdb#DescribeCertificates" }, { "target": "com.amazonaws.docdb#DescribeDBClusterParameterGroups" }, { "target": "com.amazonaws.docdb#DescribeDBClusterParameters" }, { "target": "com.amazonaws.docdb#DescribeDBClusters" }, { "target": "com.amazonaws.docdb#DescribeDBClusterSnapshotAttributes" }, { "target": "com.amazonaws.docdb#DescribeDBClusterSnapshots" }, { "target": "com.amazonaws.docdb#DescribeDBEngineVersions" }, { "target": "com.amazonaws.docdb#DescribeDBInstances" }, { "target": "com.amazonaws.docdb#DescribeDBSubnetGroups" }, { "target": "com.amazonaws.docdb#DescribeEngineDefaultClusterParameters" }, { "target": "com.amazonaws.docdb#DescribeEventCategories" }, { "target": "com.amazonaws.docdb#DescribeEvents" }, { "target": "com.amazonaws.docdb#DescribeEventSubscriptions" }, { "target": "com.amazonaws.docdb#DescribeOrderableDBInstanceOptions" }, { "target": "com.amazonaws.docdb#DescribePendingMaintenanceActions" }, { "target": "com.amazonaws.docdb#FailoverDBCluster" }, { "target": "com.amazonaws.docdb#ListTagsForResource" }, { "target": "com.amazonaws.docdb#ModifyDBCluster" }, { "target": "com.amazonaws.docdb#ModifyDBClusterParameterGroup" }, { "target": "com.amazonaws.docdb#ModifyDBClusterSnapshotAttribute" }, { "target": "com.amazonaws.docdb#ModifyDBInstance" }, { "target": "com.amazonaws.docdb#ModifyDBSubnetGroup" }, { "target": "com.amazonaws.docdb#ModifyEventSubscription" }, { "target": "com.amazonaws.docdb#RebootDBInstance" }, { "target": "com.amazonaws.docdb#RemoveSourceIdentifierFromSubscription" }, { "target": "com.amazonaws.docdb#RemoveTagsFromResource" }, { "target": "com.amazonaws.docdb#ResetDBClusterParameterGroup" }, { "target": "com.amazonaws.docdb#RestoreDBClusterFromSnapshot" }, { "target": "com.amazonaws.docdb#RestoreDBClusterToPointInTime" }, { "target": "com.amazonaws.docdb#StartDBCluster" }, { "target": "com.amazonaws.docdb#StopDBCluster" } ], "traits": { "aws.api#service": { "sdkId": "DocDB", "arnNamespace": "rds", "cloudFormationName": "DocDB", "cloudTrailEventSource": "docdb.amazonaws.com" }, "aws.auth#sigv4": { "name": "rds" }, "aws.protocols#awsQuery": {}, "smithy.api#documentation": "

Amazon DocumentDB API documentation

", "smithy.api#title": "Amazon DocumentDB with MongoDB compatibility", "smithy.api#xmlNamespace": { "uri": "http://rds.amazonaws.com/doc/2014-10-31/" } } }, "com.amazonaws.docdb#ApplyMethod": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "immediate" }, { "value": "pending-reboot" } ] } }, "com.amazonaws.docdb#ApplyPendingMaintenanceAction": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ApplyPendingMaintenanceActionMessage" }, "output": { "target": "com.amazonaws.docdb#ApplyPendingMaintenanceActionResult" }, "errors": [ { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.docdb#ResourceNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, \n to an Amazon DocumentDB instance).

" } }, "com.amazonaws.docdb#ApplyPendingMaintenanceActionMessage": { "type": "structure", "members": { "ResourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that the pending \n maintenance action applies to.

", "smithy.api#required": {} } }, "ApplyAction": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade\n

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

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

\n

Valid values:

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

Represents the input to ApplyPendingMaintenanceAction.\n

" } }, "com.amazonaws.docdb#ApplyPendingMaintenanceActionResult": { "type": "structure", "members": { "ResourcePendingMaintenanceActions": { "target": "com.amazonaws.docdb#ResourcePendingMaintenanceActions" } } }, "com.amazonaws.docdb#AttributeValueList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#xmlName": "AttributeValue" } } }, "com.amazonaws.docdb#AuthorizationNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified CIDR IP or Amazon EC2 security group isn't authorized for the\n specified security group.

\n

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf\n using IAM.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#AvailabilityZone": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the Availability Zone.

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

Information about an Availability Zone.

" } }, "com.amazonaws.docdb#AvailabilityZoneList": { "type": "list", "member": { "target": "com.amazonaws.docdb#AvailabilityZone", "traits": { "smithy.api#xmlName": "AvailabilityZone" } } }, "com.amazonaws.docdb#AvailabilityZones": { "type": "list", "member": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#xmlName": "AvailabilityZone" } } }, "com.amazonaws.docdb#Boolean": { "type": "boolean" }, "com.amazonaws.docdb#BooleanOptional": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.docdb#Certificate": { "type": "structure", "members": { "CertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The unique key that identifies a certificate.

\n

Example: rds-ca-2019\n

" } }, "CertificateType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The type of the certificate.

\n

Example: CA\n

" } }, "Thumbprint": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The thumbprint of the certificate.

" } }, "ValidFrom": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The starting date-time from which the certificate is valid.

\n

Example: 2019-07-31T17:57:09Z\n

" } }, "ValidTill": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The date-time after which the certificate is no longer valid.

\n

Example: 2024-07-31T17:57:09Z\n

" } }, "CertificateArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

\n

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019\n

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

A certificate authority (CA) certificate for an AWS account.

" } }, "com.amazonaws.docdb#CertificateList": { "type": "list", "member": { "target": "com.amazonaws.docdb#Certificate", "traits": { "smithy.api#xmlName": "Certificate" } } }, "com.amazonaws.docdb#CertificateMessage": { "type": "structure", "members": { "Certificates": { "target": "com.amazonaws.docdb#CertificateList", "traits": { "smithy.api#documentation": "

A list of certificates for this AWS account.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided if the number of records retrieved is greater than\n MaxRecords. If this parameter is specified, the marker specifies the next record\n in the list. Including the value of Marker in the next call to \n DescribeCertificates results in the next page of certificates.

" } } } }, "com.amazonaws.docdb#CertificateNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an existing certificate.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#CloudwatchLogsExportConfiguration": { "type": "structure", "members": { "EnableLogTypes": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

The list of log types to enable.

" } }, "DisableLogTypes": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

The list of log types to disable.

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

The configuration setting for the log types to be enabled for export to Amazon\n CloudWatch Logs for a specific instance or cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine\n which logs are exported (or not exported) to CloudWatch Logs. The values within these\n arrays depend on the engine that is being used.

" } }, "com.amazonaws.docdb#CopyDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CopyDBClusterParameterGroupMessage" }, "output": { "target": "com.amazonaws.docdb#CopyDBClusterParameterGroupResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBParameterGroupQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Copies the specified cluster parameter group.

" } }, "com.amazonaws.docdb#CopyDBClusterParameterGroupMessage": { "type": "structure", "members": { "SourceDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source cluster\n parameter group.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "TargetDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier for the copied cluster parameter group.

\n

Constraints:

\n \n

Example: my-cluster-param-group1\n

", "smithy.api#required": {} } }, "TargetDBClusterParameterGroupDescription": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

A description for the copied cluster parameter group.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags that are to be assigned to the parameter group.

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

Represents the input to CopyDBClusterParameterGroup.\n

" } }, "com.amazonaws.docdb#CopyDBClusterParameterGroupResult": { "type": "structure", "members": { "DBClusterParameterGroup": { "target": "com.amazonaws.docdb#DBClusterParameterGroup" } } }, "com.amazonaws.docdb#CopyDBClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CopyDBClusterSnapshotMessage" }, "output": { "target": "com.amazonaws.docdb#CopyDBClusterSnapshotResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.docdb#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Copies a snapshot of a cluster.

\n \n

To copy a cluster snapshot from a shared manual cluster snapshot,\n SourceDBClusterSnapshotIdentifier must be the Amazon \n Resource Name (ARN) of the shared cluster snapshot. You can only \n copy a shared DB cluster snapshot, whether encrypted or not, in the \n same AWS Region.

\n \n

To cancel the copy operation after it is in progress, delete the \n target cluster snapshot identified by \n TargetDBClusterSnapshotIdentifier while that cluster \n snapshot is in the copying status.

" } }, "com.amazonaws.docdb#CopyDBClusterSnapshotMessage": { "type": "structure", "members": { "SourceDBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the cluster snapshot to copy. This parameter is\n not case sensitive.

\n \n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", "smithy.api#required": {} } }, "TargetDBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the new cluster snapshot to create from the \n source cluster snapshot. This parameter is not case sensitive.

\n

Constraints:

\n \n

Example: my-cluster-snapshot2\n

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS\n key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or\n the AWS KMS key alias for the AWS KMS encryption key.

\n \n

If you copy an encrypted cluster snapshot from your AWS account, \n you can specify a value for KmsKeyId to encrypt the \n copy with a new AWS KMS encryption key. If you don't specify a value\n for KmsKeyId, then the copy of the cluster snapshot is \n encrypted with the same AWS KMS key as the source cluster snapshot.\n

\n \n

If you copy an encrypted cluster snapshot that is shared from \n another AWS account, then you must specify a value for \n KmsKeyId.

\n \n \n

To copy an encrypted cluster snapshot to another AWS Region, set\n KmsKeyId to the AWS KMS key ID that you want to use to \n encrypt the copy of the cluster snapshot in the destination Region. \n AWS KMS encryption keys are specific to the AWS Region that they are \n created in, and you can't use encryption keys from one AWS Region in \n another AWS Region.

\n \n

If you copy an unencrypted cluster snapshot and specify a value \n for the KmsKeyId parameter, an error is returned.

" } }, "PreSignedUrl": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API action in the AWS Region that \n contains the source cluster snapshot to copy. You must use the \n PreSignedUrl parameter when copying a cluster snapshot\n from another AWS Region.

\n \n

If you are using an AWS SDK tool or the AWS CLI, you can specify \n SourceRegion (or --source-region for the\n AWS CLI) instead of specifying PreSignedUrl manually. \n Specifying SourceRegion autogenerates a pre-signed URL \n that is a valid request for the operation that can be executed in\n the source AWS Region.

\n \n

The presigned URL must be a valid request for the \n CopyDBClusterSnapshot API action that can be executed \n in the source AWS Region that contains the cluster snapshot to be \n copied. The presigned URL request must contain the following\n parameter values:

\n " } }, "CopyTags": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { "smithy.api#documentation": "

Set to true to copy all tags from the source cluster \n snapshot to the target cluster snapshot, and otherwise \n false. The default is false.

" } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the cluster snapshot.

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

Represents the input to CopyDBClusterSnapshot.\n

" } }, "com.amazonaws.docdb#CopyDBClusterSnapshotResult": { "type": "structure", "members": { "DBClusterSnapshot": { "target": "com.amazonaws.docdb#DBClusterSnapshot" } } }, "com.amazonaws.docdb#CreateDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CreateDBClusterMessage" }, "output": { "target": "com.amazonaws.docdb#CreateDBClusterResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBClusterParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBClusterQuotaExceededFault" }, { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InsufficientStorageClusterCapacityFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBSubnetGroupStateFault" }, { "target": "com.amazonaws.docdb#InvalidSubnet" }, { "target": "com.amazonaws.docdb#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.docdb#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.docdb#StorageQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Creates a new Amazon DocumentDB cluster.

" } }, "com.amazonaws.docdb#CreateDBClusterMessage": { "type": "structure", "members": { "AvailabilityZones": { "target": "com.amazonaws.docdb#AvailabilityZones", "traits": { "smithy.api#documentation": "

A list of Amazon EC2 Availability Zones that instances in the \n cluster can be created in.

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The number of days for which automated backups are retained. You \n must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " } }, "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n \n

Example: my-cluster\n

", "smithy.api#required": {} } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group to associate with this \n cluster.

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

A list of EC2 VPC security groups to associate with this cluster.\n

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

A subnet group to associate with this cluster.

\n

Constraints: Must match the name of an existing \n DBSubnetGroup. Must not be default.

\n

Example: mySubnetgroup\n

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

The name of the database engine to be used for this cluster.

\n

Valid values: docdb\n

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

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

" } }, "Port": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The port number on which the instances in the cluster accept \n connections.

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

The name of the master user for the cluster.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "MasterUserPassword": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The password for the master database user. This password can \n contain any printable ASCII character except forward slash (/), \n double quote (\"), or the \"at\" symbol (@).

\n

Constraints: Must contain from 8 to 100 characters.

", "smithy.api#required": {} } }, "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created if\n automated backups are enabled using the \n BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour\n block of time for each AWS Region.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, \n in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour\n block of time for each AWS Region, occurring on a random day of the \n week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the cluster.

" } }, "StorageEncrypted": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { "smithy.api#documentation": "

Specifies whether the cluster is encrypted.

" } }, "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted cluster.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for \n the AWS KMS encryption key. If you are creating a cluster using the\n same AWS account that owns the AWS KMS encryption key that is used \n to encrypt the new cluster, you can use the AWS KMS key alias \n instead of the ARN for the AWS KMS encryption key.

\n

If an encryption key is not specified in KmsKeyId:\n

\n \n

AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS\n Region.

" } }, "PreSignedUrl": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Not currently supported.\n

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

A list of log types that need to be enabled for exporting to Amazon \n CloudWatch Logs. You can enable audit logs or profiler logs. For more \n information, see \n Auditing Amazon DocumentDB Events \n and \n Profiling Amazon DocumentDB Operations.\n

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

Specifies whether this cluster can be deleted. If \n DeletionProtection is enabled, the cluster cannot be \n deleted unless it is modified and DeletionProtection is \n disabled. DeletionProtection protects clusters from \n being accidentally deleted.

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

Represents the input to CreateDBCluster.\n

" } }, "com.amazonaws.docdb#CreateDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CreateDBClusterParameterGroupMessage" }, "output": { "target": "com.amazonaws.docdb#CreateDBClusterParameterGroupResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBParameterGroupQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Creates a new cluster parameter group.

\n

Parameters in a cluster parameter group apply to all of the \n instances in a cluster.

\n

A cluster parameter group is initially created with the default \n parameters for the database engine used by instances in the cluster.\n In Amazon DocumentDB, you cannot make modifications directly to the \n default.docdb3.6 cluster parameter group. If your \n Amazon DocumentDB cluster is using the default cluster parameter group and you\n want to modify a value in it, you must first \n create a new parameter group\n or \n copy an existing parameter group,\n modify it, and then apply the modified parameter group to your \n cluster. For the new cluster parameter group and associated settings\n to take effect, you must then reboot the instances in the cluster \n without failover. For more information,\n see \n Modifying Amazon DocumentDB Cluster Parameter Groups.\n

" } }, "com.amazonaws.docdb#CreateDBClusterParameterGroupMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n
", "smithy.api#required": {} } }, "DBParameterGroupFamily": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The cluster parameter group family name.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The description for the cluster parameter group.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the cluster parameter group.

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

Represents the input of CreateDBClusterParameterGroup.

" } }, "com.amazonaws.docdb#CreateDBClusterParameterGroupResult": { "type": "structure", "members": { "DBClusterParameterGroup": { "target": "com.amazonaws.docdb#DBClusterParameterGroup" } } }, "com.amazonaws.docdb#CreateDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#CreateDBClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CreateDBClusterSnapshotMessage" }, "output": { "target": "com.amazonaws.docdb#CreateDBClusterSnapshotResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBClusterSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Creates a snapshot of a cluster.

" } }, "com.amazonaws.docdb#CreateDBClusterSnapshotMessage": { "type": "structure", "members": { "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the cluster snapshot. This parameter is stored \n as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

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

The identifier of the cluster to create a snapshot for. This \n parameter is not case sensitive.

\n

Constraints:

\n \n

Example: my-cluster\n

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the cluster snapshot.

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

Represents the input of CreateDBClusterSnapshot.

" } }, "com.amazonaws.docdb#CreateDBClusterSnapshotResult": { "type": "structure", "members": { "DBClusterSnapshot": { "target": "com.amazonaws.docdb#DBClusterSnapshot" } } }, "com.amazonaws.docdb#CreateDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CreateDBInstanceMessage" }, "output": { "target": "com.amazonaws.docdb#CreateDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.docdb#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InstanceQuotaExceededFault" }, { "target": "com.amazonaws.docdb#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidSubnet" }, { "target": "com.amazonaws.docdb#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.docdb#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.docdb#StorageQuotaExceededFault" }, { "target": "com.amazonaws.docdb#StorageTypeNotSupportedFault" } ], "traits": { "smithy.api#documentation": "

Creates a new instance.

" } }, "com.amazonaws.docdb#CreateDBInstanceMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", "smithy.api#required": {} } }, "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The compute and memory capacity of the instance; for example,\n db.r5.large.

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

The name of the database engine to be used for this instance.

\n

Valid value: docdb\n

", "smithy.api#required": {} } }, "AvailabilityZone": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon EC2 Availability Zone that the instance is created in.

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

Example: us-east-1d\n

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The time range each week during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

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

Indicates that minor engine upgrades are applied automatically to the instance\n during the maintenance window.

\n

Default: true\n

" } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the instance. You can assign up to \n 10 tags to an instance.

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

The identifier of the cluster that the instance will belong to.

", "smithy.api#required": {} } }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

\n

Default: 1

\n

Valid values: 0-15

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

Represents the input to CreateDBInstance.

" } }, "com.amazonaws.docdb#CreateDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.docdb#DBInstance" } } }, "com.amazonaws.docdb#CreateDBSubnetGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CreateDBSubnetGroupMessage" }, "output": { "target": "com.amazonaws.docdb#CreateDBSubnetGroupResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBSubnetGroupAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.docdb#DBSubnetGroupQuotaExceededFault" }, { "target": "com.amazonaws.docdb#DBSubnetQuotaExceededFault" }, { "target": "com.amazonaws.docdb#InvalidSubnet" } ], "traits": { "smithy.api#documentation": "

Creates a new subnet group. subnet groups must contain at least one subnet in at\n least two Availability Zones in the AWS Region.

" } }, "com.amazonaws.docdb#CreateDBSubnetGroupMessage": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name for the subnet group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 letters, numbers, periods, underscores,\n spaces, or hyphens. Must not be default.

\n

Example: mySubnetgroup\n

", "smithy.api#required": {} } }, "DBSubnetGroupDescription": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The description for the subnet group.

", "smithy.api#required": {} } }, "SubnetIds": { "target": "com.amazonaws.docdb#SubnetIdentifierList", "traits": { "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the subnet group.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the subnet group.

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

Represents the input to CreateDBSubnetGroup.

" } }, "com.amazonaws.docdb#CreateDBSubnetGroupResult": { "type": "structure", "members": { "DBSubnetGroup": { "target": "com.amazonaws.docdb#DBSubnetGroup" } } }, "com.amazonaws.docdb#CreateEventSubscription": { "type": "operation", "input": { "target": "com.amazonaws.docdb#CreateEventSubscriptionMessage" }, "output": { "target": "com.amazonaws.docdb#CreateEventSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.docdb#EventSubscriptionQuotaExceededFault" }, { "target": "com.amazonaws.docdb#SNSInvalidTopicFault" }, { "target": "com.amazonaws.docdb#SNSNoAuthorizationFault" }, { "target": "com.amazonaws.docdb#SNSTopicArnNotFoundFault" }, { "target": "com.amazonaws.docdb#SourceNotFoundFault" }, { "target": "com.amazonaws.docdb#SubscriptionAlreadyExistFault" }, { "target": "com.amazonaws.docdb#SubscriptionCategoryNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon DocumentDB event notification subscription. This action requires a topic\n Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console,\n or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in\n Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS\n console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds)\n that trigger the events, and you can provide a list of event categories\n (EventCategories) for events that you want to be notified of. For\n example, you can specify SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds (such as\n SourceType = db-instance and SourceIdentifier =\n myDBInstance1), you are notified of all the db-instance events\n for the specified source. If you specify a SourceType but do not specify a\n SourceIdentifier, you receive notice of the events for that source type\n for all your Amazon DocumentDB sources. If you do not specify either the SourceType\n or the SourceIdentifier, you are notified of events generated from all\n Amazon DocumentDB sources belonging to your customer account.

" } }, "com.amazonaws.docdb#CreateEventSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be fewer than 255 characters.

", "smithy.api#required": {} } }, "SnsTopicArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon\n SNS creates the ARN when you create a topic and subscribe to it.

", "smithy.api#required": {} } }, "SourceType": { "target": "com.amazonaws.docdb#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 an instance, you would set this parameter to\n db-instance. If this value is not specified, all events are\n returned.

\n

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

" } }, "EventCategories": { "target": "com.amazonaws.docdb#EventCategoriesList", "traits": { "smithy.api#documentation": "

A list of event categories for a SourceType that you want to subscribe\n to.

" } }, "SourceIds": { "target": "com.amazonaws.docdb#SourceIdsList", "traits": { "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not\n specified, then all sources are included in the response. An identifier must begin with\n a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a\n hyphen or contain two consecutive hyphens.

\n

Constraints:

\n " } }, "Enabled": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { "smithy.api#documentation": "

A Boolean value; set to true to activate the subscription, set to\n false to create the subscription but not active it.

" } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the event subscription.

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

Represents the input to CreateEventSubscription.

" } }, "com.amazonaws.docdb#CreateEventSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.docdb#EventSubscription" } } }, "com.amazonaws.docdb#DBCluster": { "type": "structure", "members": { "AvailabilityZones": { "target": "com.amazonaws.docdb#AvailabilityZones", "traits": { "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the cluster\n can be created in.

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

Specifies the number of days for which automatic snapshots are retained.

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

Contains a user-supplied cluster identifier. This identifier is the unique key that\n identifies a cluster.

" } }, "DBClusterParameterGroup": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the name of the cluster parameter group for the cluster.

" } }, "DBSubnetGroup": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the cluster,\n including the name, description, and subnets in the subnet group.

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

Specifies the current state of this cluster.

" } }, "PercentProgress": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" } }, "EarliestRestorableTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" } }, "Endpoint": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the cluster.

" } }, "ReaderEndpoint": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The reader endpoint for the cluster. The reader endpoint for a cluster load\n balances connections across the Amazon DocumentDB replicas that are available in a cluster. As\n clients request new connections to the reader endpoint, Amazon DocumentDB distributes the\n connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can\n help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

\n

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to\n be the primary instance, your connection is dropped. To continue sending your read\n workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader\n endpoint.

" } }, "MultiAZ": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the cluster has instances in multiple Availability Zones.

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

Provides the name of the database engine to be used for this cluster.

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

Indicates the database engine version.

" } }, "LatestRestorableTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" } }, "Port": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

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

Contains the master user name for the cluster.

" } }, "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if automated\n backups are enabled, as determined by the BackupRetentionPeriod.

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in\n Universal Coordinated Time (UTC).

" } }, "DBClusterMembers": { "target": "com.amazonaws.docdb#DBClusterMemberList", "traits": { "smithy.api#documentation": "

Provides the list of instances that make up the cluster.

" } }, "VpcSecurityGroups": { "target": "com.amazonaws.docdb#VpcSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "

Provides a list of virtual private cloud (VPC) security groups that the cluster\n belongs to.

" } }, "HostedZoneId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" } }, "StorageEncrypted": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the cluster is encrypted.

" } }, "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster.

" } }, "DbClusterResourceId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the cluster. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is\n accessed.

" } }, "DBClusterArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cluster.

" } }, "AssociatedRoles": { "target": "com.amazonaws.docdb#DBClusterRoles", "traits": { "smithy.api#documentation": "

Provides a list of the AWS Identity and Access Management (IAM) roles that are\n associated with the cluster. IAM roles that are associated with a cluster grant\n permission for the cluster to access other AWS services on your behalf.

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

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

" } }, "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

A list of log types that this cluster is configured to export to Amazon CloudWatch\n Logs.

" } }, "DeletionProtection": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

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

Detailed information about a cluster.

" } }, "com.amazonaws.docdb#DBClusterAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You already have a cluster with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBClusterList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBCluster", "traits": { "smithy.api#xmlName": "DBCluster" } } }, "com.amazonaws.docdb#DBClusterMember": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the instance identifier for this member of the cluster.

" } }, "IsClusterWriter": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A value that is true if the cluster member is the primary instance for\n the cluster and false otherwise.

" } }, "DBClusterParameterGroupStatus": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the status of the cluster parameter group for this member of the DB\n cluster.

" } }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

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

Contains information about an instance that is part of a cluster.

" } }, "com.amazonaws.docdb#DBClusterMemberList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBClusterMember", "traits": { "smithy.api#xmlName": "DBClusterMember" } } }, "com.amazonaws.docdb#DBClusterMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBClusters": { "target": "com.amazonaws.docdb#DBClusterList", "traits": { "smithy.api#documentation": "

A list of clusters.

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

Represents the output of DescribeDBClusters.

" } }, "com.amazonaws.docdb#DBClusterNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBClusterParameterGroup": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Provides the name of the cluster parameter group.

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

Provides the name of the parameter group family that this cluster parameter\n group is compatible with.

" } }, "Description": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Provides the customer-specified description for this cluster parameter\n group.

" } }, "DBClusterParameterGroupArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cluster parameter group.

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

Detailed information about a cluster parameter group.

" } }, "com.amazonaws.docdb#DBClusterParameterGroupDetails": { "type": "structure", "members": { "Parameters": { "target": "com.amazonaws.docdb#ParametersList", "traits": { "smithy.api#documentation": "

Provides a list of parameters for the cluster parameter group.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the output of DBClusterParameterGroup.

" } }, "com.amazonaws.docdb#DBClusterParameterGroupList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBClusterParameterGroup", "traits": { "smithy.api#xmlName": "DBClusterParameterGroup" } } }, "com.amazonaws.docdb#DBClusterParameterGroupNameMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of a cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

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

Contains the name of a cluster parameter group.

" } }, "com.amazonaws.docdb#DBClusterParameterGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing cluster\n parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBClusterParameterGroupsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBClusterParameterGroups": { "target": "com.amazonaws.docdb#DBClusterParameterGroupList", "traits": { "smithy.api#documentation": "

A list of cluster parameter groups.

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

Represents the output of DBClusterParameterGroups.

" } }, "com.amazonaws.docdb#DBClusterQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The cluster can't be created because you have reached the maximum allowed quota of\n clusters.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.docdb#DBClusterRole": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n cluster.

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

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

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

Describes an AWS Identity and Access Management (IAM) role that is associated with a\n cluster.

" } }, "com.amazonaws.docdb#DBClusterRoles": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBClusterRole", "traits": { "smithy.api#xmlName": "DBClusterRole" } } }, "com.amazonaws.docdb#DBClusterSnapshot": { "type": "structure", "members": { "AvailabilityZones": { "target": "com.amazonaws.docdb#AvailabilityZones", "traits": { "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the cluster\n snapshot can be restored in.

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

Specifies the identifier for the cluster snapshot.

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

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

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

Provides the time when the snapshot was taken, in UTC.

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

Specifies the name of the database engine.

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

Specifies the status of this cluster snapshot.

" } }, "Port": { "target": "com.amazonaws.docdb#Integer", "traits": { "smithy.api#documentation": "

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

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

Provides the virtual private cloud (VPC) ID that is associated with the cluster\n snapshot.

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

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

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

Provides the master user name for the cluster snapshot.

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

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

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

Provides the type of the cluster snapshot.

" } }, "PercentProgress": { "target": "com.amazonaws.docdb#Integer", "traits": { "smithy.api#documentation": "

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

" } }, "StorageEncrypted": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the cluster snapshot is encrypted.

" } }, "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster snapshot.

" } }, "DBClusterSnapshotArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

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

" } }, "SourceDBClusterSnapshotArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

If the cluster snapshot was copied from a source cluster snapshot, the ARN for\n the source cluster snapshot; otherwise, a null value.

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

Detailed information about a cluster snapshot.

" } }, "com.amazonaws.docdb#DBClusterSnapshotAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You already have a cluster snapshot with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBClusterSnapshotAttribute": { "type": "structure", "members": { "AttributeName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the manual cluster snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that have\n permission to copy or restore the manual cluster snapshot.

" } }, "AttributeValues": { "target": "com.amazonaws.docdb#AttributeValueList", "traits": { "smithy.api#documentation": "

The values for the manual cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this\n element returns a list of IDs of the AWS accounts that are authorized to copy or restore\n the manual cluster snapshot. If a value of all is in the list, then the\n manual cluster snapshot is public and available for any AWS account to copy or\n restore.

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

Contains the name and values of a manual cluster snapshot attribute.

\n

Manual cluster snapshot attributes are used to authorize other AWS accounts to\n restore a manual cluster snapshot.

" } }, "com.amazonaws.docdb#DBClusterSnapshotAttributeList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBClusterSnapshotAttribute", "traits": { "smithy.api#xmlName": "DBClusterSnapshotAttribute" } } }, "com.amazonaws.docdb#DBClusterSnapshotAttributesResult": { "type": "structure", "members": { "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the cluster snapshot that the attributes apply to.

" } }, "DBClusterSnapshotAttributes": { "target": "com.amazonaws.docdb#DBClusterSnapshotAttributeList", "traits": { "smithy.api#documentation": "

The list of attributes and values for the cluster snapshot.

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

Detailed information about the attributes that are associated with a cluster\n snapshot.

" } }, "com.amazonaws.docdb#DBClusterSnapshotList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBClusterSnapshot", "traits": { "smithy.api#xmlName": "DBClusterSnapshot" } } }, "com.amazonaws.docdb#DBClusterSnapshotMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBClusterSnapshots": { "target": "com.amazonaws.docdb#DBClusterSnapshotList", "traits": { "smithy.api#documentation": "

Provides a list of cluster snapshots.

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

Represents the output of DescribeDBClusterSnapshots.

" } }, "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing cluster\n snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBEngineVersion": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the database engine.

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

The version number of the database engine.

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

The name of the parameter group family for the database engine.

" } }, "DBEngineDescription": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The description of the database engine.

" } }, "DBEngineVersionDescription": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The description of the database engine version.

" } }, "ValidUpgradeTarget": { "target": "com.amazonaws.docdb#ValidUpgradeTargetList", "traits": { "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" } }, "ExportableLogTypes": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

The types of logs that the database engine has available for export to Amazon\n CloudWatch Logs.

" } }, "SupportsLogExportsToCloudwatchLogs": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

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

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

Detailed information about an engine version.

" } }, "com.amazonaws.docdb#DBEngineVersionList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBEngineVersion", "traits": { "smithy.api#xmlName": "DBEngineVersion" } } }, "com.amazonaws.docdb#DBEngineVersionMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBEngineVersions": { "target": "com.amazonaws.docdb#DBEngineVersionList", "traits": { "smithy.api#documentation": "

Detailed information about one or more engine versions.

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

Represents the output of DescribeDBEngineVersions.

" } }, "com.amazonaws.docdb#DBInstance": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Contains a user-provided database identifier. This identifier is the unique key that\n identifies an instance.

" } }, "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the instance.

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

Provides the name of the database engine to be used for this instance.

" } }, "DBInstanceStatus": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the current state of this database.

" } }, "Endpoint": { "target": "com.amazonaws.docdb#Endpoint", "traits": { "smithy.api#documentation": "

Specifies the connection endpoint.

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

Provides the date and time that the instance was created.

" } }, "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if\n automated backups are enabled, as determined by the BackupRetentionPeriod.\n

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.docdb#Integer", "traits": { "smithy.api#documentation": "

Specifies the number of days for which automatic snapshots are retained.

" } }, "VpcSecurityGroups": { "target": "com.amazonaws.docdb#VpcSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "

Provides a list of VPC security group elements that the instance belongs to.

" } }, "AvailabilityZone": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the name of the Availability Zone that the instance is located in.

" } }, "DBSubnetGroup": { "target": "com.amazonaws.docdb#DBSubnetGroup", "traits": { "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the instance,\n including the name, description, and subnets in the subnet group.

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in\n Universal Coordinated Time (UTC).

" } }, "PendingModifiedValues": { "target": "com.amazonaws.docdb#PendingModifiedValues", "traits": { "smithy.api#documentation": "

Specifies that changes to the instance are pending. This element is included only\n when changes are pending. Specific changes are identified by subelements.

" } }, "LatestRestorableTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

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

Indicates the database engine version.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Indicates that minor version patches are applied automatically.

" } }, "PubliclyAccessible": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Not supported. Amazon DocumentDB does not currently support public endpoints. The value \n of PubliclyAccessible is always false.

" } }, "StatusInfos": { "target": "com.amazonaws.docdb#DBInstanceStatusInfoList", "traits": { "smithy.api#documentation": "

The status of a read replica. If the instance is not a read replica, this is\n blank.

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

Contains the name of the cluster that the instance is a member of if the \n instance is a member of a cluster.

" } }, "StorageEncrypted": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether or not the instance is encrypted.

" } }, "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted instance.

" } }, "DbiResourceId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the instance. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is\n accessed.

" } }, "CACertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" } }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

" } }, "DBInstanceArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the instance.

" } }, "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

A list of log types that this instance is configured to export to Amazon CloudWatch\n Logs.

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

Detailed information about an instance.

" } }, "com.amazonaws.docdb#DBInstanceAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You already have a instance with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBInstanceList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBInstance", "traits": { "smithy.api#xmlName": "DBInstance" } } }, "com.amazonaws.docdb#DBInstanceMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBInstances": { "target": "com.amazonaws.docdb#DBInstanceList", "traits": { "smithy.api#documentation": "

Detailed information about one or more instances.

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

Represents the output of DescribeDBInstances.

" } }, "com.amazonaws.docdb#DBInstanceNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing instance.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBInstanceStatusInfo": { "type": "structure", "members": { "StatusType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

This value is currently \"read replication.\"

" } }, "Normal": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

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

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

Status of the instance. For a StatusType of read replica, the values\n can be replicating, error, stopped, or\n terminated.

" } }, "Message": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance is not in\n an error state, this value is blank.

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

Provides a list of status information for an instance.

" } }, "com.amazonaws.docdb#DBInstanceStatusInfoList": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBInstanceStatusInfo", "traits": { "smithy.api#xmlName": "DBInstanceStatusInfo" } } }, "com.amazonaws.docdb#DBParameterGroupAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

A parameter group with the same name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBParameterGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an existing parameter\n group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBParameterGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

This request would cause you to exceed the allowed number of parameter\n groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBSecurityGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing security group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBSnapshotAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBSnapshotIdentifier is already being used by an existing snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBSnapshotNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBSubnetGroup": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the subnet group.

" } }, "DBSubnetGroupDescription": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Provides the description of the subnet group.

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

Provides the virtual private cloud (VPC) ID of the subnet group.

" } }, "SubnetGroupStatus": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Provides the status of the subnet group.

" } }, "Subnets": { "target": "com.amazonaws.docdb#SubnetList", "traits": { "smithy.api#documentation": "

Detailed information about one or more subnets within a subnet group.

" } }, "DBSubnetGroupArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

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

Detailed information about a subnet group.

" } }, "com.amazonaws.docdb#DBSubnetGroupAlreadyExistsFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBSubnetGroupName is already being used by an existing subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBSubnetGroupDoesNotCoverEnoughAZs": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Subnets in the subnet group should cover at least two Availability Zones unless\n there is only one Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBSubnetGroupMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBSubnetGroups": { "target": "com.amazonaws.docdb#DBSubnetGroups", "traits": { "smithy.api#documentation": "

Detailed information about one or more subnet groups.

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

Represents the output of DescribeDBSubnetGroups.

" } }, "com.amazonaws.docdb#DBSubnetGroupNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#DBSubnetGroupQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request would cause you to exceed the allowed number of subnet groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBSubnetGroups": { "type": "list", "member": { "target": "com.amazonaws.docdb#DBSubnetGroup", "traits": { "smithy.api#xmlName": "DBSubnetGroup" } } }, "com.amazonaws.docdb#DBSubnetQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request would cause you to exceed the allowed number of subnets in a subnet\n group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DBUpgradeDependencyFailureFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The upgrade failed because a resource that the depends on can't be\n modified.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#DeleteDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DeleteDBClusterMessage" }, "output": { "target": "com.amazonaws.docdb#DeleteDBClusterResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBClusterSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Deletes a previously provisioned cluster. When you delete a cluster, all\n automated backups for that cluster are deleted and can't be recovered. Manual DB\n cluster snapshots of the specified cluster are not deleted.

\n

" } }, "com.amazonaws.docdb#DeleteDBClusterMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The cluster identifier for the cluster to be deleted. This parameter isn't case\n sensitive.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "SkipFinalSnapshot": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Determines whether a final cluster snapshot is created before the cluster is\n deleted. If true is specified, no cluster snapshot is created. If\n false is specified, a cluster snapshot is created before the DB\n cluster is deleted.

\n \n

If SkipFinalSnapshot is false, you must specify a\n FinalDBSnapshotIdentifier parameter.

\n
\n

Default: false\n

" } }, "FinalDBSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The cluster snapshot identifier of the new cluster snapshot created when\n SkipFinalSnapshot is set to false.

\n \n

Specifying this parameter and also setting the SkipFinalShapshot\n parameter to true results in an error.

\n
\n

Constraints:

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

Represents the input to DeleteDBCluster.

" } }, "com.amazonaws.docdb#DeleteDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DeleteDBClusterParameterGroupMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBParameterGroupStateFault" } ], "traits": { "smithy.api#documentation": "

Deletes a specified cluster parameter group. The cluster parameter group to be\n deleted can't be associated with any clusters.

" } }, "com.amazonaws.docdb#DeleteDBClusterParameterGroupMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group.

\n

Constraints:

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

Represents the input to DeleteDBClusterParameterGroup.

" } }, "com.amazonaws.docdb#DeleteDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#DeleteDBClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DeleteDBClusterSnapshotMessage" }, "output": { "target": "com.amazonaws.docdb#DeleteDBClusterSnapshotResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault" } ], "traits": { "smithy.api#documentation": "

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The cluster snapshot must be in the available state to be\n deleted.

\n
" } }, "com.amazonaws.docdb#DeleteDBClusterSnapshotMessage": { "type": "structure", "members": { "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the cluster snapshot to delete.

\n

Constraints: Must be the name of an existing cluster snapshot in the\n available state.

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

Represents the input to DeleteDBClusterSnapshot.

" } }, "com.amazonaws.docdb#DeleteDBClusterSnapshotResult": { "type": "structure", "members": { "DBClusterSnapshot": { "target": "com.amazonaws.docdb#DBClusterSnapshot" } } }, "com.amazonaws.docdb#DeleteDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DeleteDBInstanceMessage" }, "output": { "target": "com.amazonaws.docdb#DeleteDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSnapshotAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.docdb#SnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Deletes a previously provisioned instance.\n

" } }, "com.amazonaws.docdb#DeleteDBInstanceMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The instance identifier for the instance to be deleted. This parameter isn't\n case sensitive.

\n

Constraints:

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

Represents the input to DeleteDBInstance.

" } }, "com.amazonaws.docdb#DeleteDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.docdb#DBInstance" } } }, "com.amazonaws.docdb#DeleteDBSubnetGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DeleteDBSubnetGroupMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBSubnetGroupStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBSubnetStateFault" } ], "traits": { "smithy.api#documentation": "

Deletes a subnet group.

\n \n

The specified database subnet group must not be associated with any DB\n instances.

\n
" } }, "com.amazonaws.docdb#DeleteDBSubnetGroupMessage": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n
\n

Constraints:

\n

Must match the name of an existing DBSubnetGroup. Must not be\n default.

\n

Example: mySubnetgroup\n

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

Represents the input to DeleteDBSubnetGroup.

" } }, "com.amazonaws.docdb#DeleteEventSubscription": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DeleteEventSubscriptionMessage" }, "output": { "target": "com.amazonaws.docdb#DeleteEventSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.docdb#InvalidEventSubscriptionStateFault" }, { "target": "com.amazonaws.docdb#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Deletes an Amazon DocumentDB event notification subscription.

" } }, "com.amazonaws.docdb#DeleteEventSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the Amazon DocumentDB event notification subscription that you want to\n delete.

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

Represents the input to DeleteEventSubscription.

" } }, "com.amazonaws.docdb#DeleteEventSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.docdb#EventSubscription" } } }, "com.amazonaws.docdb#DescribeCertificates": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeCertificatesMessage" }, "output": { "target": "com.amazonaws.docdb#CertificateMessage" }, "errors": [ { "target": "com.amazonaws.docdb#CertificateNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for\n this AWS account.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Certificates", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeCertificatesMessage": { "type": "structure", "members": { "CertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information\n for only the specified certificate is returned. If this parameter is omitted, a list of\n up to MaxRecords certificates is returned. This parameter is not case\n sensitive.

\n

Constraints

\n " } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records \n exist than the specified MaxRecords value, a pagination token \n called a marker is included in the response so that the remaining results can \n be retrieved.

\n

Default: 100

\n

Constraints:

\n " } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeCertificates request. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.

" } } } }, "com.amazonaws.docdb#DescribeDBClusterParameterGroups": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBClusterParameterGroupsMessage" }, "output": { "target": "com.amazonaws.docdb#DBClusterParameterGroupsMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a\n DBClusterParameterGroupName parameter is specified, the list contains\n only the description of the specified cluster parameter group.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBClusterParameterGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeDBClusterParameterGroupsMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

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

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeDBClusterParameterGroups.

" } }, "com.amazonaws.docdb#DescribeDBClusterParameters": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBClusterParametersMessage" }, "output": { "target": "com.amazonaws.docdb#DBClusterParameterGroupDetails" }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns the detailed parameter list for a particular cluster parameter\n group.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Parameters", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeDBClusterParametersMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of a specific cluster parameter group to return parameter details\n for.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

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

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeDBClusterParameters.

" } }, "com.amazonaws.docdb#DescribeDBClusterSnapshotAttributes": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBClusterSnapshotAttributesMessage" }, "output": { "target": "com.amazonaws.docdb#DescribeDBClusterSnapshotAttributesResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns a list of cluster snapshot attribute names and values for a manual DB\n cluster snapshot.

\n

When you share snapshots with other AWS accounts,\n DescribeDBClusterSnapshotAttributes returns the restore\n attribute and a list of IDs for the AWS accounts that are authorized to copy or restore\n the manual cluster snapshot. If all is included in the list of values\n for the restore attribute, then the manual cluster snapshot is public\n and can be copied or restored by all AWS accounts.

" } }, "com.amazonaws.docdb#DescribeDBClusterSnapshotAttributesMessage": { "type": "structure", "members": { "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier for the cluster snapshot to describe the attributes for.

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

Represents the input to DescribeDBClusterSnapshotAttributes.

" } }, "com.amazonaws.docdb#DescribeDBClusterSnapshotAttributesResult": { "type": "structure", "members": { "DBClusterSnapshotAttributesResult": { "target": "com.amazonaws.docdb#DBClusterSnapshotAttributesResult" } } }, "com.amazonaws.docdb#DescribeDBClusterSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBClusterSnapshotsMessage" }, "output": { "target": "com.amazonaws.docdb#DBClusterSnapshotMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns information about cluster snapshots. This API operation supports\n pagination.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBClusterSnapshots", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeDBClusterSnapshotsMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The ID of the cluster to retrieve the list of cluster snapshots for. This\n parameter can't be used with the DBClusterSnapshotIdentifier parameter.\n This parameter is not case sensitive.

\n

Constraints:

\n " } }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

A specific cluster snapshot identifier to describe. This parameter can't be used\n with the DBClusterIdentifier parameter. This value is stored as a lowercase\n string.

\n

Constraints:

\n " } }, "SnapshotType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The type of cluster snapshots to be returned. You can specify one of the following\n values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual\n cluster snapshots are returned. You can include shared cluster snapshots with\n these results by setting the IncludeShared parameter to true.\n You can include public cluster snapshots with these results by setting the\n IncludePublic parameter to true.

\n

The IncludeShared and IncludePublic parameters don't apply\n for SnapshotType values of manual or automated.\n The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when\n SnapshotType is set to public.

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "IncludeShared": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Set to true to include shared manual cluster snapshots from other AWS\n accounts that this AWS account has been given permission to copy or restore, and\n otherwise false. The default is false.

" } }, "IncludePublic": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Set to true to include manual cluster snapshots that are public and\n can be copied or restored by any AWS account, and otherwise false. The\n default is false.

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

Represents the input to DescribeDBClusterSnapshots.

" } }, "com.amazonaws.docdb#DescribeDBClusters": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBClustersMessage" }, "output": { "target": "com.amazonaws.docdb#DBClusterMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns information about provisioned Amazon DocumentDB clusters. This API \n operation supports pagination. For certain management features\n such as cluster and instance lifecycle management, Amazon DocumentDB leverages\n operational technology that is shared with Amazon RDS and Amazon \n Neptune. Use the filterName=engine,Values=docdb filter \n parameter to return only Amazon DocumentDB clusters.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBClusters", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeDBClustersMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The user-provided cluster identifier. If this parameter is specified, information\n from only the specific cluster is returned. This parameter isn't case\n sensitive.

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

A filter that specifies one or more clusters to describe.

\n

Supported filters:

\n " } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeDBClusters.

" } }, "com.amazonaws.docdb#DescribeDBEngineVersions": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBEngineVersionsMessage" }, "output": { "target": "com.amazonaws.docdb#DBEngineVersionMessage" }, "traits": { "smithy.api#documentation": "

Returns a list of the available engines.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBEngineVersions", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeDBEngineVersionsMessage": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The database engine to return.

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

The database engine version to return.

\n

Example: 3.6.0\n

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

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

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DefaultOnly": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Indicates that only the default version of the specified engine or engine and major\n version combination is returned.

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

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

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

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

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

Represents the input to DescribeDBEngineVersions.

" } }, "com.amazonaws.docdb#DescribeDBInstances": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBInstancesMessage" }, "output": { "target": "com.amazonaws.docdb#DBInstanceMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns information about provisioned Amazon DocumentDB instances. This API supports\n pagination.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBInstances", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeDBInstancesMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The user-provided instance identifier. If this parameter is specified, information\n from only the specific instance is returned. This parameter isn't case\n sensitive.

\n

Constraints:

\n " } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

A filter that specifies one or more instances to describe.

\n

Supported filters:

\n " } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeDBInstances.

" } }, "com.amazonaws.docdb#DescribeDBSubnetGroups": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeDBSubnetGroupsMessage" }, "output": { "target": "com.amazonaws.docdb#DBSubnetGroupMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a\n DBSubnetGroupName is specified, the list will contain only the\n descriptions of the specified DBSubnetGroup.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "DBSubnetGroups", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeDBSubnetGroupsMessage": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the subnet group to return details for.

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeDBSubnetGroups.

" } }, "com.amazonaws.docdb#DescribeEngineDefaultClusterParameters": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeEngineDefaultClusterParametersMessage" }, "output": { "target": "com.amazonaws.docdb#DescribeEngineDefaultClusterParametersResult" }, "traits": { "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database\n engine.

" } }, "com.amazonaws.docdb#DescribeEngineDefaultClusterParametersMessage": { "type": "structure", "members": { "DBParameterGroupFamily": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group family to return the engine parameter\n information for.

", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeEngineDefaultClusterParameters.

" } }, "com.amazonaws.docdb#DescribeEngineDefaultClusterParametersResult": { "type": "structure", "members": { "EngineDefaults": { "target": "com.amazonaws.docdb#EngineDefaults" } } }, "com.amazonaws.docdb#DescribeEventCategories": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeEventCategoriesMessage" }, "output": { "target": "com.amazonaws.docdb#EventCategoriesMessage" }, "traits": { "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a\n specified source type.

" } }, "com.amazonaws.docdb#DescribeEventCategoriesMessage": { "type": "structure", "members": { "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The type of source that is generating the events.

\n

Valid values: db-instance, db-parameter-group,\n db-security-group, db-snapshot\n

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

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

Represents the input to DescribeEventCategories.

" } }, "com.amazonaws.docdb#DescribeEventSubscriptions": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeEventSubscriptionsMessage" }, "output": { "target": "com.amazonaws.docdb#EventSubscriptionsMessage" }, "errors": [ { "target": "com.amazonaws.docdb#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a\n subscription includes SubscriptionName, SNSTopicARN,\n CustomerID, SourceType, SourceID,\n CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that\n subscription.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "EventSubscriptionsList", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeEventSubscriptionsMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the Amazon DocumentDB event notification subscription that you want to\n describe.

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeEventSubscriptions.

" } }, "com.amazonaws.docdb#DescribeEvents": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeEventsMessage" }, "output": { "target": "com.amazonaws.docdb#EventsMessage" }, "traits": { "smithy.api#documentation": "

Returns events related to instances, security groups, snapshots, and DB\n parameter groups for the past 14 days. You can obtain events specific to a particular DB\n instance, security group, snapshot, or parameter group by providing the name as\n a parameter. By default, the events of the past hour are returned.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Events", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeEventsMessage": { "type": "structure", "members": { "SourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified,\n then all sources are included in the response.

\n

Constraints:

\n " } }, "SourceType": { "target": "com.amazonaws.docdb#SourceType", "traits": { "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are\n returned.

" } }, "StartTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601\n format.

\n

Example: 2009-07-08T18:00Z

" } }, "EndTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601\n format.

\n

Example: 2009-07-08T18:00Z

" } }, "Duration": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" } }, "EventCategories": { "target": "com.amazonaws.docdb#EventCategoriesList", "traits": { "smithy.api#documentation": "

A list of event categories that trigger notifications for an event notification\n subscription.

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeEvents.

" } }, "com.amazonaws.docdb#DescribeOrderableDBInstanceOptions": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribeOrderableDBInstanceOptionsMessage" }, "output": { "target": "com.amazonaws.docdb#OrderableDBInstanceOptionsMessage" }, "traits": { "smithy.api#documentation": "

Returns a list of orderable instance options for the specified engine.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "OrderableDBInstanceOptions", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribeOrderableDBInstanceOptionsMessage": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the engine to retrieve instance options for.

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

The engine version filter value. Specify this parameter to show only the available\n offerings that match the specified engine version.

" } }, "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The instance class filter value. Specify this parameter to show only the available\n offerings that match the specified instance class.

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

The license model filter value. Specify this parameter to show only the available\n offerings that match the specified license model.

" } }, "Vpc": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { "smithy.api#documentation": "

The virtual private cloud (VPC) filter value. Specify this parameter to show only the\n available VPC or non-VPC offerings.

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the input to DescribeOrderableDBInstanceOptions.

" } }, "com.amazonaws.docdb#DescribePendingMaintenanceActions": { "type": "operation", "input": { "target": "com.amazonaws.docdb#DescribePendingMaintenanceActionsMessage" }, "output": { "target": "com.amazonaws.docdb#PendingMaintenanceActionsMessage" }, "errors": [ { "target": "com.amazonaws.docdb#ResourceNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Returns a list of resources (for example, instances) that have at least one pending\n maintenance action.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "PendingMaintenanceActions", "pageSize": "MaxRecords" } } }, "com.amazonaws.docdb#DescribePendingMaintenanceActionsMessage": { "type": "structure", "members": { "ResourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions\n for.

\n

Supported filters:

\n " } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

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

Represents the input to DescribePendingMaintenanceActions.

" } }, "com.amazonaws.docdb#Endpoint": { "type": "structure", "members": { "Address": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the DNS address of the instance.

" } }, "Port": { "target": "com.amazonaws.docdb#Integer", "traits": { "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" } }, "HostedZoneId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

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

Network information for accessing a cluster or instance. Client programs must\n specify a valid endpoint to access these Amazon DocumentDB resources.

" } }, "com.amazonaws.docdb#EngineDefaults": { "type": "structure", "members": { "DBParameterGroupFamily": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group family to return the engine parameter\n information for.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "Parameters": { "target": "com.amazonaws.docdb#ParametersList", "traits": { "smithy.api#documentation": "

The parameters of a particular cluster parameter group family.

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

Contains the result of a successful invocation of the\n DescribeEngineDefaultClusterParameters operation.

" } }, "com.amazonaws.docdb#Event": { "type": "structure", "members": { "SourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Provides the identifier for the source of the event.

" } }, "SourceType": { "target": "com.amazonaws.docdb#SourceType", "traits": { "smithy.api#documentation": "

Specifies the source type for this event.

" } }, "Message": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Provides the text of this event.

" } }, "EventCategories": { "target": "com.amazonaws.docdb#EventCategoriesList", "traits": { "smithy.api#documentation": "

Specifies the category for the event.

" } }, "Date": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

Specifies the date and time of the event.

" } }, "SourceArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

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

Detailed information about an event.

" } }, "com.amazonaws.docdb#EventCategoriesList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#xmlName": "EventCategory" } } }, "com.amazonaws.docdb#EventCategoriesMap": { "type": "structure", "members": { "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The source type that the returned categories belong to.

" } }, "EventCategories": { "target": "com.amazonaws.docdb#EventCategoriesList", "traits": { "smithy.api#documentation": "

The event categories for the specified source type.

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

An event source type, accompanied by one or more event category names.

" } }, "com.amazonaws.docdb#EventCategoriesMapList": { "type": "list", "member": { "target": "com.amazonaws.docdb#EventCategoriesMap", "traits": { "smithy.api#xmlName": "EventCategoriesMap" } } }, "com.amazonaws.docdb#EventCategoriesMessage": { "type": "structure", "members": { "EventCategoriesMapList": { "target": "com.amazonaws.docdb#EventCategoriesMapList", "traits": { "smithy.api#documentation": "

A list of event category maps.

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

Represents the output of DescribeEventCategories.

" } }, "com.amazonaws.docdb#EventList": { "type": "list", "member": { "target": "com.amazonaws.docdb#Event", "traits": { "smithy.api#xmlName": "Event" } } }, "com.amazonaws.docdb#EventSubscription": { "type": "structure", "members": { "CustomerAwsId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The AWS customer account that is associated with the Amazon DocumentDB event notification\n subscription.

" } }, "CustSubscriptionId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon DocumentDB event notification subscription ID.

" } }, "SnsTopicArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The topic ARN of the Amazon DocumentDB event notification subscription.

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

The status of the Amazon DocumentDB event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating, modifying,\n deleting, active, no-permission,\n topic-not-exist\n

\n

The no-permission status indicates that Amazon DocumentDB no longer has permission\n to post to the SNS topic. The topic-not-exist status indicates that the\n topic was deleted after the subscription was created.

" } }, "SubscriptionCreationTime": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The time at which the Amazon DocumentDB event notification subscription was created.

" } }, "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The source type for the Amazon DocumentDB event notification subscription.

" } }, "SourceIdsList": { "target": "com.amazonaws.docdb#SourceIdsList", "traits": { "smithy.api#documentation": "

A list of source IDs for the Amazon DocumentDB event notification subscription.

" } }, "EventCategoriesList": { "target": "com.amazonaws.docdb#EventCategoriesList", "traits": { "smithy.api#documentation": "

A list of event categories for the Amazon DocumentDB event notification subscription.

" } }, "Enabled": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the subscription is enabled. A value of\n true indicates that the subscription is enabled.

" } }, "EventSubscriptionArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

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

Detailed information about an event to which you have subscribed.

" } }, "com.amazonaws.docdb#EventSubscriptionQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#EventSubscriptionsList": { "type": "list", "member": { "target": "com.amazonaws.docdb#EventSubscription", "traits": { "smithy.api#xmlName": "EventSubscription" } } }, "com.amazonaws.docdb#EventSubscriptionsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "EventSubscriptionsList": { "target": "com.amazonaws.docdb#EventSubscriptionsList", "traits": { "smithy.api#documentation": "

A list of event subscriptions.

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

Represents the output of DescribeEventSubscriptions.

" } }, "com.amazonaws.docdb#EventsMessage": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "Events": { "target": "com.amazonaws.docdb#EventList", "traits": { "smithy.api#documentation": "

Detailed information about one or more events.

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

Represents the output of DescribeEvents.

" } }, "com.amazonaws.docdb#ExceptionMessage": { "type": "string" }, "com.amazonaws.docdb#FailoverDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdb#FailoverDBClusterMessage" }, "output": { "target": "com.amazonaws.docdb#FailoverDBClusterResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "

Forces a failover for a cluster.

\n

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances)\n in the cluster to be the primary instance (the cluster writer).

\n

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica,\n if one exists. You can force a failover when you want to simulate a failure of a primary\n instance for\n testing.

" } }, "com.amazonaws.docdb#FailoverDBClusterMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

A cluster identifier to force a failover for. This parameter is not case\n sensitive.

\n

Constraints:

\n " } }, "TargetDBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the instance to promote to the primary instance.

\n

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For\n example, mydbcluster-replica1.

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

Represents the input to FailoverDBCluster.

" } }, "com.amazonaws.docdb#FailoverDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#Filter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the filter. Filter names are case sensitive.

", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.docdb#FilterValueList", "traits": { "smithy.api#documentation": "

One or more filter values. Filter values are case sensitive.

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

A named set of filter values, used to return a more specific list of results. You can\n use a filter to match a set of resources by specific criteria, such as IDs.

\n

Wildcards are not supported in filters.

" } }, "com.amazonaws.docdb#FilterList": { "type": "list", "member": { "target": "com.amazonaws.docdb#Filter", "traits": { "smithy.api#xmlName": "Filter" } } }, "com.amazonaws.docdb#FilterValueList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#xmlName": "Value" } } }, "com.amazonaws.docdb#InstanceQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request would cause you to exceed the allowed number of instances.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InsufficientDBClusterCapacityFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The cluster doesn't have enough capacity for the current operation.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.docdb#InsufficientDBInstanceCapacityFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified instance class isn't available in the specified Availability\n Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InsufficientStorageClusterCapacityFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

There is not enough storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#Integer": { "type": "integer" }, "com.amazonaws.docdb#IntegerOptional": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The provided value isn't a valid cluster snapshot state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidDBClusterStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The cluster isn't in a valid state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidDBInstanceStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified instance isn't in the available state.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidDBParameterGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The parameter group is in use, or it is in a state that is not valid. If you are\n trying to delete the parameter group, you can't delete it when the parameter group\n is in this state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidDBSecurityGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The state of the security group doesn't allow deletion.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidDBSnapshotStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The state of the snapshot doesn't allow deletion.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidDBSubnetGroupStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The subnet group can't be deleted because it's in use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidDBSubnetStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The subnet isn't in the available state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidEventSubscriptionStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Someone else might be modifying a subscription. Wait a few seconds, and try\n again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidRestoreFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB\n instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidSubnet": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The requested subnet is not valid, or multiple subnets were requested that are not all\n in a common virtual private cloud (VPC).

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#InvalidVPCNetworkStateFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The subnet group doesn't cover all Availability Zones after it is created\n because of changes that were made.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#KMSKeyNotAccessibleFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

An error occurred when accessing an AWS KMS key.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#KeyList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String" } }, "com.amazonaws.docdb#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ListTagsForResourceMessage" }, "output": { "target": "com.amazonaws.docdb#TagListMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Lists all tags on an Amazon DocumentDB resource.

" } }, "com.amazonaws.docdb#ListTagsForResourceMessage": { "type": "structure", "members": { "ResourceName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name\n (ARN).

", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

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

Represents the input to ListTagsForResource.

" } }, "com.amazonaws.docdb#LogTypeList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String" } }, "com.amazonaws.docdb#ModifyDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ModifyDBClusterMessage" }, "output": { "target": "com.amazonaws.docdb#ModifyDBClusterResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBClusterParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBSecurityGroupStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBSubnetGroupStateFault" }, { "target": "com.amazonaws.docdb#InvalidSubnet" }, { "target": "com.amazonaws.docdb#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.docdb#StorageQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database\n configuration parameters by specifying these parameters and the new values in the\n request.

" } }, "com.amazonaws.docdb#ModifyDBClusterMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The cluster identifier for the cluster that is being modified. This parameter is\n not case sensitive.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "NewDBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The new cluster identifier for the cluster when renaming a cluster. This\n value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

" } }, "ApplyImmediately": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A value that specifies whether the changes in this request and any pending changes are\n asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the cluster. If this\n parameter is set to false, changes to the cluster are applied during the\n next maintenance window.

\n

The ApplyImmediately parameter affects only the\n NewDBClusterIdentifier and MasterUserPassword values. If\n you set this parameter value to false, the changes to the\n NewDBClusterIdentifier and MasterUserPassword values are\n applied during the next maintenance window. All other changes are applied immediately,\n regardless of the value of the ApplyImmediately parameter.

\n

Default: false\n

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The number of days for which automated backups are retained. You must specify a\n minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " } }, "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group to use for the cluster.

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

A list of virtual private cloud (VPC) security groups that the cluster will belong\n to.

" } }, "Port": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The port number on which the cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The same port as the original cluster.

" } }, "MasterUserPassword": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The password for the master database user. This password can contain any printable\n ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol\n (@).

\n

Constraints: Must contain from 8 to 100 characters.

" } }, "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups\n are enabled, using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.docdb#CloudwatchLogsExportConfiguration", "traits": { "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to Amazon\n CloudWatch Logs for a specific instance or cluster. The\n EnableLogTypes and DisableLogTypes arrays determine which\n logs are exported (or not exported) to CloudWatch Logs.

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

The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless the ApplyImmediately parameter is set to true.

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

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

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

Represents the input to ModifyDBCluster.

" } }, "com.amazonaws.docdb#ModifyDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ModifyDBClusterParameterGroupMessage" }, "output": { "target": "com.amazonaws.docdb#DBClusterParameterGroupNameMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBParameterGroupStateFault" } ], "traits": { "smithy.api#documentation": "

Modifies the parameters of a cluster parameter group. To modify more than one\n parameter, submit a list of the following: ParameterName,\n ParameterValue, and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

Changes to dynamic parameters are applied immediately. Changes to static\n parameters require a reboot or maintenance window\n \n before the change can take effect.

\n
\n \n

After you create a cluster parameter group, you should wait at least 5 minutes\n before creating your first cluster that uses that cluster parameter group as\n the default parameter group. This allows Amazon DocumentDB to fully complete the create action\n before the parameter group is used as the default for a new cluster. This step is\n especially important for parameters that are critical when creating the default\n database for a cluster, such as the character set for the default database\n defined by the character_set_database parameter.

\n
" } }, "com.amazonaws.docdb#ModifyDBClusterParameterGroupMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group to modify.

", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.docdb#ParametersList", "traits": { "smithy.api#documentation": "

A list of parameters in the cluster parameter group to modify.

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

Represents the input to ModifyDBClusterParameterGroup.

" } }, "com.amazonaws.docdb#ModifyDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#ModifyDBClusterSnapshotAttribute": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ModifyDBClusterSnapshotAttributeMessage" }, "output": { "target": "com.amazonaws.docdb#ModifyDBClusterSnapshotAttributeResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.docdb#SharedSnapshotQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB\n cluster snapshot.

\n

To share a manual cluster snapshot with other AWS accounts, specify\n restore as the AttributeName, and use the\n ValuesToAdd parameter to add a list of IDs of the AWS accounts that are\n authorized to restore the manual cluster snapshot. Use the value all to\n make the manual cluster snapshot public, which means that it can be copied or\n restored by all AWS accounts. Do not add the all value for any manual DB\n cluster snapshots that contain private information that you don't want available to all\n AWS accounts. If a manual cluster snapshot is encrypted, it can be shared, but only\n by specifying a list of authorized AWS account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

" } }, "com.amazonaws.docdb#ModifyDBClusterSnapshotAttributeMessage": { "type": "structure", "members": { "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier for the cluster snapshot to modify the attributes for.

", "smithy.api#required": {} } }, "AttributeName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this value to restore.

", "smithy.api#required": {} } }, "ValuesToAdd": { "target": "com.amazonaws.docdb#AttributeValueList", "traits": { "smithy.api#documentation": "

A list of cluster snapshot attributes to add to the attribute specified by\n AttributeName.

\n

To authorize other AWS accounts to copy or restore a manual cluster snapshot, set\n this list to include one or more AWS account IDs. To make the manual cluster snapshot\n restorable by any AWS account, set it to all. Do not add the\n all value for any manual cluster snapshots that contain private\n information that you don't want to be available to all AWS accounts.

" } }, "ValuesToRemove": { "target": "com.amazonaws.docdb#AttributeValueList", "traits": { "smithy.api#documentation": "

A list of cluster snapshot attributes to remove from the attribute specified by\n AttributeName.

\n

To remove authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this list to include one or more AWS account identifiers. To remove\n authorization for any AWS account to copy or restore the cluster snapshot, set it to\n all . If you specify all, an AWS account whose account ID\n is explicitly added to the restore attribute can still copy or restore a\n manual cluster snapshot.

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

Represents the input to ModifyDBClusterSnapshotAttribute.

" } }, "com.amazonaws.docdb#ModifyDBClusterSnapshotAttributeResult": { "type": "structure", "members": { "DBClusterSnapshotAttributesResult": { "target": "com.amazonaws.docdb#DBClusterSnapshotAttributesResult" } } }, "com.amazonaws.docdb#ModifyDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ModifyDBInstanceMessage" }, "output": { "target": "com.amazonaws.docdb#ModifyDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.docdb#AuthorizationNotFoundFault" }, { "target": "com.amazonaws.docdb#CertificateNotFoundFault" }, { "target": "com.amazonaws.docdb#DBInstanceAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSecurityGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBUpgradeDependencyFailureFault" }, { "target": "com.amazonaws.docdb#InsufficientDBInstanceCapacityFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBSecurityGroupStateFault" }, { "target": "com.amazonaws.docdb#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.docdb#StorageQuotaExceededFault" }, { "target": "com.amazonaws.docdb#StorageTypeNotSupportedFault" } ], "traits": { "smithy.api#documentation": "

Modifies settings for an instance. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request.

" } }, "com.amazonaws.docdb#ModifyDBInstanceMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The new compute and memory capacity of the instance; for example,\n db.r5.large. Not all instance classes are available in all AWS\n Regions.

\n

If you modify the instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless ApplyImmediately is\n specified as true for this request.

\n

Default: Uses existing setting.

" } }, "ApplyImmediately": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are\n asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the instance.

\n

If this parameter is set to false, changes to the instance are\n applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next reboot.

\n

Default: false\n

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter doesn't result in an outage except in the\n following situation, and the change is asynchronously applied as soon as possible. If\n there are pending actions that cause a reboot, and the maintenance window is changed to\n include the current time, changing this parameter causes a reboot of the instance. If\n you are moving this window to the current time, there must be at least 30 minutes\n between the current time and end of the window to ensure that pending changes are\n applied.

\n

Default: Uses existing setting.

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Must be at least 30 minutes.

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

Indicates that minor version upgrades are applied automatically to the instance\n during the maintenance window. Changing this parameter doesn't result in an outage\n except in the following case, and the change is asynchronously applied as soon as\n possible. An outage results if this parameter is set to true during the\n maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled\n automatic patching for that engine version.

" } }, "NewDBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The new instance identifier for the instance when renaming an instance. When\n you change the instance identifier, an instance reboot occurs immediately if you set\n Apply Immediately to true. It occurs during the next\n maintenance window if you set Apply Immediately to false. This\n value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

" } }, "CACertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the instance.

" } }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

\n

Default: 1

\n

Valid values: 0-15

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

Represents the input to ModifyDBInstance.

" } }, "com.amazonaws.docdb#ModifyDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.docdb#DBInstance" } } }, "com.amazonaws.docdb#ModifyDBSubnetGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ModifyDBSubnetGroupMessage" }, "output": { "target": "com.amazonaws.docdb#ModifyDBSubnetGroupResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBSubnetGroupDoesNotCoverEnoughAZs" }, { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSubnetQuotaExceededFault" }, { "target": "com.amazonaws.docdb#InvalidSubnet" }, { "target": "com.amazonaws.docdb#SubnetAlreadyInUse" } ], "traits": { "smithy.api#documentation": "

Modifies an existing subnet group. subnet groups must contain at least one\n subnet in at least two Availability Zones in the AWS Region.

" } }, "com.amazonaws.docdb#ModifyDBSubnetGroupMessage": { "type": "structure", "members": { "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name for the subnet group. This value is stored as a lowercase string. You\n can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not\n be default.

\n

Example: mySubnetgroup\n

", "smithy.api#required": {} } }, "DBSubnetGroupDescription": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The description for the subnet group.

" } }, "SubnetIds": { "target": "com.amazonaws.docdb#SubnetIdentifierList", "traits": { "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the subnet group.

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

Represents the input to ModifyDBSubnetGroup.

" } }, "com.amazonaws.docdb#ModifyDBSubnetGroupResult": { "type": "structure", "members": { "DBSubnetGroup": { "target": "com.amazonaws.docdb#DBSubnetGroup" } } }, "com.amazonaws.docdb#ModifyEventSubscription": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ModifyEventSubscriptionMessage" }, "output": { "target": "com.amazonaws.docdb#ModifyEventSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.docdb#EventSubscriptionQuotaExceededFault" }, { "target": "com.amazonaws.docdb#SNSInvalidTopicFault" }, { "target": "com.amazonaws.docdb#SNSNoAuthorizationFault" }, { "target": "com.amazonaws.docdb#SNSTopicArnNotFoundFault" }, { "target": "com.amazonaws.docdb#SubscriptionCategoryNotFoundFault" }, { "target": "com.amazonaws.docdb#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Modifies an existing Amazon DocumentDB event notification subscription.

" } }, "com.amazonaws.docdb#ModifyEventSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the Amazon DocumentDB event notification subscription.

", "smithy.api#required": {} } }, "SnsTopicArn": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The\n ARN is created by Amazon SNS when you create a topic and subscribe to it.

" } }, "SourceType": { "target": "com.amazonaws.docdb#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 an instance, set this parameter to\n db-instance. If this value is not specified, all events are\n returned.

\n

Valid values: db-instance, db-parameter-group,\n db-security-group, db-snapshot\n

" } }, "EventCategories": { "target": "com.amazonaws.docdb#EventCategoriesList", "traits": { "smithy.api#documentation": "

A list of event categories for a SourceType that you want to subscribe\n to.

" } }, "Enabled": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { "smithy.api#documentation": "

A Boolean value; set to true to activate the subscription.

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

Represents the input to ModifyEventSubscription.

" } }, "com.amazonaws.docdb#ModifyEventSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.docdb#EventSubscription" } } }, "com.amazonaws.docdb#OrderableDBInstanceOption": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The engine type of an instance.

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

The engine version of an instance.

" } }, "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The instance class for an instance.

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

The license model for an instance.

" } }, "AvailabilityZones": { "target": "com.amazonaws.docdb#AvailabilityZoneList", "traits": { "smithy.api#documentation": "

A list of Availability Zones for an instance.

" } }, "Vpc": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether an instance is in a virtual private cloud (VPC).

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

The options that are available for an instance.

" } }, "com.amazonaws.docdb#OrderableDBInstanceOptionsList": { "type": "list", "member": { "target": "com.amazonaws.docdb#OrderableDBInstanceOption", "traits": { "smithy.api#xmlName": "OrderableDBInstanceOption" } } }, "com.amazonaws.docdb#OrderableDBInstanceOptionsMessage": { "type": "structure", "members": { "OrderableDBInstanceOptions": { "target": "com.amazonaws.docdb#OrderableDBInstanceOptionsList", "traits": { "smithy.api#documentation": "

The options that are available for a particular orderable instance.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the output of DescribeOrderableDBInstanceOptions.

" } }, "com.amazonaws.docdb#Parameter": { "type": "structure", "members": { "ParameterName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the name of the parameter.

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

Specifies the value of the parameter.

" } }, "Description": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Provides a description of the parameter.

" } }, "Source": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Indicates the source of the parameter value.

" } }, "ApplyType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the engine-specific parameters type.

" } }, "DataType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" } }, "AllowedValues": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" } }, "IsModifiable": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can\n be modified. Some parameters have security or operational implications that prevent them\n from being changed.

" } }, "MinimumEngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" } }, "ApplyMethod": { "target": "com.amazonaws.docdb#ApplyMethod", "traits": { "smithy.api#documentation": "

Indicates when to apply parameter updates.

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

Detailed information about an individual parameter.

" } }, "com.amazonaws.docdb#ParametersList": { "type": "list", "member": { "target": "com.amazonaws.docdb#Parameter", "traits": { "smithy.api#xmlName": "Parameter" } } }, "com.amazonaws.docdb#PendingCloudwatchLogsExports": { "type": "structure", "members": { "LogTypesToEnable": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated,\n these log types aren't exported to CloudWatch Logs.

" } }, "LogTypesToDisable": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log\n types are exported to Amazon CloudWatch Logs.

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

A list of the log types whose configuration is still pending. These log types are in\n the process of being activated or deactivated.

" } }, "com.amazonaws.docdb#PendingMaintenanceAction": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource.

" } }, "AutoAppliedAfterDate": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The date of the maintenance window when the action is applied. The maintenance action\n is applied to the resource during its first maintenance window after this date. If this\n date is specified, any next-maintenance opt-in requests are ignored.

" } }, "ForcedApplyDate": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The date when the maintenance action is automatically applied. The maintenance action\n is applied to the resource on this date regardless of the maintenance window for the\n resource. If this date is specified, any immediate opt-in requests are\n ignored.

" } }, "OptInStatus": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" } }, "CurrentApplyDate": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The effective date when the pending maintenance action is applied to the\n resource.

" } }, "Description": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

A description providing more detail about the maintenance action.

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

Provides information about a pending maintenance action for a resource.

" } }, "com.amazonaws.docdb#PendingMaintenanceActionDetails": { "type": "list", "member": { "target": "com.amazonaws.docdb#PendingMaintenanceAction", "traits": { "smithy.api#xmlName": "PendingMaintenanceAction" } } }, "com.amazonaws.docdb#PendingMaintenanceActions": { "type": "list", "member": { "target": "com.amazonaws.docdb#ResourcePendingMaintenanceActions", "traits": { "smithy.api#xmlName": "ResourcePendingMaintenanceActions" } } }, "com.amazonaws.docdb#PendingMaintenanceActionsMessage": { "type": "structure", "members": { "PendingMaintenanceActions": { "target": "com.amazonaws.docdb#PendingMaintenanceActions", "traits": { "smithy.api#documentation": "

The maintenance actions to be applied.

" } }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

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

Represents the output of DescribePendingMaintenanceActions.

" } }, "com.amazonaws.docdb#PendingModifiedValues": { "type": "structure", "members": { "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Contains the new DBInstanceClass for the instance that will be\n applied or is currently being applied.

" } }, "AllocatedStorage": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

Contains the new AllocatedStorage size for then instance that will be\n applied or is currently being applied.

" } }, "MasterUserPassword": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Contains the pending or currently in-progress change of the master credentials for the\n instance.

" } }, "Port": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

Specifies the pending port for the instance.

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

Specifies the pending number of days for which automated backups are retained.

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

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

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

Indicates the database engine version.

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

The license model for the instance.

\n

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

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

Specifies the new Provisioned IOPS value for the instance that will be applied or\n is currently being applied.

" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Contains the new DBInstanceIdentifier for the instance that will be\n applied or is currently being applied.

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

Specifies the storage type to be associated with the instance.

" } }, "CACertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the identifier of the certificate authority (CA) certificate for the DB\n instance.

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The new subnet group for the instance.

" } }, "PendingCloudwatchLogsExports": { "target": "com.amazonaws.docdb#PendingCloudwatchLogsExports", "traits": { "smithy.api#documentation": "

A list of the log types whose configuration is still pending. These log types are in\n the process of being activated or deactivated.

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

One or more modified settings for an instance. These modified settings have been\n requested, but haven't been applied yet.

" } }, "com.amazonaws.docdb#RebootDBInstance": { "type": "operation", "input": { "target": "com.amazonaws.docdb#RebootDBInstanceMessage" }, "output": { "target": "com.amazonaws.docdb#RebootDBInstanceResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "

You might need to reboot your instance, usually for maintenance reasons. For\n example, if you make certain changes, or if you change the cluster parameter group\n that is associated with the instance, you must reboot the instance for the changes to\n take effect.

\n

Rebooting an instance restarts the database engine service. Rebooting an instance\n results in a momentary outage, during which the instance status is set to\n rebooting.

" } }, "com.amazonaws.docdb#RebootDBInstanceMessage": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "ForceFailover": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { "smithy.api#documentation": "

When true, the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't specify true if the instance is not configured for\n Multi-AZ.

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

Represents the input to RebootDBInstance.

" } }, "com.amazonaws.docdb#RebootDBInstanceResult": { "type": "structure", "members": { "DBInstance": { "target": "com.amazonaws.docdb#DBInstance" } } }, "com.amazonaws.docdb#RemoveSourceIdentifierFromSubscription": { "type": "operation", "input": { "target": "com.amazonaws.docdb#RemoveSourceIdentifierFromSubscriptionMessage" }, "output": { "target": "com.amazonaws.docdb#RemoveSourceIdentifierFromSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.docdb#SourceNotFoundFault" }, { "target": "com.amazonaws.docdb#SubscriptionNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Removes a source identifier from an existing Amazon DocumentDB event notification\n subscription.

" } }, "com.amazonaws.docdb#RemoveSourceIdentifierFromSubscriptionMessage": { "type": "structure", "members": { "SubscriptionName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the Amazon DocumentDB event notification subscription that you want to remove a\n source identifier from.

", "smithy.api#required": {} } }, "SourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the instance\n identifier for an instance, or the name of a security group.

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

Represents the input to RemoveSourceIdentifierFromSubscription.

" } }, "com.amazonaws.docdb#RemoveSourceIdentifierFromSubscriptionResult": { "type": "structure", "members": { "EventSubscription": { "target": "com.amazonaws.docdb#EventSubscription" } } }, "com.amazonaws.docdb#RemoveTagsFromResource": { "type": "operation", "input": { "target": "com.amazonaws.docdb#RemoveTagsFromResourceMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBInstanceNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSnapshotNotFoundFault" } ], "traits": { "smithy.api#documentation": "

Removes metadata tags from an Amazon DocumentDB resource.

" } }, "com.amazonaws.docdb#RemoveTagsFromResourceMessage": { "type": "structure", "members": { "ResourceName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource\n Name (ARN).

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.docdb#KeyList", "traits": { "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

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

Represents the input to RemoveTagsFromResource.

" } }, "com.amazonaws.docdb#ResetDBClusterParameterGroup": { "type": "operation", "input": { "target": "com.amazonaws.docdb#ResetDBClusterParameterGroupMessage" }, "output": { "target": "com.amazonaws.docdb#DBClusterParameterGroupNameMessage" }, "errors": [ { "target": "com.amazonaws.docdb#DBParameterGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBParameterGroupStateFault" } ], "traits": { "smithy.api#documentation": "

Modifies the parameters of a cluster parameter group to the default value. To\n reset specific parameters, submit a list of the following: ParameterName\n and ApplyMethod. To reset the entire cluster parameter group, specify\n the DBClusterParameterGroupName and ResetAllParameters\n parameters.

\n

When you reset the entire group, dynamic parameters are updated immediately and\n static parameters are set to pending-reboot to take effect on the next DB\n instance reboot.

" } }, "com.amazonaws.docdb#ResetDBClusterParameterGroupMessage": { "type": "structure", "members": { "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the cluster parameter group to reset.

", "smithy.api#required": {} } }, "ResetAllParameters": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A value that is set to true to reset all parameters in the cluster\n parameter group to their default values, and false otherwise. You can't use\n this parameter if there is a list of parameter names specified for the\n Parameters parameter.

" } }, "Parameters": { "target": "com.amazonaws.docdb#ParametersList", "traits": { "smithy.api#documentation": "

A list of parameter names in the cluster parameter group to reset to the default\n values. You can't use this parameter if the ResetAllParameters parameter is\n set to true.

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

Represents the input to ResetDBClusterParameterGroup.

" } }, "com.amazonaws.docdb#ResourceNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified resource ID was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#ResourcePendingMaintenanceActions": { "type": "structure", "members": { "ResourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that has pending \n maintenance actions.

" } }, "PendingMaintenanceActionDetails": { "target": "com.amazonaws.docdb#PendingMaintenanceActionDetails", "traits": { "smithy.api#documentation": "

A list that provides details about the pending maintenance actions\n for the resource.

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

Represents the output of ApplyPendingMaintenanceAction.\n

" } }, "com.amazonaws.docdb#RestoreDBClusterFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdb#RestoreDBClusterFromSnapshotMessage" }, "output": { "target": "com.amazonaws.docdb#RestoreDBClusterFromSnapshotResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBClusterQuotaExceededFault" }, { "target": "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSnapshotNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InsufficientDBClusterCapacityFault" }, { "target": "com.amazonaws.docdb#InsufficientStorageClusterCapacityFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBSnapshotStateFault" }, { "target": "com.amazonaws.docdb#InvalidRestoreFault" }, { "target": "com.amazonaws.docdb#InvalidSubnet" }, { "target": "com.amazonaws.docdb#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.docdb#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.docdb#StorageQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Creates a new cluster from a snapshot or cluster snapshot.

\n

If a snapshot is specified, the target cluster is created from the source DB\n snapshot with a default configuration and default security group.

\n

If a cluster snapshot is specified, the target cluster is created from the\n source cluster restore point with the same configuration as the original source DB\n cluster, except that the new cluster is created with the default security\n group.

" } }, "com.amazonaws.docdb#RestoreDBClusterFromSnapshotMessage": { "type": "structure", "members": { "AvailabilityZones": { "target": "com.amazonaws.docdb#AvailabilityZones", "traits": { "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB\n cluster can be created in.

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

The name of the cluster to create from the snapshot or cluster snapshot. This\n parameter isn't case sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", "smithy.api#required": {} } }, "SnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier for the snapshot or cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster\n snapshot. However, you can use only the ARN to specify a snapshot.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The database engine to use for the new cluster.

\n

Default: The same as source.

\n

Constraint: Must be compatible with the engine of the source.

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

The version of the database engine to use for the new cluster.

" } }, "Port": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The port number on which the new cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The same port as the original cluster.

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the subnet group to use for the new cluster.

\n

Constraints: If provided, must match the name of an existing\n DBSubnetGroup.

\n

Example: mySubnetgroup\n

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

A list of virtual private cloud (VPC) security groups that the new cluster will\n belong to.

" } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the restored cluster.

" } }, "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB\n snapshot or cluster snapshot.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS\n encryption key. If you are restoring a cluster with the same AWS account that owns\n the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS\n KMS key alias instead of the ARN for the AWS KMS encryption key.

\n

If you do not specify a value for the KmsKeyId parameter, then the\n following occurs:

\n " } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { "smithy.api#documentation": "

A list of log types that must be enabled for exporting to Amazon CloudWatch\n Logs.

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

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

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

Represents the input to RestoreDBClusterFromSnapshot.

" } }, "com.amazonaws.docdb#RestoreDBClusterFromSnapshotResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#RestoreDBClusterToPointInTime": { "type": "operation", "input": { "target": "com.amazonaws.docdb#RestoreDBClusterToPointInTimeMessage" }, "output": { "target": "com.amazonaws.docdb#RestoreDBClusterToPointInTimeResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterAlreadyExistsFault" }, { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#DBClusterQuotaExceededFault" }, { "target": "com.amazonaws.docdb#DBClusterSnapshotNotFoundFault" }, { "target": "com.amazonaws.docdb#DBSubnetGroupNotFoundFault" }, { "target": "com.amazonaws.docdb#InsufficientDBClusterCapacityFault" }, { "target": "com.amazonaws.docdb#InsufficientStorageClusterCapacityFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterSnapshotStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBSnapshotStateFault" }, { "target": "com.amazonaws.docdb#InvalidRestoreFault" }, { "target": "com.amazonaws.docdb#InvalidSubnet" }, { "target": "com.amazonaws.docdb#InvalidVPCNetworkStateFault" }, { "target": "com.amazonaws.docdb#KMSKeyNotAccessibleFault" }, { "target": "com.amazonaws.docdb#StorageQuotaExceededFault" } ], "traits": { "smithy.api#documentation": "

Restores a cluster to an arbitrary point in time. Users can restore to any point in\n time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target cluster is created from the\n source cluster with the same configuration as the original cluster, except that\n the new cluster is created with the default security group.

" } }, "com.amazonaws.docdb#RestoreDBClusterToPointInTimeMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the new cluster to be created.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "SourceDBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the source cluster from which to restore.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "RestoreToTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The date and time to restore the cluster to.

\n

Valid values: A time in Universal Coordinated Time (UTC) format.

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

" } }, "UseLatestRestorableTime": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A value that is set to true to restore the cluster to the latest\n restorable backup time, and false otherwise.

\n

Default: false\n

\n

Constraints: Cannot be specified if the RestoreToTime parameter is\n provided.

" } }, "Port": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { "smithy.api#documentation": "

The port number on which the new cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The default port for the engine.

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The subnet group name to use for the new cluster.

\n

Constraints: If provided, must match the name of an existing\n DBSubnetGroup.

\n

Example: mySubnetgroup\n

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

A list of VPC security groups that the new cluster belongs to.

" } }, "Tags": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the restored cluster.

" } }, "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted cluster from an\n encrypted cluster.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS\n encryption key. If you are restoring a cluster with the same AWS account that owns\n the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS\n KMS key alias instead of the ARN for the AWS KMS encryption key.

\n

You can restore to a new cluster and encrypt the new cluster with an AWS KMS key\n that is different from the AWS KMS key used to encrypt the source cluster. The new DB\n cluster is encrypted with the AWS KMS key identified by the KmsKeyId\n parameter.

\n

If you do not specify a value for the KmsKeyId parameter, then the\n following occurs:

\n \n

If DBClusterIdentifier refers to a cluster that is not encrypted, then\n the restore request is rejected.

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

A list of log types that must be enabled for exporting to Amazon CloudWatch\n Logs.

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

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

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

Represents the input to RestoreDBClusterToPointInTime.

" } }, "com.amazonaws.docdb#RestoreDBClusterToPointInTimeResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#SNSInvalidTopicFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Amazon SNS has responded that there is a problem with the specified topic.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#SNSNoAuthorizationFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#SNSTopicArnNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The SNS topic Amazon Resource Name (ARN) does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#SharedSnapshotQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB\n snapshot with.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#SnapshotQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request would cause you to exceed the allowed number of snapshots.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#SourceIdsList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#xmlName": "SourceId" } } }, "com.amazonaws.docdb#SourceNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The requested source could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#SourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "db-instance" }, { "value": "db-parameter-group" }, { "value": "db-security-group" }, { "value": "db-snapshot" }, { "value": "db-cluster" }, { "value": "db-cluster-snapshot" } ] } }, "com.amazonaws.docdb#StartDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdb#StartDBClusterMessage" }, "output": { "target": "com.amazonaws.docdb#StartDBClusterResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "

Restarts the stopped cluster that is specified by DBClusterIdentifier.\n For more information, see Stopping and\n Starting an Amazon DocumentDB Cluster.

" } }, "com.amazonaws.docdb#StartDBClusterMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the cluster to restart. Example:\n docdb-2019-05-28-15-24-52\n

", "smithy.api#required": {} } } } }, "com.amazonaws.docdb#StartDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#StopDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdb#StopDBClusterMessage" }, "output": { "target": "com.amazonaws.docdb#StopDBClusterResult" }, "errors": [ { "target": "com.amazonaws.docdb#DBClusterNotFoundFault" }, { "target": "com.amazonaws.docdb#InvalidDBClusterStateFault" }, { "target": "com.amazonaws.docdb#InvalidDBInstanceStateFault" } ], "traits": { "smithy.api#documentation": "

Stops the running cluster that is specified by DBClusterIdentifier. The\n cluster must be in the available state. For more information, see\n Stopping and\n Starting an Amazon DocumentDB Cluster.

" } }, "com.amazonaws.docdb#StopDBClusterMessage": { "type": "structure", "members": { "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the cluster to stop. Example:\n docdb-2019-05-28-15-24-52\n

", "smithy.api#required": {} } } } }, "com.amazonaws.docdb#StopDBClusterResult": { "type": "structure", "members": { "DBCluster": { "target": "com.amazonaws.docdb#DBCluster" } } }, "com.amazonaws.docdb#StorageQuotaExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request would cause you to exceed the allowed amount of storage available across\n all instances.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#StorageTypeNotSupportedFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Storage of the specified StorageType can't be associated with the DB\n instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#String": { "type": "string" }, "com.amazonaws.docdb#Subnet": { "type": "structure", "members": { "SubnetIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the identifier of the subnet.

" } }, "SubnetAvailabilityZone": { "target": "com.amazonaws.docdb#AvailabilityZone", "traits": { "smithy.api#documentation": "

Specifies the Availability Zone for the subnet.

" } }, "SubnetStatus": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

Specifies the status of the subnet.

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

Detailed information about a subnet.

" } }, "com.amazonaws.docdb#SubnetAlreadyInUse": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The subnet is already in use in the Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#SubnetIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#xmlName": "SubnetIdentifier" } } }, "com.amazonaws.docdb#SubnetList": { "type": "list", "member": { "target": "com.amazonaws.docdb#Subnet", "traits": { "smithy.api#xmlName": "Subnet" } } }, "com.amazonaws.docdb#SubscriptionAlreadyExistFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The provided subscription name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdb#SubscriptionCategoryNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The provided category does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#SubscriptionNotFoundFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.docdb#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The subscription name does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdb#TStamp": { "type": "timestamp" }, "com.amazonaws.docdb#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The required name of the tag. The string value can be from 1 to 128 Unicode characters\n in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the\n set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex:\n \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } }, "Value": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The optional value of the tag. The string value can be from 1 to 256 Unicode\n characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain\n only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java\n regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

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

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

" } }, "com.amazonaws.docdb#TagList": { "type": "list", "member": { "target": "com.amazonaws.docdb#Tag", "traits": { "smithy.api#xmlName": "Tag" } } }, "com.amazonaws.docdb#TagListMessage": { "type": "structure", "members": { "TagList": { "target": "com.amazonaws.docdb#TagList", "traits": { "smithy.api#documentation": "

A list of one or more tags.

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

Represents the output of ListTagsForResource.

" } }, "com.amazonaws.docdb#UpgradeTarget": { "type": "structure", "members": { "Engine": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the upgrade target database engine.

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

The version number of the upgrade target database engine.

" } }, "Description": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The version of the database engine that an instance can be upgraded to.

" } }, "AutoUpgrade": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB\n instances that have AutoMinorVersionUpgrade set to\n true.

" } }, "IsMajorVersionUpgrade": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A value that indicates whether a database engine is upgraded to a major\n version.

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

The version of the database engine that an instance can be upgraded to.

" } }, "com.amazonaws.docdb#ValidUpgradeTargetList": { "type": "list", "member": { "target": "com.amazonaws.docdb#UpgradeTarget", "traits": { "smithy.api#xmlName": "UpgradeTarget" } } }, "com.amazonaws.docdb#VpcSecurityGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#xmlName": "VpcSecurityGroupId" } } }, "com.amazonaws.docdb#VpcSecurityGroupMembership": { "type": "structure", "members": { "VpcSecurityGroupId": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the VPC security group.

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

The status of the VPC security group.

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

Used as a response element for queries on virtual private cloud (VPC) security group\n membership.

" } }, "com.amazonaws.docdb#VpcSecurityGroupMembershipList": { "type": "list", "member": { "target": "com.amazonaws.docdb#VpcSecurityGroupMembership", "traits": { "smithy.api#xmlName": "VpcSecurityGroupMembership" } } } } }