Skip to content

batch_get_attributes_metadata

batch_get_attributes_metadata(
    domain_identifier: DomainId,
    entity_type: AttributeEntityType,
    entity_identifier: EntityId,
    attribute_identifiers: AttributesList,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    entity_revision: Optional[Revision] = None,
) -> BatchGetAttributesMetadataOutput

Gets the attribute metadata.

Parameters:

  • domain_identifier (DomainId) –

    The domain ID where you want to get the attribute metadata.

  • entity_type (AttributeEntityType) –

    The entity type for which you want to get attribute metadata.

  • entity_identifier (EntityId) –

    The entity ID for which you want to get attribute metadata.

  • entity_revision (Optional[Revision], default: None ) –

    The entity revision for which you want to get attribute metadata.

  • attribute_identifiers (AttributesList) –

    The attribute identifier.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def batch_get_attributes_metadata(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    entity_type: "capo_datazone.types.attribute_entity_type.AttributeEntityType",
    entity_identifier: "capo_datazone.types.entity_id.EntityId",
    attribute_identifiers: "capo_datazone.types.attributes_list.AttributesList",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    entity_revision: Optional["capo_datazone.types.revision.Revision"] = None,
) -> "capo_datazone.types.batch_get_attributes_metadata_output.BatchGetAttributesMetadataOutput":
    """<p>Gets the attribute metadata.</p>

    Args:
        domain_identifier: <p>The domain ID where you want to get the attribute metadata.</p>
        entity_type: <p>The entity type for which you want to get attribute metadata.</p>
        entity_identifier: <p>The entity ID for which you want to get attribute metadata.</p>
        entity_revision: <p>The entity revision for which you want to get attribute metadata.</p>
        attribute_identifiers: <p>The attribute identifier.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.batch_get_attributes_metadata_input.BatchGetAttributesMetadataInput]",
    ) -> OperationResponse[
        "capo_datazone.types.batch_get_attributes_metadata_output.BatchGetAttributesMetadataOutput"
    ]:
        import capo_datazone._operations.data_zone.batch_get_attributes_metadata

        output, http_response = (
            capo_datazone._operations.data_zone.batch_get_attributes_metadata.batch_get_attributes_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_datazone.types.batch_get_attributes_metadata_output.BatchGetAttributesMetadataOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.batch_get_attributes_metadata_output

        return capo_datazone.types.batch_get_attributes_metadata_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "BatchGetAttributesMetadata", redact_output=_redact_output
        ),
    )
    input_: capo_datazone.types.batch_get_attributes_metadata_input.BatchGetAttributesMetadataInput = {
        "domain_identifier": domain_identifier,
        "entity_type": entity_type,
        "entity_identifier": entity_identifier,
        "attribute_identifiers": attribute_identifiers,
    }
    if entity_revision is not None:
        input_["entity_revision"] = entity_revision

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