Lists the identity stores that you have access to. This operation returns only the identity store ID and Amazon Resource Name (ARN) of each identity store. To obtain additional information about an identity store, call DescribeIdentityStore.
This operation returns results in paginated form. Use the NextToken parameter to retrieve additional pages of results.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return per request. This parameter is used in all List operations to specify how many results to return on one page. If you don't specify a value, the operation uses a default page size.
-
next_token
(Optional[NextToken], default:
None
)
–
The pagination token used for the ListIdentityStores API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.
Raises:
Source code in docs_src/capo_identitystore/_services/identitystore.py
| def list_identity_stores(
self,
*,
config_overrides: Optional[identitystoreClientConfig] = None,
max_results: Optional["capo_identitystore.types.max_results.MaxResults"] = None,
next_token: Optional["capo_identitystore.types.next_token.NextToken"] = None,
) -> "capo_identitystore.types.list_identity_stores_response.ListIdentityStoresResponse":
"""<p>Lists the identity stores that you have access to. This operation returns only the identity store ID and Amazon Resource Name (ARN) of each identity store. To obtain additional information about an identity store, call <code>DescribeIdentityStore</code>.</p> <p>This operation returns results in paginated form. Use the <code>NextToken</code> parameter to retrieve additional pages of results.</p>
Args:
max_results: <p>The maximum number of results to return per request. This parameter is used in all <code> List</code> operations to specify how many results to return on one page. If you don't specify a value, the operation uses a default page size.</p>
next_token: <p>The pagination token used for the <code>ListIdentityStores</code> API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
Raises:
capo_identitystore.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_identitystore.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
capo_identitystore.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
capo_identitystore.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
capo_identitystore.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_identitystore.types.list_identity_stores_request.ListIdentityStoresRequest]",
) -> OperationResponse[
"capo_identitystore.types.list_identity_stores_response.ListIdentityStoresResponse"
]:
import capo_identitystore._operations.aws_identity_store.list_identity_stores
output, http_response = (
capo_identitystore._operations.aws_identity_store.list_identity_stores.list_identity_stores(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListIdentityStores")
)
input_: capo_identitystore.types.list_identity_stores_request.ListIdentityStoresRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|