GetCredentialsCommand

Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).

The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.

If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftServerlessClient, GetCredentialsCommand } from "@aws-sdk/client-redshift-serverless"; // ES Modules import
// const { RedshiftServerlessClient, GetCredentialsCommand } = require("@aws-sdk/client-redshift-serverless"); // CommonJS import
const client = new RedshiftServerlessClient(config);
const input = { // GetCredentialsRequest
  dbName: "STRING_VALUE",
  durationSeconds: Number("int"),
  workgroupName: "STRING_VALUE",
  customDomainName: "STRING_VALUE",
};
const command = new GetCredentialsCommand(input);
const response = await client.send(command);
// { // GetCredentialsResponse
//   dbUser: "STRING_VALUE",
//   dbPassword: "STRING_VALUE",
//   expiration: new Date("TIMESTAMP"),
//   nextRefreshTime: new Date("TIMESTAMP"),
// };

GetCredentialsCommand Input

See GetCredentialsCommandInput for more details

Parameter
Type
Description
customDomainName
string | undefined

The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.

dbName
string | undefined

The name of the database to get temporary authorization to log on to.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens.

  • Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (), or hyphen.

  • The first character must be a letter.

  • Must not contain a colon ( : ) or slash ( / ).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words   in the Amazon Redshift Database Developer Guide

durationSeconds
number | undefined

The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.

workgroupName
string | undefined

The name of the workgroup associated with the database.

GetCredentialsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
dbPassword
string | undefined

A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

dbUser
string | undefined

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.

expiration
Date | undefined

The date and time the password in DbPassword expires.

nextRefreshTime
Date | undefined

The date and time of when the DbUser and DbPassword authorization refreshes.

Throws

Name
Fault
Details
InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The resource could not be found.

ValidationException
client

The input failed to satisfy the constraints specified by an AWS service.

RedshiftServerlessServiceException
Base exception class for all service exceptions from RedshiftServerless service.