Creates a custom domain association for Amazon Redshift Serverless.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftServerlessClient, CreateCustomDomainAssociationCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import + * // const { RedshiftServerlessClient, CreateCustomDomainAssociationCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import + * const client = new RedshiftServerlessClient(config); + * const input = { // CreateCustomDomainAssociationRequest + * workgroupName: "STRING_VALUE", // required + * customDomainName: "STRING_VALUE", // required + * customDomainCertificateArn: "STRING_VALUE", // required + * }; + * const command = new CreateCustomDomainAssociationCommand(input); + * const response = await client.send(command); + * // { // CreateCustomDomainAssociationResponse + * // customDomainName: "STRING_VALUE", + * // workgroupName: "STRING_VALUE", + * // customDomainCertificateArn: "STRING_VALUE", + * // customDomainCertificateExpiryTime: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param CreateCustomDomainAssociationCommandInput - {@link CreateCustomDomainAssociationCommandInput} + * @returns {@link CreateCustomDomainAssociationCommandOutput} + * @see {@link CreateCustomDomainAssociationCommandInput} for command's `input` shape. + * @see {@link CreateCustomDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The submitted action has conflicts.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input failed to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link RedshiftServerlessServiceException} + *Base exception class for all service exceptions from RedshiftServerless service.
+ * + */ +export class CreateCustomDomainAssociationCommand extends $Command< + CreateCustomDomainAssociationCommandInput, + CreateCustomDomainAssociationCommandOutput, + RedshiftServerlessClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateCustomDomainAssociationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a custom domain association for Amazon Redshift Serverless.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftServerlessClient, DeleteCustomDomainAssociationCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import + * // const { RedshiftServerlessClient, DeleteCustomDomainAssociationCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import + * const client = new RedshiftServerlessClient(config); + * const input = { // DeleteCustomDomainAssociationRequest + * workgroupName: "STRING_VALUE", // required + * customDomainName: "STRING_VALUE", // required + * }; + * const command = new DeleteCustomDomainAssociationCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteCustomDomainAssociationCommandInput - {@link DeleteCustomDomainAssociationCommandInput} + * @returns {@link DeleteCustomDomainAssociationCommandOutput} + * @see {@link DeleteCustomDomainAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteCustomDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The submitted action has conflicts.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input failed to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link RedshiftServerlessServiceException} + *Base exception class for all service exceptions from RedshiftServerless service.
+ * + */ +export class DeleteCustomDomainAssociationCommand extends $Command< + DeleteCustomDomainAssociationCommandInput, + DeleteCustomDomainAssociationCommandOutput, + RedshiftServerlessClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteCustomDomainAssociationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information about a specific custom domain association.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftServerlessClient, GetCustomDomainAssociationCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import + * // const { RedshiftServerlessClient, GetCustomDomainAssociationCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import + * const client = new RedshiftServerlessClient(config); + * const input = { // GetCustomDomainAssociationRequest + * customDomainName: "STRING_VALUE", // required + * workgroupName: "STRING_VALUE", // required + * }; + * const command = new GetCustomDomainAssociationCommand(input); + * const response = await client.send(command); + * // { // GetCustomDomainAssociationResponse + * // customDomainName: "STRING_VALUE", + * // workgroupName: "STRING_VALUE", + * // customDomainCertificateArn: "STRING_VALUE", + * // customDomainCertificateExpiryTime: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param GetCustomDomainAssociationCommandInput - {@link GetCustomDomainAssociationCommandInput} + * @returns {@link GetCustomDomainAssociationCommandOutput} + * @see {@link GetCustomDomainAssociationCommandInput} for command's `input` shape. + * @see {@link GetCustomDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The submitted action has conflicts.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input failed to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link RedshiftServerlessServiceException} + *Base exception class for all service exceptions from RedshiftServerless service.
+ * + */ +export class GetCustomDomainAssociationCommand extends $Command< + GetCustomDomainAssociationCommandInput, + GetCustomDomainAssociationCommandOutput, + RedshiftServerlessClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetCustomDomainAssociationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists custom domain associations for Amazon Redshift Serverless.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftServerlessClient, ListCustomDomainAssociationsCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import + * // const { RedshiftServerlessClient, ListCustomDomainAssociationsCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import + * const client = new RedshiftServerlessClient(config); + * const input = { // ListCustomDomainAssociationsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * customDomainName: "STRING_VALUE", + * customDomainCertificateArn: "STRING_VALUE", + * }; + * const command = new ListCustomDomainAssociationsCommand(input); + * const response = await client.send(command); + * // { // ListCustomDomainAssociationsResponse + * // nextToken: "STRING_VALUE", + * // associations: [ // AssociationList + * // { // Association + * // customDomainCertificateArn: "STRING_VALUE", + * // customDomainCertificateExpiryTime: new Date("TIMESTAMP"), + * // customDomainName: "STRING_VALUE", + * // workgroupName: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListCustomDomainAssociationsCommandInput - {@link ListCustomDomainAssociationsCommandInput} + * @returns {@link ListCustomDomainAssociationsCommandOutput} + * @see {@link ListCustomDomainAssociationsCommandInput} for command's `input` shape. + * @see {@link ListCustomDomainAssociationsCommandOutput} for command's `response` shape. + * @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link InvalidPaginationException} (client fault) + *The provided pagination token is invalid.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input failed to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link RedshiftServerlessServiceException} + *Base exception class for all service exceptions from RedshiftServerless service.
+ * + */ +export class ListCustomDomainAssociationsCommand extends $Command< + ListCustomDomainAssociationsCommandInput, + ListCustomDomainAssociationsCommandOutput, + RedshiftServerlessClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListCustomDomainAssociationsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates an Amazon Redshift Serverless certificate associated with a custom domain.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftServerlessClient, UpdateCustomDomainAssociationCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import + * // const { RedshiftServerlessClient, UpdateCustomDomainAssociationCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import + * const client = new RedshiftServerlessClient(config); + * const input = { // UpdateCustomDomainAssociationRequest + * workgroupName: "STRING_VALUE", // required + * customDomainName: "STRING_VALUE", // required + * customDomainCertificateArn: "STRING_VALUE", // required + * }; + * const command = new UpdateCustomDomainAssociationCommand(input); + * const response = await client.send(command); + * // { // UpdateCustomDomainAssociationResponse + * // customDomainName: "STRING_VALUE", + * // workgroupName: "STRING_VALUE", + * // customDomainCertificateArn: "STRING_VALUE", + * // customDomainCertificateExpiryTime: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param UpdateCustomDomainAssociationCommandInput - {@link UpdateCustomDomainAssociationCommandInput} + * @returns {@link UpdateCustomDomainAssociationCommandOutput} + * @see {@link UpdateCustomDomainAssociationCommandInput} for command's `input` shape. + * @see {@link UpdateCustomDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link RedshiftServerlessClientResolvedConfig | config} for RedshiftServerlessClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The submitted action has conflicts.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input failed to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link RedshiftServerlessServiceException} + *Base exception class for all service exceptions from RedshiftServerless service.
+ * + */ +export class UpdateCustomDomainAssociationCommand extends $Command< + UpdateCustomDomainAssociationCommandInput, + UpdateCustomDomainAssociationCommandOutput, + RedshiftServerlessClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateCustomDomainAssociationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAn object that represents the custom domain name association.
+ */ +export interface Association { + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN).
+ */ + customDomainCertificateArn?: string; + + /** + * @public + *The expiration time for the certificate.
+ */ + customDomainCertificateExpiryTime?: Date; + + /** + * @public + *The custom domain name associated with the workgroup.
+ */ + customDomainName?: string; + + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName?: string; +} + /** * @public *An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
@@ -398,6 +428,81 @@ export class ValidationException extends __BaseException { } } +/** + * @public + */ +export interface CreateCustomDomainAssociationRequest { + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName: string | undefined; + + /** + * @public + *The custom domain name to associate with the workgroup.
+ */ + customDomainName: string | undefined; + + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN).
+ */ + customDomainCertificateArn: string | undefined; +} + +/** + * @public + */ +export interface CreateCustomDomainAssociationResponse { + /** + * @public + *The custom domain name to associate with the workgroup.
+ */ + customDomainName?: string; + + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName?: string; + + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN).
+ */ + customDomainCertificateArn?: string; + + /** + * @public + *The expiration time for the certificate.
+ */ + customDomainCertificateExpiryTime?: Date; +} + +/** + * @public + *The request was denied due to request throttling.
+ */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = {}; + code?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe custom domain name associated with the workgroup.
+ */ + customDomainName?: string; + + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN).
+ */ + customDomainCertificateArn?: string; + + /** + * @public + *The expiration time for the certificate.
+ */ + customDomainCertificateExpiryTime?: Date; + /** * @public *The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.
@@ -1341,6 +1464,28 @@ export interface UpdateEndpointAccessResponse { endpoint?: EndpointAccess; } +/** + * @public + */ +export interface DeleteCustomDomainAssociationRequest { + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName: string | undefined; + + /** + * @public + *The custom domain name associated with the workgroup.
+ */ + customDomainName: string | undefined; +} + +/** + * @public + */ +export interface DeleteCustomDomainAssociationResponse {} + /** * @public */ @@ -1461,12 +1606,6 @@ export interface DeleteWorkgroupResponse { * @public */ export interface GetCredentialsRequest { - /** - * @public - *The name of the workgroup associated with the database.
- */ - workgroupName: string | undefined; - /** * @public *The name of the database to get temporary authorization to log on to.
@@ -1499,6 +1638,18 @@ export interface GetCredentialsRequest { * The minimum is 900 seconds, and the maximum is 3600 seconds. */ durationSeconds?: number; + + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName?: string; + + /** + * @public + *The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.
+ */ + customDomainName?: string; } /** @@ -1535,6 +1686,52 @@ export interface GetCredentialsResponse { nextRefreshTime?: Date; } +/** + * @public + */ +export interface GetCustomDomainAssociationRequest { + /** + * @public + *The custom domain name associated with the workgroup.
+ */ + customDomainName: string | undefined; + + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName: string | undefined; +} + +/** + * @public + */ +export interface GetCustomDomainAssociationResponse { + /** + * @public + *The custom domain name associated with the workgroup.
+ */ + customDomainName?: string; + + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName?: string; + + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN).
+ */ + customDomainCertificateArn?: string; + + /** + * @public + *The expiration time for the certificate.
+ */ + customDomainCertificateExpiryTime?: Date; +} + /** * @public */ @@ -1882,6 +2079,57 @@ export class InvalidPaginationException extends __BaseException { } } +/** + * @public + */ +export interface ListCustomDomainAssociationsRequest { + /** + * @public + *When nextToken is returned, there are more results available.
+ * The value of nextToken is a unique pagination token for each page.
+ * Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return.
+ * You can use nextToken to display the next page of results.
The custom domain name associated with the workgroup.
+ */ + customDomainName?: string; + + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN).
+ */ + customDomainCertificateArn?: string; +} + +/** + * @public + */ +export interface ListCustomDomainAssociationsResponse { + /** + * @public + *When nextToken is returned, there are more results available.
+ * The value of nextToken is a unique pagination token for each page.
+ * Make the call again using the returned token to retrieve the next page.
A list of Association objects.
+ */ + associations?: Association[]; +} + /** * @public */ @@ -2126,29 +2374,6 @@ export interface ListTagsForResourceResponse { tags?: Tag[]; } -/** - * @public - *The request was denied due to request throttling.
- */ -export class ThrottlingException extends __BaseException { - readonly name: "ThrottlingException" = "ThrottlingException"; - readonly $fault: "client" = "client"; - $retryable = {}; - code?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe 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.
You can't use adminUserPassword if manageAdminPassword is true.
The name of the workgroup associated with the database.
+ */ + workgroupName: string | undefined; + + /** + * @public + *The custom domain name associated with the workgroup.
+ */ + customDomainName: string | undefined; + + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN). This is optional.
+ */ + customDomainCertificateArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateCustomDomainAssociationResponse { + /** + * @public + *The custom domain name associated with the workgroup.
+ */ + customDomainName?: string; + + /** + * @public + *The name of the workgroup associated with the database.
+ */ + workgroupName?: string; + + /** + * @public + *The custom domain name’s certificate Amazon resource name (ARN).
+ */ + customDomainCertificateArn?: string; + + /** + * @public + *The expiration time for the certificate.
+ */ + customDomainCertificateExpiryTime?: Date; +} + /** * @public */ diff --git a/clients/client-redshift-serverless/src/pagination/ListCustomDomainAssociationsPaginator.ts b/clients/client-redshift-serverless/src/pagination/ListCustomDomainAssociationsPaginator.ts new file mode 100644 index 000000000000..5d3b241944c5 --- /dev/null +++ b/clients/client-redshift-serverless/src/pagination/ListCustomDomainAssociationsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListCustomDomainAssociationsCommand, + ListCustomDomainAssociationsCommandInput, + ListCustomDomainAssociationsCommandOutput, +} from "../commands/ListCustomDomainAssociationsCommand"; +import { RedshiftServerlessClient } from "../RedshiftServerlessClient"; +import { RedshiftServerlessPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: RedshiftServerlessClient, + input: ListCustomDomainAssociationsCommandInput, + ...args: any +): PromiseThe custom domain name’s certificate Amazon resource name (ARN).
" + } + }, + "customDomainCertificateExpiryTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The expiration time for the certificate.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup.
" + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents the custom domain name association.
" + } + }, + "com.amazonaws.redshiftserverless#AssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#Association" + } + }, "com.amazonaws.redshiftserverless#ConfigParameter": { "type": "structure", "members": { @@ -154,6 +193,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#CreateCustomDomainAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a custom domain association for Amazon Redshift Serverless.
" + } + }, + "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
", + "smithy.api#required": {} + } + }, + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name to associate with the workgroup.
", + "smithy.api#required": {} + } + }, + "customDomainCertificateArn": { + "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The custom domain name’s certificate Amazon resource name (ARN).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#CreateCustomDomainAssociationResponse": { + "type": "structure", + "members": { + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name to associate with the workgroup.
" + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
" + } + }, + "customDomainCertificateArn": { + "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The custom domain name’s certificate Amazon resource name (ARN).
" + } + }, + "customDomainCertificateExpiryTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The expiration time for the certificate.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#CreateEndpointAccess": { "type": "operation", "input": { @@ -655,6 +788,26 @@ } ] }, + "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "arn:[\\w+=/,.@-]+:acm:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" + } + }, + "com.amazonaws.redshiftserverless#CustomDomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" + } + }, "com.amazonaws.redshiftserverless#DbName": { "type": "string" }, @@ -670,6 +823,67 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom domain association for Amazon Redshift Serverless.
" + } + }, + "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
", + "smithy.api#required": {} + } + }, + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#DeleteEndpointAccess": { "type": "operation", "input": { @@ -1136,13 +1350,6 @@ "com.amazonaws.redshiftserverless#GetCredentialsRequest": { "type": "structure", "members": { - "workgroupName": { - "target": "com.amazonaws.redshiftserverless#WorkgroupName", - "traits": { - "smithy.api#documentation": "The name of the workgroup associated with the database.
", - "smithy.api#required": {} - } - }, "dbName": { "target": "com.amazonaws.redshiftserverless#DbName", "traits": { @@ -1154,6 +1361,18 @@ "traits": { "smithy.api#documentation": "The number of seconds until the returned temporary password expires.\n The minimum is 900 seconds, and the maximum is 3600 seconds.
" } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
" + } + }, + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.
" + } } }, "traits": { @@ -1192,6 +1411,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#GetCustomDomainAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetCustomDomainAssociationRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetCustomDomainAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a specific custom domain association.
" + } + }, + "com.amazonaws.redshiftserverless#GetCustomDomainAssociationRequest": { + "type": "structure", + "members": { + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup.
", + "smithy.api#required": {} + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetCustomDomainAssociationResponse": { + "type": "structure", + "members": { + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup.
" + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
" + } + }, + "customDomainCertificateArn": { + "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The custom domain name’s certificate Amazon resource name (ARN).
" + } + }, + "customDomainCertificateExpiryTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The expiration time for the certificate.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#GetEndpointAccess": { "type": "operation", "input": { @@ -1697,6 +2003,101 @@ "com.amazonaws.redshiftserverless#KmsKeyId": { "type": "string" }, + "com.amazonaws.redshiftserverless#ListCustomDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#InvalidPaginationException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists custom domain associations for Amazon Redshift Serverless.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "associations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "When nextToken is returned, there are more results available. \n The value of nextToken is a unique pagination token for each page. \n Make the call again using the returned token to retrieve the next page.
An optional parameter that specifies the maximum number of results to return.\n You can use nextToken to display the next page of results.
The custom domain name associated with the workgroup.
" + } + }, + "customDomainCertificateArn": { + "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The custom domain name’s certificate Amazon resource name (ARN).
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListCustomDomainAssociationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "When nextToken is returned, there are more results available. \n The value of nextToken is a unique pagination token for each page. \n Make the call again using the returned token to retrieve the next page.
A list of Association objects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#ListEndpointAccess": { "type": "operation", "input": { @@ -2757,15 +3158,27 @@ "type": "service", "version": "2021-04-21", "operations": [ + { + "target": "com.amazonaws.redshiftserverless#CreateCustomDomainAssociation" + }, + { + "target": "com.amazonaws.redshiftserverless#DeleteCustomDomainAssociation" + }, { "target": "com.amazonaws.redshiftserverless#DeleteResourcePolicy" }, { "target": "com.amazonaws.redshiftserverless#GetCredentials" }, + { + "target": "com.amazonaws.redshiftserverless#GetCustomDomainAssociation" + }, { "target": "com.amazonaws.redshiftserverless#GetResourcePolicy" }, + { + "target": "com.amazonaws.redshiftserverless#ListCustomDomainAssociations" + }, { "target": "com.amazonaws.redshiftserverless#ListTagsForResource" }, @@ -2777,6 +3190,9 @@ }, { "target": "com.amazonaws.redshiftserverless#UntagResource" + }, + { + "target": "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociation" } ], "resources": [ @@ -4470,6 +4886,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an Amazon Redshift Serverless certificate associated with a custom domain.
" + } + }, + "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
", + "smithy.api#required": {} + } + }, + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup.
", + "smithy.api#required": {} + } + }, + "customDomainCertificateArn": { + "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The custom domain name’s certificate Amazon resource name (ARN). This is optional.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateCustomDomainAssociationResponse": { + "type": "structure", + "members": { + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup.
" + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "The name of the workgroup associated with the database.
" + } + }, + "customDomainCertificateArn": { + "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The custom domain name’s certificate Amazon resource name (ARN).
" + } + }, + "customDomainCertificateExpiryTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The expiration time for the certificate.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshiftserverless#UpdateEndpointAccess": { "type": "operation", "input": { @@ -4573,7 +5083,7 @@ "adminUserPassword": { "target": "com.amazonaws.redshiftserverless#DbPassword", "traits": { - "smithy.api#documentation": "The password of the administrator for the first database created in the namespace. This parameter must be updated together\n with adminUsername.
You can't use adminUserPassword if manageAdminPassword is true.
The password of the administrator for the first database created in the namespace. This parameter must be updated together\n with adminUsername.
You can't use adminUserPassword if manageAdminPassword is true.
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" } }, + "customDomainName": { + "target": "com.amazonaws.redshiftserverless#CustomDomainName", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the workgroup.
" + } + }, + "customDomainCertificateArn": { + "target": "com.amazonaws.redshiftserverless#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The custom domain name’s certificate Amazon resource name (ARN).
" + } + }, + "customDomainCertificateExpiryTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The expiration time for the certificate.
", + "smithy.api#timestampFormat": "date-time" + } + }, "workgroupVersion": { "target": "smithy.api#String", "traits": {