list_directories `async` ¶

list_directories(
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[NumberResults] = None,
    state: Optional[DirectoryState] = None,
) -> ListDirectoriesResponse

Lists directories created within an account.

Parameters:

next_token (Optional[NextToken], default: None ) –

The pagination token.
max_results (Optional[NumberResults], default: None ) –

The maximum number of results to retrieve.
state (Optional[DirectoryState], default: None ) –

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

Raises:

AccessDeniedException –

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
InternalServiceException –

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
InvalidArnException –

Indicates that the provided ARN value is not valid.
InvalidNextTokenException –

Indicates that the NextToken value is not valid.
LimitExceededException –

Indicates that limits are exceeded. See Limits for more information.
RetryableConflictException –

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
ValidationException –

Indicates that your request is malformed in some manner. See the exception message.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To list all directories in your AWS account

>>> await client.list_directories()

Source code in docs_src/capo_clouddirectory/_services/async_cloud_directory.py

async def list_directories(
    self,
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
    next_token: Optional["capo_clouddirectory.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_clouddirectory.types.number_results.NumberResults"
    ] = None,
    state: Optional[
        "capo_clouddirectory.types.directory_state.DirectoryState"
    ] = None,
) -> "capo_clouddirectory.types.list_directories_response.ListDirectoriesResponse":
    """<p>Lists directories created within an account.</p>

    Args:
        next_token: <p>The pagination token.</p>
        max_results: <p>The maximum number of results to retrieve.</p>
        state: <p>The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.</p>

    Raises:
        capo_clouddirectory.errors.access_denied_exception.AccessDeniedException: <p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>
        capo_clouddirectory.errors.internal_service_exception.InternalServiceException: <p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href="http://status.aws.amazon.com/">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>
        capo_clouddirectory.errors.invalid_arn_exception.InvalidArnException: <p>Indicates that the provided ARN value is not valid.</p>
        capo_clouddirectory.errors.invalid_next_token_exception.InvalidNextTokenException: <p>Indicates that the <code>NextToken</code> value is not valid.</p>
        capo_clouddirectory.errors.limit_exceeded_exception.LimitExceededException: <p>Indicates that limits are exceeded. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Limits</a> for more information.</p>
        capo_clouddirectory.errors.retryable_conflict_exception.RetryableConflictException: <p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_clouddirectory.errors.validation_exception.ValidationException: <p>Indicates that your request is malformed in some manner. See the exception message.</p>
        capo_clouddirectory.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list all directories in your AWS account

        >>> await client.list_directories()
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.list_directories_request.ListDirectoriesRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.list_directories_response.ListDirectoriesResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_directories

        (
            output,
            http_response,
        ) = await capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_directories.async_list_directories(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDirectories")
    )
    input_: capo_clouddirectory.types.list_directories_request.ListDirectoriesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if state is not None:
        input_["state"] = state

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_directories async ¶

list_directories `async` ¶