Skip to content

describe_entity

describe_entity(
    catalog: Catalog,
    entity_id: ResourceId,
    *,
    config_overrides: Optional[MarketplaceCatalogClientConfig] = None,
) -> DescribeEntityResponse

Returns the metadata and content of the entity.

Parameters:

  • catalog (Catalog) –

    Required. The catalog related to the request. Fixed value: AWSMarketplace

  • entity_id (ResourceId) –

    Required. The unique ID of the entity to describe.

Raises:

Source code in docs_src/capo_marketplace_catalog/_services/marketplace_catalog.py
def describe_entity(
    self,
    catalog: "capo_marketplace_catalog.types.catalog.Catalog",
    entity_id: "capo_marketplace_catalog.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[MarketplaceCatalogClientConfig] = None,
) -> (
    "capo_marketplace_catalog.types.describe_entity_response.DescribeEntityResponse"
):
    """<p>Returns the metadata and content of the entity.</p>

    Args:
        catalog: <p>Required. The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>
        entity_id: <p>Required. The unique ID of the entity to describe.</p>

    Raises:
        capo_marketplace_catalog.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p> <p>HTTP status code: 403</p>
        capo_marketplace_catalog.errors.internal_service_exception.InternalServiceException: <p>There was an internal service exception.</p> <p>HTTP status code: 500</p>
        capo_marketplace_catalog.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource wasn't found.</p> <p>HTTP status code: 404</p>
        capo_marketplace_catalog.errors.resource_not_supported_exception.ResourceNotSupportedException: <p>Currently, the specified resource is not supported.</p>
        capo_marketplace_catalog.errors.throttling_exception.ThrottlingException: <p>Too many requests.</p> <p>HTTP status code: 429</p>
        capo_marketplace_catalog.errors.validation_exception.ValidationException: <p>An error occurred during validation.</p> <p>HTTP status code: 422</p>
        capo_marketplace_catalog.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_marketplace_catalog.types.describe_entity_request.DescribeEntityRequest]",
    ) -> OperationResponse[
        "capo_marketplace_catalog.types.describe_entity_response.DescribeEntityResponse"
    ]:
        import capo_marketplace_catalog._operations.awsmp_seymour.describe_entity

        output, http_response = (
            capo_marketplace_catalog._operations.awsmp_seymour.describe_entity.describe_entity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEntity")
    )
    input_: capo_marketplace_catalog.types.describe_entity_request.DescribeEntityRequest = {
        "catalog": catalog,
        "entity_id": entity_id,
    }

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