Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
-
next_token
(Optional[NextToken], default:
None
)
–
Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
Raises:
-
AccessDeniedException
–
You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
-
InternalServerException
–
The request processing has failed because of an unknown error, exception or failure with an internal server.
-
ThrottlingException
–
The limit on the number of requests per second was exceeded.
-
ValidationException
–
An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_pca_connector_ad/_services/async_pca_connector_ad.py
| async def list_directory_registrations(
self,
*,
config_overrides: Optional[AsyncPcaConnectorAdClientConfig] = None,
max_results: Optional[
"capo_pca_connector_ad.types.max_results.MaxResults"
] = None,
next_token: Optional["capo_pca_connector_ad.types.next_token.NextToken"] = None,
) -> "capo_pca_connector_ad.types.list_directory_registrations_response.ListDirectoryRegistrationsResponse":
"""<p>Lists the directory registrations that you created by using the <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration</a> action.</p>
Args:
max_results: <p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>
next_token: <p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>
Raises:
capo_pca_connector_ad.errors.access_denied_exception.AccessDeniedException: <p>You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account. </p>
capo_pca_connector_ad.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_pca_connector_ad.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded. </p>
capo_pca_connector_ad.errors.validation_exception.ValidationException: <p>An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid. </p>
capo_pca_connector_ad.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_pca_connector_ad.types.list_directory_registrations_request.ListDirectoryRegistrationsRequest]",
) -> AsyncOperationResponse[
"capo_pca_connector_ad.types.list_directory_registrations_response.ListDirectoryRegistrationsResponse"
]:
import capo_pca_connector_ad._operations.pca_connector_ad.list_directory_registrations
(
output,
http_response,
) = await capo_pca_connector_ad._operations.pca_connector_ad.list_directory_registrations.async_list_directory_registrations(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListDirectoryRegistrations")
)
input_: capo_pca_connector_ad.types.list_directory_registrations_request.ListDirectoryRegistrationsRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|