| 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.SSOAdmin.ListInstances
Description
Lists the IAM Identity Center instances that the caller has access to.
This operation returns paginated results.
Synopsis
- data ListInstances = ListInstances' {}
- newListInstances :: ListInstances
- listInstances_maxResults :: Lens' ListInstances (Maybe Natural)
- listInstances_nextToken :: Lens' ListInstances (Maybe Text)
- data ListInstancesResponse = ListInstancesResponse' {
- instances :: Maybe [InstanceMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListInstancesResponse :: Int -> ListInstancesResponse
- listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [InstanceMetadata])
- listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text)
- listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int
Creating a Request
data ListInstances Source #
See: newListInstances smart constructor.
Constructors
| ListInstances' | |
Instances
newListInstances :: ListInstances Source #
Create a value of ListInstances 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:ListInstances', listInstances_maxResults - The maximum number of results to display for the instance.
ListInstances, listInstances_nextToken - The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
Request Lenses
listInstances_maxResults :: Lens' ListInstances (Maybe Natural) Source #
The maximum number of results to display for the instance.
listInstances_nextToken :: Lens' ListInstances (Maybe Text) Source #
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Destructuring the Response
data ListInstancesResponse Source #
See: newListInstancesResponse smart constructor.
Constructors
| ListInstancesResponse' | |
Fields
| |
Instances
newListInstancesResponse Source #
Create a value of ListInstancesResponse 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:instances:ListInstancesResponse', listInstancesResponse_instances - Lists the IAM Identity Center instances that the caller has access to.
ListInstances, listInstancesResponse_nextToken - The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
$sel:httpStatus:ListInstancesResponse', listInstancesResponse_httpStatus - The response's http status code.
Response Lenses
listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [InstanceMetadata]) Source #
Lists the IAM Identity Center instances that the caller has access to.
listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text) Source #
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int Source #
The response's http status code.