Adds a source identifier to an existing event notification \n subscription.
" + "smithy.api#documentation": "Adds a source identifier to an existing event notification\n subscription.
" } }, "com.amazonaws.docdb#AddSourceIdentifierToSubscriptionMessage": { @@ -55,14 +55,14 @@ "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#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:
\nIf the source type is an instance, a \n DBInstanceIdentifier must be provided.
If the source type is a security group, a \n DBSecurityGroupName must be provided.
If the source type is a parameter group, a\n DBParameterGroupName must be provided.
If the source type is a snapshot, a \n DBSnapshotIdentifier must be provided.
The identifier of the event source to be added:
\nIf the source type is an instance, a\n DBInstanceIdentifier must be provided.
If the source type is a security group, a\n DBSecurityGroupName must be provided.
If the source type is a parameter group, a\n DBParameterGroupName must be provided.
If the source type is a snapshot, a\n DBSnapshotIdentifier must be provided.
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 Identity and Access Management (IAM) policy for Amazon DocumentDB.
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 Identity and Access Management (IAM) policy for Amazon DocumentDB.
Applies a pending maintenance action to a resource (for example, \n to an Amazon DocumentDB instance).
" + "smithy.api#documentation": "Applies a pending maintenance action to a resource (for example,\n to an Amazon DocumentDB instance).
" } }, "com.amazonaws.docdb#ApplyPendingMaintenanceActionMessage": { @@ -1367,21 +1419,21 @@ "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#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.
\nValid values: system-update, db-upgrade\n
The pending maintenance action to apply to this resource.
\nValid values: system-update, db-upgrade\n
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.
Valid values:
\n\n immediate - Apply the maintenance action \n immediately.
\n next-maintenance - Apply the maintenance \n action during the next maintenance window for the resource.\n
\n undo-opt-in - Cancel any existing \n next-maintenance opt-in requests.
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.
Valid values:
\n\n immediate - Apply the maintenance action\n immediately.
\n next-maintenance - Apply the maintenance\n action during the next maintenance window for the resource.\n
\n undo-opt-in - Cancel any existing\n next-maintenance opt-in requests.
The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.
\nAmazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
", + "smithy.api#documentation": "The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.
\nAmazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1569,7 +1621,7 @@ } }, "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.
\nThe 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.
The configuration setting for the log types to be enabled for export to Amazon\n CloudWatch Logs for a specific instance or cluster.
\nThe 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.
The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.
\nConstraints:
\nMust specify a valid cluster parameter group.
\nIf the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.
\nConstraints:
\nMust specify a valid cluster parameter group.
\nIf the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
The identifier for the copied cluster parameter group.
\nConstraints:
\nCannot be null, empty, or blank.
\nMust contain from 1 to 255 letters, numbers, or hyphens.\n
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster-param-group1\n
The identifier for the copied cluster parameter group.
\nConstraints:
\nCannot be null, empty, or blank.
\nMust contain from 1 to 255 letters, numbers, or hyphens.\n
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster-param-group1\n
Copies a snapshot of a cluster.
\n \nTo 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 Amazon Web Services Region.
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.
Copies a snapshot of a cluster.
\nTo 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 Amazon Web Services Region.
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.
The identifier of the cluster snapshot to copy. This parameter is\n not case sensitive.
\n \nConstraints:
\nMust specify a valid system snapshot in the \n available state.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.
\nIf the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.
\nExample: my-cluster-snapshot1\n
The identifier of the cluster snapshot to copy. This parameter is\n not case sensitive.
\nConstraints:
\nMust specify a valid system snapshot in the\n available state.
\nIf the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.
\nIf the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.
\nExample: my-cluster-snapshot1\n
The identifier of the new cluster snapshot to create from the \n source cluster snapshot. This parameter is not case sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.\n
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster-snapshot2\n
The identifier of the new cluster snapshot to create from the\n source cluster snapshot. This parameter is not case sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.\n
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster-snapshot2\n
The KMS key ID for an encrypted cluster snapshot. The KMS\n key ID is the Amazon Resource Name (ARN), KMS key identifier, or\n the KMS key alias for the KMS encryption key.
\n \nIf you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
The KMS key ID for an encrypted cluster snapshot. The KMS\n key ID is the Amazon Resource Name (ARN), KMS key identifier, or\n the KMS key alias for the KMS encryption key.
\nIf you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify \n SourceRegion (or --source-region for the\n 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 Amazon Web Services Region.
The presigned URL must be a valid request for the \n CopyDBClusterSnapshot API action that can be executed \n in the source Amazon Web Services Region that contains the cluster snapshot to be \n copied. The presigned URL request must contain the following\n parameter values:
\n SourceRegion - The ID of the region that \n contains the snapshot to be copied.
\n SourceDBClusterSnapshotIdentifier - The \n identifier for the the encrypted cluster snapshot to be \n copied. This identifier must be in the Amazon Resource Name\n (ARN) format for the source Amazon Web Services Region. For example, if you \n are copying an encrypted cluster snapshot from the us-east-1\n Amazon Web Services Region, then your \n SourceDBClusterSnapshotIdentifier looks \n something like the following: \n arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
\n TargetDBClusterSnapshotIdentifier - The \n identifier for the new cluster snapshot to be created. This\n parameter isn't case sensitive.
The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the\n 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 Amazon Web Services Region.
The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API action that can be executed\n in the source Amazon Web Services Region that contains the cluster snapshot to be\n copied. The presigned URL request must contain the following\n parameter values:
\n SourceRegion - The ID of the region that\n contains the snapshot to be copied.
\n SourceDBClusterSnapshotIdentifier - The\n identifier for the the encrypted cluster snapshot to be\n copied. This identifier must be in the Amazon Resource Name\n (ARN) format for the source Amazon Web Services Region. For example, if you\n are copying an encrypted cluster snapshot from the us-east-1\n Amazon Web Services Region, then your\n SourceDBClusterSnapshotIdentifier looks\n something like the following:\n arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
\n TargetDBClusterSnapshotIdentifier - The\n identifier for the new cluster snapshot to be created. This\n parameter isn't case sensitive.
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.
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.
A list of Amazon EC2 Availability Zones that instances in the \n cluster can be created in.
" + "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.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35.
\nThe number of days for which automated backups are retained. You\n must specify a minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35.
\nThe cluster identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.\n
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster\n
The cluster identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.\n
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster\n
The name of the cluster parameter group to associate with this \n cluster.
" + "smithy.api#documentation": "The name of the cluster parameter group to associate with this\n cluster.
" } }, "VpcSecurityGroupIds": { @@ -1826,13 +1878,13 @@ "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "A subnet group to associate with this cluster.
\nConstraints: Must match the name of an existing \n DBSubnetGroup. Must not be default.
Example: mySubnetgroup\n
A subnet group to associate with this cluster.
\nConstraints: Must match the name of an existing\n DBSubnetGroup. Must not be default.
Example: mySubnetgroup\n
The name of the database engine to be used for this cluster.
\nValid values: docdb\n
The name of the database engine to be used for this cluster.
\nValid values: docdb\n
The port number on which the instances in the cluster accept \n connections.
" + "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.
\nConstraints:
\nMust be from 1 to 63 letters or numbers.
\nThe first character must be a letter.
\nCannot be a reserved word for the chosen database engine.\n
\nThe name of the master user for the cluster.
\nConstraints:
\nMust be from 1 to 63 letters or numbers.
\nThe first character must be a letter.
\nCannot be a reserved word for the chosen database engine.\n
\nThe 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 (@).
\nConstraints: Must contain from 8 to 100 characters.
" + "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 (@).
\nConstraints: 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\n automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.\n
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created if\n automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.\n
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, \n in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
\nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur,\n in Universal Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
\nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" } }, "Tags": { @@ -1887,7 +1939,7 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The KMS key identifier for an encrypted cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.
\nIf an encryption key is not specified in KmsKeyId:\n
If the StorageEncrypted parameter is \n true, Amazon DocumentDB uses your default encryption key.\n
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
" + "smithy.api#documentation": "The KMS key identifier for an encrypted cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.
\nIf an encryption key is not specified in KmsKeyId:\n
If the StorageEncrypted parameter is\n true, Amazon DocumentDB uses your default encryption key.\n
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
" } }, "PreSignedUrl": { @@ -1899,13 +1951,13 @@ "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
" + "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.
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.
Creates a new cluster parameter group.
\nParameters in a cluster parameter group apply to all of the \n instances in a cluster.
\nA 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
Creates a new cluster parameter group.
\nParameters in a cluster parameter group apply to all of the\n instances in a cluster.
\nA 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
The name of the cluster parameter group.
\nConstraints:
\nMust not match the name of an existing\n DBClusterParameterGroup.
This value is stored as a lowercase string.
\nThe name of the cluster parameter group.
\nConstraints:
\nMust not match the name of an existing\n DBClusterParameterGroup.
This value is stored as a lowercase string.
\nThe identifier of the cluster snapshot. This parameter is stored \n as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster-snapshot1\n
The identifier of the cluster snapshot. This parameter is stored\n as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.\n
\nExample: my-cluster-snapshot1\n
The identifier of the cluster to create a snapshot for. This \n parameter is not case sensitive.
\nConstraints:
\nMust match the identifier of an existing \n DBCluster.
Example: my-cluster\n
The identifier of the cluster to create a snapshot for. This\n parameter is not case sensitive.
\nConstraints:
\nMust match the identifier of an existing\n DBCluster.
Example: my-cluster\n
The instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The name of the database engine to be used for this instance.
\nValid value: docdb\n
The name of the database engine to be used for this instance.
\nValid value: docdb\n
The Amazon EC2 Availability Zone that the instance is created in.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
The Amazon EC2 Availability Zone that the instance is created in.
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\nExample: us-east-1d\n
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
The default is a 30-minute window selected at random from an 8-hour block of time for\n each Amazon Web Services Region, occurring on a random day of the week.
\nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" + "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
The default is a 30-minute window selected at random from an 8-hour block of time for\n each Amazon Web Services Region, occurring on a random day of the week.
\nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
\nDefault: false\n
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
\nDefault: false\n
The tags to be assigned to the instance. You can assign up to \n 10 tags to an instance.
" + "smithy.api#documentation": "The tags to be assigned to the instance. You can assign up to\n 10 tags to an instance.
" } }, "DBClusterIdentifier": { @@ -2178,7 +2230,7 @@ "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.
\nDefault: 1
\nValid values: 0-15
" + "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.
\nDefault: 1
\nValid values: 0-15
" } }, "EnablePerformanceInsights": { @@ -2190,7 +2242,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The KMS key identifier for encryption of Performance Insights\n data.
\nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name\n for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your\n default KMS key. There is a default KMS key for your\n Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services region.
" + "smithy.api#documentation": "The KMS key identifier for encryption of Performance Insights\n data.
\nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name\n for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your\n default KMS key. There is a default KMS key for your\n Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services region.
" } } }, @@ -2241,7 +2293,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The name for the subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 letters, numbers, periods, underscores,\n spaces, or hyphens. Must not be default.
\nExample: mySubnetgroup\n
The name for the subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 letters, numbers, periods, underscores,\n spaces, or hyphens. Must not be default.
\nExample: mySubnetgroup\n
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
\nYou can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
\nYou can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
The name of the subscription.
\nConstraints: The name must be fewer than 255 characters.
", + "smithy.api#documentation": "The name of the subscription.
\nConstraints: The name must be fewer than 255 characters.
", "smithy.api#required": {} } }, @@ -2333,7 +2385,7 @@ "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 notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-cluster,\n db-parameter-group, db-security-group,\n db-cluster-snapshot\n
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-cluster,\n db-parameter-group, db-security-group,\n db-cluster-snapshot\n
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a\n hyphen or contain two consecutive hyphens.
\nConstraints:
\nIf SourceIds are provided, SourceType must also be\n provided.
If the source type is an instance, a DBInstanceIdentifier must\n be provided.
If the source type is a security group, a DBSecurityGroupName\n must be provided.
If the source type is a parameter group, a\n DBParameterGroupName must be provided.
If the source type is a snapshot, a DBSnapshotIdentifier must\n be provided.
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a\n hyphen or contain two consecutive hyphens.
\nConstraints:
\nIf SourceIds are provided, SourceType must also be\n provided.
If the source type is an instance, a DBInstanceIdentifier must\n be provided.
If the source type is a security group, a DBSecurityGroupName\n must be provided.
If the source type is a parameter group, a\n DBParameterGroupName must be provided.
If the source type is a snapshot, a DBSnapshotIdentifier must\n be provided.
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
\n \nYou can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
\nThis action only applies to Amazon DocumentDB clusters.
\nCreates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
\n \nYou can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
\nThis action only applies to Amazon DocumentDB clusters.
\nThe reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
\nIf a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
" + "smithy.api#documentation": "The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
\nIf a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
" } }, "MultiAZ": { @@ -2833,7 +2885,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The name of a cluster parameter group.
\nConstraints:
\nMust be from 1 to 255 letters or numbers.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThis value is stored as a lowercase string.
\nThe name of a cluster parameter group.
\nConstraints:
\nMust be from 1 to 255 letters or numbers.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThis value is stored as a lowercase string.
\nDescribes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
\n ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
\n PENDING - The IAMrole ARN is being associated with the cluster.
\n INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
\n ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
\n PENDING - The IAMrole ARN is being associated with the cluster.
\n INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
The name of the manual cluster snapshot attribute.
\nThe attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.
The name of the manual cluster snapshot attribute.
\nThe attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.
The values for the manual cluster snapshot attribute.
\nIf the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
The values for the manual cluster snapshot attribute.
\nIf the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
Contains the name and values of a manual cluster snapshot attribute.
\nManual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.
" + "smithy.api#documentation": "Contains the name and values of a manual cluster snapshot attribute.
\nManual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.
" } }, "com.amazonaws.docdb#DBClusterSnapshotAttributeList": { @@ -3817,7 +3869,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
\n " + "smithy.api#documentation": "Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
\n " } }, "com.amazonaws.docdb#DeleteDBClusterMessage": { @@ -3826,7 +3878,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
\nConstraints:
\nMust match an existing DBClusterIdentifier.
The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
\nConstraints:
\nMust match an existing DBClusterIdentifier.
Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.
If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.
Default: false\n
Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.
If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.
Default: false\n
The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
\nMust be from 1 to 255 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\n The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
\nMust be from 1 to 255 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThe name of the cluster parameter group.
\nConstraints:
\nMust be the name of an existing cluster parameter group.
\nYou can't delete a default cluster parameter group.
\nCannot be associated with any clusters.
\nThe name of the cluster parameter group.
\nConstraints:
\nMust be the name of an existing cluster parameter group.
\nYou can't delete a default cluster parameter group.
\nCannot be associated with any clusters.
\nDeletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe cluster snapshot must be in the available state to be deleted.
Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
\nThe cluster snapshot must be in the available state to be deleted.
The identifier of the cluster snapshot to delete.
\nConstraints: Must be the name of an existing cluster snapshot in the available state.
The identifier of the cluster snapshot to delete.
\nConstraints: Must be the name of an existing cluster snapshot in the available state.
The instance identifier for the instance to be deleted. This parameter isn't\n case sensitive.
\nConstraints:
\nMust match the name of an existing instance.
\nThe instance identifier for the instance to be deleted. This parameter isn't\n case sensitive.
\nConstraints:
\nMust match the name of an existing instance.
\nDeletes a subnet group.
\nThe specified database subnet group must not be associated with any DB\n instances.
\nDeletes a subnet group.
\nThe specified database subnet group must not be associated with any DB\n instances.
\nThe name of the database subnet group to delete.
\nYou can't delete the default subnet group.
\nConstraints:
\nMust match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup\n
The name of the database subnet group to delete.
\nYou can't delete the default subnet group.
\nConstraints:
\nMust match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup\n
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
\nThis action only applies to Amazon DocumentDB clusters.
\nDeletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
\nThis action only applies to Amazon DocumentDB clusters.
\nThe name of a specific cluster parameter group to return details for.
\nConstraints:
\nIf provided, must match the name of an existing\n DBClusterParameterGroup.
The name of a specific cluster parameter group to return details for.
\nConstraints:
\nIf provided, must match the name of an existing\n DBClusterParameterGroup.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4246,7 +4298,7 @@ "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The name of a specific cluster parameter group to return parameter details for.
\nConstraints:
\nIf provided, must match the name of an existing DBClusterParameterGroup.
The name of a specific cluster parameter group to return parameter details for.
\nConstraints:
\nIf provided, must match the name of an existing DBClusterParameterGroup.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4293,7 +4345,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of cluster snapshot attribute names and values for a manual DB\n cluster snapshot.
\nWhen you share snapshots with other Amazon Web Services accounts,\n DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
Returns a list of cluster snapshot attribute names and values for a manual DB\n cluster snapshot.
\nWhen you share snapshots with other Amazon Web Services accounts,\n DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
Constraints:
\nIf provided, must match the identifier of an existing\n DBCluster.
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
Constraints:
\nIf provided, must match the identifier of an existing\n DBCluster.
A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
\nIf provided, must match the identifier of an existing\n DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType\n parameter must also be specified.
A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
\nIf provided, must match the identifier of an existing\n DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType\n parameter must also be specified.
The type of cluster snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
\n manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
\n shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
\n public - Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
The type of cluster snapshots to be returned. You can specify one of the following values:
\n\n automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
\n manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
\n shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
\n public - Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4414,7 +4466,7 @@ } ], "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.
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.
The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.
\nConstraints:
\nIf provided, must match an existing DBClusterIdentifier.
The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.
\nConstraints:
\nIf provided, must match an existing DBClusterIdentifier.
A filter that specifies one or more clusters to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.
A filter that specifies one or more clusters to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4485,13 +4537,13 @@ "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The database engine version to return.
\nExample: 3.6.0\n
The database engine version to return.
\nExample: 3.6.0\n
The name of a specific parameter group family to return details for.
\nConstraints:
\nIf provided, must match an existing\n DBParameterGroupFamily.
The name of a specific parameter group family to return details for.
\nConstraints:
\nIf provided, must match an existing\n DBParameterGroupFamily.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4696,19 +4748,19 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
\nConstraints:
\nIf provided, must match the identifier of an existing\n DBInstance.
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
\nConstraints:
\nIf provided, must match the identifier of an existing\n DBInstance.
A filter that specifies one or more instances to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
\n db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
A filter that specifies one or more instances to describe.
\nSupported filters:
\n\n db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
\n db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4763,7 +4815,7 @@ "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4808,7 +4860,7 @@ "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4848,7 +4900,7 @@ "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The type of source that is generating the events.
\nValid values: db-instance, db-parameter-group, db-security-group\n
The type of source that is generating the events.
\nValid values: db-instance, db-parameter-group, db-security-group\n
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -4941,7 +4993,7 @@ "SourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
\nConstraints:
\nIf SourceIdentifier is provided, SourceType must also be provided.
If the source type is DBInstance, a\n DBInstanceIdentifier must be provided.
If the source type is DBSecurityGroup, a\n DBSecurityGroupName must be provided.
If the source type is DBParameterGroup, a\n DBParameterGroupName must be provided.
If the source type is DBSnapshot, a\n DBSnapshotIdentifier must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
\nThe identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
\nConstraints:
\nIf SourceIdentifier is provided, SourceType must also be provided.
If the source type is DBInstance, a\n DBInstanceIdentifier must be provided.
If the source type is DBSecurityGroup, a\n DBSecurityGroupName must be provided.
If the source type is DBParameterGroup, a\n DBParameterGroupName must be provided.
If the source type is DBSnapshot, a\n DBSnapshotIdentifier must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
\nThe beginning of the time interval to retrieve events for, specified in ISO 8601 format.
\nExample: 2009-07-08T18:00Z
" + "smithy.api#documentation": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
\nExample: 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.
\nExample: 2009-07-08T18:00Z
" + "smithy.api#documentation": "The end of the time interval for which to retrieve events, specified in ISO 8601\n format.
\nExample: 2009-07-08T18:00Z
" } }, "Duration": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of minutes to retrieve events for.
\nDefault: 60
" + "smithy.api#documentation": "The number of minutes to retrieve events for.
\nDefault: 60
" } }, "EventCategories": { @@ -4983,7 +5035,7 @@ "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -5011,7 +5063,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about Amazon DocumentDB global clusters. This API supports pagination.
\nThis action only applies to Amazon DocumentDB clusters.
\nReturns information about Amazon DocumentDB global clusters. This API supports pagination.
\nThis action only applies to Amazon DocumentDB clusters.
\nA filter that specifies one or more global DB clusters to describe.
\nSupported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.
A filter that specifies one or more global DB clusters to describe.
\nSupported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, "Marker": { @@ -5159,7 +5211,7 @@ "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.
\nSupported filters:
\n\n db-cluster-id - Accepts cluster identifiers and cluster\n Amazon Resource Names (ARNs). The results list includes only pending maintenance\n actions for the clusters identified by these ARNs.
\n db-instance-id - Accepts instance identifiers and instance\n ARNs. The results list includes only pending maintenance actions for the DB\n instances identified by these ARNs.
A filter that specifies one or more resources to return pending maintenance actions\n for.
\nSupported filters:
\n\n db-cluster-id - Accepts cluster identifiers and cluster\n Amazon Resource Names (ARNs). The results list includes only pending maintenance\n actions for the clusters identified by these ARNs.
\n db-instance-id - Accepts instance identifiers and instance\n ARNs. The results list includes only pending maintenance actions for the DB\n instances identified by these ARNs.
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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "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.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } } }, @@ -5361,7 +5413,7 @@ "Status": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The status of the Amazon DocumentDB event notification subscription.
\nConstraints:
\nCan be one of the following: creating, modifying,\n deleting, active, no-permission,\n topic-not-exist\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.
The status of the Amazon DocumentDB event notification subscription.
\nConstraints:
\nCan be one of the following: creating, modifying,\n deleting, active, no-permission,\n topic-not-exist\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.
Forces a failover for a cluster.
\nA failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
\nIf the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
" + "smithy.api#documentation": "Forces a failover for a cluster.
\nA failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
\nIf the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
" } }, "com.amazonaws.docdb#FailoverDBClusterMessage": { @@ -5504,13 +5556,13 @@ "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "A cluster identifier to force a failover for. This parameter is not case sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
A cluster identifier to force a failover for. This parameter is not case sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
The name of the instance to promote to the primary instance.
\nYou must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For\n example, mydbcluster-replica1.
The name of the instance to promote to the primary instance.
\nYou must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For\n example, mydbcluster-replica1.
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.
\nWildcards are not supported in filters.
" + "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.
\nWildcards are not supported in filters.
" } }, "com.amazonaws.docdb#FilterList": { @@ -5578,7 +5630,7 @@ "GlobalClusterResourceId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
" + "smithy.api#documentation": "The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.
" } }, "GlobalClusterArn": { @@ -6181,27 +6233,27 @@ "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.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter is\n not case sensitive.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
The new cluster identifier for the cluster when renaming a cluster. This\n value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster2\n
The new cluster identifier for the cluster when renaming a cluster. This\n value is stored as a lowercase string.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: my-cluster2\n
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.
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.
Default: false\n
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.
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.
Default: false\n
The number of days for which automated backups are retained. You must specify a\n minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35.
\nThe number of days for which automated backups are retained. You must specify a\n minimum value of 1.
\nDefault: 1
\nConstraints:
\nMust be a value from 1 to 35.
\nThe port number on which the cluster accepts connections.
\nConstraints: Must be a value from 1150 to 65535.
Default: The same port as the original cluster.
" + "smithy.api#documentation": "The port number on which the cluster accepts connections.
\nConstraints: Must be a value from 1150 to 65535.
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 (@).
\nConstraints: Must contain from 8 to 100 characters.
" + "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 (@).
\nConstraints: 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.
The default is a 30-minute window selected at random from an 8-hour block of time for\n each Amazon Web Services Region.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe daily time range during which automated backups are created if automated backups\n are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for\n each Amazon Web Services Region.
\nConstraints:
\nMust be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
\nMust not conflict with the preferred maintenance window.
\nMust be at least 30 minutes.
\nThe weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an 8-hour block of time for\n each Amazon Web Services Region, occurring on a random day of the week.
\nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" + "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
The default is a 30-minute window selected at random from an 8-hour block of time for\n each Amazon Web Services Region, occurring on a random day of the week.
\nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" } }, "CloudwatchLogsExportConfiguration": { @@ -6280,7 +6332,7 @@ } ], "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.
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.
\nAfter 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.
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.
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.
\nAfter 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.
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
\nTo share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
\nTo share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
The name of the cluster snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster\n snapshot, set this value to restore.
The name of the cluster snapshot attribute to modify.
\nTo manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster\n snapshot, set this value to restore.
A list of cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.
A list of cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.
A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
The instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
The instance identifier. This value is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.
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.
Default: Uses existing setting.
" + "smithy.api#documentation": "The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.
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.
Default: Uses existing setting.
" } }, "ApplyImmediately": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#default": false, - "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.
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.
Default: false\n
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.
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.
Default: false\n
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.
\nDefault: Uses existing setting.
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Must be at least 30 minutes.
" + "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.
\nDefault: Uses existing setting.
\nFormat: ddd:hh24:mi-ddd:hh24:mi\n
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Must be at least 30 minutes.
" } }, "AutoMinorVersionUpgrade": { @@ -6469,7 +6521,7 @@ "NewDBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": " The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
\nDefault: 1
\nValid values: 0-15
" + "smithy.api#documentation": "A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
\nDefault: 1
\nValid values: 0-15
" } }, "EnablePerformanceInsights": { @@ -6499,7 +6551,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The KMS key identifier for encryption of Performance Insights\n data.
\nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name\n for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your\n default KMS key. There is a default KMS key for your\n Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services region.
" + "smithy.api#documentation": "The KMS key identifier for encryption of Performance Insights\n data.
\nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name\n for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your\n default KMS key. There is a default KMS key for your\n Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services region.
" } } }, @@ -6550,7 +6602,7 @@ "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 can't modify the default subnet group.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup\n
The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
\nConstraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup\n
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-parameter-group, db-security-group\n
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-parameter-group, db-security-group\n
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
\nThis action only applies to Amazon DocumentDB clusters.
\nModify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
\nThis action only applies to Amazon DocumentDB clusters.
\nThe identifier for the global cluster being modified. This parameter isn't case-sensitive.
\n\t\tConstraints:
\nMust match the identifier of an existing global cluster.
\n\t\t\tThe identifier for the global cluster being modified. This parameter isn't case-sensitive.
\nConstraints:
\nMust match the identifier of an existing global cluster.
\nThe new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.
\nMust contain from 1 to 63 letters, numbers, or hyphens
\n\t\t\t\tThe first character must be a letter
\n\t\t\t\tCan't end with a hyphen or contain two consecutive hyphens
\n\t\t\tExample: my-cluster2\n
The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.
\nMust contain from 1 to 63 letters, numbers, or hyphens
\nThe first character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nExample: my-cluster2\n
The license model for the instance.
\nValid values: license-included, bring-your-own-license,\n general-public-license\n
The license model for the instance.
\nValid values: license-included, bring-your-own-license,\n general-public-license\n
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.
\nRebooting 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.
" + "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.
\nRebooting 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": { @@ -7101,14 +7153,14 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
The instance identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nMust match the identifier of an existing DBInstance.
When true, the reboot is conducted through a Multi-AZ failover.
Constraint: You can't specify true if the instance is not configured for\n Multi-AZ.
When true, the reboot is conducted through a Multi-AZ failover.
Constraint: You can't specify true if the instance is not configured for\n Multi-AZ.
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
\nThis action only applies to Amazon DocumentDB clusters.
\nDetaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
\nThis action only applies to Amazon DocumentDB clusters.
\n 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.
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.
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.
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.
The Amazon Resource Name (ARN) of the resource that has pending \n maintenance actions.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that has pending\n maintenance actions.
" } }, "PendingMaintenanceActionDetails": { @@ -7410,7 +7462,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new cluster from a snapshot or cluster snapshot.
\nIf a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
\nIf a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
" + "smithy.api#documentation": "Creates a new cluster from a snapshot or cluster snapshot.
\nIf a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
\nIf a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
" } }, "com.amazonaws.docdb#RestoreDBClusterFromSnapshotMessage": { @@ -7425,21 +7477,21 @@ "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.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: my-snapshot-id\n
The name of the cluster to create from the snapshot or cluster snapshot. This\n parameter isn't case sensitive.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nExample: my-snapshot-id\n
The identifier for the snapshot or cluster snapshot to restore from.
\nYou 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.
\nConstraints:
\nMust match the identifier of an existing snapshot.
\nThe identifier for the snapshot or cluster snapshot to restore from.
\nYou 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.
\nConstraints:
\nMust match the identifier of an existing snapshot.
\nThe database engine to use for the new cluster.
\nDefault: The same as source.
\nConstraint: Must be compatible with the engine of the source.
", + "smithy.api#documentation": "The database engine to use for the new cluster.
\nDefault: The same as source.
\nConstraint: Must be compatible with the engine of the source.
", "smithy.api#required": {} } }, @@ -7452,13 +7504,13 @@ "Port": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which the new cluster accepts connections.
\nConstraints: Must be a value from 1150 to 65535.
Default: The same port as the original cluster.
" + "smithy.api#documentation": "The port number on which the new cluster accepts connections.
\nConstraints: Must be a value from 1150 to 65535.
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.
\nConstraints: If provided, must match the name of an existing\n DBSubnetGroup.
Example: mySubnetgroup\n
The name of the subnet group to use for the new cluster.
\nConstraints: If provided, must match the name of an existing\n DBSubnetGroup.
Example: mySubnetgroup\n
The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
\nIf you do not specify a value for the KmsKeyId parameter, then the\n following occurs:
If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in\n SnapshotIdentifier is not encrypted, then the restored DB\n cluster is not encrypted.
The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
\nIf you do not specify a value for the KmsKeyId parameter, then the\n following occurs:
If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in\n SnapshotIdentifier is not encrypted, then the restored DB\n cluster is not encrypted.
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
The name of the DB cluster parameter group to associate with this DB cluster.
\n\n Type: String. Â Â Â Required: No.
\nIf this argument is omitted, the default DB cluster parameter group is used.\n If supplied, must match the name of an existing default DB cluster parameter group.\n The string must consist of from 1 to 255 letters, numbers or hyphens. Its first\n character must be a letter, and it cannot end with a hyphen or contain two consecutive\n hyphens.
" + } } }, "traits": { @@ -7569,46 +7627,46 @@ "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "The name of the new cluster to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThe name of the new cluster to be created.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThe type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
The type of restore to be performed. You can specify one of the following values:
\n\n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.
\n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.
The identifier of the source cluster from which to restore.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
The identifier of the source cluster from which to restore.
\nConstraints:
\nMust match the identifier of an existing DBCluster.
The date and time to restore the cluster to.
\nValid values: A time in Universal Coordinated Time (UTC) format.
\nConstraints:
\nMust be before the latest restorable time for the instance.
\nMust be specified if the UseLatestRestorableTime parameter is not provided.
Cannot be specified if the UseLatestRestorableTime parameter is true.
Cannot be specified if the RestoreType parameter is copy-on-write.
Example: 2015-03-07T23:45:00Z\n
The date and time to restore the cluster to.
\nValid values: A time in Universal Coordinated Time (UTC) format.
\nConstraints:
\nMust be before the latest restorable time for the instance.
\nMust be specified if the UseLatestRestorableTime parameter is not provided.
Cannot be specified if the UseLatestRestorableTime parameter is true.
Cannot be specified if the RestoreType parameter is copy-on-write.
Example: 2015-03-07T23:45:00Z\n
A value that is set to true to restore the cluster to the latest\n restorable backup time, and false otherwise.
Default: false\n
Constraints: Cannot be specified if the RestoreToTime parameter is\n provided.
A value that is set to true to restore the cluster to the latest\n restorable backup time, and false otherwise.
Default: false\n
Constraints: Cannot be specified if the RestoreToTime parameter is\n provided.
The port number on which the new cluster accepts connections.
\nConstraints: Must be a value from 1150 to 65535.
Default: The default port for the engine.
" + "smithy.api#documentation": "The port number on which the new cluster accepts connections.
\nConstraints: Must be a value from 1150 to 65535.
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.
\nConstraints: If provided, must match the name of an existing\n DBSubnetGroup.
Example: mySubnetgroup\n
The subnet group name to use for the new cluster.
\nConstraints: If provided, must match the name of an existing\n DBSubnetGroup.
Example: mySubnetgroup\n
The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
\nYou can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
\nIf the cluster is not encrypted, then the restored cluster is not encrypted.
\nIf DBClusterIdentifier refers to a cluster that is not encrypted, then\n the restore request is rejected.
The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
\nThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
\nYou can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
\nIf the cluster is not encrypted, then the restored cluster is not encrypted.
\nIf DBClusterIdentifier refers to a cluster that is not encrypted, then\n the restore request is rejected.
The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
" + "smithy.api#documentation": "The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
", + "smithy.api#input": {} } }, "com.amazonaws.fsx#AssociateFileSystemAliasesResponse": { @@ -1538,7 +1589,8 @@ } }, "traits": { - "smithy.api#documentation": "The system generated response showing the DNS aliases that \n Amazon FSx is attempting to associate with the file system. \n Use the API \n operation to monitor the status of the aliases Amazon FSx is \n associating with the file system. It can take up to 2.5 minutes for \n the alias status to change from CREATING to AVAILABLE.
The system generated response showing the DNS aliases that \n Amazon FSx is attempting to associate with the file system. \n Use the API \n operation to monitor the status of the aliases Amazon FSx is \n associating with the file system. It can take up to 2.5 minutes for \n the alias status to change from CREATING to AVAILABLE.
Describes a data repository association's automatic export policy. The\n AutoExportPolicy defines the types of updated objects on the\n file system that will be automatically exported to the data repository.\n As you create, modify, or delete files, Amazon FSx for Lustre \n automatically exports the defined changes asynchronously once your application finishes\n modifying the file.
This AutoExportPolicy is supported only for Amazon FSx for Lustre\n file systems with the Persistent_2 deployment type.
Describes a data repository association's automatic export policy. The\n AutoExportPolicy defines the types of updated objects on the\n file system that will be automatically exported to the data repository.\n As you create, modify, or delete files, Amazon FSx for Lustre \n automatically exports the defined changes asynchronously once your application finishes\n modifying the file.
The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems\n with a data repository association.
Describes the data repository association's automatic import policy.\n The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory\n listings up to date by importing changes to your Amazon FSx for Lustre file system\n as you modify objects in a linked S3 bucket.
\nThe AutoImportPolicy is supported only for Amazon FSx for Lustre\n file systems with the Persistent_2 deployment type.
Describes the data repository association's automatic import policy.\n The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory\n listings up to date by importing changes to your Amazon FSx for Lustre file system\n as you modify objects in a linked S3 bucket.
\nThe AutoImportPolicy is only supported on Amazon FSx for Lustre file systems\n with a data repository association.
Cancels a data repository task.
" + "smithy.api#documentation": "Cancels a data repository task.
", + "smithy.api#input": {} } }, "com.amazonaws.fsx#CancelDataRepositoryTaskResponse": { @@ -1964,6 +2017,9 @@ "smithy.api#documentation": "The ID of the task being canceled.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#CapacityToRelease": { @@ -1978,7 +2034,7 @@ "com.amazonaws.fsx#ClientRequestToken": { "type": "string", "traits": { - "smithy.api#documentation": "(Optional) An idempotency token for resource creation, in a string of up to 64\n ASCII characters. This token is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "(Optional) An idempotency token for resource creation, in a string of up to 63\n ASCII characters. This token is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#length": { "min": 1, "max": 63 @@ -1999,7 +2055,7 @@ "Path": { "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The Path you provide must be located within the file system’s ExportPath. \n An example Path value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .\n
Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The Path you provide must be located within the file system’s ExportPath. \n An example Path value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode.
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to\n ensure idempotent creation. This string is automatically filled on your behalf when you\n use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "(Optional) A string of up to 63 ASCII characters that Amazon FSx uses to\n ensure idempotent creation. This string is automatically filled on your behalf when you\n use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, @@ -2192,7 +2254,8 @@ } }, "traits": { - "smithy.api#documentation": "The request object for the CreateBackup operation.
The request object for the CreateBackup operation.
The response object for the CreateBackup operation.
The response object for the CreateBackup operation.
Creates an Amazon FSx for Lustre data repository association (DRA). A data\n repository association is a link between a directory on the file system and\n an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\n associations on a file system. Data repository associations are supported only\n for file systems with the Persistent_2 deployment type.
Each data repository association must have a unique Amazon FSx file\n system directory and a unique S3 bucket or prefix associated with it. You\n can configure a data repository association for automatic import only,\n for automatic export only, or for both. To learn more about linking a\n data repository to your file system, see \n Linking your file system to an S3 bucket.
\n\n CreateDataRepositoryAssociation isn't supported\n on Amazon File Cache resources. To create a DRA on Amazon File Cache,\n use the CreateFileCache operation.
Creates an Amazon FSx for Lustre data repository association (DRA). A data\n repository association is a link between a directory on the file system and\n an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\n associations on a file system. Data repository associations are supported\n for all file systems except for Scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file\n system directory and a unique S3 bucket or prefix associated with it. You\n can configure a data repository association for automatic import only,\n for automatic export only, or for both. To learn more about linking a\n data repository to your file system, see \n Linking your file system to an S3 bucket.
\n\n CreateDataRepositoryAssociation isn't supported\n on Amazon File Cache resources. To create a DRA on Amazon File Cache,\n use the CreateFileCache operation.
The response object returned after the data repository association is created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#CreateDataRepositoryTask": { @@ -2384,6 +2454,9 @@ "smithy.api#documentation": "Specifies the amount of data to release, in GiB, by an Amazon File Cache\n AUTO_RELEASE_DATA task that automatically releases files from the cache.
The description of the data repository task that you just created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#CreateFileCache": { @@ -2483,7 +2559,7 @@ "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "An idempotency token for resource creation, in a string of up to 64\n ASCII characters. This token is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
\nBy using the idempotent operation, you can retry a CreateFileCache\n operation without the risk of creating an extra cache. This approach can be useful\n when an initial call fails in a way that makes it unclear whether a cache was created.\n Examples are if a transport level timeout occurred, or your connection was reset.\n If you use the same client request token and the initial call created a cache, the\n client receives success as long as the parameters are the same.
An idempotency token for resource creation, in a string of up to 63\n ASCII characters. This token is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
\nBy using the idempotent operation, you can retry a CreateFileCache\n operation without the risk of creating an extra cache. This approach can be useful\n when an initial call fails in a way that makes it unclear whether a cache was created.\n Examples are if a transport level timeout occurred, or your connection was reset.\n If you use the same client request token and the initial call created a cache, the\n client receives success as long as the parameters are the same.
A list of up to 8 configurations for data repository associations (DRAs) to\n be created during the cache creation. The DRAs link the cache to either an\n Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
\nThe DRA configurations must meet the following requirements:
\nAll configurations on the list must be of the\n same data repository type, either all S3 or all NFS. A cache\n can't link to different data repository types at the same time.
\nAn NFS DRA must link to an NFS file system that\n supports the NFSv3 protocol.
\nDRA automatic import and automatic export is not supported.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#CreateFileCacheResponse": { @@ -2558,6 +2637,9 @@ "smithy.api#documentation": "A description of the cache that was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#CreateFileSystem": { @@ -2657,7 +2739,7 @@ "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, @@ -2718,7 +2800,8 @@ } }, "traits": { - "smithy.api#documentation": "The request object for the CreateFileSystemFromBackup\n operation.
The request object for the CreateFileSystemFromBackup\n operation.
The response object for the CreateFileSystemFromBackup\n operation.
The response object for the CreateFileSystemFromBackup\n operation.
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.
This parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.
This parameter is not supported for file systems with a data repository association.
\n(Optional) Available with Scratch and Persistent_1 deployment types. \n Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. \n The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which\n new and changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z.
The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath. If you specify only a bucket name, such as\n s3://import-bucket, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.
This parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.
(Optional) Specifies the path in the Amazon S3 bucket where the root of your\n Amazon FSx file system is exported. The path must use the same Amazon S3\n bucket as specified in ImportPath. You can provide an optional prefix to which new and\n changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z.
The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath. If you specify only a bucket name, such as\n s3://import-bucket, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.
This parameter is not supported for file systems with a data repository association.
\n(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.
\nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
\nThis parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.
(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.
\nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
\nThis parameter is not supported for file systems with a data repository association.
\n(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 for longer-term storage and for throughput-focused \n workloads that aren’t latency-sensitive.\n PERSISTENT_1 supports encryption of data in transit, and is available in all \n Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads \n that require the highest levels of IOPS/throughput. PERSISTENT_2 supports \n SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 \n is available in a limited number of Amazon Web Services Regions. \n For more information, and an up-to-date list of Amazon Web Services Regions in which \n PERSISTENT_2 is available, see \n File \n system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2, and you set FileSystemTypeVersion to\n 2.10, the CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access\n SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file\n systems from Amazon EC2 instances that support\n automatic encryption in the Amazon Web Services Regions where they are\n available. For more information about encryption in transit for FSx for Lustre\n file systems, see Encrypting data in\n transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1)
(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 for longer-term storage and for throughput-focused \n workloads that aren’t latency-sensitive.\n PERSISTENT_1 supports encryption of data in transit, and is available in all \n Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads \n that require the highest levels of IOPS/throughput. PERSISTENT_2 supports \n SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 \n is available in a limited number of Amazon Web Services Regions. \n For more information, and an up-to-date list of Amazon Web Services Regions in which \n PERSISTENT_2 is available, see \n File \n system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2, and you set FileSystemTypeVersion to\n 2.10, the CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access\n SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file\n systems from Amazon EC2 instances that support automatic encryption in\n the Amazon Web Services Regions where they are available. For more information about\n encryption in transit for FSx for Lustre file systems, see Encrypting data in\n transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1)
(Optional) Available with Scratch and Persistent_1 deployment types. When you \n create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.
\n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.
For more information, see \n Automatically import updates from your S3 bucket.
\nThis parameter is not supported for file systems with the Persistent_2 deployment type.\n Instead, use CreateDataRepositoryAssociation to create\n a data repository association to link your Lustre file system to a data repository.
(Optional) When you create your file system, your existing S3 objects appear as file and\n directory listings. Use this parameter to choose how Amazon FSx keeps your file and directory\n listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy\n can have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.
\n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.
For more information, see \n Automatically import updates from your S3 bucket.
\nThis parameter is not supported for file systems with a data repository association.
\nThe Lustre configuration for the file system being created.
\nThe following parameters are not supported for file systems with the Persistent_2\n deployment type. Instead, use CreateDataRepositoryAssociation \n to create a data repository association to link your Lustre file system to a data repository.
\n AutoImportPolicy\n
\n ExportPath\n
\n ImportedChunkSize\n
\n ImportPath\n
The Lustre configuration for the file system being created.
\nThe following parameters are not supported for file systems\n with a data repository association created with\n .
\n\n AutoImportPolicy\n
\n ExportPath\n
\n ImportedChunkSize\n
\n ImportPath\n
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API, Amazon FSx\n selects an unused IP address range for you from the 198.19.* range. By default in the \n Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from\n the VPC’s primary CIDR range to use as the endpoint IP address range for the file system.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.
" + "smithy.api#documentation": "(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API, Amazon FSx\n selects an unused IP address range for you from the 198.19.* range. By default in the \n Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from\n the VPC’s primary CIDR range to use as the endpoint IP address range for the file system.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables, as long as they don't overlap with any subnet.
" } }, "FsxAdminPassword": { @@ -2940,7 +3024,7 @@ "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, @@ -3012,7 +3096,8 @@ } }, "traits": { - "smithy.api#documentation": "The request object used to create a new Amazon FSx file system.
" + "smithy.api#documentation": "The request object used to create a new Amazon FSx file system.
", + "smithy.api#input": {} } }, "com.amazonaws.fsx#CreateFileSystemResponse": { @@ -3026,7 +3111,8 @@ } }, "traits": { - "smithy.api#documentation": "The response object returned after the file system is created.
" + "smithy.api#documentation": "The response object returned after the file system is created.
", + "smithy.api#output": {} } }, "com.amazonaws.fsx#CreateFileSystemWindowsConfiguration": { @@ -3107,7 +3193,7 @@ "JunctionPath": { "target": "com.amazonaws.fsx#JunctionPath", "traits": { - "smithy.api#documentation": "Specifies the location in the SVM's namespace where the volume is mounted. \n The JunctionPath must have a leading forward slash, such as /vol3.
Specifies the location in the SVM's namespace where the volume is mounted.\n This parameter is required. The JunctionPath must have a leading\n forward slash, such as /vol3.
Specifies the size of the volume, in megabytes (MB), that you are creating.
", + "smithy.api#documentation": "Specifies the size of the volume, in megabytes (MB), that you are creating.\n Provide any whole number in the range of 20–104857600 to specify the size of\n the volume.
", "smithy.api#required": {} } }, "StorageEfficiencyEnabled": { "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "Set to true to enable deduplication, compression, and\n compaction storage efficiency features on the volume.
" + "smithy.api#documentation": "Set to true to enable deduplication, compression, and compaction storage\n efficiency features on the volume, or set to false to disable them.\n This parameter is required.
" } }, "StorageVirtualMachineId": { @@ -3305,6 +3391,9 @@ "Tags": { "target": "com.amazonaws.fsx#Tags" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#CreateSnapshotResponse": { @@ -3316,6 +3405,9 @@ "smithy.api#documentation": "A description of the snapshot.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#CreateStorageVirtualMachine": { @@ -3396,6 +3488,9 @@ "smithy.api#documentation": "The security style of the root volume of the SVM. Specify one of the following values:
\n\n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.
\n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED if the file system is managed by both UNIX\n and Windows administrators and users consist of both NFS and SMB clients.
Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.
Returned after a successful CreateVolumeFromBackup API operation,\n describing the volume just created.
Specifies the configuration to use when creating the OpenZFS volume.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#CreateVolumeResponse": { @@ -3596,6 +3703,9 @@ "smithy.api#documentation": "Returned after a successful CreateVolume API operation, describing the volume just created.
The configuration of a data repository association that links\n an Amazon FSx for Lustre file system to an Amazon S3 bucket\n or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system.\n The data repository association configuration object is returned\n in the response of the following operations:
\n\n CreateDataRepositoryAssociation\n
\n UpdateDataRepositoryAssociation\n
\n DescribeDataRepositoryAssociations\n
Data repository associations are supported only for an Amazon FSx for Lustre\n file system with the Persistent_2 deployment type and for an\n Amazon File Cache resource.
The configuration of a data repository association that links\n an Amazon FSx for Lustre file system to an Amazon S3 bucket\n or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system.\n The data repository association configuration object is returned\n in the response of the following operations:
\n\n CreateDataRepositoryAssociation\n
\n UpdateDataRepositoryAssociation\n
\n DescribeDataRepositoryAssociations\n
Data repository associations are supported on Amazon File Cache resources and\n all Amazon FSx for Lustre file systems excluding Scratch_1 deployment\n types.
The data repository configuration object for Lustre file systems returned in the response of\n the CreateFileSystem operation.
This data type is not supported for file systems with the Persistent_2 deployment type.\n Instead, use .
The data repository configuration object for Lustre file systems returned in the response of\n the CreateFileSystem operation.
This data type is not supported on file systems with a data repository association.\n For file systems with a data repository association,\n see .
" } }, "com.amazonaws.fsx#DataRepositoryFailureDetails": { @@ -3891,7 +4001,7 @@ "Type": { "target": "com.amazonaws.fsx#DataRepositoryTaskType", "traits": { - "smithy.api#documentation": "The type of data repository task.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
\n RELEASE_DATA_FROM_FILESYSTEM tasks are not supported.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This parameter is automatically filled on your behalf when using\n the CLI or SDK.
", + "smithy.api#documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This parameter is automatically filled on your behalf when using\n the CLI or SDK.
", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "The request object for the DeleteBackup operation.
The request object for the DeleteBackup operation.
The response object for the DeleteBackup operation.
The response object for the DeleteBackup operation.
Deletes a data repository association on an Amazon FSx for Lustre\n file system. Deleting the data repository association unlinks the\n file system from the Amazon S3 bucket. When deleting a data repository\n association, you have the option of deleting the data in the file system\n that corresponds to the data repository association. Data repository\n associations are supported only for file systems with the\n Persistent_2 deployment type.
Deletes a data repository association on an Amazon FSx for Lustre\n file system. Deleting the data repository association unlinks the\n file system from the Amazon S3 bucket. When deleting a data repository\n association, you have the option of deleting the data in the file system\n that corresponds to the data repository association. Data repository\n associations are supported for all file systems except for Scratch_1\n deployment type.
Set to true to delete the data in the file system that corresponds\n to the data repository association.
Indicates whether data in the file system that corresponds to the data\n repository association is being deleted. Default is false.
The cache lifecycle for the deletion request. If the\n DeleteFileCache operation is successful, this status is\n DELETING.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This token is automatically filled on your behalf when using the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This token is automatically filled on your behalf when using the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, @@ -4622,7 +4746,8 @@ } }, "traits": { - "smithy.api#documentation": "The request object for DeleteFileSystem operation.
The request object for DeleteFileSystem operation.
The response object for the DeleteFileSystem operation.
The response object for the DeleteFileSystem operation.
The lifecycle status of the snapshot. If the DeleteSnapshot operation is\n successful, this status is DELETING.
Describes the lifecycle state of the SVM being deleted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#DeleteVolume": { @@ -4939,6 +5077,9 @@ "smithy.api#documentation": "For Amazon FSx for OpenZFS volumes, specify whether to delete all child\n volumes and snapshots.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#DeleteVolumeResponse": { @@ -4962,6 +5103,9 @@ "smithy.api#documentation": "Returned after a DeleteVolume request, showing the status of the delete\n request.
The request object for the DescribeBackups operation.
The request object for the DescribeBackups operation.
Response object for the DescribeBackups operation.
Response object for the DescribeBackups operation.
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache\n data repository associations, if one or more AssociationIds values\n are provided in the request, or if filters are used in the request. Data repository\n associations are supported only for Amazon FSx for Lustre file systems with the\n Persistent_2 deployment type and for Amazon File Cache resources.
You can use filters to narrow the response to include just data repository\n associations for specific file systems (use the file-system-id filter with\n the ID of the file system) or caches (use the file-cache-id filter with\n the ID of the cache), or data repository associations for a specific repository type\n (use the data-repository-type filter with a value of S3\n or NFS). If you don't use filters, the response returns all data\n repository associations owned by your Amazon Web Services account in the Amazon Web Services Region\n of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using\n the optional MaxResults parameter to limit the number of data repository associations\n returned in a response. If more data repository associations remain, a\n NextToken value is returned in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache\n data repository associations, if one or more AssociationIds values\n are provided in the request, or if filters are used in the request. Data repository\n associations are supported on Amazon File Cache resources and all Amazon FSx for\n Lustre file systems excluding Scratch_1 deployment types.
You can use filters to narrow the response to include just data repository\n associations for specific file systems (use the file-system-id filter with\n the ID of the file system) or caches (use the file-cache-id filter with\n the ID of the cache), or data repository associations for a specific repository type\n (use the data-repository-type filter with a value of S3\n or NFS). If you don't use filters, the response returns all data\n repository associations owned by your Amazon Web Services account in the Amazon Web Services Region\n of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using\n the optional MaxResults parameter to limit the number of data repository associations\n returned in a response. If more data repository associations remain, a\n NextToken value is returned in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
The request object for DescribeFileSystemAliases operation.
The request object for DescribeFileSystemAliases operation.
The response object for DescribeFileSystemAliases operation.
The response object for DescribeFileSystemAliases operation.
The request object for DescribeFileSystems operation.
The request object for DescribeFileSystems operation.
The response object for DescribeFileSystems operation.
The response object for DescribeFileSystems operation.
The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
" + "smithy.api#documentation": "The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
", + "smithy.api#input": {} } }, "com.amazonaws.fsx#DisassociateFileSystemAliasesResponse": { @@ -5695,7 +5882,8 @@ } }, "traits": { - "smithy.api#documentation": "The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. \n Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.
" + "smithy.api#documentation": "The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. \n Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.
", + "smithy.api#output": {} } }, "com.amazonaws.fsx#DiskIopsConfiguration": { @@ -6230,7 +6418,7 @@ "OwnerId": { "target": "com.amazonaws.fsx#AWSAccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account that created the file system. If the file system was created by an\n Identity and Access Management (IAM) user, the Amazon Web Services account to which the\n IAM user belongs is the owner.
" + "smithy.api#documentation": "The Amazon Web Services account that created the file system. If the file system was created by a\n user in IAM Identity Center, the Amazon Web Services account to which the\n IAM user belongs is the owner.
" } }, "CreationTime": { @@ -7065,7 +7253,8 @@ } }, "traits": { - "smithy.api#documentation": "The request object for ListTagsForResource operation.
The request object for ListTagsForResource operation.
The response object for ListTagsForResource operation.
The response object for ListTagsForResource operation.
(Multi-AZ only) The IP address range in which the endpoints to access your file system\n are created.
\nThe Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.\n If you do not specify this optional parameter, Amazon FSx will automatically\n select a CIDR block for you.
\n(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API, Amazon FSx\n selects an unused IP address range for you from the 198.19.* range. By default in the \n Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from\n the VPC’s primary CIDR range to use as the endpoint IP address range for the file system.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.
" } }, "Endpoints": { @@ -8199,6 +8389,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#ReleaseFileSystemNfsV3LocksResponse": { @@ -8207,6 +8400,9 @@ "FileSystem": { "target": "com.amazonaws.fsx#FileSystem" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#ReleasedCapacity": { @@ -8397,6 +8593,9 @@ "smithy.api#documentation": "The settings used when restoring the specified volume from snapshot.
\n\n DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the\n current state and the specified snapshot. If there are intermediate snapshots\n and this option isn't used, RestoreVolumeFromSnapshot fails.
\n DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes \n created from intermediate snapshots. If there are any dependent clone volumes and this \n option isn't used, RestoreVolumeFromSnapshot fails.
A list of administrative actions for the file system that are in process or waiting to\n be processed. Administrative actions describe changes to the Amazon FSx\n system.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#RouteTableId": { @@ -9506,14 +9708,16 @@ } }, "traits": { - "smithy.api#documentation": "The request object for the TagResource operation.
The request object for the TagResource operation.
The response object for the TagResource operation.
The response object for the TagResource operation.
The request object for UntagResource action.
The request object for UntagResource action.
The response object for UntagResource action.
The response object for UntagResource action.
Updates the configuration of an existing data repository association\n on an Amazon FSx for Lustre file system. Data repository associations are\n supported only for file systems with the Persistent_2 deployment type.
Updates the configuration of an existing data repository association\n on an Amazon FSx for Lustre file system. Data repository associations\n are supported for all file systems except for Scratch_1\n deployment type.
The configuration for an Amazon S3 data repository linked to an\n Amazon FSx Lustre file system with a data repository association.\n The configuration defines which file events (new, changed, or\n deleted files or directories) are automatically imported from\n the linked data repository to the file system or automatically\n exported from the file system to the data repository.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#UpdateDataRepositoryAssociationResponse": { @@ -9764,6 +9973,9 @@ "smithy.api#documentation": "The response object returned after the data repository association is updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#UpdateFileCache": { @@ -9835,6 +10047,9 @@ "smithy.api#documentation": "The configuration updates for an Amazon File Cache resource.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#UpdateFileCacheResponse": { @@ -9846,6 +10061,9 @@ "smithy.api#documentation": "A description of the cache that was updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#UpdateFileSystem": { @@ -9883,7 +10101,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor Amazon FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For Amazon FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LustreRootSquashConfiguration\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For Amazon FSx for NetApp ONTAP file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For the Amazon FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LustreRootSquashConfiguration\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listing up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update the file and directory \n listing for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.
\n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.
The AutoImportPolicy parameter is not supported for Lustre file systems with\n the Persistent_2 deployment type. Instead, use \n to update a data repository association on your Persistent_2 file system.
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listing up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:
\n NONE - (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update the file and directory \n listing for any new or changed objects after choosing this option.
\n NEW - AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option.
\n NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically\n imports file and directory listings of any new objects added to the S3 bucket, any \n existing objects that are changed in the S3 bucket, and any objects that were deleted\n in the S3 bucket.
This parameter is not supported for file systems with a data repository association.
" } }, "DataCompressionType": { @@ -10028,20 +10246,20 @@ "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent updates. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", + "smithy.api#documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure\n idempotent updates. This string is automatically filled on your behalf when you use the\n Command Line Interface (CLI) or an Amazon Web Services SDK.
", "smithy.api#idempotencyToken": {} } }, "StorageCapacity": { "target": "com.amazonaws.fsx#StorageCapacity", "traits": { - "smithy.api#documentation": "Use this parameter to increase the storage capacity of an Amazon FSx for Windows\n File Server, Amazon FSx for Lustre, or Amazon FSx for NetApp ONTAP file system.\n Specifies the storage capacity target value, in GiB, to increase the storage capacity for\n the file system that you're updating.
\nYou can't make a storage capacity increase request if there is an existing storage\n capacity increase request in progress.
\nFor Windows file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. To increase storage capacity, the file system\n must have at least 16 MBps of throughput capacity. For more information, see Managing storage\n capacity in the Amazon FSx for Windows File Server User\n Guide.
\nFor Lustre file systems, the storage capacity target value can be the following:
\nFor SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for\n 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput\n per TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput\n capacity in the Amazon FSx for Lustre User Guide.
\nFor ONTAP file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
" + "smithy.api#documentation": "Use this parameter to increase the storage capacity of an FSx for Windows File Server,\n FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.\n Specifies the storage capacity target value, in GiB, to increase the storage capacity for\n the file system that you're updating.
\nYou can't make a storage capacity increase request if there is an existing storage\n capacity increase request in progress.
\nFor Lustre file systems, the storage capacity target value can be the following:
\nFor SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for\n 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput\n per TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput\n capacity in the FSx for Lustre User Guide.
\nFor FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity in the FSx for OpenZFS User\n Guide.
\nFor Windows file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. To increase storage capacity, the file system\n must have at least 16 MBps of throughput capacity. For more information, see Managing storage\n capacity in the Amazon FSx for Windows File Server User\n Guide.
\nFor ONTAP file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
" } }, "WindowsConfiguration": { "target": "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration", "traits": { - "smithy.api#documentation": "The configuration updates for an Amazon FSx for Windows File Server file\n system.
" + "smithy.api#documentation": "The configuration updates for an Amazon FSx for Windows File Server file system.
" } }, "LustreConfiguration": { @@ -10058,7 +10276,8 @@ } }, "traits": { - "smithy.api#documentation": "The request object for the UpdateFileSystem operation.
The request object for the UpdateFileSystem operation.
The response object for the UpdateFileSystem operation.
The response object for the UpdateFileSystem operation.
Returned after a successful UpdateSnapshot operation, describing the\n snapshot that you updated.
Enter a new SvmAdminPassword if you are updating it.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#UpdateStorageVirtualMachineResponse": { @@ -10344,6 +10573,9 @@ "StorageVirtualMachine": { "target": "com.amazonaws.fsx#StorageVirtualMachine" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.fsx#UpdateSvmActiveDirectoryConfiguration": { @@ -10420,6 +10652,9 @@ "smithy.api#documentation": "The configuration of the OpenZFS volume that you are updating.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.fsx#UpdateVolumeResponse": { @@ -10431,6 +10666,9 @@ "smithy.api#documentation": "A description of the volume just updated. Returned after a successful\n UpdateVolume API operation.
Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.
\nFor details about how to configure different event sources, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\nThe following error handling options are available only for stream sources (DynamoDB and Kinesis):
\n\n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
\n DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
\n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
\n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
\n ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\nCreates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.
\nFor details about how to configure different event sources, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\n\n \n Amazon DocumentDB\n
\nThe following error handling options are available only for stream sources (DynamoDB and Kinesis):
\n\n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
\n DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
\n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
\n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
\n ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\n\n \n Amazon DocumentDB\n
\nThe Amazon Resource Name (ARN) of the event source.
\n\n Amazon Kinesis – The ARN of the data stream or a stream consumer.
\n\n Amazon DynamoDB Streams – The ARN of the stream.
\n\n Amazon Simple Queue Service – The ARN of the queue.
\n\n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
\n\n Amazon MQ – The ARN of the broker.
\nThe Amazon Resource Name (ARN) of the event source.
\n\n Amazon Kinesis – The ARN of the data stream or a stream consumer.
\n\n Amazon DynamoDB Streams – The ARN of the stream.
\n\n Amazon Simple Queue Service – The ARN of the queue.
\n\n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
\n\n Amazon MQ – The ARN of the broker.
\n\n Amazon DocumentDB – The ARN of the DocumentDB change stream.
\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis – Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams – Default 100. Max 10,000.
\n\n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
\n\n Self-managed Apache Kafka – Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis – Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams – Default 100. Max 10,000.
\n\n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
\n\n Self-managed Apache Kafka – Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
\n\n DocumentDB – Default 100. Max 10,000.
\nThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Streams only) The number of batches to process from each shard concurrently.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
" } }, "StartingPosition": { "target": "com.amazonaws.lambda#EventSourcePosition", "traits": { - "smithy.api#documentation": "The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon\n DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams.
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon\n DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams and Amazon DocumentDB.
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.
" } }, "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "(Streams only) Discard records older than the specified age. The default value is infinite (-1).
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
" } }, "BisectBatchOnFunctionError": { "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", "traits": { - "smithy.api#documentation": "(Streams only) If the function returns an error, split the batch in two and retry.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
" } }, "MaximumRetryAttempts": { "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
" } }, "TumblingWindowInSeconds": { "target": "com.amazonaws.lambda#TumblingWindowInSeconds", "traits": { - "smithy.api#documentation": "(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
" } }, "Topics": { @@ -2580,7 +2633,7 @@ "FunctionResponseTypes": { "target": "com.amazonaws.lambda#FunctionResponseTypeList", "traits": { - "smithy.api#documentation": "(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
" + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
" } }, "AmazonManagedKafkaEventSourceConfig": { @@ -2872,6 +2925,12 @@ "traits": { "smithy.api#documentation": "The cross-origin resource sharing (CORS) settings\n for your function URL.
" } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
\n\n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.
\n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", "smithy.api#required": {} } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
\n\n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.
\n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis\n streams.
The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis\n streams and Amazon DocumentDB.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
" } }, "EventSourceArn": { @@ -3919,7 +3984,7 @@ "DestinationConfig": { "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
" } }, "Topics": { @@ -3949,31 +4014,31 @@ "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "(Streams only) Discard records older than the specified age. The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
" } }, "BisectBatchOnFunctionError": { "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", "traits": { - "smithy.api#documentation": "(Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
" } }, "MaximumRetryAttempts": { "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "(Streams only) Discard records after the specified number of retries. The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
" } }, "TumblingWindowInSeconds": { "target": "com.amazonaws.lambda#TumblingWindowInSeconds", "traits": { - "smithy.api#documentation": "(Streams only) The duration in seconds of a processing window. The range is 1–900 seconds.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
" } }, "FunctionResponseTypes": { "target": "com.amazonaws.lambda#FunctionResponseTypeList", "traits": { - "smithy.api#documentation": "(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
" + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
" } }, "AmazonManagedKafkaEventSourceConfig": { @@ -4470,7 +4535,7 @@ "DestinationConfig": { "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "A destination for events after they have been sent to a function for processing.
\n\n Destinations\n
\n\n Function - The Amazon Resource Name (ARN) of a Lambda function.
\n\n Queue - The ARN of an SQS queue.
\n\n Topic - The ARN of an SNS topic.
\n\n Event Bus - The ARN of an Amazon EventBridge event bus.
\nA destination for events after they have been sent to a function for processing.
\n\n Destinations\n
\n\n Function - The Amazon Resource Name (ARN) of a Lambda function.
\n\n Queue - The ARN of a standard SQS queue.
\n\n Topic - The ARN of a standard SNS topic.
\n\n Event Bus - The ARN of an Amazon EventBridge event bus.
\nThe type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.
Use one of the following options:
\n\n BUFFERED – This is the default option. Lambda invokes your function\n using the Invoke API operation. Invocation results are available when the\n payload is complete. The maximum payload size is 6 MB.
\n RESPONSE_STREAM – Your function streams payload results as they become available.\n Lambda invokes your function using the InvokeWithResponseStream\n API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", "smithy.api#required": {} } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
\n\n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.
\n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
Data returned by your Lambda function.
", + "smithy.api#eventPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A chunk of the streamed response payload.
" + } + }, + "com.amazonaws.lambda#InvokeWithResponseStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamRequest" + }, + "output": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lambda#EC2AccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#EC2ThrottledException" + }, + { + "target": "com.amazonaws.lambda#EC2UnexpectedException" + }, + { + "target": "com.amazonaws.lambda#EFSIOException" + }, + { + "target": "com.amazonaws.lambda#EFSMountConnectivityException" + }, + { + "target": "com.amazonaws.lambda#EFSMountFailureException" + }, + { + "target": "com.amazonaws.lambda#EFSMountTimeoutException" + }, + { + "target": "com.amazonaws.lambda#ENILimitReachedException" + }, + { + "target": "com.amazonaws.lambda#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.lambda#InvalidRequestContentException" + }, + { + "target": "com.amazonaws.lambda#InvalidRuntimeException" + }, + { + "target": "com.amazonaws.lambda#InvalidSecurityGroupIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidSubnetIDException" + }, + { + "target": "com.amazonaws.lambda#InvalidZipFileException" + }, + { + "target": "com.amazonaws.lambda#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.lambda#KMSDisabledException" + }, + { + "target": "com.amazonaws.lambda#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.lambda#KMSNotFoundException" + }, + { + "target": "com.amazonaws.lambda#RequestTooLargeException" + }, + { + "target": "com.amazonaws.lambda#ResourceConflictException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lambda#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.lambda#ServiceException" + }, + { + "target": "com.amazonaws.lambda#SubnetIPAddressLimitReachedException" + }, + { + "target": "com.amazonaws.lambda#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lambda#UnsupportedMediaTypeException" + } + ], + "traits": { + "smithy.api#documentation": "Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-11-15/functions/{FunctionName}/response-streaming-invocations", + "code": 200 + } + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamCompleteEvent": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "An error code.
" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The details of any returned error.
" + } + }, + "LogResult": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The last 4 KB of the execution log, which is base64-encoded.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A response confirming that the event stream is complete.
" + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamRequest": { + "type": "structure", + "members": { + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "The name of the Lambda function.
\n\n Name formats\n
\n\n Function name – my-function.
\n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
\n Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InvocationType": { + "target": "com.amazonaws.lambda#ResponseStreamingInvocationType", + "traits": { + "smithy.api#documentation": "Use one of the following options:
\n\n RequestResponse (default) – Invoke the function synchronously. Keep the\n connection open until the function returns a response or times out. The API operation\n response includes the function response and additional data.
\n DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke\n the function.
Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context\n object.
", + "smithy.api#httpHeader": "X-Amz-Client-Context" + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "The alias name.
", + "smithy.api#httpQuery": "Qualifier" + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "The JSON that you want to provide to your Lambda function as input.
\nYou can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also\n specify a file path. For example, --payload file://payload.json.
For a successful request, the HTTP status code is in the 200 range. For the\n RequestResponse invocation type, this status code is 200. For the DryRun\n invocation type, this status code is 204.
The version of the function that executed. When you invoke a function with an alias, this\n indicates which version the alias resolved to.
", + "smithy.api#httpHeader": "X-Amz-Executed-Version" + } + }, + "EventStream": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamResponseEvent", + "traits": { + "smithy.api#documentation": "The stream of response payloads.
", + "smithy.api#httpPayload": {} + } + }, + "ResponseStreamContentType": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The type of data the stream is returning.
", + "smithy.api#httpHeader": "Content-Type" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lambda#InvokeWithResponseStreamResponseEvent": { + "type": "union", + "members": { + "PayloadChunk": { + "target": "com.amazonaws.lambda#InvokeResponseStreamUpdate", + "traits": { + "smithy.api#documentation": "A chunk of the streamed response payload.
" + } + }, + "InvokeComplete": { + "target": "com.amazonaws.lambda#InvokeWithResponseStreamCompleteEvent", + "traits": { + "smithy.api#documentation": "An object that's returned when the stream has ended and all the payload chunks have been\n returned.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.
The Amazon Resource Name (ARN) of the event source.
\n\n Amazon Kinesis – The ARN of the data stream or a stream consumer.
\n\n Amazon DynamoDB Streams – The ARN of the stream.
\n\n Amazon Simple Queue Service – The ARN of the queue.
\n\n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
\n\n Amazon MQ – The ARN of the broker.
\nThe Amazon Resource Name (ARN) of the event source.
\n\n Amazon Kinesis – The ARN of the data stream or a stream consumer.
\n\n Amazon DynamoDB Streams – The ARN of the stream.
\n\n Amazon Simple Queue Service – The ARN of the queue.
\n\n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
\n\n Amazon MQ – The ARN of the broker.
\n\n Amazon DocumentDB – The ARN of the DocumentDB change stream.
\nA destination for events after they have been sent to a function for processing.
\n\n Destinations\n
\n\n Function - The Amazon Resource Name (ARN) of a Lambda function.
\n\n Queue - The ARN of an SQS queue.
\n\n Topic - The ARN of an SNS topic.
\n\n Event Bus - The ARN of an Amazon EventBridge event bus.
\nA destination for events after they have been sent to a function for processing.
\n\n Destinations\n
\n\n Function - The Amazon Resource Name (ARN) of a Lambda function.
\n\n Queue - The ARN of a standard SQS queue.
\n\n Topic - The ARN of a standard SNS topic.
\n\n Event Bus - The ARN of an Amazon EventBridge event bus.
\nUpdates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.
\nFor details about how to configure different event sources, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\nThe following error handling options are available only for stream sources (DynamoDB and Kinesis):
\n\n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
\n DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
\n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
\n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
\n ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\nUpdates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.
\nFor details about how to configure different event sources, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\n\n \n Amazon DocumentDB\n
\nThe following error handling options are available only for stream sources (DynamoDB and Kinesis):
\n\n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
\n DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
\n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
\n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
\n ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
\n\n \n Amazon Kinesis\n
\n\n \n Amazon SQS\n
\n\n \n Amazon MSK\n
\n\n \n Apache Kafka\n
\n\n \n Amazon DocumentDB\n
\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis – Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams – Default 100. Max 10,000.
\n\n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
\n\n Self-managed Apache Kafka – Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis – Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams – Default 100. Max 10,000.
\n\n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
\n\n Self-managed Apache Kafka – Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
\n\n DocumentDB – Default 100. Max 10,000.
\nThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.
" } }, "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "(Streams only) Discard records older than the specified age. The default value is infinite (-1).
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
" } }, "BisectBatchOnFunctionError": { "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", "traits": { - "smithy.api#documentation": "(Streams only) If the function returns an error, split the batch in two and retry.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
" } }, "MaximumRetryAttempts": { "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
" } }, "ParallelizationFactor": { "target": "com.amazonaws.lambda#ParallelizationFactor", "traits": { - "smithy.api#documentation": "(Streams only) The number of batches to process from each shard concurrently.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
" } }, "SourceAccessConfigurations": { @@ -10786,13 +11144,13 @@ "TumblingWindowInSeconds": { "target": "com.amazonaws.lambda#TumblingWindowInSeconds", "traits": { - "smithy.api#documentation": "(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.
" + "smithy.api#documentation": "(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
" } }, "FunctionResponseTypes": { "target": "com.amazonaws.lambda#FunctionResponseTypeList", "traits": { - "smithy.api#documentation": "(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
" + "smithy.api#documentation": "(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
" } }, "ScalingConfig": { @@ -11164,7 +11522,7 @@ "DestinationConfig": { "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "A destination for events after they have been sent to a function for processing.
\n\n Destinations\n
\n\n Function - The Amazon Resource Name (ARN) of a Lambda function.
\n\n Queue - The ARN of an SQS queue.
\n\n Topic - The ARN of an SNS topic.
\n\n Event Bus - The ARN of an Amazon EventBridge event bus.
\nA destination for events after they have been sent to a function for processing.
\n\n Destinations\n
\n\n Function - The Amazon Resource Name (ARN) of a Lambda function.
\n\n Queue - The ARN of a standard SQS queue.
\n\n Topic - The ARN of a standard SNS topic.
\n\n Event Bus - The ARN of an Amazon EventBridge event bus.
\nThe cross-origin resource sharing (CORS) settings\n for your function URL.
" } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
\n\n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.
\n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
", "smithy.api#required": {} } + }, + "InvokeMode": { + "target": "com.amazonaws.lambda#InvokeMode", + "traits": { + "smithy.api#documentation": "Use one of the following options:
\n\n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.
\n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "The refresh schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#CreateTemplate": { "type": "operation", "input": { @@ -8258,6 +8366,21 @@ } } }, + "com.amazonaws.quicksight#DataSetRefreshProperties": { + "type": "structure", + "members": { + "RefreshConfiguration": { + "target": "com.amazonaws.quicksight#RefreshConfiguration", + "traits": { + "smithy.api#documentation": "The refresh configuration for a dataset.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The refresh properties of a dataset.
" + } + }, "com.amazonaws.quicksight#DataSetSchema": { "type": "structure", "members": { @@ -9393,6 +9516,63 @@ "smithy.api#documentation": "The configuration that defines the default value of a DateTime parameter when a value has not been set.
Deletes the dataset refresh properties of the dataset.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteDataSetRequest": { "type": "structure", "members": { @@ -10789,6 +11055,109 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DeleteRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a refresh schedule from a dataset.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteTemplate": { "type": "operation", "input": { @@ -12484,6 +12853,98 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the refresh properties of a dataset.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "The dataset refresh properties.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeDataSetRequest": { "type": "structure", "members": { @@ -13589,6 +14050,109 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a summary of a refresh schedule.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { + "type": "structure", + "members": { + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "The refresh schedule.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeTemplate": { "type": "operation", "input": { @@ -19544,6 +20108,21 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.quicksight#IncrementalRefresh": { + "type": "structure", + "members": { + "LookbackWindow": { + "target": "com.amazonaws.quicksight#LookbackWindow", + "traits": { + "smithy.api#documentation": "The lookback window setup for an incremental refresh configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The incremental refresh configuration for a dataset.
" + } + }, "com.amazonaws.quicksight#Ingestion": { "type": "structure", "members": { @@ -19883,6 +20462,12 @@ "traits": { "smithy.api#enumValue": "CURSOR_NOT_ENABLED" } + }, + "DUPLICATE_COLUMN_NAMES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATE_COLUMN_NAMES_FOUND" + } } } }, @@ -23000,6 +23585,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#ListRefreshSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesResponse": { + "type": "structure", + "members": { + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#RefreshSchedules", + "traits": { + "smithy.api#documentation": "The list of refresh schedules for the dataset.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#ListTagsForResource": { "type": "operation", "input": { @@ -24172,6 +24846,59 @@ } } }, + "com.amazonaws.quicksight#LookbackWindow": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The name of the lookback window column.
", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.quicksight#PositiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The lookback window column size.
", + "smithy.api#required": {} + } + }, + "SizeUnit": { + "target": "com.amazonaws.quicksight#LookbackWindowSizeUnit", + "traits": { + "smithy.api#documentation": "The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
The lookback window setup of an incremental refresh configuration.
" + } + }, + "com.amazonaws.quicksight#LookbackWindowSizeUnit": { + "type": "enum", + "members": { + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + } + } + }, "com.amazonaws.quicksight#ManifestFileLocation": { "type": "structure", "members": { @@ -27179,6 +27906,15 @@ } } }, + "com.amazonaws.quicksight#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.quicksight#PostgreSqlParameters": { "type": "structure", "members": { @@ -27402,6 +28138,102 @@ } } }, + "com.amazonaws.quicksight#PutDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates the dataset refresh properties for the dataset.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "The dataset refresh properties.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#Query": { "type": "string", "traits": { @@ -27498,6 +28330,9 @@ { "target": "com.amazonaws.quicksight#CreateNamespace" }, + { + "target": "com.amazonaws.quicksight#CreateRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#CreateTemplate" }, @@ -27525,6 +28360,9 @@ { "target": "com.amazonaws.quicksight#DeleteDataSet" }, + { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshProperties" + }, { "target": "com.amazonaws.quicksight#DeleteDataSource" }, @@ -27546,6 +28384,9 @@ { "target": "com.amazonaws.quicksight#DeleteNamespace" }, + { + "target": "com.amazonaws.quicksight#DeleteRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#DeleteTemplate" }, @@ -27597,6 +28438,9 @@ { "target": "com.amazonaws.quicksight#DescribeDataSetPermissions" }, + { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshProperties" + }, { "target": "com.amazonaws.quicksight#DescribeDataSource" }, @@ -27630,6 +28474,9 @@ { "target": "com.amazonaws.quicksight#DescribeNamespace" }, + { + "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#DescribeTemplate" }, @@ -27705,6 +28552,9 @@ { "target": "com.amazonaws.quicksight#ListNamespaces" }, + { + "target": "com.amazonaws.quicksight#ListRefreshSchedules" + }, { "target": "com.amazonaws.quicksight#ListTagsForResource" }, @@ -27732,6 +28582,9 @@ { "target": "com.amazonaws.quicksight#ListUsers" }, + { + "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" + }, { "target": "com.amazonaws.quicksight#RegisterUser" }, @@ -27813,6 +28666,9 @@ { "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" }, + { + "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#UpdateTemplate" }, @@ -28210,8 +29066,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28223,8 +29079,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28236,8 +29092,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28249,8 +29105,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28262,8 +29118,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28275,8 +29131,8 @@ }, "params": { "Region": "api", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28288,8 +29144,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28301,8 +29157,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28314,8 +29170,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28327,8 +29183,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28340,8 +29196,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28353,8 +29209,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28366,8 +29222,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28379,8 +29235,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28392,8 +29248,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28405,8 +29261,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -28418,8 +29274,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28431,8 +29287,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28444,8 +29300,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -28457,8 +29313,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28470,8 +29326,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28483,8 +29339,8 @@ }, "params": { "Region": "api", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28496,8 +29352,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28509,8 +29365,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28522,8 +29378,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -28535,8 +29391,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28548,8 +29404,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28561,8 +29428,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28574,8 +29452,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28587,8 +29476,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28600,8 +29500,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28613,8 +29513,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -28626,8 +29526,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -28638,8 +29538,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -28650,10 +29550,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -29333,6 +30239,145 @@ } } }, + "com.amazonaws.quicksight#RefreshConfiguration": { + "type": "structure", + "members": { + "IncrementalRefresh": { + "target": "com.amazonaws.quicksight#IncrementalRefresh", + "traits": { + "smithy.api#documentation": "The incremental refresh for the dataset.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The refresh configuration of a dataset.
" + } + }, + "com.amazonaws.quicksight#RefreshFrequency": { + "type": "structure", + "members": { + "Interval": { + "target": "com.amazonaws.quicksight#RefreshInterval", + "traits": { + "smithy.api#documentation": "The interval between scheduled refreshes. Valid values are as follows:
\n\n MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
\n MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
\n HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
\n DAILY: The dataset refreshes every day.
\n WEEKLY: The dataset refreshes every week.
\n MONTHLY: The dataset refreshes every month.
The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.
" + } + }, + "Timezone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().
The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the interval between each scheduled refresh of a dataset.
" + } + }, + "com.amazonaws.quicksight#RefreshInterval": { + "type": "enum", + "members": { + "MINUTE15": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE15" + } + }, + "MINUTE30": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE30" + } + }, + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.quicksight#RefreshSchedule": { + "type": "structure", + "members": { + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "An identifier for the refresh schedule.
", + "smithy.api#required": {} + } + }, + "ScheduleFrequency": { + "target": "com.amazonaws.quicksight#RefreshFrequency", + "traits": { + "smithy.api#documentation": "The frequency for the refresh schedule.
", + "smithy.api#required": {} + } + }, + "StartAfterDateTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
The type of refresh that a datset undergoes. Valid values are as follows:
\n\n FULL_REFRESH: A complete refresh of a dataset.
\n INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.
For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The refresh schedule of a dataset.
" + } + }, + "com.amazonaws.quicksight#RefreshSchedules": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "A list of RefreshSchedule objects.
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
", "smithy.api#required": {} } + }, + "TagRuleConfigurations": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList", + "traits": { + "smithy.api#documentation": "A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
" + } } }, "traits": { @@ -30424,6 +31475,30 @@ "smithy.api#documentation": "A set of rules associated with a tag.
" } }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.quicksight#RowLevelPermissionTagRuleList": { "type": "list", "member": { @@ -30650,9 +31725,188 @@ } }, "ChartConfiguration": { - "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", + "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a sankey diagram.
" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "The list of custom actions that are configured for a visual.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A sankey diagram.
\nFor more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is aggregated by category.
" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is aggregated by category.
" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The category field well of a scatter plot.
" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The size field well of a scatter plot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The aggregated field well of a scatter plot.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", + "traits": { + "smithy.api#documentation": "The field wells of the visual.
" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
" + } + }, + "YAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
" + } + }, + "YAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "The legend display setup of the visual.
" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "The options that determine if visual data labels are displayed.
" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "The legend display setup of the visual.
" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "The palette (chart color) display setup of the visual.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a scatter plot.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotFieldWells": { + "type": "structure", + "members": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.
" + } + }, + "ScatterPlotUnaggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", + "traits": { + "smithy.api#documentation": "The unaggregated field wells of a scatter plot. Scatter plots without a category field\n well have unaggregated field wells. The x and y-axes of these scatter plots are\n unaggregated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The field well configuration of a scatter plot.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is a dimension field and cannot be aggregated.
" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is a dimension field and cannot be aggregated.
" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The size field well of a scatter plot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The unaggregated field wells of a scatter plot.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "The title that is displayed on the visual.
" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "The subtitle that is displayed on the visual.
" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", "traits": { - "smithy.api#documentation": "The configuration of a sankey diagram.
" + "smithy.api#documentation": "The configuration settings of the visual.
" } }, "Actions": { @@ -30660,195 +31914,36 @@ "traits": { "smithy.api#documentation": "The list of custom actions that are configured for a visual.
" } - } - }, - "traits": { - "smithy.api#documentation": "A sankey diagram.
\nFor more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is aggregated by category.
" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is aggregated by category.
" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "The category field well of a scatter plot.
" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "The size field well of a scatter plot.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The aggregated field well of a scatter plot.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", - "traits": { - "smithy.api#documentation": "The field wells of the visual.
" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
" - } - }, - "YAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
" - } - }, - "YAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "The legend display setup of the visual.
" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "The options that determine if visual data labels are displayed.
" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "The legend display setup of the visual.
" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "The palette (chart color) display setup of the visual.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of a scatter plot.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotFieldWells": { - "type": "structure", - "members": { - "ScatterPlotCategoricallyAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.
" - } - }, - "ScatterPlotUnaggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", - "traits": { - "smithy.api#documentation": "The unaggregated field wells of a scatter plot. Scatter plots without a category field\n well have unaggregated field wells. The x and y-axes of these scatter plots are\n unaggregated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The field well configuration of a scatter plot.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is a dimension field and cannot be aggregated.
" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is a dimension field and cannot be aggregated.
" - } }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", "traits": { - "smithy.api#documentation": "The size field well of a scatter plot.
" + "smithy.api#documentation": "The column hierarchy that is used during drill-downs and drill-ups.
" } } }, "traits": { - "smithy.api#documentation": "The unaggregated field wells of a scatter plot.
" + "smithy.api#documentation": "A scatter plot.
\nFor more information, see Using scatter plots in the Amazon QuickSight User Guide.
" } }, - "com.amazonaws.quicksight#ScatterPlotVisual": { + "com.amazonaws.quicksight#ScheduleRefreshOnEntity": { "type": "structure", "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "The title that is displayed on the visual.
" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "The subtitle that is displayed on the visual.
" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", - "traits": { - "smithy.api#documentation": "The configuration settings of the visual.
" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", + "DayOfWeek": { + "target": "com.amazonaws.quicksight#DayOfWeek", "traits": { - "smithy.api#documentation": "The list of custom actions that are configured for a visual.
" + "smithy.api#documentation": "The day of the week that you want to schedule a refresh on.
" } }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "DayOfMonth": { + "target": "com.amazonaws.quicksight#DayOfMonth", "traits": { - "smithy.api#documentation": "The column hierarchy that is used during drill-downs and drill-ups.
" + "smithy.api#documentation": "The day of the month that you want to schedule refresh on.
" } } }, "traits": { - "smithy.api#documentation": "A scatter plot.
\nFor more information, see Using scatter plots in the Amazon QuickSight User Guide.
" + "smithy.api#documentation": "The refresh on entity for weekly or monthly schedules.
" } }, "com.amazonaws.quicksight#ScrollBarOptions": { @@ -38434,6 +39529,111 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a refresh schedule for a dataset.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "The refresh schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateResourcePermissionList": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/redshift-data.json b/codegen/sdk-codegen/aws-models/redshift-data.json index 724a2a35c76..2b3f50a2dea 100644 --- a/codegen/sdk-codegen/aws-models/redshift-data.json +++ b/codegen/sdk-codegen/aws-models/redshift-data.json @@ -34,7 +34,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
" + "smithy.api#documentation": "Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, provide the secret-arn of a secret \n stored in Secrets Manager which has username and password. \n The specified secret contains credentials\n to connect to the database you specify. \n When you are connecting to a cluster, you also supply the database name, \n If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. \n When you are connecting to a serverless workgroup, you also supply the database name.
Temporary credentials - when connecting to your data warehouse, choose one of the following options:
\nWhen connecting to a serverless workgroup, specify the workgroup name and database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift-serverless:GetCredentials operation is required.
When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.
When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. \n Also, permission to call the redshift:GetClusterCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
" } }, "com.amazonaws.redshiftdata#BatchExecuteStatementException": { @@ -85,7 +85,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
" } }, "Database": { @@ -547,7 +547,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", + "smithy.api#documentation": "Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, provide the secret-arn of a secret \n stored in Secrets Manager which has username and password. \n The specified secret contains credentials\n to connect to the database you specify. \n When you are connecting to a cluster, you also supply the database name, \n If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. \n When you are connecting to a serverless workgroup, you also supply the database name.
Temporary credentials - when connecting to your data warehouse, choose one of the following options:
\nWhen connecting to a serverless workgroup, specify the workgroup name and database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift-serverless:GetCredentials operation is required.
When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.
When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. \n Also, permission to call the redshift:GetClusterCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -575,7 +575,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
" } }, "Database": { @@ -667,7 +667,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
" + "smithy.api#documentation": "Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, provide the secret-arn of a secret \n stored in Secrets Manager which has username and password. \n The specified secret contains credentials\n to connect to the database you specify. \n When you are connecting to a cluster, you also supply the database name, \n If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. \n When you are connecting to a serverless workgroup, you also supply the database name.
Temporary credentials - when connecting to your data warehouse, choose one of the following options:
\nWhen connecting to a serverless workgroup, specify the workgroup name and database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift-serverless:GetCredentials operation is required.
When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.
When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. \n Also, permission to call the redshift:GetClusterCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
" } }, "com.amazonaws.redshiftdata#ExecuteStatementException": { @@ -719,7 +719,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
" } }, "Database": { @@ -980,7 +980,7 @@ } ], "traits": { - "smithy.api#documentation": "List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", + "smithy.api#documentation": "List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, provide the secret-arn of a secret \n stored in Secrets Manager which has username and password. \n The specified secret contains credentials\n to connect to the database you specify. \n When you are connecting to a cluster, you also supply the database name, \n If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. \n When you are connecting to a serverless workgroup, you also supply the database name.
Temporary credentials - when connecting to your data warehouse, choose one of the following options:
\nWhen connecting to a serverless workgroup, specify the workgroup name and database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift-serverless:GetCredentials operation is required.
When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.
When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. \n Also, permission to call the redshift:GetClusterCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1015,7 +1015,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
" } }, "NextToken": { @@ -1076,7 +1076,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", + "smithy.api#documentation": "Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
\nSecrets Manager - when connecting to a cluster, provide the secret-arn of a secret \n stored in Secrets Manager which has username and password. \n The specified secret contains credentials\n to connect to the database you specify. \n When you are connecting to a cluster, you also supply the database name, \n If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. \n When you are connecting to a serverless workgroup, you also supply the database name.
Temporary credentials - when connecting to your data warehouse, choose one of the following options:
\nWhen connecting to a serverless workgroup, specify the workgroup name and database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift-serverless:GetCredentials operation is required.
When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.
When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. \n Also, permission to call the redshift:GetClusterCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1104,7 +1104,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
" } }, "Database": { @@ -1275,7 +1275,7 @@ } ], "traits": { - "smithy.api#documentation": "List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
\nTemporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", + "smithy.api#documentation": "List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:
Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret \n stored in Secrets Manager which has username and password. \n The specified secret contains credentials\n to connect to the database you specify. \n When you are connecting to a cluster, you also supply the database name, \n If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. \n When you are connecting to a serverless workgroup, you also supply the database name.
Temporary credentials - when connecting to your data warehouse, choose one of the following options:
\nWhen connecting to a serverless workgroup, specify the workgroup name and database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift-serverless:GetCredentials operation is required.
When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.\n The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo.\n Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.
When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. \n Also, permission to call the redshift:GetClusterCredentials operation is required.
For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1303,7 +1303,7 @@ "DbUser": { "target": "com.amazonaws.redshiftdata#String", "traits": { - "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
" + "smithy.api#documentation": "The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
" } }, "Database": { @@ -1810,8 +1810,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1823,8 +1823,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1836,8 +1836,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1849,8 +1849,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1862,8 +1862,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1875,8 +1875,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1888,8 +1888,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1901,8 +1901,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1914,8 +1914,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1927,8 +1927,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1940,8 +1940,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1953,8 +1953,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1966,8 +1977,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1979,8 +2001,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1992,8 +2025,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2005,8 +2049,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2018,8 +2062,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2031,8 +2075,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2043,8 +2087,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2055,10 +2099,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/codegen/sdk-codegen/aws-models/service-catalog.json b/codegen/sdk-codegen/aws-models/service-catalog.json index 04fbeaf76f0..043d159b4cb 100644 --- a/codegen/sdk-codegen/aws-models/service-catalog.json +++ b/codegen/sdk-codegen/aws-models/service-catalog.json @@ -9344,7 +9344,7 @@ "Type": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", "traits": { - "smithy.api#documentation": "The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE - CloudFormation template
\n MARKETPLACE_AMI - Amazon Web Services Marketplace AMI
\n MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources
The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE - CloudFormation template
\n MARKETPLACE_AMI - Amazon Web Services Marketplace AMI
\n MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources
\n TERRAFORM_OPEN_SOURCE - Terraform open source configuration file