# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [ConvertRecoveryPointToSnapshot](API_ConvertRecoveryPointToSnapshot.md) 
+  [CreateCustomDomainAssociation](API_CreateCustomDomainAssociation.md) 
+  [CreateEndpointAccess](API_CreateEndpointAccess.md) 
+  [CreateNamespace](API_CreateNamespace.md) 
+  [CreateReservation](API_CreateReservation.md) 
+  [CreateScheduledAction](API_CreateScheduledAction.md) 
+  [CreateSnapshot](API_CreateSnapshot.md) 
+  [CreateSnapshotCopyConfiguration](API_CreateSnapshotCopyConfiguration.md) 
+  [CreateUsageLimit](API_CreateUsageLimit.md) 
+  [CreateWorkgroup](API_CreateWorkgroup.md) 
+  [DeleteCustomDomainAssociation](API_DeleteCustomDomainAssociation.md) 
+  [DeleteEndpointAccess](API_DeleteEndpointAccess.md) 
+  [DeleteNamespace](API_DeleteNamespace.md) 
+  [DeleteResourcePolicy](API_DeleteResourcePolicy.md) 
+  [DeleteScheduledAction](API_DeleteScheduledAction.md) 
+  [DeleteSnapshot](API_DeleteSnapshot.md) 
+  [DeleteSnapshotCopyConfiguration](API_DeleteSnapshotCopyConfiguration.md) 
+  [DeleteUsageLimit](API_DeleteUsageLimit.md) 
+  [DeleteWorkgroup](API_DeleteWorkgroup.md) 
+  [GetCredentials](API_GetCredentials.md) 
+  [GetCustomDomainAssociation](API_GetCustomDomainAssociation.md) 
+  [GetEndpointAccess](API_GetEndpointAccess.md) 
+  [GetIdentityCenterAuthToken](API_GetIdentityCenterAuthToken.md) 
+  [GetNamespace](API_GetNamespace.md) 
+  [GetRecoveryPoint](API_GetRecoveryPoint.md) 
+  [GetReservation](API_GetReservation.md) 
+  [GetReservationOffering](API_GetReservationOffering.md) 
+  [GetResourcePolicy](API_GetResourcePolicy.md) 
+  [GetScheduledAction](API_GetScheduledAction.md) 
+  [GetSnapshot](API_GetSnapshot.md) 
+  [GetTableRestoreStatus](API_GetTableRestoreStatus.md) 
+  [GetTrack](API_GetTrack.md) 
+  [GetUsageLimit](API_GetUsageLimit.md) 
+  [GetWorkgroup](API_GetWorkgroup.md) 
+  [ListCustomDomainAssociations](API_ListCustomDomainAssociations.md) 
+  [ListEndpointAccess](API_ListEndpointAccess.md) 
+  [ListManagedWorkgroups](API_ListManagedWorkgroups.md) 
+  [ListNamespaces](API_ListNamespaces.md) 
+  [ListRecoveryPoints](API_ListRecoveryPoints.md) 
+  [ListReservationOfferings](API_ListReservationOfferings.md) 
+  [ListReservations](API_ListReservations.md) 
+  [ListScheduledActions](API_ListScheduledActions.md) 
+  [ListSnapshotCopyConfigurations](API_ListSnapshotCopyConfigurations.md) 
+  [ListSnapshots](API_ListSnapshots.md) 
+  [ListTableRestoreStatus](API_ListTableRestoreStatus.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTracks](API_ListTracks.md) 
+  [ListUsageLimits](API_ListUsageLimits.md) 
+  [ListWorkgroups](API_ListWorkgroups.md) 
+  [PutResourcePolicy](API_PutResourcePolicy.md) 
+  [RestoreFromRecoveryPoint](API_RestoreFromRecoveryPoint.md) 
+  [RestoreFromSnapshot](API_RestoreFromSnapshot.md) 
+  [RestoreTableFromRecoveryPoint](API_RestoreTableFromRecoveryPoint.md) 
+  [RestoreTableFromSnapshot](API_RestoreTableFromSnapshot.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateCustomDomainAssociation](API_UpdateCustomDomainAssociation.md) 
+  [UpdateEndpointAccess](API_UpdateEndpointAccess.md) 
+  [UpdateLakehouseConfiguration](API_UpdateLakehouseConfiguration.md) 
+  [UpdateNamespace](API_UpdateNamespace.md) 
+  [UpdateScheduledAction](API_UpdateScheduledAction.md) 
+  [UpdateSnapshot](API_UpdateSnapshot.md) 
+  [UpdateSnapshotCopyConfiguration](API_UpdateSnapshotCopyConfiguration.md) 
+  [UpdateUsageLimit](API_UpdateUsageLimit.md) 
+  [UpdateWorkgroup](API_UpdateWorkgroup.md) 

# ConvertRecoveryPointToSnapshot
<a name="API_ConvertRecoveryPointToSnapshot"></a>

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see [Working with snapshots and recovery points](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery-points.html).

## Request Syntax
<a name="API_ConvertRecoveryPointToSnapshot_RequestSyntax"></a>

```
{
   "recoveryPointId": "string",
   "retentionPeriod": number,
   "snapshotName": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_ConvertRecoveryPointToSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [recoveryPointId](#API_ConvertRecoveryPointToSnapshot_RequestSyntax) **   <a name="redshiftserverless-ConvertRecoveryPointToSnapshot-request-recoveryPointId"></a>
The unique identifier of the recovery point.  
Type: String  
Required: Yes

 ** [retentionPeriod](#API_ConvertRecoveryPointToSnapshot_RequestSyntax) **   <a name="redshiftserverless-ConvertRecoveryPointToSnapshot-request-retentionPeriod"></a>
How long to retain the snapshot.  
Type: Integer  
Required: No

 ** [snapshotName](#API_ConvertRecoveryPointToSnapshot_RequestSyntax) **   <a name="redshiftserverless-ConvertRecoveryPointToSnapshot-request-snapshotName"></a>
The name of the snapshot.  
Type: String  
Required: Yes

 ** [tags](#API_ConvertRecoveryPointToSnapshot_RequestSyntax) **   <a name="redshiftserverless-ConvertRecoveryPointToSnapshot-request-tags"></a>
An array of [Tag objects](https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) to associate with the created snapshot.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_ConvertRecoveryPointToSnapshot_ResponseSyntax"></a>

```
{
   "snapshot": { 
      "accountsWithProvisionedRestoreAccess": [ "string" ],
      "accountsWithRestoreAccess": [ "string" ],
      "actualIncrementalBackupSizeInMegaBytes": number,
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "backupProgressInMegaBytes": number,
      "currentBackupRateInMegaBytesPerSecond": number,
      "elapsedTimeInSeconds": number,
      "estimatedSecondsToCompletion": number,
      "kmsKeyId": "string",
      "namespaceArn": "string",
      "namespaceName": "string",
      "ownerAccount": "string",
      "snapshotArn": "string",
      "snapshotCreateTime": "string",
      "snapshotName": "string",
      "snapshotRemainingDays": number,
      "snapshotRetentionPeriod": number,
      "snapshotRetentionStartTime": "string",
      "status": "string",
      "totalBackupSizeInMegaBytes": number
   }
}
```

## Response Elements
<a name="API_ConvertRecoveryPointToSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshot](#API_ConvertRecoveryPointToSnapshot_ResponseSyntax) **   <a name="redshiftserverless-ConvertRecoveryPointToSnapshot-response-snapshot"></a>
The snapshot converted from the recovery point.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_ConvertRecoveryPointToSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The request exceeded the number of tags allowed for a resource.    
 ** resourceName **   
The name of the resource that exceeded the number of tags allowed for a resource.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ConvertRecoveryPointToSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ConvertRecoveryPointToSnapshot) 

# CreateCustomDomainAssociation
<a name="API_CreateCustomDomainAssociation"></a>

Creates a custom domain association for Amazon Redshift Serverless.

## Request Syntax
<a name="API_CreateCustomDomainAssociation_RequestSyntax"></a>

```
{
   "customDomainCertificateArn": "string",
   "customDomainName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_CreateCustomDomainAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [customDomainCertificateArn](#API_CreateCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-CreateCustomDomainAssociation-request-customDomainCertificateArn"></a>
The custom domain name’s certificate Amazon resource name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*.*`   
Required: Yes

 ** [customDomainName](#API_CreateCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-CreateCustomDomainAssociation-request-customDomainName"></a>
The custom domain name to associate with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`   
Required: Yes

 ** [workgroupName](#API_CreateCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-CreateCustomDomainAssociation-request-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_CreateCustomDomainAssociation_ResponseSyntax"></a>

```
{
   "customDomainCertificateArn": "string",
   "customDomainCertificateExpiryTime": "string",
   "customDomainName": "string",
   "workgroupName": "string"
}
```

## Response Elements
<a name="API_CreateCustomDomainAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [customDomainCertificateArn](#API_CreateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-CreateCustomDomainAssociation-response-customDomainCertificateArn"></a>
The custom domain name’s certificate Amazon resource name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*.*` 

 ** [customDomainCertificateExpiryTime](#API_CreateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-CreateCustomDomainAssociation-response-customDomainCertificateExpiryTime"></a>
The expiration time for the certificate.  
Type: Timestamp

 ** [customDomainName](#API_CreateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-CreateCustomDomainAssociation-response-customDomainName"></a>
The custom domain name to associate with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])` 

 ** [workgroupName](#API_CreateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-CreateCustomDomainAssociation-response-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+` 

## Errors
<a name="API_CreateCustomDomainAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateCustomDomainAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateCustomDomainAssociation) 

# CreateEndpointAccess
<a name="API_CreateEndpointAccess"></a>

Creates an Amazon Redshift Serverless managed VPC endpoint.

## Request Syntax
<a name="API_CreateEndpointAccess_RequestSyntax"></a>

```
{
   "endpointName": "string",
   "ownerAccount": "string",
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ],
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_CreateEndpointAccess_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endpointName](#API_CreateEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-CreateEndpointAccess-request-endpointName"></a>
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.  
Type: String  
Required: Yes

 ** [ownerAccount](#API_CreateEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-CreateEndpointAccess-request-ownerAccount"></a>
The owner AWS account for the Amazon Redshift Serverless workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `.*(\d{12}).*`   
Required: No

 ** [subnetIds](#API_CreateEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-CreateEndpointAccess-request-subnetIds"></a>
The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.  
Type: Array of strings  
Required: Yes

 ** [vpcSecurityGroupIds](#API_CreateEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-CreateEndpointAccess-request-vpcSecurityGroupIds"></a>
The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.  
Type: Array of strings  
Required: No

 ** [workgroupName](#API_CreateEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-CreateEndpointAccess-request-workgroupName"></a>
The name of the workgroup to associate with the VPC endpoint.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreateEndpointAccess_ResponseSyntax"></a>

```
{
   "endpoint": { 
      "address": "string",
      "endpointArn": "string",
      "endpointCreateTime": "string",
      "endpointName": "string",
      "endpointStatus": "string",
      "port": number,
      "subnetIds": [ "string" ],
      "vpcEndpoint": { 
         "networkInterfaces": [ 
            { 
               "availabilityZone": "string",
               "ipv6Address": "string",
               "networkInterfaceId": "string",
               "privateIpAddress": "string",
               "subnetId": "string"
            }
         ],
         "vpcEndpointId": "string",
         "vpcId": "string"
      },
      "vpcSecurityGroups": [ 
         { 
            "status": "string",
            "vpcSecurityGroupId": "string"
         }
      ],
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_CreateEndpointAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endpoint](#API_CreateEndpointAccess_ResponseSyntax) **   <a name="redshiftserverless-CreateEndpointAccess-response-endpoint"></a>
The created VPC endpoint.  
Type: [EndpointAccess](API_EndpointAccess.md) object

## Errors
<a name="API_CreateEndpointAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateEndpointAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateEndpointAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateEndpointAccess) 

# CreateNamespace
<a name="API_CreateNamespace"></a>

Creates a namespace in Amazon Redshift Serverless.

## Request Syntax
<a name="API_CreateNamespace_RequestSyntax"></a>

```
{
   "adminPasswordSecretKmsKeyId": "string",
   "adminUsername": "string",
   "adminUserPassword": "string",
   "dbName": "string",
   "defaultIamRoleArn": "string",
   "iamRoles": [ "string" ],
   "kmsKeyId": "string",
   "logExports": [ "string" ],
   "manageAdminPassword": boolean,
   "namespaceName": "string",
   "redshiftIdcApplicationArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateNamespace_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [adminPasswordSecretKmsKeyId](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-adminPasswordSecretKmsKeyId"></a>
The ID of the AWS 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.  
Type: String  
Required: No

 ** [adminUsername](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-adminUsername"></a>
The username of the administrator for the first database created in the namespace.  
Type: String  
Required: No

 ** [adminUserPassword](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-adminUserPassword"></a>
The password of the administrator for the first database created in the namespace.  
You can't use `adminUserPassword` if `manageAdminPassword` is true.   
Type: String  
Required: No

 ** [dbName](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-dbName"></a>
The name of the first database created in the namespace.  
Type: String  
Required: No

 ** [defaultIamRoleArn](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-defaultIamRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.  
Type: String  
Required: No

 ** [iamRoles](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-iamRoles"></a>
A list of IAM roles to associate with the namespace.  
Type: Array of strings  
Required: No

 ** [kmsKeyId](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-kmsKeyId"></a>
The ID of the AWS Key Management Service key used to encrypt your data.  
Type: String  
Required: No

 ** [logExports](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-logExports"></a>
The types of logs the namespace can export. Available export types are `userlog`, `connectionlog`, and `useractivitylog`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 16 items.  
Valid Values: `useractivitylog | userlog | connectionlog`   
Required: No

 ** [manageAdminPassword](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-manageAdminPassword"></a>
If `true`, Amazon Redshift uses AWS 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.   
Type: Boolean  
Required: No

 ** [namespaceName](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-namespaceName"></a>
The name of the namespace.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [redshiftIdcApplicationArn](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-redshiftIdcApplicationArn"></a>
The ARN for the Redshift application that integrates with IAM Identity Center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [tags](#API_CreateNamespace_RequestSyntax) **   <a name="redshiftserverless-CreateNamespace-request-tags"></a>
A list of tag instances.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateNamespace_ResponseSyntax"></a>

```
{
   "namespace": { 
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "catalogArn": "string",
      "creationDate": "string",
      "dbName": "string",
      "defaultIamRoleArn": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "lakehouseRegistrationStatus": "string",
      "logExports": [ "string" ],
      "namespaceArn": "string",
      "namespaceId": "string",
      "namespaceName": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_CreateNamespace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [namespace](#API_CreateNamespace_ResponseSyntax) **   <a name="redshiftserverless-CreateNamespace-response-namespace"></a>
The created namespace object.  
Type: [Namespace](API_Namespace.md) object

## Errors
<a name="API_CreateNamespace_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** TooManyTagsException **   
The request exceeded the number of tags allowed for a resource.    
 ** resourceName **   
The name of the resource that exceeded the number of tags allowed for a resource.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateNamespace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateNamespace) 

# CreateReservation
<a name="API_CreateReservation"></a>

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.

## Request Syntax
<a name="API_CreateReservation_RequestSyntax"></a>

```
{
   "capacity": number,
   "clientToken": "string",
   "offeringId": "string"
}
```

## Request Parameters
<a name="API_CreateReservation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [capacity](#API_CreateReservation_RequestSyntax) **   <a name="redshiftserverless-CreateReservation-request-capacity"></a>
The number of Redshift Processing Units (RPUs) to reserve.  
Type: Integer  
Required: Yes

 ** [clientToken](#API_CreateReservation_RequestSyntax) **   <a name="redshiftserverless-CreateReservation-request-clientToken"></a>
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 ](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Required: No

 ** [offeringId](#API_CreateReservation_RequestSyntax) **   <a name="redshiftserverless-CreateReservation-request-offeringId"></a>
The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

## Response Syntax
<a name="API_CreateReservation_ResponseSyntax"></a>

```
{
   "reservation": { 
      "capacity": number,
      "endDate": "string",
      "offering": { 
         "currencyCode": "string",
         "duration": number,
         "hourlyCharge": number,
         "offeringId": "string",
         "offeringType": "string",
         "upfrontCharge": number
      },
      "reservationArn": "string",
      "reservationId": "string",
      "startDate": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_CreateReservation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [reservation](#API_CreateReservation_ResponseSyntax) **   <a name="redshiftserverless-CreateReservation-response-reservation"></a>
The reservation object that the `CreateReservation` action created.  
Type: [Reservation](API_Reservation.md) object

## Errors
<a name="API_CreateReservation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The request exceeded the number of tags allowed for a resource.    
 ** resourceName **   
The name of the resource that exceeded the number of tags allowed for a resource.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateReservation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateReservation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateReservation) 

# CreateScheduledAction
<a name="API_CreateScheduledAction"></a>

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.

## Request Syntax
<a name="API_CreateScheduledAction_RequestSyntax"></a>

```
{
   "enabled": boolean,
   "endTime": number,
   "namespaceName": "string",
   "roleArn": "string",
   "schedule": { ... },
   "scheduledActionDescription": "string",
   "scheduledActionName": "string",
   "startTime": number,
   "targetAction": { ... }
}
```

## Request Parameters
<a name="API_CreateScheduledAction_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [enabled](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-enabled"></a>
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](https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html).  
Type: Boolean  
Required: No

 ** [endTime](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-endTime"></a>
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.  
Type: Timestamp  
Required: No

 ** [namespaceName](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-namespaceName"></a>
The name of the namespace for which to create a scheduled action.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [roleArn](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-roleArn"></a>
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](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) in the Amazon Redshift Management Guide  
Type: String  
Required: Yes

 ** [schedule](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-schedule"></a>
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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) in the *Amazon CloudWatch Events User Guide*.
Type: [Schedule](API_Schedule.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [scheduledActionDescription](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-scheduledActionDescription"></a>
The description of the scheduled action.  
Type: String  
Required: No

 ** [scheduledActionName](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-scheduledActionName"></a>
The name of the scheduled action.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 60.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [startTime](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-startTime"></a>
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.  
Type: Timestamp  
Required: No

 ** [targetAction](#API_CreateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-CreateScheduledAction-request-targetAction"></a>
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"}}"`   
Type: [TargetAction](API_TargetAction.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_CreateScheduledAction_ResponseSyntax"></a>

```
{
   "scheduledAction": { 
      "endTime": number,
      "namespaceName": "string",
      "nextInvocations": [ number ],
      "roleArn": "string",
      "schedule": { ... },
      "scheduledActionDescription": "string",
      "scheduledActionName": "string",
      "scheduledActionUuid": "string",
      "startTime": number,
      "state": "string",
      "targetAction": { ... }
   }
}
```

## Response Elements
<a name="API_CreateScheduledAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [scheduledAction](#API_CreateScheduledAction_ResponseSyntax) **   <a name="redshiftserverless-CreateScheduledAction-response-scheduledAction"></a>
The returned `ScheduledAction` object that describes the properties of a scheduled action.  
Type: [ScheduledActionResponse](API_ScheduledActionResponse.md) object

## Errors
<a name="API_CreateScheduledAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateScheduledAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateScheduledAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateScheduledAction) 

# CreateSnapshot
<a name="API_CreateSnapshot"></a>

Creates a snapshot of all databases in a namespace. For more information about snapshots, see [ Working with snapshots and recovery points](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery-points.html).

## Request Syntax
<a name="API_CreateSnapshot_RequestSyntax"></a>

```
{
   "namespaceName": "string",
   "retentionPeriod": number,
   "snapshotName": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [namespaceName](#API_CreateSnapshot_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshot-request-namespaceName"></a>
The namespace to create a snapshot for.  
Type: String  
Required: Yes

 ** [retentionPeriod](#API_CreateSnapshot_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshot-request-retentionPeriod"></a>
How long to retain the created snapshot.  
Type: Integer  
Required: No

 ** [snapshotName](#API_CreateSnapshot_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshot-request-snapshotName"></a>
The name of the snapshot.  
Type: String  
Required: Yes

 ** [tags](#API_CreateSnapshot_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshot-request-tags"></a>
An array of [Tag objects](https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) to associate with the snapshot.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateSnapshot_ResponseSyntax"></a>

```
{
   "snapshot": { 
      "accountsWithProvisionedRestoreAccess": [ "string" ],
      "accountsWithRestoreAccess": [ "string" ],
      "actualIncrementalBackupSizeInMegaBytes": number,
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "backupProgressInMegaBytes": number,
      "currentBackupRateInMegaBytesPerSecond": number,
      "elapsedTimeInSeconds": number,
      "estimatedSecondsToCompletion": number,
      "kmsKeyId": "string",
      "namespaceArn": "string",
      "namespaceName": "string",
      "ownerAccount": "string",
      "snapshotArn": "string",
      "snapshotCreateTime": "string",
      "snapshotName": "string",
      "snapshotRemainingDays": number,
      "snapshotRetentionPeriod": number,
      "snapshotRetentionStartTime": "string",
      "status": "string",
      "totalBackupSizeInMegaBytes": number
   }
}
```

## Response Elements
<a name="API_CreateSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshot](#API_CreateSnapshot_ResponseSyntax) **   <a name="redshiftserverless-CreateSnapshot-response-snapshot"></a>
The created snapshot object.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_CreateSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The request exceeded the number of tags allowed for a resource.    
 ** resourceName **   
The name of the resource that exceeded the number of tags allowed for a resource.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateSnapshot) 

# CreateSnapshotCopyConfiguration
<a name="API_CreateSnapshotCopyConfiguration"></a>

Creates a snapshot copy configuration that lets you copy snapshots to another AWS Region.

## Request Syntax
<a name="API_CreateSnapshotCopyConfiguration_RequestSyntax"></a>

```
{
   "destinationKmsKeyId": "string",
   "destinationRegion": "string",
   "namespaceName": "string",
   "snapshotRetentionPeriod": number
}
```

## Request Parameters
<a name="API_CreateSnapshotCopyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [destinationKmsKeyId](#API_CreateSnapshotCopyConfiguration_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshotCopyConfiguration-request-destinationKmsKeyId"></a>
The KMS key to use to encrypt your snapshots in the destination AWS Region.  
Type: String  
Required: No

 ** [destinationRegion](#API_CreateSnapshotCopyConfiguration_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshotCopyConfiguration-request-destinationRegion"></a>
The destination AWS Region that you want to copy snapshots to.  
Type: String  
Required: Yes

 ** [namespaceName](#API_CreateSnapshotCopyConfiguration_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshotCopyConfiguration-request-namespaceName"></a>
The name of the namespace to copy snapshots from.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [snapshotRetentionPeriod](#API_CreateSnapshotCopyConfiguration_RequestSyntax) **   <a name="redshiftserverless-CreateSnapshotCopyConfiguration-request-snapshotRetentionPeriod"></a>
The retention period of the snapshots that you copy to the destination AWS Region.  
Type: Integer  
Required: No

## Response Syntax
<a name="API_CreateSnapshotCopyConfiguration_ResponseSyntax"></a>

```
{
   "snapshotCopyConfiguration": { 
      "destinationKmsKeyId": "string",
      "destinationRegion": "string",
      "namespaceName": "string",
      "snapshotCopyConfigurationArn": "string",
      "snapshotCopyConfigurationId": "string",
      "snapshotRetentionPeriod": number
   }
}
```

## Response Elements
<a name="API_CreateSnapshotCopyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshotCopyConfiguration](#API_CreateSnapshotCopyConfiguration_ResponseSyntax) **   <a name="redshiftserverless-CreateSnapshotCopyConfiguration-response-snapshotCopyConfiguration"></a>
The snapshot copy configuration object that is returned.  
Type: [SnapshotCopyConfiguration](API_SnapshotCopyConfiguration.md) object

## Errors
<a name="API_CreateSnapshotCopyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateSnapshotCopyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateSnapshotCopyConfiguration) 

# CreateUsageLimit
<a name="API_CreateUsageLimit"></a>

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier. 

## Request Syntax
<a name="API_CreateUsageLimit_RequestSyntax"></a>

```
{
   "amount": number,
   "breachAction": "string",
   "period": "string",
   "resourceArn": "string",
   "usageType": "string"
}
```

## Request Parameters
<a name="API_CreateUsageLimit_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [amount](#API_CreateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-CreateUsageLimit-request-amount"></a>
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.  
Type: Long  
Required: Yes

 ** [breachAction](#API_CreateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-CreateUsageLimit-request-breachAction"></a>
The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.  
Type: String  
Valid Values: `log | emit-metric | deactivate`   
Required: No

 ** [period](#API_CreateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-CreateUsageLimit-request-period"></a>
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.  
Type: String  
Valid Values: `daily | weekly | monthly`   
Required: No

 ** [resourceArn](#API_CreateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-CreateUsageLimit-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.  
Type: String  
Required: Yes

 ** [usageType](#API_CreateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-CreateUsageLimit-request-usageType"></a>
The type of Amazon Redshift Serverless usage to create a usage limit for.  
Type: String  
Valid Values: `serverless-compute | cross-region-datasharing`   
Required: Yes

## Response Syntax
<a name="API_CreateUsageLimit_ResponseSyntax"></a>

```
{
   "usageLimit": { 
      "amount": number,
      "breachAction": "string",
      "period": "string",
      "resourceArn": "string",
      "usageLimitArn": "string",
      "usageLimitId": "string",
      "usageType": "string"
   }
}
```

## Response Elements
<a name="API_CreateUsageLimit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [usageLimit](#API_CreateUsageLimit_ResponseSyntax) **   <a name="redshiftserverless-CreateUsageLimit-response-usageLimit"></a>
The returned usage limit object.  
Type: [UsageLimit](API_UsageLimit.md) object

## Errors
<a name="API_CreateUsageLimit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateUsageLimit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateUsageLimit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateUsageLimit) 

# CreateWorkgroup
<a name="API_CreateWorkgroup"></a>

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](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*.

## Request Syntax
<a name="API_CreateWorkgroup_RequestSyntax"></a>

```
{
   "baseCapacity": number,
   "configParameters": [ 
      { 
         "parameterKey": "string",
         "parameterValue": "string"
      }
   ],
   "enhancedVpcRouting": boolean,
   "extraComputeForAutomaticOptimization": boolean,
   "ipAddressType": "string",
   "maxCapacity": number,
   "namespaceName": "string",
   "port": number,
   "pricePerformanceTarget": { 
      "level": number,
      "status": "string"
   },
   "publiclyAccessible": boolean,
   "securityGroupIds": [ "string" ],
   "subnetIds": [ "string" ],
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "trackName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_CreateWorkgroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [baseCapacity](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-baseCapacity"></a>
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).  
Type: Integer  
Required: No

 ** [configParameters](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-configParameters"></a>
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](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless).  
Type: Array of [ConfigParameter](API_ConfigParameter.md) objects  
Required: No

 ** [enhancedVpcRouting](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-enhancedVpcRouting"></a>
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.  
Type: Boolean  
Required: No

 ** [extraComputeForAutomaticOptimization](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-extraComputeForAutomaticOptimization"></a>
If `true`, allocates additional compute resources for running automatic optimization operations.  
Default: false  
Type: Boolean  
Required: No

 ** [ipAddressType](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-ipAddressType"></a>
The IP address type that the workgroup supports. Possible values are `ipv4` and `dualstack`.  
Type: String  
Pattern: `(ipv4|dualstack)`   
Required: No

 ** [maxCapacity](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-maxCapacity"></a>
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.  
Type: Integer  
Required: No

 ** [namespaceName](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-namespaceName"></a>
The name of the namespace to associate with the workgroup.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [port](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-port"></a>
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.  
Type: Integer  
Required: No

 ** [pricePerformanceTarget](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-pricePerformanceTarget"></a>
An object that represents the price performance target settings for the workgroup.  
Type: [PerformanceTarget](API_PerformanceTarget.md) object  
Required: No

 ** [publiclyAccessible](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-publiclyAccessible"></a>
A value that specifies whether the workgroup can be accessed from a public network.  
Type: Boolean  
Required: No

 ** [securityGroupIds](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-securityGroupIds"></a>
An array of security group IDs to associate with the workgroup.  
Type: Array of strings  
Required: No

 ** [subnetIds](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-subnetIds"></a>
An array of VPC subnet IDs to associate with the workgroup.  
Type: Array of strings  
Required: No

 ** [tags](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-tags"></a>
A array of tag instances.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [trackName](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-trackName"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_]+`   
Required: No

 ** [workgroupName](#API_CreateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-CreateWorkgroup-request-workgroupName"></a>
The name of the created workgroup.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_CreateWorkgroup_ResponseSyntax"></a>

```
{
   "workgroup": { 
      "baseCapacity": number,
      "configParameters": [ 
         { 
            "parameterKey": "string",
            "parameterValue": "string"
         }
      ],
      "creationDate": "string",
      "crossAccountVpcs": [ "string" ],
      "customDomainCertificateArn": "string",
      "customDomainCertificateExpiryTime": "string",
      "customDomainName": "string",
      "endpoint": { 
         "address": "string",
         "port": number,
         "vpcEndpoints": [ 
            { 
               "networkInterfaces": [ 
                  { 
                     "availabilityZone": "string",
                     "ipv6Address": "string",
                     "networkInterfaceId": "string",
                     "privateIpAddress": "string",
                     "subnetId": "string"
                  }
               ],
               "vpcEndpointId": "string",
               "vpcId": "string"
            }
         ]
      },
      "enhancedVpcRouting": boolean,
      "extraComputeForAutomaticOptimization": boolean,
      "ipAddressType": "string",
      "maxCapacity": number,
      "namespaceName": "string",
      "patchVersion": "string",
      "pendingTrackName": "string",
      "port": number,
      "pricePerformanceTarget": { 
         "level": number,
         "status": "string"
      },
      "publiclyAccessible": boolean,
      "securityGroupIds": [ "string" ],
      "status": "string",
      "subnetIds": [ "string" ],
      "trackName": "string",
      "workgroupArn": "string",
      "workgroupId": "string",
      "workgroupName": "string",
      "workgroupVersion": "string"
   }
}
```

## Response Elements
<a name="API_CreateWorkgroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [workgroup](#API_CreateWorkgroup_ResponseSyntax) **   <a name="redshiftserverless-CreateWorkgroup-response-workgroup"></a>
The created workgroup object.  
Type: [Workgroup](API_Workgroup.md) object

## Errors
<a name="API_CreateWorkgroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InsufficientCapacityException **   
There is an insufficient capacity to perform the action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** Ipv6CidrBlockNotFoundException **   
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.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** TooManyTagsException **   
The request exceeded the number of tags allowed for a resource.    
 ** resourceName **   
The name of the resource that exceeded the number of tags allowed for a resource.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateWorkgroup_Examples"></a>

### Example
<a name="API_CreateWorkgroup_Example_1"></a>

This example illustrates one usage of CreateWorkgroup.

#### Sample Request
<a name="API_CreateWorkgroup_Example_1_Request"></a>

```
aws redshift-serverless create-workgroup 
--workgroup-name test-workgroup 
--namespace-name test-namespace 
--track-name current
--region us-east-1
```

#### Sample Response
<a name="API_CreateWorkgroup_Example_1_Response"></a>

```
{
    "workgroup": {
        "workgroupId": "875083e4-50b5-4ad7-bd8b-b01beb74d912",
        "workgroupArn": "arn:aws:redshift-serverless:us-east-1:012345678901:workgroup/875083e4-50b5-4ad7-bd8b-b01beb74d912",
        "workgroupName": "test-workgroup",
        "namespaceName": "test-namespace",
        "baseCapacity": 32,
        "enhancedVpcRouting": false,
        ...
        "securityGroupIds": [
            "sg-0f0e3edaf8473b3d2"
        ],
        "subnetIds": [
            "subnet-05a4615a242adf950",
            "subnet-0d364615acc244f2a",
            "subnet-037672f31c13d78a0",
            "subnet-062539bdf89dfa749",
            "subnet-01534423c994e5e30",
            "subnet-042b4ad9afe0826c6"
        ],
        "status": "CREATING",
        "endpoint": {
            "address": "test-workgroup-1.012345678901.us-east-1-dsk.redshift-serverless-dev.amazonaws.com",
            "port": 5439
        },
        "publiclyAccessible": false,
        "creationDate": "2024-12-13T14:19:50.636000+00:00",
        "pricePerformanceTarget": {
            "status": "DISABLED"
        },
        "ipAddressType": "ipv4",
        "trackName": "current"
    }
}
```

## See Also
<a name="API_CreateWorkgroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/CreateWorkgroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/CreateWorkgroup) 

# DeleteCustomDomainAssociation
<a name="API_DeleteCustomDomainAssociation"></a>

Deletes a custom domain association for Amazon Redshift Serverless.

## Request Syntax
<a name="API_DeleteCustomDomainAssociation_RequestSyntax"></a>

```
{
   "customDomainName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_DeleteCustomDomainAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [customDomainName](#API_DeleteCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-DeleteCustomDomainAssociation-request-customDomainName"></a>
The custom domain name associated with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`   
Required: Yes

 ** [workgroupName](#API_DeleteCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-DeleteCustomDomainAssociation-request-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Elements
<a name="API_DeleteCustomDomainAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteCustomDomainAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteCustomDomainAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteCustomDomainAssociation) 

# DeleteEndpointAccess
<a name="API_DeleteEndpointAccess"></a>

Deletes an Amazon Redshift Serverless managed VPC endpoint.

## Request Syntax
<a name="API_DeleteEndpointAccess_RequestSyntax"></a>

```
{
   "endpointName": "string"
}
```

## Request Parameters
<a name="API_DeleteEndpointAccess_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endpointName](#API_DeleteEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-DeleteEndpointAccess-request-endpointName"></a>
The name of the VPC endpoint to delete.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_DeleteEndpointAccess_ResponseSyntax"></a>

```
{
   "endpoint": { 
      "address": "string",
      "endpointArn": "string",
      "endpointCreateTime": "string",
      "endpointName": "string",
      "endpointStatus": "string",
      "port": number,
      "subnetIds": [ "string" ],
      "vpcEndpoint": { 
         "networkInterfaces": [ 
            { 
               "availabilityZone": "string",
               "ipv6Address": "string",
               "networkInterfaceId": "string",
               "privateIpAddress": "string",
               "subnetId": "string"
            }
         ],
         "vpcEndpointId": "string",
         "vpcId": "string"
      },
      "vpcSecurityGroups": [ 
         { 
            "status": "string",
            "vpcSecurityGroupId": "string"
         }
      ],
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_DeleteEndpointAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endpoint](#API_DeleteEndpointAccess_ResponseSyntax) **   <a name="redshiftserverless-DeleteEndpointAccess-response-endpoint"></a>
The deleted VPC endpoint.  
Type: [EndpointAccess](API_EndpointAccess.md) object

## Errors
<a name="API_DeleteEndpointAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteEndpointAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteEndpointAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteEndpointAccess) 

# DeleteNamespace
<a name="API_DeleteNamespace"></a>

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.

## Request Syntax
<a name="API_DeleteNamespace_RequestSyntax"></a>

```
{
   "finalSnapshotName": "string",
   "finalSnapshotRetentionPeriod": number,
   "namespaceName": "string"
}
```

## Request Parameters
<a name="API_DeleteNamespace_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [finalSnapshotName](#API_DeleteNamespace_RequestSyntax) **   <a name="redshiftserverless-DeleteNamespace-request-finalSnapshotName"></a>
The name of the snapshot to be created before the namespace is deleted.  
Type: String  
Required: No

 ** [finalSnapshotRetentionPeriod](#API_DeleteNamespace_RequestSyntax) **   <a name="redshiftserverless-DeleteNamespace-request-finalSnapshotRetentionPeriod"></a>
How long to retain the final snapshot.  
Type: Integer  
Required: No

 ** [namespaceName](#API_DeleteNamespace_RequestSyntax) **   <a name="redshiftserverless-DeleteNamespace-request-namespaceName"></a>
The name of the namespace to delete.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_DeleteNamespace_ResponseSyntax"></a>

```
{
   "namespace": { 
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "catalogArn": "string",
      "creationDate": "string",
      "dbName": "string",
      "defaultIamRoleArn": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "lakehouseRegistrationStatus": "string",
      "logExports": [ "string" ],
      "namespaceArn": "string",
      "namespaceId": "string",
      "namespaceName": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_DeleteNamespace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [namespace](#API_DeleteNamespace_ResponseSyntax) **   <a name="redshiftserverless-DeleteNamespace-response-namespace"></a>
The deleted namespace object.  
Type: [Namespace](API_Namespace.md) object

## Errors
<a name="API_DeleteNamespace_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteNamespace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteNamespace) 

# DeleteResourcePolicy
<a name="API_DeleteResourcePolicy"></a>

Deletes the specified resource policy.

## Request Syntax
<a name="API_DeleteResourcePolicy_RequestSyntax"></a>

```
{
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_DeleteResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="redshiftserverless-DeleteResourcePolicy-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the policy to delete.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteResourcePolicy) 

# DeleteScheduledAction
<a name="API_DeleteScheduledAction"></a>

Deletes a scheduled action.

## Request Syntax
<a name="API_DeleteScheduledAction_RequestSyntax"></a>

```
{
   "scheduledActionName": "string"
}
```

## Request Parameters
<a name="API_DeleteScheduledAction_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [scheduledActionName](#API_DeleteScheduledAction_RequestSyntax) **   <a name="redshiftserverless-DeleteScheduledAction-request-scheduledActionName"></a>
The name of the scheduled action to delete.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 60.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_DeleteScheduledAction_ResponseSyntax"></a>

```
{
   "scheduledAction": { 
      "endTime": number,
      "namespaceName": "string",
      "nextInvocations": [ number ],
      "roleArn": "string",
      "schedule": { ... },
      "scheduledActionDescription": "string",
      "scheduledActionName": "string",
      "scheduledActionUuid": "string",
      "startTime": number,
      "state": "string",
      "targetAction": { ... }
   }
}
```

## Response Elements
<a name="API_DeleteScheduledAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [scheduledAction](#API_DeleteScheduledAction_ResponseSyntax) **   <a name="redshiftserverless-DeleteScheduledAction-response-scheduledAction"></a>
The deleted scheduled action object.  
Type: [ScheduledActionResponse](API_ScheduledActionResponse.md) object

## Errors
<a name="API_DeleteScheduledAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteScheduledAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteScheduledAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteScheduledAction) 

# DeleteSnapshot
<a name="API_DeleteSnapshot"></a>

Deletes a snapshot from Amazon Redshift Serverless.

## Request Syntax
<a name="API_DeleteSnapshot_RequestSyntax"></a>

```
{
   "snapshotName": "string"
}
```

## Request Parameters
<a name="API_DeleteSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [snapshotName](#API_DeleteSnapshot_RequestSyntax) **   <a name="redshiftserverless-DeleteSnapshot-request-snapshotName"></a>
The name of the snapshot to be deleted.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_DeleteSnapshot_ResponseSyntax"></a>

```
{
   "snapshot": { 
      "accountsWithProvisionedRestoreAccess": [ "string" ],
      "accountsWithRestoreAccess": [ "string" ],
      "actualIncrementalBackupSizeInMegaBytes": number,
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "backupProgressInMegaBytes": number,
      "currentBackupRateInMegaBytesPerSecond": number,
      "elapsedTimeInSeconds": number,
      "estimatedSecondsToCompletion": number,
      "kmsKeyId": "string",
      "namespaceArn": "string",
      "namespaceName": "string",
      "ownerAccount": "string",
      "snapshotArn": "string",
      "snapshotCreateTime": "string",
      "snapshotName": "string",
      "snapshotRemainingDays": number,
      "snapshotRetentionPeriod": number,
      "snapshotRetentionStartTime": "string",
      "status": "string",
      "totalBackupSizeInMegaBytes": number
   }
}
```

## Response Elements
<a name="API_DeleteSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshot](#API_DeleteSnapshot_ResponseSyntax) **   <a name="redshiftserverless-DeleteSnapshot-response-snapshot"></a>
The deleted snapshot object.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_DeleteSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteSnapshot) 

# DeleteSnapshotCopyConfiguration
<a name="API_DeleteSnapshotCopyConfiguration"></a>

Deletes a snapshot copy configuration

## Request Syntax
<a name="API_DeleteSnapshotCopyConfiguration_RequestSyntax"></a>

```
{
   "snapshotCopyConfigurationId": "string"
}
```

## Request Parameters
<a name="API_DeleteSnapshotCopyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [snapshotCopyConfigurationId](#API_DeleteSnapshotCopyConfiguration_RequestSyntax) **   <a name="redshiftserverless-DeleteSnapshotCopyConfiguration-request-snapshotCopyConfigurationId"></a>
The ID of the snapshot copy configuration to delete.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_DeleteSnapshotCopyConfiguration_ResponseSyntax"></a>

```
{
   "snapshotCopyConfiguration": { 
      "destinationKmsKeyId": "string",
      "destinationRegion": "string",
      "namespaceName": "string",
      "snapshotCopyConfigurationArn": "string",
      "snapshotCopyConfigurationId": "string",
      "snapshotRetentionPeriod": number
   }
}
```

## Response Elements
<a name="API_DeleteSnapshotCopyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshotCopyConfiguration](#API_DeleteSnapshotCopyConfiguration_ResponseSyntax) **   <a name="redshiftserverless-DeleteSnapshotCopyConfiguration-response-snapshotCopyConfiguration"></a>
The deleted snapshot copy configuration object.  
Type: [SnapshotCopyConfiguration](API_SnapshotCopyConfiguration.md) object

## Errors
<a name="API_DeleteSnapshotCopyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteSnapshotCopyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteSnapshotCopyConfiguration) 

# DeleteUsageLimit
<a name="API_DeleteUsageLimit"></a>

Deletes a usage limit from Amazon Redshift Serverless.

## Request Syntax
<a name="API_DeleteUsageLimit_RequestSyntax"></a>

```
{
   "usageLimitId": "string"
}
```

## Request Parameters
<a name="API_DeleteUsageLimit_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [usageLimitId](#API_DeleteUsageLimit_RequestSyntax) **   <a name="redshiftserverless-DeleteUsageLimit-request-usageLimitId"></a>
The unique identifier of the usage limit to delete.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_DeleteUsageLimit_ResponseSyntax"></a>

```
{
   "usageLimit": { 
      "amount": number,
      "breachAction": "string",
      "period": "string",
      "resourceArn": "string",
      "usageLimitArn": "string",
      "usageLimitId": "string",
      "usageType": "string"
   }
}
```

## Response Elements
<a name="API_DeleteUsageLimit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [usageLimit](#API_DeleteUsageLimit_ResponseSyntax) **   <a name="redshiftserverless-DeleteUsageLimit-response-usageLimit"></a>
The deleted usage limit object.  
Type: [UsageLimit](API_UsageLimit.md) object

## Errors
<a name="API_DeleteUsageLimit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteUsageLimit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteUsageLimit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteUsageLimit) 

# DeleteWorkgroup
<a name="API_DeleteWorkgroup"></a>

Deletes a workgroup.

## Request Syntax
<a name="API_DeleteWorkgroup_RequestSyntax"></a>

```
{
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_DeleteWorkgroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [workgroupName](#API_DeleteWorkgroup_RequestSyntax) **   <a name="redshiftserverless-DeleteWorkgroup-request-workgroupName"></a>
The name of the workgroup to be deleted.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_DeleteWorkgroup_ResponseSyntax"></a>

```
{
   "workgroup": { 
      "baseCapacity": number,
      "configParameters": [ 
         { 
            "parameterKey": "string",
            "parameterValue": "string"
         }
      ],
      "creationDate": "string",
      "crossAccountVpcs": [ "string" ],
      "customDomainCertificateArn": "string",
      "customDomainCertificateExpiryTime": "string",
      "customDomainName": "string",
      "endpoint": { 
         "address": "string",
         "port": number,
         "vpcEndpoints": [ 
            { 
               "networkInterfaces": [ 
                  { 
                     "availabilityZone": "string",
                     "ipv6Address": "string",
                     "networkInterfaceId": "string",
                     "privateIpAddress": "string",
                     "subnetId": "string"
                  }
               ],
               "vpcEndpointId": "string",
               "vpcId": "string"
            }
         ]
      },
      "enhancedVpcRouting": boolean,
      "extraComputeForAutomaticOptimization": boolean,
      "ipAddressType": "string",
      "maxCapacity": number,
      "namespaceName": "string",
      "patchVersion": "string",
      "pendingTrackName": "string",
      "port": number,
      "pricePerformanceTarget": { 
         "level": number,
         "status": "string"
      },
      "publiclyAccessible": boolean,
      "securityGroupIds": [ "string" ],
      "status": "string",
      "subnetIds": [ "string" ],
      "trackName": "string",
      "workgroupArn": "string",
      "workgroupId": "string",
      "workgroupName": "string",
      "workgroupVersion": "string"
   }
}
```

## Response Elements
<a name="API_DeleteWorkgroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [workgroup](#API_DeleteWorkgroup_ResponseSyntax) **   <a name="redshiftserverless-DeleteWorkgroup-response-workgroup"></a>
The deleted workgroup object.  
Type: [Workgroup](API_Workgroup.md) object

## Errors
<a name="API_DeleteWorkgroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteWorkgroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/DeleteWorkgroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/DeleteWorkgroup) 

# GetCredentials
<a name="API_GetCredentials"></a>

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 AWS 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.

## Request Syntax
<a name="API_GetCredentials_RequestSyntax"></a>

```
{
   "customDomainName": "string",
   "dbName": "string",
   "durationSeconds": number,
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_GetCredentials_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [customDomainName](#API_GetCredentials_RequestSyntax) **   <a name="redshiftserverless-GetCredentials-request-customDomainName"></a>
The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`   
Required: No

 ** [dbName](#API_GetCredentials_RequestSyntax) **   <a name="redshiftserverless-GetCredentials-request-dbName"></a>
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 ](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide
Type: String  
Required: No

 ** [durationSeconds](#API_GetCredentials_RequestSyntax) **   <a name="redshiftserverless-GetCredentials-request-durationSeconds"></a>
The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.  
Type: Integer  
Required: No

 ** [workgroupName](#API_GetCredentials_RequestSyntax) **   <a name="redshiftserverless-GetCredentials-request-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: No

## Response Syntax
<a name="API_GetCredentials_ResponseSyntax"></a>

```
{
   "dbPassword": "string",
   "dbUser": "string",
   "expiration": number,
   "nextRefreshTime": number
}
```

## Response Elements
<a name="API_GetCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbPassword](#API_GetCredentials_ResponseSyntax) **   <a name="redshiftserverless-GetCredentials-response-dbPassword"></a>
A temporary password that authorizes the user name returned by `DbUser` to log on to the database `DbName`.  
Type: String

 ** [dbUser](#API_GetCredentials_ResponseSyntax) **   <a name="redshiftserverless-GetCredentials-response-dbUser"></a>
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.  
Type: String

 ** [expiration](#API_GetCredentials_ResponseSyntax) **   <a name="redshiftserverless-GetCredentials-response-expiration"></a>
The date and time the password in `DbPassword` expires.  
Type: Timestamp

 ** [nextRefreshTime](#API_GetCredentials_ResponseSyntax) **   <a name="redshiftserverless-GetCredentials-response-nextRefreshTime"></a>
The date and time of when the `DbUser` and `DbPassword` authorization refreshes.  
Type: Timestamp

## Errors
<a name="API_GetCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetCredentials) 

# GetCustomDomainAssociation
<a name="API_GetCustomDomainAssociation"></a>

Gets information about a specific custom domain association.

## Request Syntax
<a name="API_GetCustomDomainAssociation_RequestSyntax"></a>

```
{
   "customDomainName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_GetCustomDomainAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [customDomainName](#API_GetCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-GetCustomDomainAssociation-request-customDomainName"></a>
The custom domain name associated with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`   
Required: Yes

 ** [workgroupName](#API_GetCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-GetCustomDomainAssociation-request-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_GetCustomDomainAssociation_ResponseSyntax"></a>

```
{
   "customDomainCertificateArn": "string",
   "customDomainCertificateExpiryTime": "string",
   "customDomainName": "string",
   "workgroupName": "string"
}
```

## Response Elements
<a name="API_GetCustomDomainAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [customDomainCertificateArn](#API_GetCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-GetCustomDomainAssociation-response-customDomainCertificateArn"></a>
The custom domain name’s certificate Amazon resource name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*.*` 

 ** [customDomainCertificateExpiryTime](#API_GetCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-GetCustomDomainAssociation-response-customDomainCertificateExpiryTime"></a>
The expiration time for the certificate.  
Type: Timestamp

 ** [customDomainName](#API_GetCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-GetCustomDomainAssociation-response-customDomainName"></a>
The custom domain name associated with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])` 

 ** [workgroupName](#API_GetCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-GetCustomDomainAssociation-response-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+` 

## Errors
<a name="API_GetCustomDomainAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetCustomDomainAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetCustomDomainAssociation) 

# GetEndpointAccess
<a name="API_GetEndpointAccess"></a>

Returns information, such as the name, about a VPC endpoint.

## Request Syntax
<a name="API_GetEndpointAccess_RequestSyntax"></a>

```
{
   "endpointName": "string"
}
```

## Request Parameters
<a name="API_GetEndpointAccess_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endpointName](#API_GetEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-GetEndpointAccess-request-endpointName"></a>
The name of the VPC endpoint to return information for.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_GetEndpointAccess_ResponseSyntax"></a>

```
{
   "endpoint": { 
      "address": "string",
      "endpointArn": "string",
      "endpointCreateTime": "string",
      "endpointName": "string",
      "endpointStatus": "string",
      "port": number,
      "subnetIds": [ "string" ],
      "vpcEndpoint": { 
         "networkInterfaces": [ 
            { 
               "availabilityZone": "string",
               "ipv6Address": "string",
               "networkInterfaceId": "string",
               "privateIpAddress": "string",
               "subnetId": "string"
            }
         ],
         "vpcEndpointId": "string",
         "vpcId": "string"
      },
      "vpcSecurityGroups": [ 
         { 
            "status": "string",
            "vpcSecurityGroupId": "string"
         }
      ],
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_GetEndpointAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endpoint](#API_GetEndpointAccess_ResponseSyntax) **   <a name="redshiftserverless-GetEndpointAccess-response-endpoint"></a>
The returned VPC endpoint.  
Type: [EndpointAccess](API_EndpointAccess.md) object

## Errors
<a name="API_GetEndpointAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetEndpointAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetEndpointAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetEndpointAccess) 

# GetIdentityCenterAuthToken
<a name="API_GetIdentityCenterAuthToken"></a>

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 AWS 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.

## Request Syntax
<a name="API_GetIdentityCenterAuthToken_RequestSyntax"></a>

```
{
   "workgroupNames": [ "string" ]
}
```

## Request Parameters
<a name="API_GetIdentityCenterAuthToken_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [workgroupNames](#API_GetIdentityCenterAuthToken_RequestSyntax) **   <a name="redshiftserverless-GetIdentityCenterAuthToken-request-workgroupNames"></a>
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.
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_GetIdentityCenterAuthToken_ResponseSyntax"></a>

```
{
   "expirationTime": "string",
   "token": "string"
}
```

## Response Elements
<a name="API_GetIdentityCenterAuthToken_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [expirationTime](#API_GetIdentityCenterAuthToken_ResponseSyntax) **   <a name="redshiftserverless-GetIdentityCenterAuthToken-response-expirationTime"></a>
The date and time when the Identity Center authentication token expires.  
After this time, a new token must be requested for continued access.  
Type: Timestamp

 ** [token](#API_GetIdentityCenterAuthToken_ResponseSyntax) **   <a name="redshiftserverless-GetIdentityCenterAuthToken-response-token"></a>
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.  
Type: String

## Errors
<a name="API_GetIdentityCenterAuthToken_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** DryRunException **   
This exception is thrown when the request was successful, but dry run was enabled so no action was taken.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetIdentityCenterAuthToken_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetIdentityCenterAuthToken) 

# GetNamespace
<a name="API_GetNamespace"></a>

Returns information about a namespace in Amazon Redshift Serverless.

## Request Syntax
<a name="API_GetNamespace_RequestSyntax"></a>

```
{
   "namespaceName": "string"
}
```

## Request Parameters
<a name="API_GetNamespace_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [namespaceName](#API_GetNamespace_RequestSyntax) **   <a name="redshiftserverless-GetNamespace-request-namespaceName"></a>
The name of the namespace to retrieve information for.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_GetNamespace_ResponseSyntax"></a>

```
{
   "namespace": { 
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "catalogArn": "string",
      "creationDate": "string",
      "dbName": "string",
      "defaultIamRoleArn": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "lakehouseRegistrationStatus": "string",
      "logExports": [ "string" ],
      "namespaceArn": "string",
      "namespaceId": "string",
      "namespaceName": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_GetNamespace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [namespace](#API_GetNamespace_ResponseSyntax) **   <a name="redshiftserverless-GetNamespace-response-namespace"></a>
The returned namespace object.  
Type: [Namespace](API_Namespace.md) object

## Errors
<a name="API_GetNamespace_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetNamespace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetNamespace) 

# GetRecoveryPoint
<a name="API_GetRecoveryPoint"></a>

Returns information about a recovery point.

## Request Syntax
<a name="API_GetRecoveryPoint_RequestSyntax"></a>

```
{
   "recoveryPointId": "string"
}
```

## Request Parameters
<a name="API_GetRecoveryPoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [recoveryPointId](#API_GetRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-GetRecoveryPoint-request-recoveryPointId"></a>
The unique identifier of the recovery point to return information for.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_GetRecoveryPoint_ResponseSyntax"></a>

```
{
   "recoveryPoint": { 
      "namespaceArn": "string",
      "namespaceName": "string",
      "recoveryPointCreateTime": "string",
      "recoveryPointId": "string",
      "totalSizeInMegaBytes": number,
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_GetRecoveryPoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [recoveryPoint](#API_GetRecoveryPoint_ResponseSyntax) **   <a name="redshiftserverless-GetRecoveryPoint-response-recoveryPoint"></a>
The returned recovery point object.  
Type: [RecoveryPoint](API_RecoveryPoint.md) object

## Errors
<a name="API_GetRecoveryPoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetRecoveryPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetRecoveryPoint) 

# GetReservation
<a name="API_GetReservation"></a>

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.

## Request Syntax
<a name="API_GetReservation_RequestSyntax"></a>

```
{
   "reservationId": "string"
}
```

## Request Parameters
<a name="API_GetReservation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [reservationId](#API_GetReservation_RequestSyntax) **   <a name="redshiftserverless-GetReservation-request-reservationId"></a>
The ID of the reservation to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

## Response Syntax
<a name="API_GetReservation_ResponseSyntax"></a>

```
{
   "reservation": { 
      "capacity": number,
      "endDate": "string",
      "offering": { 
         "currencyCode": "string",
         "duration": number,
         "hourlyCharge": number,
         "offeringId": "string",
         "offeringType": "string",
         "upfrontCharge": number
      },
      "reservationArn": "string",
      "reservationId": "string",
      "startDate": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_GetReservation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [reservation](#API_GetReservation_ResponseSyntax) **   <a name="redshiftserverless-GetReservation-response-reservation"></a>
The returned reservation object.  
Type: [Reservation](API_Reservation.md) object

## Errors
<a name="API_GetReservation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReservation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetReservation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetReservation) 

# GetReservationOffering
<a name="API_GetReservationOffering"></a>

Returns the reservation offering. The offering determines the payment schedule for the reservation.

## Request Syntax
<a name="API_GetReservationOffering_RequestSyntax"></a>

```
{
   "offeringId": "string"
}
```

## Request Parameters
<a name="API_GetReservationOffering_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [offeringId](#API_GetReservationOffering_RequestSyntax) **   <a name="redshiftserverless-GetReservationOffering-request-offeringId"></a>
The identifier for the offering..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

## Response Syntax
<a name="API_GetReservationOffering_ResponseSyntax"></a>

```
{
   "reservationOffering": { 
      "currencyCode": "string",
      "duration": number,
      "hourlyCharge": number,
      "offeringId": "string",
      "offeringType": "string",
      "upfrontCharge": number
   }
}
```

## Response Elements
<a name="API_GetReservationOffering_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [reservationOffering](#API_GetReservationOffering_ResponseSyntax) **   <a name="redshiftserverless-GetReservationOffering-response-reservationOffering"></a>
The returned reservation offering. The offering determines the payment schedule for the reservation.  
Type: [ReservationOffering](API_ReservationOffering.md) object

## Errors
<a name="API_GetReservationOffering_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReservationOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetReservationOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetReservationOffering) 

# GetResourcePolicy
<a name="API_GetResourcePolicy"></a>

Returns a resource policy.

## Request Syntax
<a name="API_GetResourcePolicy_RequestSyntax"></a>

```
{
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_GetResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_GetResourcePolicy_RequestSyntax) **   <a name="redshiftserverless-GetResourcePolicy-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to return.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_GetResourcePolicy_ResponseSyntax"></a>

```
{
   "resourcePolicy": { 
      "policy": "string",
      "resourceArn": "string"
   }
}
```

## Response Elements
<a name="API_GetResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [resourcePolicy](#API_GetResourcePolicy_ResponseSyntax) **   <a name="redshiftserverless-GetResourcePolicy-response-resourcePolicy"></a>
The returned resource policy.  
Type: [ResourcePolicy](API_ResourcePolicy.md) object

## Errors
<a name="API_GetResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetResourcePolicy) 

# GetScheduledAction
<a name="API_GetScheduledAction"></a>

Returns information about a scheduled action.

## Request Syntax
<a name="API_GetScheduledAction_RequestSyntax"></a>

```
{
   "scheduledActionName": "string"
}
```

## Request Parameters
<a name="API_GetScheduledAction_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [scheduledActionName](#API_GetScheduledAction_RequestSyntax) **   <a name="redshiftserverless-GetScheduledAction-request-scheduledActionName"></a>
The name of the scheduled action.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 60.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_GetScheduledAction_ResponseSyntax"></a>

```
{
   "scheduledAction": { 
      "endTime": number,
      "namespaceName": "string",
      "nextInvocations": [ number ],
      "roleArn": "string",
      "schedule": { ... },
      "scheduledActionDescription": "string",
      "scheduledActionName": "string",
      "scheduledActionUuid": "string",
      "startTime": number,
      "state": "string",
      "targetAction": { ... }
   }
}
```

## Response Elements
<a name="API_GetScheduledAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [scheduledAction](#API_GetScheduledAction_ResponseSyntax) **   <a name="redshiftserverless-GetScheduledAction-response-scheduledAction"></a>
The returned scheduled action object.  
Type: [ScheduledActionResponse](API_ScheduledActionResponse.md) object

## Errors
<a name="API_GetScheduledAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetScheduledAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetScheduledAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetScheduledAction) 

# GetSnapshot
<a name="API_GetSnapshot"></a>

Returns information about a specific snapshot.

## Request Syntax
<a name="API_GetSnapshot_RequestSyntax"></a>

```
{
   "ownerAccount": "string",
   "snapshotArn": "string",
   "snapshotName": "string"
}
```

## Request Parameters
<a name="API_GetSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ownerAccount](#API_GetSnapshot_RequestSyntax) **   <a name="redshiftserverless-GetSnapshot-request-ownerAccount"></a>
The owner AWS account of a snapshot shared with another user.  
Type: String  
Required: No

 ** [snapshotArn](#API_GetSnapshot_RequestSyntax) **   <a name="redshiftserverless-GetSnapshot-request-snapshotArn"></a>
The Amazon Resource Name (ARN) of the snapshot to return.  
Type: String  
Required: No

 ** [snapshotName](#API_GetSnapshot_RequestSyntax) **   <a name="redshiftserverless-GetSnapshot-request-snapshotName"></a>
The name of the snapshot to return.  
Type: String  
Required: No

## Response Syntax
<a name="API_GetSnapshot_ResponseSyntax"></a>

```
{
   "snapshot": { 
      "accountsWithProvisionedRestoreAccess": [ "string" ],
      "accountsWithRestoreAccess": [ "string" ],
      "actualIncrementalBackupSizeInMegaBytes": number,
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "backupProgressInMegaBytes": number,
      "currentBackupRateInMegaBytesPerSecond": number,
      "elapsedTimeInSeconds": number,
      "estimatedSecondsToCompletion": number,
      "kmsKeyId": "string",
      "namespaceArn": "string",
      "namespaceName": "string",
      "ownerAccount": "string",
      "snapshotArn": "string",
      "snapshotCreateTime": "string",
      "snapshotName": "string",
      "snapshotRemainingDays": number,
      "snapshotRetentionPeriod": number,
      "snapshotRetentionStartTime": "string",
      "status": "string",
      "totalBackupSizeInMegaBytes": number
   }
}
```

## Response Elements
<a name="API_GetSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshot](#API_GetSnapshot_ResponseSyntax) **   <a name="redshiftserverless-GetSnapshot-response-snapshot"></a>
The returned snapshot object.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_GetSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetSnapshot) 

# GetTableRestoreStatus
<a name="API_GetTableRestoreStatus"></a>

Returns information about a `TableRestoreStatus` object.

## Request Syntax
<a name="API_GetTableRestoreStatus_RequestSyntax"></a>

```
{
   "tableRestoreRequestId": "string"
}
```

## Request Parameters
<a name="API_GetTableRestoreStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [tableRestoreRequestId](#API_GetTableRestoreStatus_RequestSyntax) **   <a name="redshiftserverless-GetTableRestoreStatus-request-tableRestoreRequestId"></a>
The ID of the `RestoreTableFromSnapshot` request to return status for.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_GetTableRestoreStatus_ResponseSyntax"></a>

```
{
   "tableRestoreStatus": { 
      "message": "string",
      "namespaceName": "string",
      "newTableName": "string",
      "progressInMegaBytes": number,
      "recoveryPointId": "string",
      "requestTime": number,
      "snapshotName": "string",
      "sourceDatabaseName": "string",
      "sourceSchemaName": "string",
      "sourceTableName": "string",
      "status": "string",
      "tableRestoreRequestId": "string",
      "targetDatabaseName": "string",
      "targetSchemaName": "string",
      "totalDataInMegaBytes": number,
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_GetTableRestoreStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tableRestoreStatus](#API_GetTableRestoreStatus_ResponseSyntax) **   <a name="redshiftserverless-GetTableRestoreStatus-response-tableRestoreStatus"></a>
The returned `TableRestoreStatus` object that contains information about the status of your `RestoreTableFromSnapshot` request.  
Type: [TableRestoreStatus](API_TableRestoreStatus.md) object

## Errors
<a name="API_GetTableRestoreStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetTableRestoreStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetTableRestoreStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetTableRestoreStatus) 

# GetTrack
<a name="API_GetTrack"></a>

Get the Redshift Serverless version for a specified track.

## Request Syntax
<a name="API_GetTrack_RequestSyntax"></a>

```
{
   "trackName": "string"
}
```

## Request Parameters
<a name="API_GetTrack_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [trackName](#API_GetTrack_RequestSyntax) **   <a name="redshiftserverless-GetTrack-request-trackName"></a>
The name of the track of which its version is fetched.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_]+`   
Required: Yes

## Response Syntax
<a name="API_GetTrack_ResponseSyntax"></a>

```
{
   "track": { 
      "trackName": "string",
      "updateTargets": [ 
         { 
            "trackName": "string",
            "workgroupVersion": "string"
         }
      ],
      "workgroupVersion": "string"
   }
}
```

## Response Elements
<a name="API_GetTrack_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [track](#API_GetTrack_ResponseSyntax) **   <a name="redshiftserverless-GetTrack-response-track"></a>
The version of the specified track.  
Type: [ServerlessTrack](API_ServerlessTrack.md) object

## Errors
<a name="API_GetTrack_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** DryRunException **   
This exception is thrown when the request was successful, but dry run was enabled so no action was taken.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetTrack_Examples"></a>

### Example
<a name="API_GetTrack_Example_1"></a>

This example illustrates one usage of GetTrack.

#### Sample Request
<a name="API_GetTrack_Example_1_Request"></a>

```
aws redshift-serverless get-track
 --track-name current
--region us-east-1
```

#### Sample Response
<a name="API_GetTrack_Example_1_Response"></a>

```
{
    "track": {
        "trackName": "current",
        "workgroupVersion": "1.0.107360",
        "updateTargets": [
            {
                "trackName": "trailing",
                "workgroupVersion": "1.0.106452"
            }
        ]
    }
}
```

## See Also
<a name="API_GetTrack_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetTrack) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetTrack) 

# GetUsageLimit
<a name="API_GetUsageLimit"></a>

Returns information about a usage limit.

## Request Syntax
<a name="API_GetUsageLimit_RequestSyntax"></a>

```
{
   "usageLimitId": "string"
}
```

## Request Parameters
<a name="API_GetUsageLimit_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [usageLimitId](#API_GetUsageLimit_RequestSyntax) **   <a name="redshiftserverless-GetUsageLimit-request-usageLimitId"></a>
The unique identifier of the usage limit to return information for.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_GetUsageLimit_ResponseSyntax"></a>

```
{
   "usageLimit": { 
      "amount": number,
      "breachAction": "string",
      "period": "string",
      "resourceArn": "string",
      "usageLimitArn": "string",
      "usageLimitId": "string",
      "usageType": "string"
   }
}
```

## Response Elements
<a name="API_GetUsageLimit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [usageLimit](#API_GetUsageLimit_ResponseSyntax) **   <a name="redshiftserverless-GetUsageLimit-response-usageLimit"></a>
The returned usage limit object.  
Type: [UsageLimit](API_UsageLimit.md) object

## Errors
<a name="API_GetUsageLimit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetUsageLimit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetUsageLimit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetUsageLimit) 

# GetWorkgroup
<a name="API_GetWorkgroup"></a>

Returns information about a specific workgroup.

## Request Syntax
<a name="API_GetWorkgroup_RequestSyntax"></a>

```
{
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_GetWorkgroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [workgroupName](#API_GetWorkgroup_RequestSyntax) **   <a name="redshiftserverless-GetWorkgroup-request-workgroupName"></a>
The name of the workgroup to return information for.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_GetWorkgroup_ResponseSyntax"></a>

```
{
   "workgroup": { 
      "baseCapacity": number,
      "configParameters": [ 
         { 
            "parameterKey": "string",
            "parameterValue": "string"
         }
      ],
      "creationDate": "string",
      "crossAccountVpcs": [ "string" ],
      "customDomainCertificateArn": "string",
      "customDomainCertificateExpiryTime": "string",
      "customDomainName": "string",
      "endpoint": { 
         "address": "string",
         "port": number,
         "vpcEndpoints": [ 
            { 
               "networkInterfaces": [ 
                  { 
                     "availabilityZone": "string",
                     "ipv6Address": "string",
                     "networkInterfaceId": "string",
                     "privateIpAddress": "string",
                     "subnetId": "string"
                  }
               ],
               "vpcEndpointId": "string",
               "vpcId": "string"
            }
         ]
      },
      "enhancedVpcRouting": boolean,
      "extraComputeForAutomaticOptimization": boolean,
      "ipAddressType": "string",
      "maxCapacity": number,
      "namespaceName": "string",
      "patchVersion": "string",
      "pendingTrackName": "string",
      "port": number,
      "pricePerformanceTarget": { 
         "level": number,
         "status": "string"
      },
      "publiclyAccessible": boolean,
      "securityGroupIds": [ "string" ],
      "status": "string",
      "subnetIds": [ "string" ],
      "trackName": "string",
      "workgroupArn": "string",
      "workgroupId": "string",
      "workgroupName": "string",
      "workgroupVersion": "string"
   }
}
```

## Response Elements
<a name="API_GetWorkgroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [workgroup](#API_GetWorkgroup_ResponseSyntax) **   <a name="redshiftserverless-GetWorkgroup-response-workgroup"></a>
The returned workgroup object.  
Type: [Workgroup](API_Workgroup.md) object

## Errors
<a name="API_GetWorkgroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetWorkgroup_Examples"></a>

### Example
<a name="API_GetWorkgroup_Example_1"></a>

This example illustrates one usage of GetWorkgroup.

#### Sample Request
<a name="API_GetWorkgroup_Example_1_Request"></a>

```
aws redshift-serverless get-workgroup 
--workgroup-name test-wg
--region us-east-1
```

#### Sample Response
<a name="API_GetWorkgroup_Example_1_Response"></a>

```
{
  "workgroup": {
    "workgroupId": "875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupArn": "arn:aws:redshift-serverless:us-east-1:012345678901:workgroup/875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupName": "test-wg",
    "namespaceName": "test-ns",
    "baseCapacity": 32,
    "enhancedVpcRouting": false,
    ...
    "ipAddressType": "ipv4",
    "trackName": "current",
    "pendingTrackName": "trailing"
  }
}
```

## See Also
<a name="API_GetWorkgroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/GetWorkgroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/GetWorkgroup) 

# ListCustomDomainAssociations
<a name="API_ListCustomDomainAssociations"></a>

 Lists custom domain associations for Amazon Redshift Serverless.

## Request Syntax
<a name="API_ListCustomDomainAssociations_RequestSyntax"></a>

```
{
   "customDomainCertificateArn": "string",
   "customDomainName": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListCustomDomainAssociations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [customDomainCertificateArn](#API_ListCustomDomainAssociations_RequestSyntax) **   <a name="redshiftserverless-ListCustomDomainAssociations-request-customDomainCertificateArn"></a>
The custom domain name’s certificate Amazon resource name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*.*`   
Required: No

 ** [customDomainName](#API_ListCustomDomainAssociations_RequestSyntax) **   <a name="redshiftserverless-ListCustomDomainAssociations-request-customDomainName"></a>
The custom domain name associated with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`   
Required: No

 ** [maxResults](#API_ListCustomDomainAssociations_RequestSyntax) **   <a name="redshiftserverless-ListCustomDomainAssociations-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListCustomDomainAssociations_RequestSyntax) **   <a name="redshiftserverless-ListCustomDomainAssociations-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListCustomDomainAssociations_ResponseSyntax"></a>

```
{
   "associations": [ 
      { 
         "customDomainCertificateArn": "string",
         "customDomainCertificateExpiryTime": "string",
         "customDomainName": "string",
         "workgroupName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListCustomDomainAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [associations](#API_ListCustomDomainAssociations_ResponseSyntax) **   <a name="redshiftserverless-ListCustomDomainAssociations-response-associations"></a>
A list of Association objects.  
Type: Array of [Association](API_Association.md) objects

 ** [nextToken](#API_ListCustomDomainAssociations_ResponseSyntax) **   <a name="redshiftserverless-ListCustomDomainAssociations-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

## Errors
<a name="API_ListCustomDomainAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** InvalidPaginationException **   
The provided pagination token is invalid.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListCustomDomainAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListCustomDomainAssociations) 

# ListEndpointAccess
<a name="API_ListEndpointAccess"></a>

Returns an array of `EndpointAccess` objects and relevant information.

## Request Syntax
<a name="API_ListEndpointAccess_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "ownerAccount": "string",
   "vpcId": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_ListEndpointAccess_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-ListEndpointAccess-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-ListEndpointAccess-request-nextToken"></a>
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.  
Type: String  
Required: No

 ** [ownerAccount](#API_ListEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-ListEndpointAccess-request-ownerAccount"></a>
The owner AWS account for the Amazon Redshift Serverless workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `.*(\d{12}).*`   
Required: No

 ** [vpcId](#API_ListEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-ListEndpointAccess-request-vpcId"></a>
The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.  
Type: String  
Required: No

 ** [workgroupName](#API_ListEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-ListEndpointAccess-request-workgroupName"></a>
The name of the workgroup associated with the VPC endpoint to return.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListEndpointAccess_ResponseSyntax"></a>

```
{
   "endpoints": [ 
      { 
         "address": "string",
         "endpointArn": "string",
         "endpointCreateTime": "string",
         "endpointName": "string",
         "endpointStatus": "string",
         "port": number,
         "subnetIds": [ "string" ],
         "vpcEndpoint": { 
            "networkInterfaces": [ 
               { 
                  "availabilityZone": "string",
                  "ipv6Address": "string",
                  "networkInterfaceId": "string",
                  "privateIpAddress": "string",
                  "subnetId": "string"
               }
            ],
            "vpcEndpointId": "string",
            "vpcId": "string"
         },
         "vpcSecurityGroups": [ 
            { 
               "status": "string",
               "vpcSecurityGroupId": "string"
            }
         ],
         "workgroupName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEndpointAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endpoints](#API_ListEndpointAccess_ResponseSyntax) **   <a name="redshiftserverless-ListEndpointAccess-response-endpoints"></a>
The returned VPC endpoints.  
Type: Array of [EndpointAccess](API_EndpointAccess.md) objects

 ** [nextToken](#API_ListEndpointAccess_ResponseSyntax) **   <a name="redshiftserverless-ListEndpointAccess-response-nextToken"></a>
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.  
Type: String

## Errors
<a name="API_ListEndpointAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListEndpointAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListEndpointAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListEndpointAccess) 

# ListManagedWorkgroups
<a name="API_ListManagedWorkgroups"></a>

Returns information about a list of specified managed workgroups in your account.

## Request Syntax
<a name="API_ListManagedWorkgroups_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "sourceArn": "string"
}
```

## Request Parameters
<a name="API_ListManagedWorkgroups_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListManagedWorkgroups_RequestSyntax) **   <a name="redshiftserverless-ListManagedWorkgroups-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListManagedWorkgroups_RequestSyntax) **   <a name="redshiftserverless-ListManagedWorkgroups-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

 ** [sourceArn](#API_ListManagedWorkgroups_RequestSyntax) **   <a name="redshiftserverless-ListManagedWorkgroups-request-sourceArn"></a>
The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.  
Type: String  
Pattern: `arn:aws[a-z-]*:glue:[a-z0-9-]+:\d+:(database|catalog)[a-z0-9-:]*(?:/[A-Za-z0-9-_]{1,255})*`   
Required: No

## Response Syntax
<a name="API_ListManagedWorkgroups_ResponseSyntax"></a>

```
{
   "managedWorkgroups": [ 
      { 
         "creationDate": "string",
         "managedWorkgroupId": "string",
         "managedWorkgroupName": "string",
         "sourceArn": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListManagedWorkgroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [managedWorkgroups](#API_ListManagedWorkgroups_ResponseSyntax) **   <a name="redshiftserverless-ListManagedWorkgroups-response-managedWorkgroups"></a>
The returned array of managed workgroups.  
Type: Array of [ManagedWorkgroupListItem](API_ManagedWorkgroupListItem.md) objects

 ** [nextToken](#API_ListManagedWorkgroups_ResponseSyntax) **   <a name="redshiftserverless-ListManagedWorkgroups-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

## Errors
<a name="API_ListManagedWorkgroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

## See Also
<a name="API_ListManagedWorkgroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListManagedWorkgroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListManagedWorkgroups) 

# ListNamespaces
<a name="API_ListNamespaces"></a>

Returns information about a list of specified namespaces.

## Request Syntax
<a name="API_ListNamespaces_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListNamespaces_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListNamespaces_RequestSyntax) **   <a name="redshiftserverless-ListNamespaces-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListNamespaces_RequestSyntax) **   <a name="redshiftserverless-ListNamespaces-request-nextToken"></a>
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.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListNamespaces_ResponseSyntax"></a>

```
{
   "namespaces": [ 
      { 
         "adminPasswordSecretArn": "string",
         "adminPasswordSecretKmsKeyId": "string",
         "adminUsername": "string",
         "catalogArn": "string",
         "creationDate": "string",
         "dbName": "string",
         "defaultIamRoleArn": "string",
         "iamRoles": [ "string" ],
         "kmsKeyId": "string",
         "lakehouseRegistrationStatus": "string",
         "logExports": [ "string" ],
         "namespaceArn": "string",
         "namespaceId": "string",
         "namespaceName": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListNamespaces_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [namespaces](#API_ListNamespaces_ResponseSyntax) **   <a name="redshiftserverless-ListNamespaces-response-namespaces"></a>
The list of returned namespaces.  
Type: Array of [Namespace](API_Namespace.md) objects

 ** [nextToken](#API_ListNamespaces_ResponseSyntax) **   <a name="redshiftserverless-ListNamespaces-response-nextToken"></a>
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.  
Type: String

## Errors
<a name="API_ListNamespaces_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListNamespaces_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListNamespaces) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListNamespaces) 

# ListRecoveryPoints
<a name="API_ListRecoveryPoints"></a>

Returns an array of recovery points.

## Request Syntax
<a name="API_ListRecoveryPoints_RequestSyntax"></a>

```
{
   "endTime": number,
   "maxResults": number,
   "namespaceArn": "string",
   "namespaceName": "string",
   "nextToken": "string",
   "startTime": number
}
```

## Request Parameters
<a name="API_ListRecoveryPoints_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endTime](#API_ListRecoveryPoints_RequestSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-request-endTime"></a>
The time when creation of the recovery point finished.  
Type: Timestamp  
Required: No

 ** [maxResults](#API_ListRecoveryPoints_RequestSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [namespaceArn](#API_ListRecoveryPoints_RequestSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-request-namespaceArn"></a>
The Amazon Resource Name (ARN) of the namespace from which to list recovery points.  
Type: String  
Required: No

 ** [namespaceName](#API_ListRecoveryPoints_RequestSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-request-namespaceName"></a>
The name of the namespace to list recovery points for.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: No

 ** [nextToken](#API_ListRecoveryPoints_RequestSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-request-nextToken"></a>
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.  
Type: String  
Required: No

 ** [startTime](#API_ListRecoveryPoints_RequestSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-request-startTime"></a>
The time when the recovery point's creation was initiated.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_ListRecoveryPoints_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "recoveryPoints": [ 
      { 
         "namespaceArn": "string",
         "namespaceName": "string",
         "recoveryPointCreateTime": "string",
         "recoveryPointId": "string",
         "totalSizeInMegaBytes": number,
         "workgroupName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRecoveryPoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListRecoveryPoints_ResponseSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-response-nextToken"></a>
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.  
Type: String

 ** [recoveryPoints](#API_ListRecoveryPoints_ResponseSyntax) **   <a name="redshiftserverless-ListRecoveryPoints-response-recoveryPoints"></a>
The returned recovery point objects.  
Type: Array of [RecoveryPoint](API_RecoveryPoint.md) objects

## Errors
<a name="API_ListRecoveryPoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListRecoveryPoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListRecoveryPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListRecoveryPoints) 

# ListReservationOfferings
<a name="API_ListReservationOfferings"></a>

Returns the current reservation offerings in your account.

## Request Syntax
<a name="API_ListReservationOfferings_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListReservationOfferings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListReservationOfferings_RequestSyntax) **   <a name="redshiftserverless-ListReservationOfferings-request-maxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListReservationOfferings_RequestSyntax) **   <a name="redshiftserverless-ListReservationOfferings-request-nextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListReservationOfferings_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "reservationOfferingsList": [ 
      { 
         "currencyCode": "string",
         "duration": number,
         "hourlyCharge": number,
         "offeringId": "string",
         "offeringType": "string",
         "upfrontCharge": number
      }
   ]
}
```

## Response Elements
<a name="API_ListReservationOfferings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListReservationOfferings_ResponseSyntax) **   <a name="redshiftserverless-ListReservationOfferings-response-nextToken"></a>
The token to use when requesting the next set of items.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

 ** [reservationOfferingsList](#API_ListReservationOfferings_ResponseSyntax) **   <a name="redshiftserverless-ListReservationOfferings-response-reservationOfferingsList"></a>
The returned list of reservation offerings.  
Type: Array of [ReservationOffering](API_ReservationOffering.md) objects

## Errors
<a name="API_ListReservationOfferings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReservationOfferings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListReservationOfferings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListReservationOfferings) 

# ListReservations
<a name="API_ListReservations"></a>

Returns a list of Reservation objects.

## Request Syntax
<a name="API_ListReservations_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListReservations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListReservations_RequestSyntax) **   <a name="redshiftserverless-ListReservations-request-maxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListReservations_RequestSyntax) **   <a name="redshiftserverless-ListReservations-request-nextToken"></a>
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListReservations_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "reservationsList": [ 
      { 
         "capacity": number,
         "endDate": "string",
         "offering": { 
            "currencyCode": "string",
            "duration": number,
            "hourlyCharge": number,
            "offeringId": "string",
            "offeringType": "string",
            "upfrontCharge": number
         },
         "reservationArn": "string",
         "reservationId": "string",
         "startDate": "string",
         "status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListReservations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListReservations_ResponseSyntax) **   <a name="redshiftserverless-ListReservations-response-nextToken"></a>
The token to use when requesting the next set of items.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

 ** [reservationsList](#API_ListReservations_ResponseSyntax) **   <a name="redshiftserverless-ListReservations-response-reservationsList"></a>
The serverless reservations returned by the request.  
Type: Array of [Reservation](API_Reservation.md) objects

## Errors
<a name="API_ListReservations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReservations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListReservations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListReservations) 

# ListScheduledActions
<a name="API_ListScheduledActions"></a>

Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.

## Request Syntax
<a name="API_ListScheduledActions_RequestSyntax"></a>

```
{
   "maxResults": number,
   "namespaceName": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListScheduledActions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListScheduledActions_RequestSyntax) **   <a name="redshiftserverless-ListScheduledActions-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. Use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [namespaceName](#API_ListScheduledActions_RequestSyntax) **   <a name="redshiftserverless-ListScheduledActions-request-namespaceName"></a>
The name of namespace associated with the scheduled action to retrieve.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: No

 ** [nextToken](#API_ListScheduledActions_RequestSyntax) **   <a name="redshiftserverless-ListScheduledActions-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListScheduledActions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "scheduledActions": [ 
      { 
         "namespaceName": "string",
         "scheduledActionName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListScheduledActions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListScheduledActions_ResponseSyntax) **   <a name="redshiftserverless-ListScheduledActions-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

 ** [scheduledActions](#API_ListScheduledActions_ResponseSyntax) **   <a name="redshiftserverless-ListScheduledActions-response-scheduledActions"></a>
All of the returned scheduled action association objects.  
Type: Array of [ScheduledActionAssociation](API_ScheduledActionAssociation.md) objects

## Errors
<a name="API_ListScheduledActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** InvalidPaginationException **   
The provided pagination token is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListScheduledActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListScheduledActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListScheduledActions) 

# ListSnapshotCopyConfigurations
<a name="API_ListSnapshotCopyConfigurations"></a>

Returns a list of snapshot copy configurations.

## Request Syntax
<a name="API_ListSnapshotCopyConfigurations_RequestSyntax"></a>

```
{
   "maxResults": number,
   "namespaceName": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListSnapshotCopyConfigurations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListSnapshotCopyConfigurations_RequestSyntax) **   <a name="redshiftserverless-ListSnapshotCopyConfigurations-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [namespaceName](#API_ListSnapshotCopyConfigurations_RequestSyntax) **   <a name="redshiftserverless-ListSnapshotCopyConfigurations-request-namespaceName"></a>
The namespace from which to list all snapshot copy configurations.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: No

 ** [nextToken](#API_ListSnapshotCopyConfigurations_RequestSyntax) **   <a name="redshiftserverless-ListSnapshotCopyConfigurations-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListSnapshotCopyConfigurations_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "snapshotCopyConfigurations": [ 
      { 
         "destinationKmsKeyId": "string",
         "destinationRegion": "string",
         "namespaceName": "string",
         "snapshotCopyConfigurationArn": "string",
         "snapshotCopyConfigurationId": "string",
         "snapshotRetentionPeriod": number
      }
   ]
}
```

## Response Elements
<a name="API_ListSnapshotCopyConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListSnapshotCopyConfigurations_ResponseSyntax) **   <a name="redshiftserverless-ListSnapshotCopyConfigurations-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

 ** [snapshotCopyConfigurations](#API_ListSnapshotCopyConfigurations_ResponseSyntax) **   <a name="redshiftserverless-ListSnapshotCopyConfigurations-response-snapshotCopyConfigurations"></a>
All of the returned snapshot copy configurations.  
Type: Array of [SnapshotCopyConfiguration](API_SnapshotCopyConfiguration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.

## Errors
<a name="API_ListSnapshotCopyConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** InvalidPaginationException **   
The provided pagination token is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListSnapshotCopyConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListSnapshotCopyConfigurations) 

# ListSnapshots
<a name="API_ListSnapshots"></a>

Returns a list of snapshots.

## Request Syntax
<a name="API_ListSnapshots_RequestSyntax"></a>

```
{
   "endTime": number,
   "maxResults": number,
   "namespaceArn": "string",
   "namespaceName": "string",
   "nextToken": "string",
   "ownerAccount": "string",
   "startTime": number
}
```

## Request Parameters
<a name="API_ListSnapshots_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endTime](#API_ListSnapshots_RequestSyntax) **   <a name="redshiftserverless-ListSnapshots-request-endTime"></a>
The timestamp showing when the snapshot creation finished.  
Type: Timestamp  
Required: No

 ** [maxResults](#API_ListSnapshots_RequestSyntax) **   <a name="redshiftserverless-ListSnapshots-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [namespaceArn](#API_ListSnapshots_RequestSyntax) **   <a name="redshiftserverless-ListSnapshots-request-namespaceArn"></a>
The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.  
Type: String  
Required: No

 ** [namespaceName](#API_ListSnapshots_RequestSyntax) **   <a name="redshiftserverless-ListSnapshots-request-namespaceName"></a>
The namespace from which to list all snapshots.  
Type: String  
Required: No

 ** [nextToken](#API_ListSnapshots_RequestSyntax) **   <a name="redshiftserverless-ListSnapshots-request-nextToken"></a>
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.  
Type: String  
Required: No

 ** [ownerAccount](#API_ListSnapshots_RequestSyntax) **   <a name="redshiftserverless-ListSnapshots-request-ownerAccount"></a>
The owner AWS account of the snapshot.  
Type: String  
Required: No

 ** [startTime](#API_ListSnapshots_RequestSyntax) **   <a name="redshiftserverless-ListSnapshots-request-startTime"></a>
The time when the creation of the snapshot was initiated.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_ListSnapshots_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "accountsWithProvisionedRestoreAccess": [ "string" ],
         "accountsWithRestoreAccess": [ "string" ],
         "actualIncrementalBackupSizeInMegaBytes": number,
         "adminPasswordSecretArn": "string",
         "adminPasswordSecretKmsKeyId": "string",
         "adminUsername": "string",
         "backupProgressInMegaBytes": number,
         "currentBackupRateInMegaBytesPerSecond": number,
         "elapsedTimeInSeconds": number,
         "estimatedSecondsToCompletion": number,
         "kmsKeyId": "string",
         "namespaceArn": "string",
         "namespaceName": "string",
         "ownerAccount": "string",
         "snapshotArn": "string",
         "snapshotCreateTime": "string",
         "snapshotName": "string",
         "snapshotRemainingDays": number,
         "snapshotRetentionPeriod": number,
         "snapshotRetentionStartTime": "string",
         "status": "string",
         "totalBackupSizeInMegaBytes": number
      }
   ]
}
```

## Response Elements
<a name="API_ListSnapshots_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListSnapshots_ResponseSyntax) **   <a name="redshiftserverless-ListSnapshots-response-nextToken"></a>
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.  
Type: String

 ** [snapshots](#API_ListSnapshots_ResponseSyntax) **   <a name="redshiftserverless-ListSnapshots-response-snapshots"></a>
All of the returned snapshot objects.  
Type: Array of [Snapshot](API_Snapshot.md) objects

## Errors
<a name="API_ListSnapshots_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListSnapshots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListSnapshots) 

# ListTableRestoreStatus
<a name="API_ListTableRestoreStatus"></a>

Returns information about an array of `TableRestoreStatus` objects.

## Request Syntax
<a name="API_ListTableRestoreStatus_RequestSyntax"></a>

```
{
   "maxResults": number,
   "namespaceName": "string",
   "nextToken": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_ListTableRestoreStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListTableRestoreStatus_RequestSyntax) **   <a name="redshiftserverless-ListTableRestoreStatus-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [namespaceName](#API_ListTableRestoreStatus_RequestSyntax) **   <a name="redshiftserverless-ListTableRestoreStatus-request-namespaceName"></a>
The namespace from which to list all of the statuses of `RestoreTableFromSnapshot` operations .  
Type: String  
Required: No

 ** [nextToken](#API_ListTableRestoreStatus_RequestSyntax) **   <a name="redshiftserverless-ListTableRestoreStatus-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

 ** [workgroupName](#API_ListTableRestoreStatus_RequestSyntax) **   <a name="redshiftserverless-ListTableRestoreStatus-request-workgroupName"></a>
The workgroup from which to list all of the statuses of `RestoreTableFromSnapshot` operations.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListTableRestoreStatus_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "tableRestoreStatuses": [ 
      { 
         "message": "string",
         "namespaceName": "string",
         "newTableName": "string",
         "progressInMegaBytes": number,
         "recoveryPointId": "string",
         "requestTime": number,
         "snapshotName": "string",
         "sourceDatabaseName": "string",
         "sourceSchemaName": "string",
         "sourceTableName": "string",
         "status": "string",
         "tableRestoreRequestId": "string",
         "targetDatabaseName": "string",
         "targetSchemaName": "string",
         "totalDataInMegaBytes": number,
         "workgroupName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTableRestoreStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTableRestoreStatus_ResponseSyntax) **   <a name="redshiftserverless-ListTableRestoreStatus-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

 ** [tableRestoreStatuses](#API_ListTableRestoreStatus_ResponseSyntax) **   <a name="redshiftserverless-ListTableRestoreStatus-response-tableRestoreStatuses"></a>
The array of returned `TableRestoreStatus` objects.  
Type: Array of [TableRestoreStatus](API_TableRestoreStatus.md) objects

## Errors
<a name="API_ListTableRestoreStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidPaginationException **   
The provided pagination token is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListTableRestoreStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListTableRestoreStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListTableRestoreStatus) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists the tags assigned to a resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="redshiftserverless-ListTagsForResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to list tags for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="redshiftserverless-ListTagsForResource-response-tags"></a>
A map of the key-value pairs assigned to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListTagsForResource) 

# ListTracks
<a name="API_ListTracks"></a>

List the Amazon Redshift Serverless versions.

## Request Syntax
<a name="API_ListTracks_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListTracks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListTracks_RequestSyntax) **   <a name="redshiftserverless-ListTracks-request-maxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListTracks_RequestSyntax) **   <a name="redshiftserverless-ListTracks-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListTracks_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "tracks": [ 
      { 
         "trackName": "string",
         "updateTargets": [ 
            { 
               "trackName": "string",
               "workgroupVersion": "string"
            }
         ],
         "workgroupVersion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTracks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTracks_ResponseSyntax) **   <a name="redshiftserverless-ListTracks-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

 ** [tracks](#API_ListTracks_ResponseSyntax) **   <a name="redshiftserverless-ListTracks-response-tracks"></a>
The returned tracks.  
Type: Array of [ServerlessTrack](API_ServerlessTrack.md) objects

## Errors
<a name="API_ListTracks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** InvalidPaginationException **   
The provided pagination token is invalid.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_ListTracks_Examples"></a>

### Example
<a name="API_ListTracks_Example_1"></a>

This example illustrates one usage of ListTracks.

#### Sample Request
<a name="API_ListTracks_Example_1_Request"></a>

```
aws redshift-serverless list-tracks 
--region us-east-1
```

#### Sample Response
<a name="API_ListTracks_Example_1_Response"></a>

```
{
    "tracks": [
        {
            "trackName": "current",
            "workgroupVersion": "1.0.106980",
            "updateTargets": [
                {
                    "trackName": "trailing",
                    "workgroupVersion": "1.0.106452"
                }
            ]
        },
        {
            "trackName": "trailing",
            "workgroupVersion": "1.0.106452",
            "updateTargets": [
                {
                    "trackName": "current",
                    "workgroupVersion": "1.0.106980"
                }
            ]
        }
    ]
}
```

## See Also
<a name="API_ListTracks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListTracks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListTracks) 

# ListUsageLimits
<a name="API_ListUsageLimits"></a>

Lists all usage limits within Amazon Redshift Serverless.

## Request Syntax
<a name="API_ListUsageLimits_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "resourceArn": "string",
   "usageType": "string"
}
```

## Request Parameters
<a name="API_ListUsageLimits_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListUsageLimits_RequestSyntax) **   <a name="redshiftserverless-ListUsageLimits-request-maxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListUsageLimits_RequestSyntax) **   <a name="redshiftserverless-ListUsageLimits-request-nextToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.  
Required: No

 ** [resourceArn](#API_ListUsageLimits_RequestSyntax) **   <a name="redshiftserverless-ListUsageLimits-request-resourceArn"></a>
The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.  
Type: String  
Required: No

 ** [usageType](#API_ListUsageLimits_RequestSyntax) **   <a name="redshiftserverless-ListUsageLimits-request-usageType"></a>
The Amazon Redshift Serverless feature whose limits you want to see.  
Type: String  
Valid Values: `serverless-compute | cross-region-datasharing`   
Required: No

## Response Syntax
<a name="API_ListUsageLimits_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "usageLimits": [ 
      { 
         "amount": number,
         "breachAction": "string",
         "period": "string",
         "resourceArn": "string",
         "usageLimitArn": "string",
         "usageLimitId": "string",
         "usageType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListUsageLimits_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListUsageLimits_ResponseSyntax) **   <a name="redshiftserverless-ListUsageLimits-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 1024.

 ** [usageLimits](#API_ListUsageLimits_ResponseSyntax) **   <a name="redshiftserverless-ListUsageLimits-response-usageLimits"></a>
An array of returned usage limit objects.  
Type: Array of [UsageLimit](API_UsageLimit.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.

## Errors
<a name="API_ListUsageLimits_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** InvalidPaginationException **   
The provided pagination token is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListUsageLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListUsageLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListUsageLimits) 

# ListWorkgroups
<a name="API_ListWorkgroups"></a>

Returns information about a list of specified workgroups.

## Request Syntax
<a name="API_ListWorkgroups_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "ownerAccount": "string"
}
```

## Request Parameters
<a name="API_ListWorkgroups_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListWorkgroups_RequestSyntax) **   <a name="redshiftserverless-ListWorkgroups-request-maxResults"></a>
An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to display the next page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListWorkgroups_RequestSyntax) **   <a name="redshiftserverless-ListWorkgroups-request-nextToken"></a>
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.  
Type: String  
Required: No

 ** [ownerAccount](#API_ListWorkgroups_RequestSyntax) **   <a name="redshiftserverless-ListWorkgroups-request-ownerAccount"></a>
The owner AWS account for the Amazon Redshift Serverless workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `.*(\d{12}).*`   
Required: No

## Response Syntax
<a name="API_ListWorkgroups_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "workgroups": [ 
      { 
         "baseCapacity": number,
         "configParameters": [ 
            { 
               "parameterKey": "string",
               "parameterValue": "string"
            }
         ],
         "creationDate": "string",
         "crossAccountVpcs": [ "string" ],
         "customDomainCertificateArn": "string",
         "customDomainCertificateExpiryTime": "string",
         "customDomainName": "string",
         "endpoint": { 
            "address": "string",
            "port": number,
            "vpcEndpoints": [ 
               { 
                  "networkInterfaces": [ 
                     { 
                        "availabilityZone": "string",
                        "ipv6Address": "string",
                        "networkInterfaceId": "string",
                        "privateIpAddress": "string",
                        "subnetId": "string"
                     }
                  ],
                  "vpcEndpointId": "string",
                  "vpcId": "string"
               }
            ]
         },
         "enhancedVpcRouting": boolean,
         "extraComputeForAutomaticOptimization": boolean,
         "ipAddressType": "string",
         "maxCapacity": number,
         "namespaceName": "string",
         "patchVersion": "string",
         "pendingTrackName": "string",
         "port": number,
         "pricePerformanceTarget": { 
            "level": number,
            "status": "string"
         },
         "publiclyAccessible": boolean,
         "securityGroupIds": [ "string" ],
         "status": "string",
         "subnetIds": [ "string" ],
         "trackName": "string",
         "workgroupArn": "string",
         "workgroupId": "string",
         "workgroupName": "string",
         "workgroupVersion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListWorkgroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListWorkgroups_ResponseSyntax) **   <a name="redshiftserverless-ListWorkgroups-response-nextToken"></a>
 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.  
Type: String

 ** [workgroups](#API_ListWorkgroups_ResponseSyntax) **   <a name="redshiftserverless-ListWorkgroups-response-workgroups"></a>
The returned array of workgroups.  
Type: Array of [Workgroup](API_Workgroup.md) objects

## Errors
<a name="API_ListWorkgroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_ListWorkgroups_Examples"></a>

### Example
<a name="API_ListWorkgroups_Example_1"></a>

This example illustrates one usage of ListWorkgroups.

#### Sample Request
<a name="API_ListWorkgroups_Example_1_Request"></a>

```
aws redshift-serverless list-workgroups 
--region us-east-1
```

#### Sample Response
<a name="API_ListWorkgroups_Example_1_Response"></a>

```
{
  "workgroups": [
    {
      "workgroupId": "aff51189-e570-474d-9feb-ae83286e057c",
      "workgroupArn": "arn:aws:redshift-serverless:us-east-1:012345678901:workgroup/aff51189-e570-474d-9feb-ae83286e057c",
      "workgroupName": "test-track-1",
      "namespaceName": "test-track-ns",
      "baseCapacity": 32,
      "enhancedVpcRouting": false,
      "trackName": "current",
      "pendingTrackName": "trailing"
    ]
  },
  ...
}
```

## See Also
<a name="API_ListWorkgroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/ListWorkgroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/ListWorkgroups) 

# PutResourcePolicy
<a name="API_PutResourcePolicy"></a>

Creates or updates a resource policy. Currently, you can use policies to share snapshots across AWS accounts.

## Request Syntax
<a name="API_PutResourcePolicy_RequestSyntax"></a>

```
{
   "policy": "string",
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_PutResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [policy](#API_PutResourcePolicy_RequestSyntax) **   <a name="redshiftserverless-PutResourcePolicy-request-policy"></a>
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\" }]}"`   
Type: String  
Required: Yes

 ** [resourceArn](#API_PutResourcePolicy_RequestSyntax) **   <a name="redshiftserverless-PutResourcePolicy-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the account to create or update a resource policy for.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_PutResourcePolicy_ResponseSyntax"></a>

```
{
   "resourcePolicy": { 
      "policy": "string",
      "resourceArn": "string"
   }
}
```

## Response Elements
<a name="API_PutResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [resourcePolicy](#API_PutResourcePolicy_ResponseSyntax) **   <a name="redshiftserverless-PutResourcePolicy-response-resourcePolicy"></a>
The policy that was created or updated.  
Type: [ResourcePolicy](API_ResourcePolicy.md) object

## Errors
<a name="API_PutResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_PutResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/PutResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/PutResourcePolicy) 

# RestoreFromRecoveryPoint
<a name="API_RestoreFromRecoveryPoint"></a>

Restore the data from a recovery point.

## Request Syntax
<a name="API_RestoreFromRecoveryPoint_RequestSyntax"></a>

```
{
   "namespaceName": "string",
   "recoveryPointId": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_RestoreFromRecoveryPoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [namespaceName](#API_RestoreFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreFromRecoveryPoint-request-namespaceName"></a>
The name of the namespace to restore data into.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [recoveryPointId](#API_RestoreFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreFromRecoveryPoint-request-recoveryPointId"></a>
The unique identifier of the recovery point to restore from.  
Type: String  
Required: Yes

 ** [workgroupName](#API_RestoreFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreFromRecoveryPoint-request-workgroupName"></a>
The name of the workgroup used to restore data.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_RestoreFromRecoveryPoint_ResponseSyntax"></a>

```
{
   "namespace": { 
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "catalogArn": "string",
      "creationDate": "string",
      "dbName": "string",
      "defaultIamRoleArn": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "lakehouseRegistrationStatus": "string",
      "logExports": [ "string" ],
      "namespaceArn": "string",
      "namespaceId": "string",
      "namespaceName": "string",
      "status": "string"
   },
   "recoveryPointId": "string"
}
```

## Response Elements
<a name="API_RestoreFromRecoveryPoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [namespace](#API_RestoreFromRecoveryPoint_ResponseSyntax) **   <a name="redshiftserverless-RestoreFromRecoveryPoint-response-namespace"></a>
The namespace that data was restored into.  
Type: [Namespace](API_Namespace.md) object

 ** [recoveryPointId](#API_RestoreFromRecoveryPoint_ResponseSyntax) **   <a name="redshiftserverless-RestoreFromRecoveryPoint-response-recoveryPointId"></a>
The unique identifier of the recovery point used for the restore.  
Type: String

## Errors
<a name="API_RestoreFromRecoveryPoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RestoreFromRecoveryPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/RestoreFromRecoveryPoint) 

# RestoreFromSnapshot
<a name="API_RestoreFromSnapshot"></a>

Restores a namespace from a snapshot.

## Request Syntax
<a name="API_RestoreFromSnapshot_RequestSyntax"></a>

```
{
   "adminPasswordSecretKmsKeyId": "string",
   "manageAdminPassword": boolean,
   "namespaceName": "string",
   "ownerAccount": "string",
   "snapshotArn": "string",
   "snapshotName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_RestoreFromSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [adminPasswordSecretKmsKeyId](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-request-adminPasswordSecretKmsKeyId"></a>
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.  
Type: String  
Required: No

 ** [manageAdminPassword](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-request-manageAdminPassword"></a>
If `true`, Amazon Redshift uses AWS 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.  
Type: Boolean  
Required: No

 ** [namespaceName](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-request-namespaceName"></a>
The name of the namespace to restore the snapshot to.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [ownerAccount](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-request-ownerAccount"></a>
The AWS account that owns the snapshot.  
Type: String  
Required: No

 ** [snapshotArn](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-request-snapshotArn"></a>
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\$1id>:snapshot:<cluster\$1identifier>/<snapshot\$1identifier>.  
Type: String  
Required: No

 ** [snapshotName](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-request-snapshotName"></a>
The name of the snapshot to restore from. Must not be specified at the same time as `snapshotArn`.  
Type: String  
Required: No

 ** [workgroupName](#API_RestoreFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-request-workgroupName"></a>
The name of the workgroup used to restore the snapshot.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_RestoreFromSnapshot_ResponseSyntax"></a>

```
{
   "namespace": { 
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "catalogArn": "string",
      "creationDate": "string",
      "dbName": "string",
      "defaultIamRoleArn": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "lakehouseRegistrationStatus": "string",
      "logExports": [ "string" ],
      "namespaceArn": "string",
      "namespaceId": "string",
      "namespaceName": "string",
      "status": "string"
   },
   "ownerAccount": "string",
   "snapshotName": "string"
}
```

## Response Elements
<a name="API_RestoreFromSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [namespace](#API_RestoreFromSnapshot_ResponseSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-response-namespace"></a>
A collection of database objects and users.  
Type: [Namespace](API_Namespace.md) object

 ** [ownerAccount](#API_RestoreFromSnapshot_ResponseSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-response-ownerAccount"></a>
The owner AWS; account of the snapshot that was restored.  
Type: String

 ** [snapshotName](#API_RestoreFromSnapshot_ResponseSyntax) **   <a name="redshiftserverless-RestoreFromSnapshot-response-snapshotName"></a>
The name of the snapshot used to restore the namespace.  
Type: String

## Errors
<a name="API_RestoreFromSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The service limit was exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RestoreFromSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/RestoreFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/RestoreFromSnapshot) 

# RestoreTableFromRecoveryPoint
<a name="API_RestoreTableFromRecoveryPoint"></a>

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.

## Request Syntax
<a name="API_RestoreTableFromRecoveryPoint_RequestSyntax"></a>

```
{
   "activateCaseSensitiveIdentifier": boolean,
   "namespaceName": "string",
   "newTableName": "string",
   "recoveryPointId": "string",
   "sourceDatabaseName": "string",
   "sourceSchemaName": "string",
   "sourceTableName": "string",
   "targetDatabaseName": "string",
   "targetSchemaName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_RestoreTableFromRecoveryPoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [activateCaseSensitiveIdentifier](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-activateCaseSensitiveIdentifier"></a>
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.  
Type: Boolean  
Required: No

 ** [namespaceName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-namespaceName"></a>
Namespace of the recovery point to restore from.  
Type: String  
Required: Yes

 ** [newTableName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-newTableName"></a>
The name of the table to create from the restore operation.  
Type: String  
Required: Yes

 ** [recoveryPointId](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-recoveryPointId"></a>
The ID of the recovery point to restore the table from.  
Type: String  
Required: Yes

 ** [sourceDatabaseName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-sourceDatabaseName"></a>
The name of the source database that contains the table being restored.  
Type: String  
Required: Yes

 ** [sourceSchemaName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-sourceSchemaName"></a>
The name of the source schema that contains the table being restored.  
Type: String  
Required: No

 ** [sourceTableName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-sourceTableName"></a>
The name of the source table being restored.  
Type: String  
Required: Yes

 ** [targetDatabaseName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-targetDatabaseName"></a>
The name of the database to restore the table to.  
Type: String  
Required: No

 ** [targetSchemaName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-targetSchemaName"></a>
The name of the schema to restore the table to.  
Type: String  
Required: No

 ** [workgroupName](#API_RestoreTableFromRecoveryPoint_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-request-workgroupName"></a>
The workgroup to restore the table to.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_RestoreTableFromRecoveryPoint_ResponseSyntax"></a>

```
{
   "tableRestoreStatus": { 
      "message": "string",
      "namespaceName": "string",
      "newTableName": "string",
      "progressInMegaBytes": number,
      "recoveryPointId": "string",
      "requestTime": number,
      "snapshotName": "string",
      "sourceDatabaseName": "string",
      "sourceSchemaName": "string",
      "sourceTableName": "string",
      "status": "string",
      "tableRestoreRequestId": "string",
      "targetDatabaseName": "string",
      "targetSchemaName": "string",
      "totalDataInMegaBytes": number,
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_RestoreTableFromRecoveryPoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tableRestoreStatus](#API_RestoreTableFromRecoveryPoint_ResponseSyntax) **   <a name="redshiftserverless-RestoreTableFromRecoveryPoint-response-tableRestoreStatus"></a>
Contains information about a table restore request.  
Type: [TableRestoreStatus](API_TableRestoreStatus.md) object

## Errors
<a name="API_RestoreTableFromRecoveryPoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RestoreTableFromRecoveryPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/RestoreTableFromRecoveryPoint) 

# RestoreTableFromSnapshot
<a name="API_RestoreTableFromSnapshot"></a>

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](https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved).

## Request Syntax
<a name="API_RestoreTableFromSnapshot_RequestSyntax"></a>

```
{
   "activateCaseSensitiveIdentifier": boolean,
   "namespaceName": "string",
   "newTableName": "string",
   "snapshotName": "string",
   "sourceDatabaseName": "string",
   "sourceSchemaName": "string",
   "sourceTableName": "string",
   "targetDatabaseName": "string",
   "targetSchemaName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_RestoreTableFromSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [activateCaseSensitiveIdentifier](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-activateCaseSensitiveIdentifier"></a>
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.  
Type: Boolean  
Required: No

 ** [namespaceName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-namespaceName"></a>
The namespace of the snapshot to restore from.  
Type: String  
Required: Yes

 ** [newTableName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-newTableName"></a>
The name of the table to create from the restore operation.  
Type: String  
Required: Yes

 ** [snapshotName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-snapshotName"></a>
The name of the snapshot to restore the table from.  
Type: String  
Required: Yes

 ** [sourceDatabaseName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-sourceDatabaseName"></a>
The name of the source database that contains the table being restored.  
Type: String  
Required: Yes

 ** [sourceSchemaName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-sourceSchemaName"></a>
The name of the source schema that contains the table being restored.  
Type: String  
Required: No

 ** [sourceTableName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-sourceTableName"></a>
The name of the source table being restored.  
Type: String  
Required: Yes

 ** [targetDatabaseName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-targetDatabaseName"></a>
The name of the database to restore the table to.  
Type: String  
Required: No

 ** [targetSchemaName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-targetSchemaName"></a>
The name of the schema to restore the table to.  
Type: String  
Required: No

 ** [workgroupName](#API_RestoreTableFromSnapshot_RequestSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-request-workgroupName"></a>
The workgroup to restore the table to.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_RestoreTableFromSnapshot_ResponseSyntax"></a>

```
{
   "tableRestoreStatus": { 
      "message": "string",
      "namespaceName": "string",
      "newTableName": "string",
      "progressInMegaBytes": number,
      "recoveryPointId": "string",
      "requestTime": number,
      "snapshotName": "string",
      "sourceDatabaseName": "string",
      "sourceSchemaName": "string",
      "sourceTableName": "string",
      "status": "string",
      "tableRestoreRequestId": "string",
      "targetDatabaseName": "string",
      "targetSchemaName": "string",
      "totalDataInMegaBytes": number,
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_RestoreTableFromSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tableRestoreStatus](#API_RestoreTableFromSnapshot_ResponseSyntax) **   <a name="redshiftserverless-RestoreTableFromSnapshot-response-tableRestoreStatus"></a>
The TableRestoreStatus object that contains the status of the restore operation.  
Type: [TableRestoreStatus](API_TableRestoreStatus.md) object

## Errors
<a name="API_RestoreTableFromSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RestoreTableFromSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/RestoreTableFromSnapshot) 

# TagResource
<a name="API_TagResource"></a>

Assigns one or more tags to a resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="redshiftserverless-TagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="redshiftserverless-TagResource-request-tags"></a>
The map of the key-value pairs used to tag the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The request exceeded the number of tags allowed for a resource.    
 ** resourceName **   
The name of the resource that exceeded the number of tags allowed for a resource.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes a tag or set of tags from a resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="redshiftserverless-UntagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to remove tags from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="redshiftserverless-UntagResource-request-tagKeys"></a>
The tag or set of tags to remove from the resource.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UntagResource) 

# UpdateCustomDomainAssociation
<a name="API_UpdateCustomDomainAssociation"></a>

Updates an Amazon Redshift Serverless certificate associated with a custom domain.

## Request Syntax
<a name="API_UpdateCustomDomainAssociation_RequestSyntax"></a>

```
{
   "customDomainCertificateArn": "string",
   "customDomainName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_UpdateCustomDomainAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [customDomainCertificateArn](#API_UpdateCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-UpdateCustomDomainAssociation-request-customDomainCertificateArn"></a>
The custom domain name’s certificate Amazon resource name (ARN). This is optional.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*.*`   
Required: Yes

 ** [customDomainName](#API_UpdateCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-UpdateCustomDomainAssociation-request-customDomainName"></a>
The custom domain name associated with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])`   
Required: Yes

 ** [workgroupName](#API_UpdateCustomDomainAssociation_RequestSyntax) **   <a name="redshiftserverless-UpdateCustomDomainAssociation-request-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateCustomDomainAssociation_ResponseSyntax"></a>

```
{
   "customDomainCertificateArn": "string",
   "customDomainCertificateExpiryTime": "string",
   "customDomainName": "string",
   "workgroupName": "string"
}
```

## Response Elements
<a name="API_UpdateCustomDomainAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [customDomainCertificateArn](#API_UpdateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-UpdateCustomDomainAssociation-response-customDomainCertificateArn"></a>
The custom domain name’s certificate Amazon resource name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*.*` 

 ** [customDomainCertificateExpiryTime](#API_UpdateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-UpdateCustomDomainAssociation-response-customDomainCertificateExpiryTime"></a>
The expiration time for the certificate.  
Type: Timestamp

 ** [customDomainName](#API_UpdateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-UpdateCustomDomainAssociation-response-customDomainName"></a>
The custom domain name associated with the workgroup.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])` 

 ** [workgroupName](#API_UpdateCustomDomainAssociation_ResponseSyntax) **   <a name="redshiftserverless-UpdateCustomDomainAssociation-response-workgroupName"></a>
The name of the workgroup associated with the database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+` 

## Errors
<a name="API_UpdateCustomDomainAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateCustomDomainAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateCustomDomainAssociation) 

# UpdateEndpointAccess
<a name="API_UpdateEndpointAccess"></a>

Updates an Amazon Redshift Serverless managed endpoint.

## Request Syntax
<a name="API_UpdateEndpointAccess_RequestSyntax"></a>

```
{
   "endpointName": "string",
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Request Parameters
<a name="API_UpdateEndpointAccess_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endpointName](#API_UpdateEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-UpdateEndpointAccess-request-endpointName"></a>
The name of the VPC endpoint to update.  
Type: String  
Required: Yes

 ** [vpcSecurityGroupIds](#API_UpdateEndpointAccess_RequestSyntax) **   <a name="redshiftserverless-UpdateEndpointAccess-request-vpcSecurityGroupIds"></a>
The list of VPC security groups associated with the endpoint after the endpoint is modified.  
Type: Array of strings  
Required: No

## Response Syntax
<a name="API_UpdateEndpointAccess_ResponseSyntax"></a>

```
{
   "endpoint": { 
      "address": "string",
      "endpointArn": "string",
      "endpointCreateTime": "string",
      "endpointName": "string",
      "endpointStatus": "string",
      "port": number,
      "subnetIds": [ "string" ],
      "vpcEndpoint": { 
         "networkInterfaces": [ 
            { 
               "availabilityZone": "string",
               "ipv6Address": "string",
               "networkInterfaceId": "string",
               "privateIpAddress": "string",
               "subnetId": "string"
            }
         ],
         "vpcEndpointId": "string",
         "vpcId": "string"
      },
      "vpcSecurityGroups": [ 
         { 
            "status": "string",
            "vpcSecurityGroupId": "string"
         }
      ],
      "workgroupName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateEndpointAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endpoint](#API_UpdateEndpointAccess_ResponseSyntax) **   <a name="redshiftserverless-UpdateEndpointAccess-response-endpoint"></a>
The updated VPC endpoint.  
Type: [EndpointAccess](API_EndpointAccess.md) object

## Errors
<a name="API_UpdateEndpointAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateEndpointAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateEndpointAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateEndpointAccess) 

# UpdateLakehouseConfiguration
<a name="API_UpdateLakehouseConfiguration"></a>

Modifies the lakehouse configuration for a namespace. This operation allows you to manage Amazon Redshift federated permissions and AWS IAM Identity Center trusted identity propagation.

## Request Syntax
<a name="API_UpdateLakehouseConfiguration_RequestSyntax"></a>

```
{
   "catalogName": "string",
   "dryRun": boolean,
   "lakehouseIdcApplicationArn": "string",
   "lakehouseIdcRegistration": "string",
   "lakehouseRegistration": "string",
   "namespaceName": "string"
}
```

## Request Parameters
<a name="API_UpdateLakehouseConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [catalogName](#API_UpdateLakehouseConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-request-catalogName"></a>
The name of the AWS 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_-]*$`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-z0-9_-]*[a-z]+[a-z0-9_-]*`   
Required: No

 ** [dryRun](#API_UpdateLakehouseConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-request-dryRun"></a>
A boolean value that, if `true`, validates the request without actually updating the lakehouse configuration. Use this to check for errors before making changes.  
Type: Boolean  
Required: No

 ** [lakehouseIdcApplicationArn](#API_UpdateLakehouseConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-request-lakehouseIdcApplicationArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling AWS IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions.  
Type: String  
Required: No

 ** [lakehouseIdcRegistration](#API_UpdateLakehouseConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-request-lakehouseIdcRegistration"></a>
Modifies the AWS IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions. Valid values are `Associate` or `Disassociate`.  
Type: String  
Valid Values: `Associate | Disassociate`   
Required: No

 ** [lakehouseRegistration](#API_UpdateLakehouseConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-request-lakehouseRegistration"></a>
Specifies whether to register or deregister the namespace with Amazon Redshift federated permissions. Valid values are `Register` or `Deregister`.  
Type: String  
Valid Values: `Register | Deregister`   
Required: No

 ** [namespaceName](#API_UpdateLakehouseConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-request-namespaceName"></a>
The name of the namespace whose lakehouse configuration you want to modify.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateLakehouseConfiguration_ResponseSyntax"></a>

```
{
   "catalogArn": "string",
   "lakehouseIdcApplicationArn": "string",
   "lakehouseRegistrationStatus": "string",
   "namespaceName": "string"
}
```

## Response Elements
<a name="API_UpdateLakehouseConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [catalogArn](#API_UpdateLakehouseConfiguration_ResponseSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-response-catalogArn"></a>
The Amazon Resource Name (ARN) of the AWS Glue Data Catalog associated with the lakehouse configuration.  
Type: String

 ** [lakehouseIdcApplicationArn](#API_UpdateLakehouseConfiguration_ResponseSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-response-lakehouseIdcApplicationArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling AWS IAM Identity Center trusted identity propagation.  
Type: String

 ** [lakehouseRegistrationStatus](#API_UpdateLakehouseConfiguration_ResponseSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-response-lakehouseRegistrationStatus"></a>
The current status of the lakehouse registration. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.  
Type: String

 ** [namespaceName](#API_UpdateLakehouseConfiguration_ResponseSyntax) **   <a name="redshiftserverless-UpdateLakehouseConfiguration-response-namespaceName"></a>
The name of the namespace.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+` 

## Errors
<a name="API_UpdateLakehouseConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** DryRunException **   
This exception is thrown when the request was successful, but dry run was enabled so no action was taken.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateLakehouseConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateLakehouseConfiguration) 

# UpdateNamespace
<a name="API_UpdateNamespace"></a>

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.

## Request Syntax
<a name="API_UpdateNamespace_RequestSyntax"></a>

```
{
   "adminPasswordSecretKmsKeyId": "string",
   "adminUsername": "string",
   "adminUserPassword": "string",
   "defaultIamRoleArn": "string",
   "iamRoles": [ "string" ],
   "kmsKeyId": "string",
   "logExports": [ "string" ],
   "manageAdminPassword": boolean,
   "namespaceName": "string"
}
```

## Request Parameters
<a name="API_UpdateNamespace_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [adminPasswordSecretKmsKeyId](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-adminPasswordSecretKmsKeyId"></a>
The ID of the AWS 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.  
Type: String  
Required: No

 ** [adminUsername](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-adminUsername"></a>
The username of the administrator for the first database created in the namespace. This parameter must be updated together with `adminUserPassword`.  
Type: String  
Required: No

 ** [adminUserPassword](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-adminUserPassword"></a>
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.   
Type: String  
Required: No

 ** [defaultIamRoleArn](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-defaultIamRoleArn"></a>
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`.  
Type: String  
Required: No

 ** [iamRoles](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-iamRoles"></a>
A list of IAM roles to associate with the namespace. This parameter must be updated together with `defaultIamRoleArn`.  
Type: Array of strings  
Required: No

 ** [kmsKeyId](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-kmsKeyId"></a>
The ID of the AWS Key Management Service key used to encrypt your data.  
Type: String  
Required: No

 ** [logExports](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-logExports"></a>
The types of logs the namespace can export. The export types are `userlog`, `connectionlog`, and `useractivitylog`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 16 items.  
Valid Values: `useractivitylog | userlog | connectionlog`   
Required: No

 ** [manageAdminPassword](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-manageAdminPassword"></a>
If `true`, Amazon Redshift uses AWS 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.   
Type: Boolean  
Required: No

 ** [namespaceName](#API_UpdateNamespace_RequestSyntax) **   <a name="redshiftserverless-UpdateNamespace-request-namespaceName"></a>
The name of the namespace to update. You can't update the name of a namespace once it is created.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateNamespace_ResponseSyntax"></a>

```
{
   "namespace": { 
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "catalogArn": "string",
      "creationDate": "string",
      "dbName": "string",
      "defaultIamRoleArn": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "lakehouseRegistrationStatus": "string",
      "logExports": [ "string" ],
      "namespaceArn": "string",
      "namespaceId": "string",
      "namespaceName": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_UpdateNamespace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [namespace](#API_UpdateNamespace_ResponseSyntax) **   <a name="redshiftserverless-UpdateNamespace-response-namespace"></a>
A list of tag instances.  
Type: [Namespace](API_Namespace.md) object

## Errors
<a name="API_UpdateNamespace_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateNamespace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateNamespace) 

# UpdateScheduledAction
<a name="API_UpdateScheduledAction"></a>

Updates a scheduled action.

## Request Syntax
<a name="API_UpdateScheduledAction_RequestSyntax"></a>

```
{
   "enabled": boolean,
   "endTime": number,
   "roleArn": "string",
   "schedule": { ... },
   "scheduledActionDescription": "string",
   "scheduledActionName": "string",
   "startTime": number,
   "targetAction": { ... }
}
```

## Request Parameters
<a name="API_UpdateScheduledAction_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [enabled](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-enabled"></a>
Specifies whether to enable the scheduled action.  
Type: Boolean  
Required: No

 ** [endTime](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-endTime"></a>
The end time in UTC of the scheduled action to update.  
Type: Timestamp  
Required: No

 ** [roleArn](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-roleArn"></a>
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](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) in the Amazon Redshift Management Guide  
Type: String  
Required: No

 ** [schedule](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-schedule"></a>
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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) in the *Amazon CloudWatch Events User Guide*.
Type: [Schedule](API_Schedule.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [scheduledActionDescription](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-scheduledActionDescription"></a>
The descripion of the scheduled action to update to.  
Type: String  
Required: No

 ** [scheduledActionName](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-scheduledActionName"></a>
The name of the scheduled action to update to.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 60.  
Pattern: `[a-z0-9-]+`   
Required: Yes

 ** [startTime](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-startTime"></a>
The start time in UTC of the scheduled action to update to.  
Type: Timestamp  
Required: No

 ** [targetAction](#API_UpdateScheduledAction_RequestSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-request-targetAction"></a>
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"}}"`   
Type: [TargetAction](API_TargetAction.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_UpdateScheduledAction_ResponseSyntax"></a>

```
{
   "scheduledAction": { 
      "endTime": number,
      "namespaceName": "string",
      "nextInvocations": [ number ],
      "roleArn": "string",
      "schedule": { ... },
      "scheduledActionDescription": "string",
      "scheduledActionName": "string",
      "scheduledActionUuid": "string",
      "startTime": number,
      "state": "string",
      "targetAction": { ... }
   }
}
```

## Response Elements
<a name="API_UpdateScheduledAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [scheduledAction](#API_UpdateScheduledAction_ResponseSyntax) **   <a name="redshiftserverless-UpdateScheduledAction-response-scheduledAction"></a>
The ScheduledAction object that was updated.  
Type: [ScheduledActionResponse](API_ScheduledActionResponse.md) object

## Errors
<a name="API_UpdateScheduledAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateScheduledAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateScheduledAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateScheduledAction) 

# UpdateSnapshot
<a name="API_UpdateSnapshot"></a>

Updates a snapshot.

## Request Syntax
<a name="API_UpdateSnapshot_RequestSyntax"></a>

```
{
   "retentionPeriod": number,
   "snapshotName": "string"
}
```

## Request Parameters
<a name="API_UpdateSnapshot_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [retentionPeriod](#API_UpdateSnapshot_RequestSyntax) **   <a name="redshiftserverless-UpdateSnapshot-request-retentionPeriod"></a>
The new retention period of the snapshot.  
Type: Integer  
Required: No

 ** [snapshotName](#API_UpdateSnapshot_RequestSyntax) **   <a name="redshiftserverless-UpdateSnapshot-request-snapshotName"></a>
The name of the snapshot.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateSnapshot_ResponseSyntax"></a>

```
{
   "snapshot": { 
      "accountsWithProvisionedRestoreAccess": [ "string" ],
      "accountsWithRestoreAccess": [ "string" ],
      "actualIncrementalBackupSizeInMegaBytes": number,
      "adminPasswordSecretArn": "string",
      "adminPasswordSecretKmsKeyId": "string",
      "adminUsername": "string",
      "backupProgressInMegaBytes": number,
      "currentBackupRateInMegaBytesPerSecond": number,
      "elapsedTimeInSeconds": number,
      "estimatedSecondsToCompletion": number,
      "kmsKeyId": "string",
      "namespaceArn": "string",
      "namespaceName": "string",
      "ownerAccount": "string",
      "snapshotArn": "string",
      "snapshotCreateTime": "string",
      "snapshotName": "string",
      "snapshotRemainingDays": number,
      "snapshotRetentionPeriod": number,
      "snapshotRetentionStartTime": "string",
      "status": "string",
      "totalBackupSizeInMegaBytes": number
   }
}
```

## Response Elements
<a name="API_UpdateSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshot](#API_UpdateSnapshot_ResponseSyntax) **   <a name="redshiftserverless-UpdateSnapshot-response-snapshot"></a>
The updated snapshot object.  
Type: [Snapshot](API_Snapshot.md) object

## Errors
<a name="API_UpdateSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateSnapshot) 

# UpdateSnapshotCopyConfiguration
<a name="API_UpdateSnapshotCopyConfiguration"></a>

Updates a snapshot copy configuration.

## Request Syntax
<a name="API_UpdateSnapshotCopyConfiguration_RequestSyntax"></a>

```
{
   "snapshotCopyConfigurationId": "string",
   "snapshotRetentionPeriod": number
}
```

## Request Parameters
<a name="API_UpdateSnapshotCopyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [snapshotCopyConfigurationId](#API_UpdateSnapshotCopyConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateSnapshotCopyConfiguration-request-snapshotCopyConfigurationId"></a>
The ID of the snapshot copy configuration to update.  
Type: String  
Required: Yes

 ** [snapshotRetentionPeriod](#API_UpdateSnapshotCopyConfiguration_RequestSyntax) **   <a name="redshiftserverless-UpdateSnapshotCopyConfiguration-request-snapshotRetentionPeriod"></a>
The new retention period of how long to keep a snapshot in the destination AWS Region.  
Type: Integer  
Required: No

## Response Syntax
<a name="API_UpdateSnapshotCopyConfiguration_ResponseSyntax"></a>

```
{
   "snapshotCopyConfiguration": { 
      "destinationKmsKeyId": "string",
      "destinationRegion": "string",
      "namespaceName": "string",
      "snapshotCopyConfigurationArn": "string",
      "snapshotCopyConfigurationId": "string",
      "snapshotRetentionPeriod": number
   }
}
```

## Response Elements
<a name="API_UpdateSnapshotCopyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [snapshotCopyConfiguration](#API_UpdateSnapshotCopyConfiguration_ResponseSyntax) **   <a name="redshiftserverless-UpdateSnapshotCopyConfiguration-response-snapshotCopyConfiguration"></a>
The updated snapshot copy configuration object.  
Type: [SnapshotCopyConfiguration](API_SnapshotCopyConfiguration.md) object

## Errors
<a name="API_UpdateSnapshotCopyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSnapshotCopyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateSnapshotCopyConfiguration) 

# UpdateUsageLimit
<a name="API_UpdateUsageLimit"></a>

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

## Request Syntax
<a name="API_UpdateUsageLimit_RequestSyntax"></a>

```
{
   "amount": number,
   "breachAction": "string",
   "usageLimitId": "string"
}
```

## Request Parameters
<a name="API_UpdateUsageLimit_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [amount](#API_UpdateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-UpdateUsageLimit-request-amount"></a>
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.  
Type: Long  
Required: No

 ** [breachAction](#API_UpdateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-UpdateUsageLimit-request-breachAction"></a>
The new action that Amazon Redshift Serverless takes when the limit is reached.  
Type: String  
Valid Values: `log | emit-metric | deactivate`   
Required: No

 ** [usageLimitId](#API_UpdateUsageLimit_RequestSyntax) **   <a name="redshiftserverless-UpdateUsageLimit-request-usageLimitId"></a>
The identifier of the usage limit to update.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateUsageLimit_ResponseSyntax"></a>

```
{
   "usageLimit": { 
      "amount": number,
      "breachAction": "string",
      "period": "string",
      "resourceArn": "string",
      "usageLimitArn": "string",
      "usageLimitId": "string",
      "usageType": "string"
   }
}
```

## Response Elements
<a name="API_UpdateUsageLimit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [usageLimit](#API_UpdateUsageLimit_ResponseSyntax) **   <a name="redshiftserverless-UpdateUsageLimit-response-usageLimit"></a>
The updated usage limit object.  
Type: [UsageLimit](API_UsageLimit.md) object

## Errors
<a name="API_UpdateUsageLimit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateUsageLimit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateUsageLimit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateUsageLimit) 

# UpdateWorkgroup
<a name="API_UpdateWorkgroup"></a>

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](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*.

## Request Syntax
<a name="API_UpdateWorkgroup_RequestSyntax"></a>

```
{
   "baseCapacity": number,
   "configParameters": [ 
      { 
         "parameterKey": "string",
         "parameterValue": "string"
      }
   ],
   "enhancedVpcRouting": boolean,
   "extraComputeForAutomaticOptimization": boolean,
   "ipAddressType": "string",
   "maxCapacity": number,
   "port": number,
   "pricePerformanceTarget": { 
      "level": number,
      "status": "string"
   },
   "publiclyAccessible": boolean,
   "securityGroupIds": [ "string" ],
   "subnetIds": [ "string" ],
   "trackName": "string",
   "workgroupName": "string"
}
```

## Request Parameters
<a name="API_UpdateWorkgroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [baseCapacity](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-baseCapacity"></a>
The new base data warehouse capacity in Redshift Processing Units (RPUs).  
Type: Integer  
Required: No

 ** [configParameters](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-configParameters"></a>
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](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless).  
Type: Array of [ConfigParameter](API_ConfigParameter.md) objects  
Required: No

 ** [enhancedVpcRouting](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-enhancedVpcRouting"></a>
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.  
Type: Boolean  
Required: No

 ** [extraComputeForAutomaticOptimization](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-extraComputeForAutomaticOptimization"></a>
If `true`, allocates additional compute resources for running automatic optimization operations.  
Default: false  
Type: Boolean  
Required: No

 ** [ipAddressType](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-ipAddressType"></a>
The IP address type that the workgroup supports. Possible values are `ipv4` and `dualstack`.  
Type: String  
Pattern: `(ipv4|dualstack)`   
Required: No

 ** [maxCapacity](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-maxCapacity"></a>
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.  
Type: Integer  
Required: No

 ** [port](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-port"></a>
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.  
Type: Integer  
Required: No

 ** [pricePerformanceTarget](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-pricePerformanceTarget"></a>
An object that represents the price performance target settings for the workgroup.  
Type: [PerformanceTarget](API_PerformanceTarget.md) object  
Required: No

 ** [publiclyAccessible](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-publiclyAccessible"></a>
A value that specifies whether the workgroup can be accessible from a public network.  
Type: Boolean  
Required: No

 ** [securityGroupIds](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-securityGroupIds"></a>
An array of security group IDs to associate with the workgroup.  
Type: Array of strings  
Required: No

 ** [subnetIds](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-subnetIds"></a>
An array of VPC subnet IDs to associate with the workgroup.  
Type: Array of strings  
Required: No

 ** [trackName](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-trackName"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_]+`   
Required: No

 ** [workgroupName](#API_UpdateWorkgroup_RequestSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-request-workgroupName"></a>
The name of the workgroup to update. You can't update the name of a workgroup once it is created.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateWorkgroup_ResponseSyntax"></a>

```
{
   "workgroup": { 
      "baseCapacity": number,
      "configParameters": [ 
         { 
            "parameterKey": "string",
            "parameterValue": "string"
         }
      ],
      "creationDate": "string",
      "crossAccountVpcs": [ "string" ],
      "customDomainCertificateArn": "string",
      "customDomainCertificateExpiryTime": "string",
      "customDomainName": "string",
      "endpoint": { 
         "address": "string",
         "port": number,
         "vpcEndpoints": [ 
            { 
               "networkInterfaces": [ 
                  { 
                     "availabilityZone": "string",
                     "ipv6Address": "string",
                     "networkInterfaceId": "string",
                     "privateIpAddress": "string",
                     "subnetId": "string"
                  }
               ],
               "vpcEndpointId": "string",
               "vpcId": "string"
            }
         ]
      },
      "enhancedVpcRouting": boolean,
      "extraComputeForAutomaticOptimization": boolean,
      "ipAddressType": "string",
      "maxCapacity": number,
      "namespaceName": "string",
      "patchVersion": "string",
      "pendingTrackName": "string",
      "port": number,
      "pricePerformanceTarget": { 
         "level": number,
         "status": "string"
      },
      "publiclyAccessible": boolean,
      "securityGroupIds": [ "string" ],
      "status": "string",
      "subnetIds": [ "string" ],
      "trackName": "string",
      "workgroupArn": "string",
      "workgroupId": "string",
      "workgroupName": "string",
      "workgroupVersion": "string"
   }
}
```

## Response Elements
<a name="API_UpdateWorkgroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [workgroup](#API_UpdateWorkgroup_ResponseSyntax) **   <a name="redshiftserverless-UpdateWorkgroup-response-workgroup"></a>
The updated workgroup object.  
Type: [Workgroup](API_Workgroup.md) object

## Errors
<a name="API_UpdateWorkgroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The submitted action has conflicts.  
HTTP Status Code: 400

 ** InsufficientCapacityException **   
There is an insufficient capacity to perform the action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** Ipv6CidrBlockNotFoundException **   
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.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource could not be found.    
 ** resourceName **   
The name of the resource that could not be found.
HTTP Status Code: 400

 ** ValidationException **   
The input failed to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateWorkgroup_Examples"></a>

### Example
<a name="API_UpdateWorkgroup_Example_1"></a>

This example illustrates one usage of UpdateWorkgroup.

#### Sample Request
<a name="API_UpdateWorkgroup_Example_1_Request"></a>

```
aws redshift-serverless update-workgroup
--workgroup-name test-wg
--track-name trailing
```

#### Sample Response
<a name="API_UpdateWorkgroup_Example_1_Response"></a>

```
{
  "workgroup": {
    "workgroupId": "875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupArn": "arn:aws:redshift-serverless:us-east-1:012345678901:workgroup/875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupName": "test-wg",
    "namespaceName": "test-namespace",
    "baseCapacity": 32,
    "enhancedVpcRouting": false,
    ...
    "ipAddressType": "ipv4",
    "trackName": "current"
    "pendingTrackName": "trailing"
  }
}
```

## See Also
<a name="API_UpdateWorkgroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/redshift-serverless-2021-04-21/UpdateWorkgroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/redshift-serverless-2021-04-21/UpdateWorkgroup)