Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RedshiftData.ListDatabases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

This operation returns paginated results.

Synopsis

data ListDatabases = ListDatabases' {
- clusterIdentifier :: Maybe Text
- dbUser :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- secretArn :: Maybe Text
- workgroupName :: Maybe Text
- database :: Text
}
newListDatabases :: Text -> ListDatabases
listDatabases_clusterIdentifier :: Lens' ListDatabases (Maybe Text)
listDatabases_dbUser :: Lens' ListDatabases (Maybe Text)
listDatabases_maxResults :: Lens' ListDatabases (Maybe Natural)
listDatabases_nextToken :: Lens' ListDatabases (Maybe Text)
listDatabases_secretArn :: Lens' ListDatabases (Maybe Text)
listDatabases_workgroupName :: Lens' ListDatabases (Maybe Text)
listDatabases_database :: Lens' ListDatabases Text
data ListDatabasesResponse = ListDatabasesResponse' {
- databases :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListDatabasesResponse :: Int -> ListDatabasesResponse
listDatabasesResponse_databases :: Lens' ListDatabasesResponse (Maybe [Text])
listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (Maybe Text)
listDatabasesResponse_httpStatus :: Lens' ListDatabasesResponse Int

Creating a Request

data ListDatabases Source #

See: newListDatabases smart constructor.

Constructors

ListDatabases'

Fields

clusterIdentifier :: Maybe Text
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
dbUser :: Maybe Text
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
maxResults :: Maybe Natural
The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
nextToken :: Maybe Text
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
secretArn :: Maybe Text
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
workgroupName :: Maybe Text
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
database :: Text
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Instances

Instances details

ToJSON ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods toJSON :: ListDatabases -> Value # toEncoding :: ListDatabases -> Encoding # toJSONList :: [ListDatabases] -> Value # toEncodingList :: [ListDatabases] -> Encoding #
ToHeaders ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods toHeaders :: ListDatabases -> [Header] #
ToPath ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods toPath :: ListDatabases -> ByteString #
ToQuery ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods toQuery :: ListDatabases -> QueryString #
AWSPager ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods page :: ListDatabases -> AWSResponse ListDatabases -> Maybe ListDatabases #
AWSRequest ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Associated Types type AWSResponse ListDatabases # Methods request :: (Service -> Service) -> ListDatabases -> Request ListDatabases # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDatabases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDatabases))) #
Generic ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Associated Types type Rep ListDatabases :: Type -> Type # Methods from :: ListDatabases -> Rep ListDatabases x # to :: Rep ListDatabases x -> ListDatabases #
Read ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods readsPrec :: Int -> ReadS ListDatabases # readList :: ReadS [ListDatabases] # readPrec :: ReadPrec ListDatabases # readListPrec :: ReadPrec [ListDatabases] #
Show ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods showsPrec :: Int -> ListDatabases -> ShowS # show :: ListDatabases -> String # showList :: [ListDatabases] -> ShowS #
NFData ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods rnf :: ListDatabases -> () #
Eq ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods (==) :: ListDatabases -> ListDatabases -> Bool # (/=) :: ListDatabases -> ListDatabases -> Bool #
Hashable ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods hashWithSalt :: Int -> ListDatabases -> Int # hash :: ListDatabases -> Int #
type AWSResponse ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases type AWSResponse ListDatabases = ListDatabasesResponse
type Rep ListDatabases Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases type Rep ListDatabases = D1 ('MetaData "ListDatabases" "Amazonka.RedshiftData.ListDatabases" "amazonka-redshift-data-2.0-Hy9KEgtH5Bc3altuyuPuYo" 'False) (C1 ('MetaCons "ListDatabases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dbUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "workgroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListDatabases Source #

Arguments

:: Text	`$sel:database:ListDatabases'`
-> ListDatabases

Create a value of ListDatabases with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clusterIdentifier:ListDatabases', listDatabases_clusterIdentifier - The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

$sel:dbUser:ListDatabases', listDatabases_dbUser - The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

$sel:maxResults:ListDatabases', listDatabases_maxResults - The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

ListDatabases, listDatabases_nextToken - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

ListDatabases, listDatabases_secretArn - The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

$sel:workgroupName:ListDatabases', listDatabases_workgroupName - The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

$sel:database:ListDatabases', listDatabases_database - The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Request Lenses

listDatabases_clusterIdentifier :: Lens' ListDatabases (Maybe Text) Source #

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

listDatabases_dbUser :: Lens' ListDatabases (Maybe Text) Source #

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

listDatabases_maxResults :: Lens' ListDatabases (Maybe Natural) Source #

The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.

listDatabases_nextToken :: Lens' ListDatabases (Maybe Text) Source #

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

listDatabases_secretArn :: Lens' ListDatabases (Maybe Text) Source #

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

listDatabases_workgroupName :: Lens' ListDatabases (Maybe Text) Source #

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

listDatabases_database :: Lens' ListDatabases Text Source #

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Destructuring the Response

data ListDatabasesResponse Source #

See: newListDatabasesResponse smart constructor.

Constructors

ListDatabasesResponse'

Fields

databases :: Maybe [Text]
The names of databases.
nextToken :: Maybe Text
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListDatabasesResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Associated Types type Rep ListDatabasesResponse :: Type -> Type # Methods from :: ListDatabasesResponse -> Rep ListDatabasesResponse x # to :: Rep ListDatabasesResponse x -> ListDatabasesResponse #
Read ListDatabasesResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods readsPrec :: Int -> ReadS ListDatabasesResponse # readList :: ReadS [ListDatabasesResponse] # readPrec :: ReadPrec ListDatabasesResponse # readListPrec :: ReadPrec [ListDatabasesResponse] #
Show ListDatabasesResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods showsPrec :: Int -> ListDatabasesResponse -> ShowS # show :: ListDatabasesResponse -> String # showList :: [ListDatabasesResponse] -> ShowS #
NFData ListDatabasesResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods rnf :: ListDatabasesResponse -> () #
Eq ListDatabasesResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases Methods (==) :: ListDatabasesResponse -> ListDatabasesResponse -> Bool # (/=) :: ListDatabasesResponse -> ListDatabasesResponse -> Bool #
type Rep ListDatabasesResponse Source #
Instance details Defined in Amazonka.RedshiftData.ListDatabases type Rep ListDatabasesResponse = D1 ('MetaData "ListDatabasesResponse" "Amazonka.RedshiftData.ListDatabases" "amazonka-redshift-data-2.0-Hy9KEgtH5Bc3altuyuPuYo" 'False) (C1 ('MetaCons "ListDatabasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "databases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDatabasesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDatabasesResponse'`
-> ListDatabasesResponse

Create a value of ListDatabasesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:databases:ListDatabasesResponse', listDatabasesResponse_databases - The names of databases.

ListDatabases, listDatabasesResponse_nextToken - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

$sel:httpStatus:ListDatabasesResponse', listDatabasesResponse_httpStatus - The response's http status code.

Response Lenses

listDatabasesResponse_databases :: Lens' ListDatabasesResponse (Maybe [Text]) Source #

The names of databases.

listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (Maybe Text) Source #

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

listDatabasesResponse_httpStatus :: Lens' ListDatabasesResponse Int Source #

The response's http status code.