batch_read `async` ¶

batch_read(
    directory_arn: Arn,
    operations: BatchReadOperationList,
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
    consistency_level: Optional[ConsistencyLevel] = None,
) -> BatchReadResponse

Performs all the read operations in a batch.

Parameters:

directory_arn (Arn) –

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.
operations (BatchReadOperationList) –

A list of operations that are part of the batch.
consistency_level (Optional[ConsistencyLevel], default: None ) –

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

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.
DirectoryNotEnabledException –

Operations are only permitted on enabled directories.
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.
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 run a batch read command

>>> await client.batch_read(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', operations=[], consistency_level='EVENTUAL')

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

async def batch_read(
    self,
    directory_arn: "capo_clouddirectory.types.arn.Arn",
    operations: "capo_clouddirectory.types.batch_read_operation_list.BatchReadOperationList",
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
    consistency_level: Optional[
        "capo_clouddirectory.types.consistency_level.ConsistencyLevel"
    ] = None,
) -> "capo_clouddirectory.types.batch_read_response.BatchReadResponse":
    """<p>Performs all the read operations in a batch. </p>

    Args:
        directory_arn: <p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>
        operations: <p>A list of operations that are part of the batch.</p>
        consistency_level: <p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</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.directory_not_enabled_exception.DirectoryNotEnabledException: <p>Operations are only permitted on enabled directories.</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.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 run a batch read command

        >>> await client.batch_read(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', operations=[], consistency_level='EVENTUAL')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.batch_read_request.BatchReadRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.batch_read_response.BatchReadResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.batch_read

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchRead")
    )
    input_: capo_clouddirectory.types.batch_read_request.BatchReadRequest = {
        "directory_arn": directory_arn,
        "operations": operations,
    }
    if consistency_level is not None:
        input_["consistency_level"] = consistency_level

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

batch_read async ¶

batch_read `async` ¶