Skip to content

create_listing_change_set

create_listing_change_set(
    domain_identifier: DomainId,
    entity_identifier: EntityIdentifier,
    entity_type: EntityType,
    action: ChangeAction,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    entity_revision: Optional[Revision] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateListingChangeSetOutput

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the Amazon DataZone domain.

  • entity_identifier (EntityIdentifier) –

    The ID of the asset.

  • entity_type (EntityType) –

    The type of an entity.

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

    The revision of an asset.

  • action (ChangeAction) –

    Specifies whether to publish or unpublish a listing.

  • client_token (Optional[ClientToken], default: None ) –

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def create_listing_change_set(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    entity_identifier: "capo_datazone.types.entity_identifier.EntityIdentifier",
    entity_type: "capo_datazone.types.entity_type.EntityType",
    action: "capo_datazone.types.change_action.ChangeAction",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    entity_revision: Optional["capo_datazone.types.revision.Revision"] = None,
    client_token: Optional["capo_datazone.types.client_token.ClientToken"] = None,
) -> "capo_datazone.types.create_listing_change_set_output.CreateListingChangeSetOutput":
    """<p>Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog. </p>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain.</p>
        entity_identifier: <p>The ID of the asset.</p>
        entity_type: <p>The type of an entity.</p>
        entity_revision: <p>The revision of an asset.</p>
        action: <p>Specifies whether to publish or unpublish a listing.</p>
        client_token: <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</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.conflict_exception.ConflictException: <p>There is a conflict while performing 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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request has exceeded the specified service quota.</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.create_listing_change_set_input.CreateListingChangeSetInput]",
    ) -> OperationResponse[
        "capo_datazone.types.create_listing_change_set_output.CreateListingChangeSetOutput"
    ]:
        import capo_datazone._operations.data_zone.create_listing_change_set

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateListingChangeSet")
    )
    input_: capo_datazone.types.create_listing_change_set_input.CreateListingChangeSetInput = {
        "domain_identifier": domain_identifier,
        "entity_identifier": entity_identifier,
        "entity_type": entity_type,
        "action": action,
    }
    if entity_revision is not None:
        input_["entity_revision"] = entity_revision
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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