Lists custom domain associations for Amazon Redshift Serverless.
Request Syntax
{
"customDomainCertificateArn": "string",
"customDomainName": "string",
"maxResults": number,
"nextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- customDomainCertificateArn
-
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
-
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
-
An optional parameter that specifies the maximum number of results to return. You can use
nextTokento display the next page of results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
When
nextTokenis returned, there are more results available. The value ofnextTokenis 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
{
"associations": [
{
"customDomainCertificateArn": "string",
"customDomainCertificateExpiryTime": "string",
"customDomainName": "string",
"workgroupName": "string"
}
],
"nextToken": "string"
}Response Elements
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
-
A list of Association objects.
Type: Array of Association objects
- nextToken
-
When
nextTokenis returned, there are more results available. The value ofnextTokenis 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
For information about the errors that are common to all actions, see Common Errors.
- 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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
