Skip to content

batch_describe_entities

batch_describe_entities(
    entity_request_list: EntityRequestList,
    *,
    config_overrides: Optional[MarketplaceCatalogClientConfig] = None,
) -> BatchDescribeEntitiesResponse

Returns metadata and content for multiple entities. This is the Batch version of the DescribeEntity API and uses the same IAM permission action as DescribeEntity API.

Parameters:

  • entity_request_list (EntityRequestList) –

    List of entity IDs and the catalogs the entities are present in.

Raises:

Source code in docs_src/capo_marketplace_catalog/_services/marketplace_catalog.py
def batch_describe_entities(
    self,
    entity_request_list: "capo_marketplace_catalog.types.entity_request_list.EntityRequestList",
    *,
    config_overrides: Optional[MarketplaceCatalogClientConfig] = None,
) -> "capo_marketplace_catalog.types.batch_describe_entities_response.BatchDescribeEntitiesResponse":
    """<p>Returns metadata and content for multiple entities. This is the Batch version of the <code>DescribeEntity</code> API and uses the same IAM permission action as <code>DescribeEntity</code> API.</p>

    Args:
        entity_request_list: <p>List of entity IDs and the catalogs the entities are present in.</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.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.batch_describe_entities_request.BatchDescribeEntitiesRequest]",
    ) -> OperationResponse[
        "capo_marketplace_catalog.types.batch_describe_entities_response.BatchDescribeEntitiesResponse"
    ]:
        import capo_marketplace_catalog._operations.awsmp_seymour.batch_describe_entities

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchDescribeEntities")
    )
    input_: capo_marketplace_catalog.types.batch_describe_entities_request.BatchDescribeEntitiesRequest = {
        "entity_request_list": entity_request_list
    }

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