Skip to content

get_data_lake_namespace

get_data_lake_namespace(
    instance_id: UUID,
    name: DataLakeNamespaceName,
    *,
    config_overrides: Optional[SupplyChainClientConfig] = None,
) -> GetDataLakeNamespaceResponse

Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.

Parameters:

Raises:

Examples:

Get properties of an existing AWS Supply Chain namespace

>>> client.get_data_lake_namespace(instance_id='1877dd20-dee9-4639-8e99-cb67acf21fe5', name='my_namespace')
Get proporties of an existing pre-defined AWS Supply Chain namespace
>>> client.get_data_lake_namespace(instance_id='1877dd20-dee9-4639-8e99-cb67acf21fe5', name='asc')
Source code in docs_src/capo_supplychain/_services/supply_chain.py
def get_data_lake_namespace(
    self,
    instance_id: "capo_supplychain.types.uuid.UUID",
    name: "capo_supplychain.types.data_lake_namespace_name.DataLakeNamespaceName",
    *,
    config_overrides: Optional[SupplyChainClientConfig] = None,
) -> "capo_supplychain.types.get_data_lake_namespace_response.GetDataLakeNamespaceResponse":
    """<p>Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.</p>

    Args:
        instance_id: <p>The Amazon Web Services Supply Chain instance identifier.</p>
        name: <p>The name of the namespace. Besides the namespaces user created, you can also specify the pre-defined namespaces:</p> <ul> <li> <p> <b>asc</b> - Pre-defined namespace containing Amazon Web Services Supply Chain supported datasets, see <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html</a>.</p> </li> <li> <p> <b>default</b> - Pre-defined namespace containing datasets with custom user-defined schemas.</p> </li> </ul>

    Raises:
        capo_supplychain.errors.access_denied_exception.AccessDeniedException: <p>You do not have the required privileges to perform this action.</p>
        capo_supplychain.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_supplychain.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_supplychain.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_supplychain.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_supplychain.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_supplychain.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an AWS service.</p>
        capo_supplychain.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get properties of an existing AWS Supply Chain namespace

        >>> client.get_data_lake_namespace(instance_id='1877dd20-dee9-4639-8e99-cb67acf21fe5', name='my_namespace')
        Get proporties of an existing pre-defined AWS Supply Chain namespace

        >>> client.get_data_lake_namespace(instance_id='1877dd20-dee9-4639-8e99-cb67acf21fe5', name='asc')
    """

    def _handler(
        req: "OperationRequest[capo_supplychain.types.get_data_lake_namespace_request.GetDataLakeNamespaceRequest]",
    ) -> OperationResponse[
        "capo_supplychain.types.get_data_lake_namespace_response.GetDataLakeNamespaceResponse"
    ]:
        import capo_supplychain._operations.galaxy_public_api_gateway.get_data_lake_namespace

        output, http_response = (
            capo_supplychain._operations.galaxy_public_api_gateway.get_data_lake_namespace.get_data_lake_namespace(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDataLakeNamespace")
    )
    input_: capo_supplychain.types.get_data_lake_namespace_request.GetDataLakeNamespaceRequest = {
        "instance_id": instance_id,
        "name": name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output