| 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.QuickSight.ListNamespaces
Description
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
This operation returns paginated results.
Synopsis
- data ListNamespaces = ListNamespaces' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- awsAccountId :: Text
- newListNamespaces :: Text -> ListNamespaces
- listNamespaces_maxResults :: Lens' ListNamespaces (Maybe Natural)
- listNamespaces_nextToken :: Lens' ListNamespaces (Maybe Text)
- listNamespaces_awsAccountId :: Lens' ListNamespaces Text
- data ListNamespacesResponse = ListNamespacesResponse' {}
- newListNamespacesResponse :: Int -> ListNamespacesResponse
- listNamespacesResponse_namespaces :: Lens' ListNamespacesResponse (Maybe [NamespaceInfoV2])
- listNamespacesResponse_nextToken :: Lens' ListNamespacesResponse (Maybe Text)
- listNamespacesResponse_requestId :: Lens' ListNamespacesResponse (Maybe Text)
- listNamespacesResponse_status :: Lens' ListNamespacesResponse Int
Creating a Request
data ListNamespaces Source #
See: newListNamespaces smart constructor.
Constructors
| ListNamespaces' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListNamespaces |
Create a value of ListNamespaces 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:maxResults:ListNamespaces', listNamespaces_maxResults - The maximum number of results to return.
ListNamespaces, listNamespaces_nextToken - A unique pagination token that can be used in a subsequent request. You
will receive a pagination token in the response body of a previous
ListNameSpaces API call if there is more data that can be returned. To
receive the data, make another ListNamespaces API call with the
returned token to retrieve the next page of data. Each token is valid
for 24 hours. If you try to make a ListNamespaces API call with an
expired token, you will receive a HTTP 400 InvalidNextTokenException
error.
ListNamespaces, listNamespaces_awsAccountId - The ID for the Amazon Web Services account that contains the Amazon
QuickSight namespaces that you want to list.
Request Lenses
listNamespaces_maxResults :: Lens' ListNamespaces (Maybe Natural) Source #
The maximum number of results to return.
listNamespaces_nextToken :: Lens' ListNamespaces (Maybe Text) Source #
A unique pagination token that can be used in a subsequent request. You
will receive a pagination token in the response body of a previous
ListNameSpaces API call if there is more data that can be returned. To
receive the data, make another ListNamespaces API call with the
returned token to retrieve the next page of data. Each token is valid
for 24 hours. If you try to make a ListNamespaces API call with an
expired token, you will receive a HTTP 400 InvalidNextTokenException
error.
listNamespaces_awsAccountId :: Lens' ListNamespaces Text Source #
The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
Destructuring the Response
data ListNamespacesResponse Source #
See: newListNamespacesResponse smart constructor.
Constructors
| ListNamespacesResponse' | |
Fields
| |
Instances
newListNamespacesResponse Source #
Arguments
| :: Int | |
| -> ListNamespacesResponse |
Create a value of ListNamespacesResponse 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:namespaces:ListNamespacesResponse', listNamespacesResponse_namespaces - The information about the namespaces in this Amazon Web Services
account. The response includes the namespace ARN, name, Amazon Web
Services Region, notification email address, creation status, and
identity store.
ListNamespaces, listNamespacesResponse_nextToken - A unique pagination token that can be used in a subsequent request.
Receiving NextToken in your response inticates that there is more data
that can be returned. To receive the data, make another ListNamespaces
API call with the returned token to retrieve the next page of data. Each
token is valid for 24 hours. If you try to make a ListNamespaces API
call with an expired token, you will receive a
HTTP 400 InvalidNextTokenException error.
$sel:requestId:ListNamespacesResponse', listNamespacesResponse_requestId - The Amazon Web Services request ID for this operation.
ListNamespacesResponse, listNamespacesResponse_status - The HTTP status of the request.
Response Lenses
listNamespacesResponse_namespaces :: Lens' ListNamespacesResponse (Maybe [NamespaceInfoV2]) Source #
The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.
listNamespacesResponse_nextToken :: Lens' ListNamespacesResponse (Maybe Text) Source #
A unique pagination token that can be used in a subsequent request.
Receiving NextToken in your response inticates that there is more data
that can be returned. To receive the data, make another ListNamespaces
API call with the returned token to retrieve the next page of data. Each
token is valid for 24 hours. If you try to make a ListNamespaces API
call with an expired token, you will receive a
HTTP 400 InvalidNextTokenException error.
listNamespacesResponse_requestId :: Lens' ListNamespacesResponse (Maybe Text) Source #
The Amazon Web Services request ID for this operation.
listNamespacesResponse_status :: Lens' ListNamespacesResponse Int Source #
The HTTP status of the request.