Skip to content

describe_container

describe_container(
    *,
    config_overrides: Optional[MediaStoreClientConfig] = None,
    container_name: Optional[ContainerName] = None,
) -> DescribeContainerOutput

Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers.

Parameters:

Raises:

Source code in docs_src/capo_mediastore/_services/media_store.py
def describe_container(
    self,
    *,
    config_overrides: Optional[MediaStoreClientConfig] = None,
    container_name: Optional[
        "capo_mediastore.types.container_name.ContainerName"
    ] = None,
) -> "capo_mediastore.types.describe_container_output.DescribeContainerOutput":
    """<p>Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The <code>DescribeContainer</code> request returns a single <code>Container</code> object based on <code>ContainerName</code>. To return all <code>Container</code> objects that are associated with a specified AWS account, use <a>ListContainers</a>.</p>

    Args:
        container_name: <p>The name of the container to query.</p>

    Raises:
        capo_mediastore.errors.container_not_found_exception.ContainerNotFoundException: <p>The container that you specified in the request does not exist.</p>
        capo_mediastore.errors.internal_server_error.InternalServerError: <p>The service is temporarily unavailable.</p>
        capo_mediastore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mediastore.types.describe_container_input.DescribeContainerInput]",
    ) -> OperationResponse[
        "capo_mediastore.types.describe_container_output.DescribeContainerOutput"
    ]:
        import capo_mediastore._operations.media_store_20170901.describe_container

        output, http_response = (
            capo_mediastore._operations.media_store_20170901.describe_container.describe_container(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeContainer")
    )
    input_: capo_mediastore.types.describe_container_input.DescribeContainerInput = {}
    if container_name is not None:
        input_["container_name"] = container_name

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