get_keyspace `async` ¶

get_keyspace(
    keyspace_name: KeyspaceName,
    *,
    config_overrides: Optional[AsyncKeyspacesClientConfig] = None,
) -> GetKeyspaceResponse

Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation.

Parameters:

keyspace_name (KeyspaceName) –

The name of the keyspace.

Raises:

AccessDeniedException –

You don't have sufficient access permissions to perform this action.
InternalServerException –

Amazon Keyspaces was unable to fully process this request because of an internal server error.
ResourceNotFoundException –

The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.
ServiceQuotaExceededException –

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
ValidationException –

The operation failed due to an invalid or malformed request.
UnknownServiceError –

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

Source code in docs_src/capo_keyspaces/_services/async_keyspaces.py

async def get_keyspace(
    self,
    keyspace_name: "capo_keyspaces.types.keyspace_name.KeyspaceName",
    *,
    config_overrides: Optional[AsyncKeyspacesClientConfig] = None,
) -> "capo_keyspaces.types.get_keyspace_response.GetKeyspaceResponse":
    """<p>Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an <code>UpdateKeyspace</code> operation.</p>

    Args:
        keyspace_name: <p>The name of the keyspace.</p>

    Raises:
        capo_keyspaces.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access permissions to perform this action. </p>
        capo_keyspaces.errors.internal_server_exception.InternalServerException: <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
        capo_keyspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
        capo_keyspaces.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
        capo_keyspaces.errors.validation_exception.ValidationException: <p>The operation failed due to an invalid or malformed request.</p>
        capo_keyspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_keyspaces.types.get_keyspace_request.GetKeyspaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_keyspaces.types.get_keyspace_response.GetKeyspaceResponse"
    ]:
        import capo_keyspaces._operations.keyspaces_service.get_keyspace

        (
            output,
            http_response,
        ) = await capo_keyspaces._operations.keyspaces_service.get_keyspace.async_get_keyspace(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetKeyspace")
    )
    input_: capo_keyspaces.types.get_keyspace_request.GetKeyspaceRequest = {
        "keyspace_name": keyspace_name
    }

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

get_keyspace async ¶

get_keyspace `async` ¶