| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.RedshiftData.ListSchemas
Description
Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:
- Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
- Temporary credentials - specify the cluster identifier, the database
name, and the database user name. Permission to call the
redshift:GetClusterCredentialsoperation is required to use this method.
This operation returns paginated results.
Synopsis
- data ListSchemas = ListSchemas' {}
- newListSchemas :: Text -> Text -> ListSchemas
- listSchemas_dbUser :: Lens' ListSchemas (Maybe Text)
- listSchemas_connectedDatabase :: Lens' ListSchemas (Maybe Text)
- listSchemas_nextToken :: Lens' ListSchemas (Maybe Text)
- listSchemas_secretArn :: Lens' ListSchemas (Maybe Text)
- listSchemas_maxResults :: Lens' ListSchemas (Maybe Natural)
- listSchemas_schemaPattern :: Lens' ListSchemas (Maybe Text)
- listSchemas_clusterIdentifier :: Lens' ListSchemas Text
- listSchemas_database :: Lens' ListSchemas Text
- data ListSchemasResponse = ListSchemasResponse' {}
- newListSchemasResponse :: Int -> ListSchemasResponse
- listSchemasResponse_schemas :: Lens' ListSchemasResponse (Maybe [Text])
- listSchemasResponse_nextToken :: Lens' ListSchemasResponse (Maybe Text)
- listSchemasResponse_httpStatus :: Lens' ListSchemasResponse Int
Creating a Request
data ListSchemas Source #
See: newListSchemas smart constructor.
Constructors
| ListSchemas' | |
Fields
| |
Instances
Create a value of ListSchemas 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:dbUser:ListSchemas', listSchemas_dbUser - The database user name. This parameter is required when authenticating
using temporary credentials.
$sel:connectedDatabase:ListSchemas', listSchemas_connectedDatabase - A database name. The connected database is specified when you connect
with your authentication credentials.
$sel:nextToken:ListSchemas', listSchemas_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:secretArn:ListSchemas', listSchemas_secretArn - The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
$sel:maxResults:ListSchemas', listSchemas_maxResults - The maximum number of schemas to return in the response. If more schemas
exist than fit in one response, then NextToken is returned to page
through the results.
$sel:schemaPattern:ListSchemas', listSchemas_schemaPattern - A pattern to filter results by schema name. Within a schema pattern,
"%" means match any substring of 0 or more characters and "_" means
match any one character. Only schema name entries matching the search
pattern are returned.
$sel:clusterIdentifier:ListSchemas', listSchemas_clusterIdentifier - The cluster identifier. This parameter is required when authenticating
using either Secrets Manager or temporary credentials.
$sel:database:ListSchemas', listSchemas_database - The name of the database that contains the schemas to list. If
ConnectedDatabase is not specified, this is also the database to
connect to with your authentication credentials.
Request Lenses
listSchemas_dbUser :: Lens' ListSchemas (Maybe Text) Source #
The database user name. This parameter is required when authenticating using temporary credentials.
listSchemas_connectedDatabase :: Lens' ListSchemas (Maybe Text) Source #
A database name. The connected database is specified when you connect with your authentication credentials.
listSchemas_nextToken :: Lens' ListSchemas (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.
listSchemas_secretArn :: Lens' ListSchemas (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.
listSchemas_maxResults :: Lens' ListSchemas (Maybe Natural) Source #
The maximum number of schemas to return in the response. If more schemas
exist than fit in one response, then NextToken is returned to page
through the results.
listSchemas_schemaPattern :: Lens' ListSchemas (Maybe Text) Source #
A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.
listSchemas_clusterIdentifier :: Lens' ListSchemas Text Source #
The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
listSchemas_database :: Lens' ListSchemas Text Source #
The name of the database that contains the schemas to list. If
ConnectedDatabase is not specified, this is also the database to
connect to with your authentication credentials.
Destructuring the Response
data ListSchemasResponse Source #
See: newListSchemasResponse smart constructor.
Constructors
| ListSchemasResponse' | |
Fields
| |
Instances
newListSchemasResponse Source #
Arguments
| :: Int | |
| -> ListSchemasResponse |
Create a value of ListSchemasResponse 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:schemas:ListSchemasResponse', listSchemasResponse_schemas - The schemas that match the request pattern.
$sel:nextToken:ListSchemas', listSchemasResponse_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:ListSchemasResponse', listSchemasResponse_httpStatus - The response's http status code.
Response Lenses
listSchemasResponse_schemas :: Lens' ListSchemasResponse (Maybe [Text]) Source #
The schemas that match the request pattern.
listSchemasResponse_nextToken :: Lens' ListSchemasResponse (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.
listSchemasResponse_httpStatus :: Lens' ListSchemasResponse Int Source #
The response's http status code.