{ "smithy": "2.0", "shapes": { "com.amazonaws.redshiftserverless#AccessDeniedException": { "type": "structure", "members": { "code": { "target": "smithy.api#String" }, "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "
You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.redshiftserverless#AccountIdList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.redshiftserverless#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.redshiftserverless#Association": { "type": "structure", "members": { "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN).
" } }, "customDomainCertificateExpiryTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The expiration time for the certificate.
", "smithy.api#timestampFormat": "date-time" } }, "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup.
" } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
" } } }, "traits": { "smithy.api#documentation": "An object that represents the custom domain name association.
" } }, "com.amazonaws.redshiftserverless#AssociationList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#Association" } }, "com.amazonaws.redshiftserverless#Capacity": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.redshiftserverless#CatalogNameString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$" } }, "com.amazonaws.redshiftserverless#Charge": { "type": "double", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.redshiftserverless#ConfigParameter": { "type": "structure", "members": { "parameterKey": { "target": "com.amazonaws.redshiftserverless#ParameterKey", "traits": { "smithy.api#documentation": "The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. If you're using wlm_json_configuration, the maximum size of parameterValue is 8000 characters. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
The value of the parameter to set.
" } } }, "traits": { "smithy.api#documentation": "An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
" } }, "com.amazonaws.redshiftserverless#ConfigParameterList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#ConfigParameter" } }, "com.amazonaws.redshiftserverless#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The submitted action has conflicts.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.redshiftserverless#TooManyTagsException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
" } }, "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotRequest": { "type": "structure", "members": { "recoveryPointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the recovery point.
", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot.
", "smithy.api#required": {} } }, "retentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "How long to retain the snapshot.
" } }, "tags": { "target": "com.amazonaws.redshiftserverless#TagList", "traits": { "smithy.api#documentation": "An array of Tag objects to associate with the created snapshot.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotResponse": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.redshiftserverless#Snapshot", "traits": { "smithy.api#documentation": "The snapshot converted from the recovery point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CreateCustomDomainAssociation": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a custom domain association for Amazon Redshift Serverless.
" } }, "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationRequest": { "type": "structure", "members": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
", "smithy.api#required": {} } }, "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name to associate with the workgroup.
", "smithy.api#required": {} } }, "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationResponse": { "type": "structure", "members": { "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name to associate with the workgroup.
" } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
" } }, "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN).
" } }, "customDomainCertificateExpiryTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The expiration time for the certificate.
", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CreateEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#CreateEndpointAccessRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#CreateEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Redshift Serverless managed VPC endpoint.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#CreateEndpointAccessRequest": { "type": "structure", "members": { "endpointName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the VPC endpoint. An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.redshiftserverless#SubnetIdList", "traits": { "smithy.api#documentation": "The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
", "smithy.api#required": {} } }, "workgroupName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the workgroup to associate with the VPC endpoint.
", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" } }, "ownerAccount": { "target": "com.amazonaws.redshiftserverless#OwnerAccount", "traits": { "smithy.api#documentation": "The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateEndpointAccessResponse": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.redshiftserverless#EndpointAccess", "traits": { "smithy.api#documentation": "The created VPC endpoint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CreateNamespace": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#CreateNamespaceRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#CreateNamespaceResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#TooManyTagsException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a namespace in Amazon Redshift Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#CreateNamespaceRequest": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace.
", "smithy.api#required": {} } }, "adminUsername": { "target": "com.amazonaws.redshiftserverless#DbUser", "traits": { "smithy.api#documentation": "The username of the administrator for the first database created in the namespace.
" } }, "adminUserPassword": { "target": "com.amazonaws.redshiftserverless#DbPassword", "traits": { "smithy.api#documentation": "The password of the administrator for the first database created in the namespace.
You can't use adminUserPassword if manageAdminPassword is true.
The name of the first database created in the namespace.
" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
" } }, "defaultIamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
" } }, "iamRoles": { "target": "com.amazonaws.redshiftserverless#IamRoleArnList", "traits": { "smithy.api#documentation": "A list of IAM roles to associate with the namespace.
" } }, "logExports": { "target": "com.amazonaws.redshiftserverless#LogExportList", "traits": { "smithy.api#documentation": "The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.
A list of tag instances.
" } }, "manageAdminPassword": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
The ARN for the Redshift application that integrates with IAM Identity Center.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateNamespaceResponse": { "type": "structure", "members": { "namespace": { "target": "com.amazonaws.redshiftserverless#Namespace", "traits": { "smithy.api#documentation": "The created namespace object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CreateReservation": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#CreateReservationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#CreateReservationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#TooManyTagsException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#CreateReservationRequest": { "type": "structure", "members": { "capacity": { "target": "com.amazonaws.redshiftserverless#Capacity", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of Redshift Processing Units (RPUs) to reserve.
", "smithy.api#required": {} } }, "offeringId": { "target": "com.amazonaws.redshiftserverless#OfferingId", "traits": { "smithy.api#documentation": "The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. This token must be a valid UUIDv4 value. For more information about idempotency, see Making retries safe with idempotent APIs .
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateReservationResponse": { "type": "structure", "members": { "reservation": { "target": "com.amazonaws.redshiftserverless#Reservation", "traits": { "smithy.api#documentation": "The reservation object that the CreateReservation action created.
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.
The name of the scheduled action.
", "smithy.api#required": {} } }, "targetAction": { "target": "com.amazonaws.redshiftserverless#TargetAction", "traits": { "smithy.api#required": {} } }, "schedule": { "target": "com.amazonaws.redshiftserverless#Schedule", "traits": { "smithy.api#documentation": "The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
", "smithy.api#required": {} } }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace for which to create a scheduled action.
", "smithy.api#required": {} } }, "enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.
The description of the scheduled action.
" } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateScheduledActionResponse": { "type": "structure", "members": { "scheduledAction": { "target": "com.amazonaws.redshiftserverless#ScheduledActionResponse", "traits": { "smithy.api#documentation": "The returned ScheduledAction object that describes the properties of a scheduled action.
Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#CreateSnapshotCopyConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#CreateSnapshotCopyConfigurationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#CreateSnapshotCopyConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#CreateSnapshotCopyConfigurationRequest": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to copy snapshots from.
", "smithy.api#required": {} } }, "destinationRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The destination Amazon Web Services Region that you want to copy snapshots to.
", "smithy.api#required": {} } }, "snapshotRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The retention period of the snapshots that you copy to the destination Amazon Web Services Region.
" } }, "destinationKmsKeyId": { "target": "com.amazonaws.redshiftserverless#KmsKeyId", "traits": { "smithy.api#documentation": "The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateSnapshotCopyConfigurationResponse": { "type": "structure", "members": { "snapshotCopyConfiguration": { "target": "com.amazonaws.redshiftserverless#SnapshotCopyConfiguration", "traits": { "smithy.api#documentation": "The snapshot copy configuration object that is returned.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CreateSnapshotRequest": { "type": "structure", "members": { "namespaceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace to create a snapshot for.
", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot.
", "smithy.api#required": {} } }, "retentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "How long to retain the created snapshot.
" } }, "tags": { "target": "com.amazonaws.redshiftserverless#TagList", "traits": { "smithy.api#documentation": "An array of Tag objects to associate with the snapshot.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateSnapshotResponse": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.redshiftserverless#Snapshot", "traits": { "smithy.api#documentation": "The created snapshot object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CreateSnapshotScheduleActionParameters": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace for which you want to configure a scheduled action to create a snapshot.
", "smithy.api#required": {} } }, "snapshotNamePrefix": { "target": "com.amazonaws.redshiftserverless#SnapshotNamePrefix", "traits": { "smithy.api#documentation": "A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
", "smithy.api#required": {} } }, "retentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The retention period of the snapshot created by the scheduled action.
" } }, "tags": { "target": "com.amazonaws.redshiftserverless#TagList", "traits": { "smithy.api#documentation": "An array of Tag objects to associate with the snapshot.
" } } }, "traits": { "smithy.api#documentation": "The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.
" } }, "com.amazonaws.redshiftserverless#CreateUsageLimit": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#CreateUsageLimitRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#CreateUsageLimitResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#CreateUsageLimitRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
", "smithy.api#required": {} } }, "usageType": { "target": "com.amazonaws.redshiftserverless#UsageLimitUsageType", "traits": { "smithy.api#documentation": "The type of Amazon Redshift Serverless usage to create a usage limit for.
", "smithy.api#required": {} } }, "amount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.redshiftserverless#UsageLimitPeriod", "traits": { "smithy.api#documentation": "The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
" } }, "breachAction": { "target": "com.amazonaws.redshiftserverless#UsageLimitBreachAction", "traits": { "smithy.api#documentation": "The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateUsageLimitResponse": { "type": "structure", "members": { "usageLimit": { "target": "com.amazonaws.redshiftserverless#UsageLimit", "traits": { "smithy.api#documentation": "The returned usage limit object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CreateWorkgroup": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#CreateWorkgroupRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#CreateWorkgroupResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InsufficientCapacityException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#Ipv6CidrBlockNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#TooManyTagsException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an workgroup in Amazon Redshift Serverless.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public access workgroup
Modifying a private workgroup to public
Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#CreateWorkgroupRequest": { "type": "structure", "members": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the created workgroup.
", "smithy.api#required": {} } }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to associate with the workgroup.
", "smithy.api#required": {} } }, "baseCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
" } }, "enhancedVpcRouting": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
" } }, "configParameters": { "target": "com.amazonaws.redshiftserverless#ConfigParameterList", "traits": { "smithy.api#documentation": "An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. If you're using wlm_json_configuration, the maximum size of parameterValue is 8000 characters. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
An array of security group IDs to associate with the workgroup.
" } }, "subnetIds": { "target": "com.amazonaws.redshiftserverless#SubnetIdList", "traits": { "smithy.api#documentation": "An array of VPC subnet IDs to associate with the workgroup.
" } }, "publiclyAccessible": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "A value that specifies whether the workgroup can be accessed from a public network.
" } }, "tags": { "target": "com.amazonaws.redshiftserverless#TagList", "traits": { "smithy.api#documentation": "A array of tag instances.
" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" } }, "maxCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" } }, "pricePerformanceTarget": { "target": "com.amazonaws.redshiftserverless#PerformanceTarget", "traits": { "smithy.api#documentation": "An object that represents the price performance target settings for the workgroup.
" } }, "ipAddressType": { "target": "com.amazonaws.redshiftserverless#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.
If true, allocates additional compute resources for running automatic optimization operations.
Default: false
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#CreateWorkgroupResponse": { "type": "structure", "members": { "workgroup": { "target": "com.amazonaws.redshiftserverless#Workgroup", "traits": { "smithy.api#documentation": "The created workgroup object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#CrossVpcEndpointResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.redshiftserverless#CreateEndpointAccess" }, { "target": "com.amazonaws.redshiftserverless#DeleteEndpointAccess" }, { "target": "com.amazonaws.redshiftserverless#GetEndpointAccess" }, { "target": "com.amazonaws.redshiftserverless#ListEndpointAccess" }, { "target": "com.amazonaws.redshiftserverless#UpdateEndpointAccess" } ] }, "com.amazonaws.redshiftserverless#CurrencyCode": { "type": "string" }, "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "arn:[\\w+=/,.@-]+:acm:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" } }, "com.amazonaws.redshiftserverless#CustomDomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 253 }, "smithy.api#pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" } }, "com.amazonaws.redshiftserverless#DbName": { "type": "string" }, "com.amazonaws.redshiftserverless#DbPassword": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.redshiftserverless#DbUser": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociation": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a custom domain association for Amazon Redshift Serverless.
" } }, "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationRequest": { "type": "structure", "members": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
", "smithy.api#required": {} } }, "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteEndpointAccessRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an Amazon Redshift Serverless managed VPC endpoint.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#DeleteEndpointAccessRequest": { "type": "structure", "members": { "endpointName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the VPC endpoint to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteEndpointAccessResponse": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.redshiftserverless#EndpointAccess", "traits": { "smithy.api#documentation": "The deleted VPC endpoint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteNamespace": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteNamespaceRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteNamespaceResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#DeleteNamespaceRequest": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to delete.
", "smithy.api#required": {} } }, "finalSnapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot to be created before the namespace is deleted.
" } }, "finalSnapshotRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "How long to retain the final snapshot.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteNamespaceResponse": { "type": "structure", "members": { "namespace": { "target": "com.amazonaws.redshiftserverless#Namespace", "traits": { "smithy.api#documentation": "The deleted namespace object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteResourcePolicyRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the specified resource policy.
" } }, "com.amazonaws.redshiftserverless#DeleteResourcePolicyRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteResourcePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteScheduledAction": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteScheduledActionRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteScheduledActionResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a scheduled action.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#DeleteScheduledActionRequest": { "type": "structure", "members": { "scheduledActionName": { "target": "com.amazonaws.redshiftserverless#ScheduledActionName", "traits": { "smithy.api#documentation": "The name of the scheduled action to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteScheduledActionResponse": { "type": "structure", "members": { "scheduledAction": { "target": "com.amazonaws.redshiftserverless#ScheduledActionResponse", "traits": { "smithy.api#documentation": "The deleted scheduled action object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteSnapshotRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a snapshot from Amazon Redshift Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#DeleteSnapshotCopyConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteSnapshotCopyConfigurationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteSnapshotCopyConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a snapshot copy configuration
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#DeleteSnapshotCopyConfigurationRequest": { "type": "structure", "members": { "snapshotCopyConfigurationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the snapshot copy configuration to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteSnapshotCopyConfigurationResponse": { "type": "structure", "members": { "snapshotCopyConfiguration": { "target": "com.amazonaws.redshiftserverless#SnapshotCopyConfiguration", "traits": { "smithy.api#documentation": "The deleted snapshot copy configuration object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteSnapshotRequest": { "type": "structure", "members": { "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot to be deleted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteSnapshotResponse": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.redshiftserverless#Snapshot", "traits": { "smithy.api#documentation": "The deleted snapshot object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteUsageLimit": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteUsageLimitRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteUsageLimitResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a usage limit from Amazon Redshift Serverless.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#DeleteUsageLimitRequest": { "type": "structure", "members": { "usageLimitId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the usage limit to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteUsageLimitResponse": { "type": "structure", "members": { "usageLimit": { "target": "com.amazonaws.redshiftserverless#UsageLimit", "traits": { "smithy.api#documentation": "The deleted usage limit object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DeleteWorkgroup": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#DeleteWorkgroupRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#DeleteWorkgroupResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a workgroup.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#DeleteWorkgroupRequest": { "type": "structure", "members": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup to be deleted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#DeleteWorkgroupResponse": { "type": "structure", "members": { "workgroup": { "target": "com.amazonaws.redshiftserverless#Workgroup", "traits": { "smithy.api#documentation": "The deleted workgroup object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#DryRunException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This exception is thrown when the request was successful, but dry run was enabled so no action was taken.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.redshiftserverless#Duration": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.redshiftserverless#Endpoint": { "type": "structure", "members": { "address": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The DNS address of the VPC endpoint.
" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The port that Amazon Redshift Serverless listens on.
" } }, "vpcEndpoints": { "target": "com.amazonaws.redshiftserverless#VpcEndpointList", "traits": { "smithy.api#documentation": "An array of VpcEndpoint objects.
The VPC endpoint object.
" } }, "com.amazonaws.redshiftserverless#EndpointAccess": { "type": "structure", "members": { "endpointName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the VPC endpoint.
" } }, "endpointStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The status of the VPC endpoint.
" } }, "workgroupName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the endpoint.
" } }, "endpointCreateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time that the endpoint was created.
", "smithy.api#timestampFormat": "date-time" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The port number on which Amazon Redshift Serverless accepts incoming connections.
" } }, "address": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The DNS address of the endpoint.
" } }, "subnetIds": { "target": "com.amazonaws.redshiftserverless#SubnetIdList", "traits": { "smithy.api#documentation": "The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
" } }, "vpcSecurityGroups": { "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupMembershipList", "traits": { "smithy.api#documentation": "The security groups associated with the endpoint.
" } }, "vpcEndpoint": { "target": "com.amazonaws.redshiftserverless#VpcEndpoint", "traits": { "smithy.api#documentation": "The connection endpoint for connecting to Amazon Redshift Serverless.
" } }, "endpointArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the VPC endpoint.
" } } }, "traits": { "smithy.api#documentation": "Information about an Amazon Redshift Serverless VPC endpoint.
" } }, "com.amazonaws.redshiftserverless#EndpointAccessList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#EndpointAccess" } }, "com.amazonaws.redshiftserverless#GetCredentials": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetCredentialsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetCredentialsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).
The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.
If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
The name of the database to get temporary authorization to log on to.
Constraints:
Must be 1 to 64 alphanumeric characters or hyphens.
Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
The first character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide
The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.
" } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
" } }, "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetCredentialsResponse": { "type": "structure", "members": { "dbUser": { "target": "com.amazonaws.redshiftserverless#DbUser", "traits": { "smithy.api#documentation": "A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC.
A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.
The date and time the password in DbPassword expires.
The date and time of when the DbUser and DbPassword authorization refreshes.
Gets information about a specific custom domain association.
" } }, "com.amazonaws.redshiftserverless#GetCustomDomainAssociationRequest": { "type": "structure", "members": { "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup.
", "smithy.api#required": {} } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetCustomDomainAssociationResponse": { "type": "structure", "members": { "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup.
" } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
" } }, "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN).
" } }, "customDomainCertificateExpiryTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The expiration time for the certificate.
", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetEndpointAccessRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information, such as the name, about a VPC endpoint.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetEndpointAccessRequest": { "type": "structure", "members": { "endpointName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the VPC endpoint to return information for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetEndpointAccessResponse": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.redshiftserverless#EndpointAccess", "traits": { "smithy.api#documentation": "The returned VPC endpoint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetIdentityCenterAuthToken": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetIdentityCenterAuthTokenRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetIdentityCenterAuthTokenResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#DryRunException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns an Identity Center authentication token for accessing Amazon Redshift Serverless workgroups.
The token provides secure access to data within the specified workgroups using Identity Center identity propagation. The token expires after a specified duration and must be refreshed for continued access.
The Identity and Access Management (IAM) user or role that runs GetIdentityCenterAuthToken must have appropriate permissions to access the specified workgroups and Identity Center integration must be configured for the workgroups.
" } }, "com.amazonaws.redshiftserverless#GetIdentityCenterAuthTokenRequest": { "type": "structure", "members": { "workgroupNames": { "target": "com.amazonaws.redshiftserverless#WorkgroupNameList", "traits": { "smithy.api#documentation": "A list of workgroup names for which to generate the Identity Center authentication token.
Constraints:
Must contain between 1 and 20 workgroup names.
Each workgroup name must be a valid Amazon Redshift Serverless workgroup identifier.
All specified workgroups must have Identity Center integration enabled.
The Identity Center authentication token that can be used to access data in the specified workgroups.
This token contains the Identity Center identity information and is encrypted for secure transmission.
", "smithy.api#jsonName": "Token" } }, "expirationTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the Identity Center authentication token expires.
After this time, a new token must be requested for continued access.
", "smithy.api#jsonName": "ExpirationTime", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {}, "smithy.api#sensitive": {} } }, "com.amazonaws.redshiftserverless#GetNamespace": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetNamespaceRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetNamespaceResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a namespace in Amazon Redshift Serverless.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetNamespaceRequest": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to retrieve information for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetNamespaceResponse": { "type": "structure", "members": { "namespace": { "target": "com.amazonaws.redshiftserverless#Namespace", "traits": { "smithy.api#documentation": "The returned namespace object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetRecoveryPointRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetRecoveryPointResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a recovery point.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetRecoveryPointRequest": { "type": "structure", "members": { "recoveryPointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the recovery point to return information for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetRecoveryPointResponse": { "type": "structure", "members": { "recoveryPoint": { "target": "com.amazonaws.redshiftserverless#RecoveryPoint", "traits": { "smithy.api#documentation": "The returned recovery point object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetReservation": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetReservationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetReservationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetReservationOffering": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetReservationOfferingRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetReservationOfferingResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the reservation offering. The offering determines the payment schedule for the reservation.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetReservationOfferingRequest": { "type": "structure", "members": { "offeringId": { "target": "com.amazonaws.redshiftserverless#OfferingId", "traits": { "smithy.api#documentation": "The identifier for the offering..
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetReservationOfferingResponse": { "type": "structure", "members": { "reservationOffering": { "target": "com.amazonaws.redshiftserverless#ReservationOffering", "traits": { "smithy.api#documentation": "The returned reservation offering. The offering determines the payment schedule for the reservation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetReservationRequest": { "type": "structure", "members": { "reservationId": { "target": "com.amazonaws.redshiftserverless#ReservationId", "traits": { "smithy.api#documentation": "The ID of the reservation to retrieve.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetReservationResponse": { "type": "structure", "members": { "reservation": { "target": "com.amazonaws.redshiftserverless#Reservation", "traits": { "smithy.api#documentation": "The returned reservation object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a resource policy.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetResourcePolicyRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to return.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetResourcePolicyResponse": { "type": "structure", "members": { "resourcePolicy": { "target": "com.amazonaws.redshiftserverless#ResourcePolicy", "traits": { "smithy.api#documentation": "The returned resource policy.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetScheduledAction": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetScheduledActionRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetScheduledActionResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a scheduled action.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetScheduledActionRequest": { "type": "structure", "members": { "scheduledActionName": { "target": "com.amazonaws.redshiftserverless#ScheduledActionName", "traits": { "smithy.api#documentation": "The name of the scheduled action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetScheduledActionResponse": { "type": "structure", "members": { "scheduledAction": { "target": "com.amazonaws.redshiftserverless#ScheduledActionResponse", "traits": { "smithy.api#documentation": "The returned scheduled action object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetSnapshotRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a specific snapshot.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetSnapshotRequest": { "type": "structure", "members": { "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot to return.
" } }, "ownerAccount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The owner Amazon Web Services account of a snapshot shared with another user.
" } }, "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot to return.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetSnapshotResponse": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.redshiftserverless#Snapshot", "traits": { "smithy.api#documentation": "The returned snapshot object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetTableRestoreStatus": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetTableRestoreStatusRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetTableRestoreStatusResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a TableRestoreStatus object.
The ID of the RestoreTableFromSnapshot request to return status for.
The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.
Get the Redshift Serverless version for a specified track.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetTrackRequest": { "type": "structure", "members": { "trackName": { "target": "com.amazonaws.redshiftserverless#TrackName", "traits": { "smithy.api#documentation": "The name of the track of which its version is fetched.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetTrackResponse": { "type": "structure", "members": { "track": { "target": "com.amazonaws.redshiftserverless#ServerlessTrack", "traits": { "smithy.api#documentation": "The version of the specified track.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetUsageLimit": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetUsageLimitRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetUsageLimitResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a usage limit.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetUsageLimitRequest": { "type": "structure", "members": { "usageLimitId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the usage limit to return information for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetUsageLimitResponse": { "type": "structure", "members": { "usageLimit": { "target": "com.amazonaws.redshiftserverless#UsageLimit", "traits": { "smithy.api#documentation": "The returned usage limit object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#GetWorkgroup": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#GetWorkgroupRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#GetWorkgroupResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a specific workgroup.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#GetWorkgroupRequest": { "type": "structure", "members": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup to return information for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#GetWorkgroupResponse": { "type": "structure", "members": { "workgroup": { "target": "com.amazonaws.redshiftserverless#Workgroup", "traits": { "smithy.api#documentation": "The returned workgroup object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#IamRoleArn": { "type": "string" }, "com.amazonaws.redshiftserverless#IamRoleArnList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#IamRoleArn" } }, "com.amazonaws.redshiftserverless#InsufficientCapacityException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "There is an insufficient capacity to perform the action.
", "smithy.api#error": "client", "smithy.api#httpError": 400, "smithy.api#retryable": {} } }, "com.amazonaws.redshiftserverless#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.redshiftserverless#InvalidPaginationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The provided pagination token is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.redshiftserverless#IpAddressType": { "type": "string", "traits": { "smithy.api#pattern": "^(ipv4|dualstack)$" } }, "com.amazonaws.redshiftserverless#Ipv6CidrBlockNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.redshiftserverless#KmsKeyId": { "type": "string" }, "com.amazonaws.redshiftserverless#LakehouseIdcRegistration": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ASSOCIATE", "value": "Associate" }, { "name": "DISASSOCIATE", "value": "Disassociate" } ] } }, "com.amazonaws.redshiftserverless#LakehouseRegistration": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "REGISTER", "value": "Register" }, { "name": "DEREGISTER", "value": "Deregister" } ] } }, "com.amazonaws.redshiftserverless#ListCustomDomainAssociations": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#InvalidPaginationException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists custom domain associations for Amazon Redshift Serverless.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "associations" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The custom domain name associated with the workgroup.
" } }, "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN).
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
A list of Association objects.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListEndpointAccessRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns an array of EndpointAccess objects and relevant information.
If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The name of the workgroup associated with the VPC endpoint to return.
" } }, "vpcId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
" } }, "ownerAccount": { "target": "com.amazonaws.redshiftserverless#OwnerAccount", "traits": { "smithy.api#documentation": "The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListEndpointAccessResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The returned VPC endpoints.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListManagedWorkgroups": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListManagedWorkgroupsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListManagedWorkgroupsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" } ], "traits": { "smithy.api#documentation": "Returns information about a list of specified managed workgroups in your account.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "managedWorkgroups" } } }, "com.amazonaws.redshiftserverless#ListManagedWorkgroupsRequest": { "type": "structure", "members": { "sourceArn": { "target": "com.amazonaws.redshiftserverless#SourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the managed workgroup in the Glue Data Catalog.
" } }, "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "If your initial ListManagedWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListManagedWorkgroups operations, which returns results in the next page.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListManagedWorkgroupsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
" } }, "managedWorkgroups": { "target": "com.amazonaws.redshiftserverless#ManagedWorkgroups", "traits": { "smithy.api#documentation": "The returned array of managed workgroups.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListNamespaces": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListNamespacesRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListNamespacesResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a list of specified namespaces.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "namespaces" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListNamespacesRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The list of returned namespaces.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListRecoveryPoints": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListRecoveryPointsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListRecoveryPointsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns an array of recovery points.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "recoveryPoints" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListRecoveryPointsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The time when the recovery point's creation was initiated.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when creation of the recovery point finished.
" } }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to list recovery points for.
" } }, "namespaceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the namespace from which to list recovery points.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListRecoveryPointsResponse": { "type": "structure", "members": { "recoveryPoints": { "target": "com.amazonaws.redshiftserverless#RecoveryPointList", "traits": { "smithy.api#documentation": "The returned recovery point objects.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Returns the current reservation offerings in your account.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "reservationOfferingsList" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListReservationOfferingsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListReservationOfferingsResponse": { "type": "structure", "members": { "reservationOfferingsList": { "target": "com.amazonaws.redshiftserverless#ReservationOfferingsList", "traits": { "smithy.api#documentation": "The returned list of reservation offerings.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "The token to use when requesting the next set of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListReservations": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListReservationsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListReservationsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of Reservation objects.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "reservationsList" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListReservationsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListReservationsResponse": { "type": "structure", "members": { "reservationsList": { "target": "com.amazonaws.redshiftserverless#ReservationsList", "traits": { "smithy.api#documentation": "The serverless reservations returned by the request.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "The token to use when requesting the next set of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListScheduledActions": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListScheduledActionsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListScheduledActionsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#InvalidPaginationException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "scheduledActions" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListScheduledActionsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. Use nextToken to display the next page of results.
The name of namespace associated with the scheduled action to retrieve.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListScheduledActionsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" } }, "scheduledActions": { "target": "com.amazonaws.redshiftserverless#ScheduledActionsList", "traits": { "smithy.api#documentation": "All of the returned scheduled action association objects.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListSnapshotCopyConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListSnapshotCopyConfigurationsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListSnapshotCopyConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#InvalidPaginationException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of snapshot copy configurations.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshotCopyConfigurations" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListSnapshotCopyConfigurationsRequest": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The namespace from which to list all snapshot copy configurations.
" } }, "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
All of the returned snapshot copy configurations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListSnapshotsRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListSnapshotsResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of snapshots.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshots" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListSnapshotsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The namespace from which to list all snapshots.
" } }, "namespaceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
" } }, "ownerAccount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The owner Amazon Web Services account of the snapshot.
" } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the creation of the snapshot was initiated.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp showing when the snapshot creation finished.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListSnapshotsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
All of the returned snapshot objects.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListTableRestoreStatus": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListTableRestoreStatusRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListTableRestoreStatusResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InvalidPaginationException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about an array of TableRestoreStatus objects.
If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "namespaceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.
If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.
The array of returned TableRestoreStatus objects.
Lists the tags assigned to a resource.
", "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.redshiftserverless#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to list tags for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.redshiftserverless#TagList", "traits": { "smithy.api#documentation": "A map of the key-value pairs assigned to the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#ListTracks": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#ListTracksRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#ListTracksResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#InvalidPaginationException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "List the Amazon Redshift Serverless versions.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "tracks" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListTracksRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "If your initial ListTracksRequest operation returns a nextToken, you can include the returned nextToken in following ListTracksRequest operations, which returns results in the next page.
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListTracksResponse": { "type": "structure", "members": { "tracks": { "target": "com.amazonaws.redshiftserverless#TrackList", "traits": { "smithy.api#documentation": "The returned tracks.
" } }, "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Lists all usage limits within Amazon Redshift Serverless.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "usageLimits" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListUsageLimitsRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
" } }, "usageType": { "target": "com.amazonaws.redshiftserverless#UsageLimitUsageType", "traits": { "smithy.api#documentation": "The Amazon Redshift Serverless feature whose limits you want to see.
" } }, "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.
An array of returned usage limit objects.
" } }, "nextToken": { "target": "com.amazonaws.redshiftserverless#PaginationToken", "traits": { "smithy.api#documentation": "When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Returns information about a list of specified workgroups.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "workgroups" }, "smithy.api#readonly": {} } }, "com.amazonaws.redshiftserverless#ListWorkgroupsRequest": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#ListWorkgroupsResponse": { "type": "structure", "members": { "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": " If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
The returned array of workgroups.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#LogDestinationType": { "type": "string", "traits": { "smithy.api#documentation": "Destination type for log publishing.", "smithy.api#enum": [ { "name": "S3TABLE", "value": "s3table" }, { "name": "CLOUDWATCH", "value": "cloudwatch" } ] } }, "com.amazonaws.redshiftserverless#LogExport": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "USER_ACTIVITY_LOG", "value": "useractivitylog" }, { "name": "USER_LOG", "value": "userlog" }, { "name": "CONNECTION_LOG", "value": "connectionlog" } ] } }, "com.amazonaws.redshiftserverless#LogExportList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#LogExport" }, "traits": { "smithy.api#length": { "min": 0, "max": 16 } } }, "com.amazonaws.redshiftserverless#ManagedWorkgroupListItem": { "type": "structure", "members": { "managedWorkgroupName": { "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupName", "traits": { "smithy.api#documentation": "The name of the managed workgroup.
" } }, "managedWorkgroupId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the managed workgroup.
" } }, "sourceArn": { "target": "com.amazonaws.redshiftserverless#SourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the managed workgroup in the Glue Data Catalog.
" } }, "status": { "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupStatus", "traits": { "smithy.api#documentation": "The status of the managed workgroup.
" } }, "creationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The creation date of the managed workgroup.
", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "A collection of Amazon Redshift compute resources managed by Glue.
" } }, "com.amazonaws.redshiftserverless#ManagedWorkgroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9_:\\-]+$" } }, "com.amazonaws.redshiftserverless#ManagedWorkgroupResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.redshiftserverless#ListManagedWorkgroups" } ] }, "com.amazonaws.redshiftserverless#ManagedWorkgroupStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "MODIFYING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MODIFYING" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "NOT_AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_AVAILABLE" } } } }, "com.amazonaws.redshiftserverless#ManagedWorkgroups": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupListItem" } }, "com.amazonaws.redshiftserverless#Namespace": { "type": "structure", "members": { "namespaceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with a namespace.
" } }, "namespaceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of a namespace.
" } }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
" } }, "adminUsername": { "target": "com.amazonaws.redshiftserverless#DbUser", "traits": { "smithy.api#documentation": "The username of the administrator for the first database created in the namespace.
" } }, "dbName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the first database created in the namespace.
" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
" } }, "defaultIamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
" } }, "iamRoles": { "target": "com.amazonaws.redshiftserverless#IamRoleArnList", "traits": { "smithy.api#documentation": "A list of IAM roles to associate with the namespace.
" } }, "logExports": { "target": "com.amazonaws.redshiftserverless#LogExportList", "traits": { "smithy.api#documentation": "The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
" } }, "status": { "target": "com.amazonaws.redshiftserverless#NamespaceStatus", "traits": { "smithy.api#documentation": "The status of the namespace.
" } }, "creationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The date of when the namespace was created.
", "smithy.api#timestampFormat": "date-time" } }, "adminPasswordSecretArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
" } }, "adminPasswordSecretKmsKeyId": { "target": "com.amazonaws.redshiftserverless#KmsKeyId", "traits": { "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
" } }, "lakehouseRegistrationStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.
" } }, "catalogArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.
" } }, "s3TablePublishStatus": { "target": "com.amazonaws.redshiftserverless#S3TablePublishStatus", "traits": { "smithy.api#documentation": "The current Amazon S3 Tables log-publishing status for the namespace. Not returned when S3 Tables publishing has never been configured for the namespace.
" } } }, "traits": { "smithy.api#documentation": "A collection of database objects and users.
" } }, "com.amazonaws.redshiftserverless#NamespaceList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#Namespace" } }, "com.amazonaws.redshiftserverless#NamespaceName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 64 }, "smithy.api#pattern": "^[a-z0-9-]+$" } }, "com.amazonaws.redshiftserverless#NamespaceResource": { "type": "resource", "identifiers": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName" } }, "put": { "target": "com.amazonaws.redshiftserverless#CreateNamespace" }, "read": { "target": "com.amazonaws.redshiftserverless#GetNamespace" }, "update": { "target": "com.amazonaws.redshiftserverless#UpdateNamespace" }, "delete": { "target": "com.amazonaws.redshiftserverless#DeleteNamespace" }, "list": { "target": "com.amazonaws.redshiftserverless#ListNamespaces" }, "operations": [ { "target": "com.amazonaws.redshiftserverless#UpdateLakehouseConfiguration" } ], "traits": { "aws.api#arn": { "template": "namespace/{namespaceName}" }, "smithy.api#noReplace": {} } }, "com.amazonaws.redshiftserverless#NamespaceStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "AVAILABLE", "value": "AVAILABLE" }, { "name": "MODIFYING", "value": "MODIFYING" }, { "name": "DELETING", "value": "DELETING" } ] } }, "com.amazonaws.redshiftserverless#NetworkInterface": { "type": "structure", "members": { "networkInterfaceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the network interface.
" } }, "subnetId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the subnet.
" } }, "privateIpAddress": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The IPv4 address of the network interface within the subnet.
" } }, "availabilityZone": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The availability Zone.
" } }, "ipv6Address": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The IPv6 address of the network interface within the subnet.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
" } }, "com.amazonaws.redshiftserverless#NetworkInterfaceList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#NetworkInterface" } }, "com.amazonaws.redshiftserverless#NextInvocationsList": { "type": "list", "member": { "target": "smithy.api#Timestamp" } }, "com.amazonaws.redshiftserverless#OfferingId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.redshiftserverless#OfferingType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ALL_UPFRONT", "value": "ALL_UPFRONT" }, { "name": "NO_UPFRONT", "value": "NO_UPFRONT" } ] } }, "com.amazonaws.redshiftserverless#OwnerAccount": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 12 }, "smithy.api#pattern": "(\\d{12})" } }, "com.amazonaws.redshiftserverless#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 1024 } } }, "com.amazonaws.redshiftserverless#ParameterKey": { "type": "string" }, "com.amazonaws.redshiftserverless#ParameterValue": { "type": "string" }, "com.amazonaws.redshiftserverless#PerformanceTarget": { "type": "structure", "members": { "status": { "target": "com.amazonaws.redshiftserverless#PerformanceTargetStatus", "traits": { "smithy.api#documentation": "Whether the price performance target is enabled for the workgroup.
" } }, "level": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#documentation": "An object that represents the price performance target settings for the workgroup.
" } }, "com.amazonaws.redshiftserverless#PerformanceTargetStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ENABLED", "value": "ENABLED" }, { "name": "DISABLED", "value": "DISABLED" } ] } }, "com.amazonaws.redshiftserverless#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#PutResourcePolicyRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#PutResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
" } }, "com.amazonaws.redshiftserverless#PutResourcePolicyRequest": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account to create or update a resource policy for.
", "smithy.api#required": {} } }, "policy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.
\"{\\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\" : [{ \\\"Sid\\\": \\\"AllowUserRestoreFromSnapshot\\\", \\\"Principal\\\":{\\\"AWS\\\": [\\\"739247239426\\\"]}, \\\"Action\\\": [\\\"redshift-serverless:RestoreFromSnapshot\\\"] , \\\"Effect\\\": \\\"Allow\\\" }]}\"
The policy that was created or updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#RecoveryPoint": { "type": "structure", "members": { "recoveryPointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the recovery point.
" } }, "recoveryPointCreateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time the recovery point is created.
", "smithy.api#timestampFormat": "date-time" } }, "totalSizeInMegaBytes": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "The total size of the data in the recovery point in megabytes.
" } }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace the recovery point is associated with.
" } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup the recovery point is associated with.
" } }, "namespaceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
" } } }, "traits": { "smithy.api#documentation": "The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.
" } }, "com.amazonaws.redshiftserverless#RecoveryPointList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#RecoveryPoint" } }, "com.amazonaws.redshiftserverless#RecoveryPointResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshot" }, { "target": "com.amazonaws.redshiftserverless#GetRecoveryPoint" }, { "target": "com.amazonaws.redshiftserverless#ListRecoveryPoints" }, { "target": "com.amazonaws.redshiftserverless#RestoreFromRecoveryPoint" }, { "target": "com.amazonaws.redshiftserverless#RestoreTableFromRecoveryPoint" } ] }, "com.amazonaws.redshiftserverless#RedshiftIdcApplicationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.redshiftserverless#RedshiftServerless": { "type": "service", "version": "2021-04-21", "operations": [ { "target": "com.amazonaws.redshiftserverless#CreateCustomDomainAssociation" }, { "target": "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociation" }, { "target": "com.amazonaws.redshiftserverless#DeleteResourcePolicy" }, { "target": "com.amazonaws.redshiftserverless#GetCredentials" }, { "target": "com.amazonaws.redshiftserverless#GetCustomDomainAssociation" }, { "target": "com.amazonaws.redshiftserverless#GetIdentityCenterAuthToken" }, { "target": "com.amazonaws.redshiftserverless#GetResourcePolicy" }, { "target": "com.amazonaws.redshiftserverless#GetTrack" }, { "target": "com.amazonaws.redshiftserverless#ListCustomDomainAssociations" }, { "target": "com.amazonaws.redshiftserverless#ListTagsForResource" }, { "target": "com.amazonaws.redshiftserverless#ListTracks" }, { "target": "com.amazonaws.redshiftserverless#PutResourcePolicy" }, { "target": "com.amazonaws.redshiftserverless#TagResource" }, { "target": "com.amazonaws.redshiftserverless#UntagResource" }, { "target": "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociation" } ], "resources": [ { "target": "com.amazonaws.redshiftserverless#CrossVpcEndpointResource" }, { "target": "com.amazonaws.redshiftserverless#ManagedWorkgroupResource" }, { "target": "com.amazonaws.redshiftserverless#NamespaceResource" }, { "target": "com.amazonaws.redshiftserverless#RecoveryPointResource" }, { "target": "com.amazonaws.redshiftserverless#ReservationResource" }, { "target": "com.amazonaws.redshiftserverless#ScheduledActionResource" }, { "target": "com.amazonaws.redshiftserverless#SnapshotResource" }, { "target": "com.amazonaws.redshiftserverless#UsageLimitResource" }, { "target": "com.amazonaws.redshiftserverless#WorkgroupResource" } ], "traits": { "aws.api#service": { "sdkId": "Redshift Serverless", "arnNamespace": "redshift-serverless" }, "aws.auth#sigv4": { "name": "redshift-serverless" }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#awsJson1_1": {}, "smithy.api#cors": {}, "smithy.api#documentation": "This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.
Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.
To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless?.
", "smithy.api#title": "Redshift Serverless", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://redshift-serverless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://redshift-serverless-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://redshift-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://redshift-serverless.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://redshift-serverless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://redshift-serverless-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://redshift-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://redshift-serverless.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://redshift-serverless.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://redshift-serverless.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.redshiftserverless#Reservation": { "type": "structure", "members": { "reservationId": { "target": "com.amazonaws.redshiftserverless#ReservationId", "traits": { "smithy.api#documentation": "The identifier that uniquely identifies the serverless reservation.
" } }, "reservationArn": { "target": "com.amazonaws.redshiftserverless#ReservationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation.
" } }, "startDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start date for the serverless reservation. This is the date you created the reservation.
", "smithy.api#timestampFormat": "date-time" } }, "endDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end date for the serverless reservation. This date is one year after the start date that you specify.
", "smithy.api#timestampFormat": "date-time" } }, "capacity": { "target": "com.amazonaws.redshiftserverless#Capacity", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of Redshift Processing Units (RPUs) to reserve.
" } }, "offering": { "target": "com.amazonaws.redshiftserverless#ReservationOffering", "traits": { "smithy.api#documentation": "The type of offering for the reservation. The offering class determines the payment schedule for the reservation.
" } }, "status": { "target": "com.amazonaws.redshiftserverless#Status", "traits": { "smithy.api#documentation": "The status of the reservation. Possible values include the following:
payment-pending
active
payment-failed
retired
Represents an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.
" } }, "com.amazonaws.redshiftserverless#ReservationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.redshiftserverless#ReservationId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.redshiftserverless#ReservationOffering": { "type": "structure", "members": { "offeringId": { "target": "com.amazonaws.redshiftserverless#OfferingId", "traits": { "smithy.api#documentation": "The offering identifier.
" } }, "duration": { "target": "com.amazonaws.redshiftserverless#Duration", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The duration, in seconds, for which the reservation reserves the RPUs.
" } }, "upfrontCharge": { "target": "com.amazonaws.redshiftserverless#Charge", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The up-front price you are charged for the reservation.
" } }, "hourlyCharge": { "target": "com.amazonaws.redshiftserverless#Charge", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The rate you are charged for each hour the reservation is active.
" } }, "currencyCode": { "target": "com.amazonaws.redshiftserverless#CurrencyCode", "traits": { "smithy.api#documentation": "The currency code for the offering.
" } }, "offeringType": { "target": "com.amazonaws.redshiftserverless#OfferingType", "traits": { "smithy.api#documentation": "Determines the payment schedule for the reservation.
" } } }, "traits": { "smithy.api#documentation": "The class of offering for the reservation. The offering class determines the payment schedule for the reservation.
" } }, "com.amazonaws.redshiftserverless#ReservationOfferingsList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#ReservationOffering" } }, "com.amazonaws.redshiftserverless#ReservationResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.redshiftserverless#CreateReservation" }, { "target": "com.amazonaws.redshiftserverless#GetReservation" }, { "target": "com.amazonaws.redshiftserverless#GetReservationOffering" }, { "target": "com.amazonaws.redshiftserverless#ListReservationOfferings" }, { "target": "com.amazonaws.redshiftserverless#ListReservations" } ] }, "com.amazonaws.redshiftserverless#ReservationsList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#Reservation" } }, "com.amazonaws.redshiftserverless#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceName": { "target": "com.amazonaws.redshiftserverless#AmazonResourceName", "traits": { "smithy.api#documentation": "The name of the resource that could not be found.
" } } }, "traits": { "smithy.api#documentation": "The resource could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.redshiftserverless#ResourcePolicy": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
" } }, "policy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The resource policy.
" } } }, "traits": { "smithy.api#documentation": "The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
" } }, "com.amazonaws.redshiftserverless#RestoreFromRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Restore the data from a recovery point.
" } }, "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointRequest": { "type": "structure", "members": { "recoveryPointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the recovery point to restore from.
", "smithy.api#required": {} } }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to restore data into.
", "smithy.api#required": {} } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup used to restore data.
", "smithy.api#required": {} } }, "maintainIntegration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "If true, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace.
Default: true
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointResponse": { "type": "structure", "members": { "recoveryPointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the recovery point used for the restore.
" } }, "namespace": { "target": "com.amazonaws.redshiftserverless#Namespace", "traits": { "smithy.api#documentation": "The namespace that data was restored into.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#RestoreFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#RestoreFromSnapshotRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#RestoreFromSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Restores a namespace from a snapshot.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#RestoreFromSnapshotRequest": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to restore the snapshot to.
", "smithy.api#required": {} } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup used to restore the snapshot.
", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as snapshotName.
The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
" } }, "ownerAccount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Web Services account that owns the snapshot.
" } }, "manageAdminPassword": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
" } }, "maintainIntegration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "If true, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace.
Default: true
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#RestoreFromSnapshotResponse": { "type": "structure", "members": { "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot used to restore the namespace.
" } }, "ownerAccount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The owner Amazon Web Services; account of the snapshot that was restored.
" } }, "namespace": { "target": "com.amazonaws.redshiftserverless#Namespace" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#RestoreTableFromRecoveryPoint": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#RestoreTableFromRecoveryPointRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#RestoreTableFromRecoveryPointResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
" } }, "com.amazonaws.redshiftserverless#RestoreTableFromRecoveryPointRequest": { "type": "structure", "members": { "namespaceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Namespace of the recovery point to restore from.
", "smithy.api#required": {} } }, "workgroupName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The workgroup to restore the table to.
", "smithy.api#required": {} } }, "recoveryPointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the recovery point to restore the table from.
", "smithy.api#required": {} } }, "sourceDatabaseName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source database that contains the table being restored.
", "smithy.api#required": {} } }, "sourceSchemaName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source schema that contains the table being restored.
" } }, "sourceTableName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source table being restored.
", "smithy.api#required": {} } }, "targetDatabaseName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the database to restore the table to.
" } }, "targetSchemaName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the schema to restore the table to.
" } }, "newTableName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the table to create from the restore operation.
", "smithy.api#required": {} } }, "activateCaseSensitiveIdentifier": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#RestoreTableFromRecoveryPointResponse": { "type": "structure", "members": { "tableRestoreStatus": { "target": "com.amazonaws.redshiftserverless#TableRestoreStatus" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#RestoreTableFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#RestoreTableFromSnapshotRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#RestoreTableFromSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
" } }, "com.amazonaws.redshiftserverless#RestoreTableFromSnapshotRequest": { "type": "structure", "members": { "namespaceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace of the snapshot to restore from.
", "smithy.api#required": {} } }, "workgroupName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The workgroup to restore the table to.
", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot to restore the table from.
", "smithy.api#required": {} } }, "sourceDatabaseName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source database that contains the table being restored.
", "smithy.api#required": {} } }, "sourceSchemaName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source schema that contains the table being restored.
" } }, "sourceTableName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source table being restored.
", "smithy.api#required": {} } }, "targetDatabaseName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the database to restore the table to.
" } }, "targetSchemaName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the schema to restore the table to.
" } }, "newTableName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the table to create from the restore operation.
", "smithy.api#required": {} } }, "activateCaseSensitiveIdentifier": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#RestoreTableFromSnapshotResponse": { "type": "structure", "members": { "tableRestoreStatus": { "target": "com.amazonaws.redshiftserverless#TableRestoreStatus", "traits": { "smithy.api#documentation": "The TableRestoreStatus object that contains the status of the restore operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#S3TableAction": { "type": "string", "traits": { "smithy.api#documentation": "Action to perform for S3 Table log publishing.", "smithy.api#enum": [ { "name": "ENABLE", "value": "Enable" }, { "name": "DISABLE", "value": "Disable" } ] } }, "com.amazonaws.redshiftserverless#S3TableGranularity": { "type": "string", "traits": { "smithy.api#documentation": "Granularity for S3 Table scoping in serverless.", "smithy.api#enum": [ { "name": "NAMESPACE", "value": "namespace" }, { "name": "ACCOUNT", "value": "account" } ] } }, "com.amazonaws.redshiftserverless#S3TableLastIngestionTimeMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "Map of system table name to the last ingestion time (ISO-8601) for that table." } }, "com.amazonaws.redshiftserverless#S3TableName": { "type": "string", "traits": { "smithy.api#documentation": "A system-table view name to publish to S3 Tables (e.g. \"sys_query_history\"), or the\nkeyword \"all\" to publish every current and future system table.", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(all|sys_[a-z0-9_]+)$" } }, "com.amazonaws.redshiftserverless#S3TableNameList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#S3TableName" }, "traits": { "smithy.api#documentation": "List of system table names (or \"all\") to publish to S3 Tables. Sized to hold the full\nSYS_* universe (28+ today, grows as new views are onboarded) plus headroom.", "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.redshiftserverless#S3TablePublishStatus": { "type": "structure", "members": { "s3Tables": { "target": "com.amazonaws.redshiftserverless#S3TableNameList", "traits": { "smithy.api#documentation": "The system tables currently being published.
" } }, "s3TableNamespace": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the namespace in the S3 table bucket that holds the published tables.
" } }, "s3TableGranularity": { "target": "com.amazonaws.redshiftserverless#S3TableGranularity", "traits": { "smithy.api#documentation": "The scope currently in effect. Values are namespace or account.
true when the namespace is enrolled in every current and future system table rather than an explicit list of tables.
A map of system table name to the time that table last received data, as an ISO-8601 timestamp. A table that has not yet been ingested is absent from the map. Use it to judge data freshness.
" } } }, "traits": { "smithy.api#documentation": "Describes the state of Amazon S3 Tables system-table log publishing for a namespace.
" } }, "com.amazonaws.redshiftserverless#Schedule": { "type": "union", "members": { "at": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule of when Amazon Redshift Serverless should run the scheduled action.
" } }, "com.amazonaws.redshiftserverless#ScheduledActionAssociation": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "Name of associated Amazon Redshift Serverless namespace.
" } }, "scheduledActionName": { "target": "com.amazonaws.redshiftserverless#ScheduledActionName", "traits": { "smithy.api#documentation": "Name of associated scheduled action.
" } } }, "traits": { "smithy.api#documentation": "Contains names of objects associated with a scheduled action.
" } }, "com.amazonaws.redshiftserverless#ScheduledActionName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 60 }, "smithy.api#pattern": "^[a-z0-9-]+$" } }, "com.amazonaws.redshiftserverless#ScheduledActionResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.redshiftserverless#CreateScheduledAction" }, { "target": "com.amazonaws.redshiftserverless#DeleteScheduledAction" }, { "target": "com.amazonaws.redshiftserverless#GetScheduledAction" }, { "target": "com.amazonaws.redshiftserverless#ListScheduledActions" }, { "target": "com.amazonaws.redshiftserverless#UpdateScheduledAction" } ] }, "com.amazonaws.redshiftserverless#ScheduledActionResponse": { "type": "structure", "members": { "scheduledActionName": { "target": "com.amazonaws.redshiftserverless#ScheduledActionName", "traits": { "smithy.api#documentation": "The name of the scheduled action.
" } }, "schedule": { "target": "com.amazonaws.redshiftserverless#Schedule", "traits": { "smithy.api#documentation": "The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The description of the scheduled action.
" } }, "nextInvocations": { "target": "com.amazonaws.redshiftserverless#NextInvocationsList", "traits": { "smithy.api#documentation": "An array of timestamps of when the next scheduled actions will trigger.
" } }, "roleArn": { "target": "com.amazonaws.redshiftserverless#IamRoleArn", "traits": { "smithy.api#documentation": "The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" } }, "state": { "target": "com.amazonaws.redshiftserverless#State", "traits": { "smithy.api#documentation": "The state of the scheduled action.
" } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end time of
" } }, "targetAction": { "target": "com.amazonaws.redshiftserverless#TargetAction" }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
" } }, "scheduledActionUuid": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The uuid of the scheduled action.
" } } }, "traits": { "smithy.api#documentation": "The returned scheduled action object.
" } }, "com.amazonaws.redshiftserverless#ScheduledActionsList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#ScheduledActionAssociation" } }, "com.amazonaws.redshiftserverless#SecurityGroupId": { "type": "string" }, "com.amazonaws.redshiftserverless#SecurityGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#SecurityGroupId" } }, "com.amazonaws.redshiftserverless#ServerlessTrack": { "type": "structure", "members": { "trackName": { "target": "com.amazonaws.redshiftserverless#TrackName", "traits": { "smithy.api#documentation": "The name of the track. Valid values are current and trailing.
The workgroup version number for the workgroup release.
" } }, "updateTargets": { "target": "com.amazonaws.redshiftserverless#UpdateTargetsList", "traits": { "smithy.api#documentation": "An array of UpdateTarget objects to update with the track.
Defines a track that determines which Amazon Redshift version to apply after a new version is released. If the value for ServerlessTrack is current, the workgroup is updated to the most recently certified release. If the value is trailing, the workgroup is updated to the previously certified release.
The service limit was exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.redshiftserverless#Snapshot": { "type": "structure", "members": { "namespaceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the namepsace.
" } }, "namespaceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
" } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot.
" } }, "snapshotCreateTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the snapshot was created.
", "smithy.api#timestampFormat": "date-time" } }, "adminUsername": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The username of the database within a snapshot.
" } }, "status": { "target": "com.amazonaws.redshiftserverless#SnapshotStatus", "traits": { "smithy.api#documentation": "The status of the snapshot.
" } }, "kmsKeyId": { "target": "com.amazonaws.redshiftserverless#KmsKeyId", "traits": { "smithy.api#documentation": "The unique identifier of the KMS key used to encrypt the snapshot.
" } }, "ownerAccount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The owner Amazon Web Services; account of the snapshot.
" } }, "totalBackupSizeInMegaBytes": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "The total size, in megabytes, of how big the snapshot is.
" } }, "actualIncrementalBackupSizeInMegaBytes": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "The size of the incremental backup in megabytes.
" } }, "backupProgressInMegaBytes": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "The size in megabytes of the data that has been backed up to a snapshot.
" } }, "currentBackupRateInMegaBytesPerSecond": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "The rate at which data is backed up into a snapshot in megabytes per second.
" } }, "estimatedSecondsToCompletion": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The estimated amount of seconds until the snapshot completes backup.
" } }, "elapsedTimeInSeconds": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The amount of time it took to back up data into a snapshot.
" } }, "snapshotRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The period of time, in days, of how long the snapshot is retained.
" } }, "snapshotRemainingDays": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The amount of days until the snapshot is deleted.
" } }, "snapshotRetentionStartTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when data within the snapshot started getting retained.
", "smithy.api#timestampFormat": "date-time" } }, "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot.
" } }, "accountsWithRestoreAccess": { "target": "com.amazonaws.redshiftserverless#AccountIdList", "traits": { "smithy.api#documentation": "All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
" } }, "accountsWithProvisionedRestoreAccess": { "target": "com.amazonaws.redshiftserverless#AccountIdList", "traits": { "smithy.api#documentation": "All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
" } }, "adminPasswordSecretArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
" } }, "adminPasswordSecretKmsKeyId": { "target": "com.amazonaws.redshiftserverless#KmsKeyId", "traits": { "smithy.api#documentation": "The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
" } } }, "traits": { "smithy.api#documentation": "A snapshot object that contains databases.
" } }, "com.amazonaws.redshiftserverless#SnapshotCopyConfiguration": { "type": "structure", "members": { "snapshotCopyConfigurationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the snapshot copy configuration object.
" } }, "snapshotCopyConfigurationArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ARN of the snapshot copy configuration object.
" } }, "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
" } }, "destinationRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The destination Amazon Web Services Region to copy snapshots to.
" } }, "snapshotRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The retention period of snapshots that are copied to the destination Amazon Web Services Region.
" } }, "destinationKmsKeyId": { "target": "com.amazonaws.redshiftserverless#KmsKeyId", "traits": { "smithy.api#documentation": "The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
" } } }, "traits": { "smithy.api#documentation": "The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region.
" } }, "com.amazonaws.redshiftserverless#SnapshotCopyConfigurations": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#SnapshotCopyConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.redshiftserverless#SnapshotList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#Snapshot" } }, "com.amazonaws.redshiftserverless#SnapshotNamePrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 235 } } }, "com.amazonaws.redshiftserverless#SnapshotResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.redshiftserverless#CreateSnapshot" }, { "target": "com.amazonaws.redshiftserverless#CreateSnapshotCopyConfiguration" }, { "target": "com.amazonaws.redshiftserverless#DeleteSnapshot" }, { "target": "com.amazonaws.redshiftserverless#DeleteSnapshotCopyConfiguration" }, { "target": "com.amazonaws.redshiftserverless#GetSnapshot" }, { "target": "com.amazonaws.redshiftserverless#GetTableRestoreStatus" }, { "target": "com.amazonaws.redshiftserverless#ListSnapshotCopyConfigurations" }, { "target": "com.amazonaws.redshiftserverless#ListSnapshots" }, { "target": "com.amazonaws.redshiftserverless#ListTableRestoreStatus" }, { "target": "com.amazonaws.redshiftserverless#RestoreFromSnapshot" }, { "target": "com.amazonaws.redshiftserverless#RestoreTableFromSnapshot" }, { "target": "com.amazonaws.redshiftserverless#UpdateSnapshot" }, { "target": "com.amazonaws.redshiftserverless#UpdateSnapshotCopyConfiguration" } ] }, "com.amazonaws.redshiftserverless#SnapshotStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "AVAILABLE", "value": "AVAILABLE" }, { "name": "CREATING", "value": "CREATING" }, { "name": "DELETED", "value": "DELETED" }, { "name": "CANCELLED", "value": "CANCELLED" }, { "name": "FAILED", "value": "FAILED" }, { "name": "COPYING", "value": "COPYING" } ] } }, "com.amazonaws.redshiftserverless#SourceArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[a-z-]*:glue:[a-z0-9-]+:\\d+:(database|catalog)[a-z0-9-:]*(?:/[A-Za-z0-9-_]{1,255})*$" } }, "com.amazonaws.redshiftserverless#State": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACTIVE", "value": "ACTIVE" }, { "name": "DISABLED", "value": "DISABLED" } ] } }, "com.amazonaws.redshiftserverless#Status": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16 } } }, "com.amazonaws.redshiftserverless#SubnetId": { "type": "string" }, "com.amazonaws.redshiftserverless#SubnetIdList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#SubnetId" } }, "com.amazonaws.redshiftserverless#TableRestoreStatus": { "type": "structure", "members": { "tableRestoreRequestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the RestoreTableFromSnapshot request.
" } }, "status": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.
A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.
The time that the table restore request was made, in Universal Coordinated Time (UTC).
" } }, "namespaceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace of the table being restored from.
" } }, "workgroupName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the workgroup being restored from.
" } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot being restored from.
" } }, "progressInMegaBytes": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The amount of data restored to the new table so far, in megabytes (MB).
" } }, "totalDataInMegaBytes": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The total amount of data to restore to the new table, in megabytes (MB).
" } }, "sourceDatabaseName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source database being restored from.
" } }, "sourceSchemaName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source schema being restored from.
" } }, "sourceTableName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the source table being restored from.
" } }, "targetDatabaseName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the database to restore to.
" } }, "targetSchemaName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the schema to restore to.
" } }, "newTableName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the table to create from the restore operation.
" } }, "recoveryPointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the recovery point being restored from.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a table restore request.
" } }, "com.amazonaws.redshiftserverless#TableRestoreStatusList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#TableRestoreStatus" } }, "com.amazonaws.redshiftserverless#Tag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.redshiftserverless#TagKey", "traits": { "smithy.api#documentation": "The key to use in the tag.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.redshiftserverless#TagValue", "traits": { "smithy.api#documentation": "The value of the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A map of key-value pairs.
" } }, "com.amazonaws.redshiftserverless#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.redshiftserverless#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.redshiftserverless#TagList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.redshiftserverless#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#TagResourceRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#TooManyTagsException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Assigns one or more tags to a resource.
" } }, "com.amazonaws.redshiftserverless#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.redshiftserverless#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.redshiftserverless#TagList", "traits": { "smithy.api#documentation": "The map of the key-value pairs used to tag the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.redshiftserverless#TargetAction": { "type": "union", "members": { "createSnapshot": { "target": "com.amazonaws.redshiftserverless#CreateSnapshotScheduleActionParameters" } }, "traits": { "smithy.api#documentation": "A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.
\"{\"CreateSnapshot\": {\"NamespaceName\": \"sampleNamespace\",\"SnapshotName\": \"sampleSnapshot\", \"retentionPeriod\": \"1\"}}\"
The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} } }, "com.amazonaws.redshiftserverless#TooManyTagsException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" }, "resourceName": { "target": "com.amazonaws.redshiftserverless#AmazonResourceName", "traits": { "smithy.api#documentation": "The name of the resource that exceeded the number of tags allowed for a resource.
" } } }, "traits": { "smithy.api#documentation": "The request exceeded the number of tags allowed for a resource.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.redshiftserverless#TrackList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#ServerlessTrack" } }, "com.amazonaws.redshiftserverless#TrackName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9_]+$" } }, "com.amazonaws.redshiftserverless#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UntagResourceRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes a tag or set of tags from a resource.
" } }, "com.amazonaws.redshiftserverless#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.redshiftserverless#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to remove tags from.
", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.redshiftserverless#TagKeyList", "traits": { "smithy.api#documentation": "The tag or set of tags to remove from the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociation": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ThrottlingException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an Amazon Redshift Serverless certificate associated with a custom domain.
" } }, "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationRequest": { "type": "structure", "members": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
", "smithy.api#required": {} } }, "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup.
", "smithy.api#required": {} } }, "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN). This is optional.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationResponse": { "type": "structure", "members": { "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup.
" } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup associated with the database.
" } }, "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN).
" } }, "customDomainCertificateExpiryTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The expiration time for the certificate.
", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateEndpointAccess": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateEndpointAccessRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateEndpointAccessResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an Amazon Redshift Serverless managed endpoint.
" } }, "com.amazonaws.redshiftserverless#UpdateEndpointAccessRequest": { "type": "structure", "members": { "endpointName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the VPC endpoint to update.
", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupIdList", "traits": { "smithy.api#documentation": "The list of VPC security groups associated with the endpoint after the endpoint is modified.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UpdateEndpointAccessResponse": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.redshiftserverless#EndpointAccess", "traits": { "smithy.api#documentation": "The updated VPC endpoint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateLakehouseConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateLakehouseConfigurationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateLakehouseConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#DryRunException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Modifies the lakehouse configuration for a namespace. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM Identity Center trusted identity propagation.
" } }, "com.amazonaws.redshiftserverless#UpdateLakehouseConfigurationRequest": { "type": "structure", "members": { "namespaceName": { "target": "com.amazonaws.redshiftserverless#NamespaceName", "traits": { "smithy.api#documentation": "The name of the namespace whose lakehouse configuration you want to modify.
", "smithy.api#required": {} } }, "lakehouseRegistration": { "target": "com.amazonaws.redshiftserverless#LakehouseRegistration", "traits": { "smithy.api#documentation": "Specifies whether to register or deregister the namespace with Amazon Redshift federated permissions. Valid values are Register or Deregister.
The name of the Glue Data Catalog that will be associated with the namespace enabled with Amazon Redshift federated permissions.
Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$
Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.
The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions.
" } }, "dryRun": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "A boolean value that, if true, validates the request without actually updating the lakehouse configuration. Use this to check for errors before making changes.
The name of the namespace.
" } }, "lakehouseIdcApplicationArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation.
" } }, "lakehouseRegistrationStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The current status of the lakehouse registration. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.
" } }, "catalogArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the lakehouse configuration.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateNamespace": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateNamespaceRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateNamespaceResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.
Similarly, an S3 Tables log-publishing update (a request where logDestinationType is s3table) cannot be combined with any other namespace configuration change and must be submitted as its own request.
The name of the namespace to update. You can't update the name of a namespace once it is created.
", "smithy.api#required": {} } }, "adminUserPassword": { "target": "com.amazonaws.redshiftserverless#DbPassword", "traits": { "smithy.api#documentation": "The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.
You can't use adminUserPassword if manageAdminPassword is true.
If your admin user account is locked, this operation also unlocks your account and resets the failed-login counter. This option is available only when account lockout security is enabled for the namespace.
" } }, "adminUsername": { "target": "com.amazonaws.redshiftserverless#DbUser", "traits": { "smithy.api#documentation": "The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
" } }, "defaultIamRoleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.
A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.
The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.
If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
The destination for the log data. Valid values are s3table and cloudwatch.
Set this to s3table to manage Amazon S3 Tables system-table publishing for the namespace.
Whether to enable or disable Amazon S3 Tables publishing. Valid values are Enable and Disable, matched case-insensitively.
When omitted, defaults to Enable. Valid only when logDestinationType is s3table.
The system tables to publish (on enable) or to stop publishing (on disable). Each value is either a system table view name that begins with sys_ or the keyword all.
Omitting this parameter, passing an empty list, or including all each select every current and future system table. Each name must be 1-128 characters, and the list can contain up to 256 names.
Valid only when logDestinationType is s3table.
The identifier of the Key Management Service key used to encrypt the published Amazon S3 Tables data. When omitted, the data is encrypted with SSE-S3 (Amazon S3 managed keys).
Valid only when logDestinationType is s3table.
The scope of the Amazon S3 Tables destination. Valid values are namespace and account, matched case-insensitively. namespace scopes the published tables to this namespace; account scopes them to the Amazon Web Services account.
Required when enabling. Omitting this parameter or passing a blank value fails with ValidationException. Valid only when logDestinationType is s3table.
A list of tag instances.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateScheduledAction": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateScheduledActionRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateScheduledActionResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a scheduled action.
", "smithy.api#idempotent": {} } }, "com.amazonaws.redshiftserverless#UpdateScheduledActionRequest": { "type": "structure", "members": { "scheduledActionName": { "target": "com.amazonaws.redshiftserverless#ScheduledActionName", "traits": { "smithy.api#documentation": "The name of the scheduled action to update to.
", "smithy.api#required": {} } }, "targetAction": { "target": "com.amazonaws.redshiftserverless#TargetAction" }, "schedule": { "target": "com.amazonaws.redshiftserverless#Schedule", "traits": { "smithy.api#documentation": "The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.
Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide
" } }, "enabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to enable the scheduled action.
" } }, "scheduledActionDescription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The descripion of the scheduled action to update to.
" } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The start time in UTC of the scheduled action to update to.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The end time in UTC of the scheduled action to update.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UpdateScheduledActionResponse": { "type": "structure", "members": { "scheduledAction": { "target": "com.amazonaws.redshiftserverless#ScheduledActionResponse", "traits": { "smithy.api#documentation": "The ScheduledAction object that was updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateSnapshotRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a snapshot.
" } }, "com.amazonaws.redshiftserverless#UpdateSnapshotCopyConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateSnapshotCopyConfigurationRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateSnapshotCopyConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#AccessDeniedException" }, { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a snapshot copy configuration.
" } }, "com.amazonaws.redshiftserverless#UpdateSnapshotCopyConfigurationRequest": { "type": "structure", "members": { "snapshotCopyConfigurationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the snapshot copy configuration to update.
", "smithy.api#required": {} } }, "snapshotRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UpdateSnapshotCopyConfigurationResponse": { "type": "structure", "members": { "snapshotCopyConfiguration": { "target": "com.amazonaws.redshiftserverless#SnapshotCopyConfiguration", "traits": { "smithy.api#documentation": "The updated snapshot copy configuration object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateSnapshotRequest": { "type": "structure", "members": { "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the snapshot.
", "smithy.api#required": {} } }, "retentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The new retention period of the snapshot.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UpdateSnapshotResponse": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.redshiftserverless#Snapshot", "traits": { "smithy.api#documentation": "The updated snapshot object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateTarget": { "type": "structure", "members": { "trackName": { "target": "com.amazonaws.redshiftserverless#TrackName", "traits": { "smithy.api#documentation": "The name of the new track.
" } }, "workgroupVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The workgroup version for the new track.
" } } }, "traits": { "smithy.api#documentation": "A track that you can switch the current track to.
" } }, "com.amazonaws.redshiftserverless#UpdateTargetsList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#UpdateTarget" } }, "com.amazonaws.redshiftserverless#UpdateUsageLimit": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateUsageLimitRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateUsageLimitResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
" } }, "com.amazonaws.redshiftserverless#UpdateUsageLimitRequest": { "type": "structure", "members": { "usageLimitId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the usage limit to update.
", "smithy.api#required": {} } }, "amount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
" } }, "breachAction": { "target": "com.amazonaws.redshiftserverless#UsageLimitBreachAction", "traits": { "smithy.api#documentation": "The new action that Amazon Redshift Serverless takes when the limit is reached.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UpdateUsageLimitResponse": { "type": "structure", "members": { "usageLimit": { "target": "com.amazonaws.redshiftserverless#UsageLimit", "traits": { "smithy.api#documentation": "The updated usage limit object.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UpdateWorkgroup": { "type": "operation", "input": { "target": "com.amazonaws.redshiftserverless#UpdateWorkgroupRequest" }, "output": { "target": "com.amazonaws.redshiftserverless#UpdateWorkgroupResponse" }, "errors": [ { "target": "com.amazonaws.redshiftserverless#ConflictException" }, { "target": "com.amazonaws.redshiftserverless#InsufficientCapacityException" }, { "target": "com.amazonaws.redshiftserverless#InternalServerException" }, { "target": "com.amazonaws.redshiftserverless#Ipv6CidrBlockNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" }, { "target": "com.amazonaws.redshiftserverless#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked:
Creating a public access workgroup
Modifying a private workgroup to public
Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public
For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
" } }, "com.amazonaws.redshiftserverless#UpdateWorkgroupRequest": { "type": "structure", "members": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup to update. You can't update the name of a workgroup once it is created.
", "smithy.api#required": {} } }, "baseCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The new base data warehouse capacity in Redshift Processing Units (RPUs).
" } }, "enhancedVpcRouting": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
" } }, "configParameters": { "target": "com.amazonaws.redshiftserverless#ConfigParameterList", "traits": { "smithy.api#documentation": "An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. If you're using wlm_json_configuration, the maximum size of parameterValue is 8000 characters. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
A value that specifies whether the workgroup can be accessible from a public network.
" } }, "subnetIds": { "target": "com.amazonaws.redshiftserverless#SubnetIdList", "traits": { "smithy.api#documentation": "An array of VPC subnet IDs to associate with the workgroup.
" } }, "securityGroupIds": { "target": "com.amazonaws.redshiftserverless#SecurityGroupIdList", "traits": { "smithy.api#documentation": "An array of security group IDs to associate with the workgroup.
" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" } }, "maxCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" } }, "ipAddressType": { "target": "com.amazonaws.redshiftserverless#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
An object that represents the price performance target settings for the workgroup.
" } }, "trackName": { "target": "com.amazonaws.redshiftserverless#TrackName", "traits": { "smithy.api#documentation": "An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.
If true, allocates additional compute resources for running automatic optimization operations.
Default: false
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.redshiftserverless#UpdateWorkgroupResponse": { "type": "structure", "members": { "workgroup": { "target": "com.amazonaws.redshiftserverless#Workgroup", "traits": { "smithy.api#documentation": "The updated workgroup object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.redshiftserverless#UsageLimit": { "type": "structure", "members": { "usageLimitId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the usage limit.
" } }, "usageLimitArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource associated with the usage limit.
" } }, "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
" } }, "usageType": { "target": "com.amazonaws.redshiftserverless#UsageLimitUsageType", "traits": { "smithy.api#documentation": "The Amazon Redshift Serverless feature to limit.
" } }, "amount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.
" } }, "period": { "target": "com.amazonaws.redshiftserverless#UsageLimitPeriod", "traits": { "smithy.api#documentation": "The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
" } }, "breachAction": { "target": "com.amazonaws.redshiftserverless#UsageLimitBreachAction", "traits": { "smithy.api#documentation": "The action that Amazon Redshift Serverless takes when the limit is reached.
" } } }, "traits": { "smithy.api#documentation": "The usage limit object.
" } }, "com.amazonaws.redshiftserverless#UsageLimitBreachAction": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "LOG", "value": "log" }, { "name": "EMIT_METRIC", "value": "emit-metric" }, { "name": "DEACTIVATE", "value": "deactivate" } ] } }, "com.amazonaws.redshiftserverless#UsageLimitPeriod": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "DAILY", "value": "daily" }, { "name": "WEEKLY", "value": "weekly" }, { "name": "MONTHLY", "value": "monthly" } ] } }, "com.amazonaws.redshiftserverless#UsageLimitResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.redshiftserverless#CreateUsageLimit" }, { "target": "com.amazonaws.redshiftserverless#DeleteUsageLimit" }, { "target": "com.amazonaws.redshiftserverless#GetUsageLimit" }, { "target": "com.amazonaws.redshiftserverless#ListUsageLimits" }, { "target": "com.amazonaws.redshiftserverless#UpdateUsageLimit" } ] }, "com.amazonaws.redshiftserverless#UsageLimitUsageType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "SERVERLESS_COMPUTE", "value": "serverless-compute" }, { "name": "CROSS_REGION_DATASHARING", "value": "cross-region-datasharing" } ] } }, "com.amazonaws.redshiftserverless#UsageLimits": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#UsageLimit" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.redshiftserverless#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The input failed to satisfy the constraints specified by an Amazon Web Services service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.redshiftserverless#VpcEndpoint": { "type": "structure", "members": { "vpcEndpointId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The connection endpoint ID for connecting to Amazon Redshift Serverless.
" } }, "vpcId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The VPC identifier that the endpoint is associated with.
" } }, "networkInterfaces": { "target": "com.amazonaws.redshiftserverless#NetworkInterfaceList", "traits": { "smithy.api#documentation": "One or more network interfaces of the endpoint. Also known as an interface endpoint.
" } } }, "traits": { "smithy.api#documentation": "The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
" } }, "com.amazonaws.redshiftserverless#VpcEndpointList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#VpcEndpoint" } }, "com.amazonaws.redshiftserverless#VpcIds": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.redshiftserverless#VpcSecurityGroupId": { "type": "string" }, "com.amazonaws.redshiftserverless#VpcSecurityGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupId" } }, "com.amazonaws.redshiftserverless#VpcSecurityGroupMembership": { "type": "structure", "members": { "vpcSecurityGroupId": { "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupId", "traits": { "smithy.api#documentation": "The unique identifier of the VPC security group.
" } }, "status": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The status of the VPC security group.
" } } }, "traits": { "smithy.api#documentation": "Describes the members of a VPC security group.
" } }, "com.amazonaws.redshiftserverless#VpcSecurityGroupMembershipList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupMembership" } }, "com.amazonaws.redshiftserverless#Workgroup": { "type": "structure", "members": { "workgroupId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the workgroup.
" } }, "workgroupArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that links to the workgroup.
" } }, "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName", "traits": { "smithy.api#documentation": "The name of the workgroup.
" } }, "namespaceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace the workgroup is associated with.
" } }, "baseCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
" } }, "enhancedVpcRouting": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
" } }, "configParameters": { "target": "com.amazonaws.redshiftserverless#ConfigParameterList", "traits": { "smithy.api#documentation": "An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. If you're using wlm_json_configuration, the maximum size of parameterValue is 8000 characters. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
An array of security group IDs to associate with the workgroup.
" } }, "subnetIds": { "target": "com.amazonaws.redshiftserverless#SubnetIdList", "traits": { "smithy.api#documentation": "An array of subnet IDs the workgroup is associated with.
" } }, "status": { "target": "com.amazonaws.redshiftserverless#WorkgroupStatus", "traits": { "smithy.api#documentation": "The status of the workgroup.
" } }, "endpoint": { "target": "com.amazonaws.redshiftserverless#Endpoint", "traits": { "smithy.api#documentation": "The endpoint that is created from the workgroup.
" } }, "publiclyAccessible": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "A value that specifies whether the workgroup can be accessible from a public network.
" } }, "creationDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The creation date of the workgroup.
", "smithy.api#timestampFormat": "date-time" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" } }, "customDomainName": { "target": "com.amazonaws.redshiftserverless#CustomDomainName", "traits": { "smithy.api#documentation": "The custom domain name associated with the workgroup.
" } }, "customDomainCertificateArn": { "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", "traits": { "smithy.api#documentation": "The custom domain name\u2019s certificate Amazon resource name (ARN).
" } }, "customDomainCertificateExpiryTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The expiration time for the certificate.
", "smithy.api#timestampFormat": "date-time" } }, "workgroupVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.
" } }, "patchVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.
" } }, "maxCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" } }, "crossAccountVpcs": { "target": "com.amazonaws.redshiftserverless#VpcIds", "traits": { "smithy.api#documentation": "A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.
" } }, "ipAddressType": { "target": "com.amazonaws.redshiftserverless#IpAddressType", "traits": { "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
An object that represents the price performance target settings for the workgroup.
" } }, "trackName": { "target": "com.amazonaws.redshiftserverless#TrackName", "traits": { "smithy.api#documentation": "The name of the track for the workgroup.
" } }, "pendingTrackName": { "target": "com.amazonaws.redshiftserverless#TrackName", "traits": { "smithy.api#documentation": "The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied.
" } }, "extraComputeForAutomaticOptimization": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "A boolean value that, if true, indicates that the workgroup allocates additional compute resources to run automatic optimization operations.
Default: false
" } } }, "traits": { "smithy.api#documentation": "The collection of computing resources from which an endpoint is created.
" } }, "com.amazonaws.redshiftserverless#WorkgroupList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#Workgroup" } }, "com.amazonaws.redshiftserverless#WorkgroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 64 }, "smithy.api#pattern": "^[a-z0-9-]+$" } }, "com.amazonaws.redshiftserverless#WorkgroupNameList": { "type": "list", "member": { "target": "com.amazonaws.redshiftserverless#WorkgroupName" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.redshiftserverless#WorkgroupResource": { "type": "resource", "identifiers": { "workgroupName": { "target": "com.amazonaws.redshiftserverless#WorkgroupName" } }, "put": { "target": "com.amazonaws.redshiftserverless#CreateWorkgroup" }, "read": { "target": "com.amazonaws.redshiftserverless#GetWorkgroup" }, "update": { "target": "com.amazonaws.redshiftserverless#UpdateWorkgroup" }, "delete": { "target": "com.amazonaws.redshiftserverless#DeleteWorkgroup" }, "list": { "target": "com.amazonaws.redshiftserverless#ListWorkgroups" }, "traits": { "aws.api#arn": { "template": "workgroup/{workgroupName}" }, "smithy.api#noReplace": {} } }, "com.amazonaws.redshiftserverless#WorkgroupStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "CREATING", "value": "CREATING" }, { "name": "AVAILABLE", "value": "AVAILABLE" }, { "name": "MODIFYING", "value": "MODIFYING" }, { "name": "DELETING", "value": "DELETING" } ] } } } }