Skip to content

get_segment_snapshot

get_segment_snapshot(
    domain_name: name,
    segment_definition_name: name,
    snapshot_id: uuid,
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> GetSegmentSnapshotResponse

Retrieve the latest status of a segment snapshot.

Parameters:

  • domain_name (name) –

    The unique identifier of the domain.

  • segment_definition_name (name) –

    The unique name of the segment definition.

  • snapshot_id (uuid) –

    The unique identifier of the segment snapshot.

Raises:

Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
def get_segment_snapshot(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    segment_definition_name: "capo_customer_profiles.types.name.name",
    snapshot_id: "capo_customer_profiles.types.uuid.uuid",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> "capo_customer_profiles.types.get_segment_snapshot_response.GetSegmentSnapshotResponse":
    """<p>Retrieve the latest status of a segment snapshot.</p>

    Args:
        domain_name: <p>The unique identifier of the domain.</p>
        segment_definition_name: <p>The unique name of the segment definition.</p>
        snapshot_id: <p>The unique identifier of the segment snapshot.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.get_segment_snapshot_request.GetSegmentSnapshotRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.get_segment_snapshot_response.GetSegmentSnapshotResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.get_segment_snapshot

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.get_segment_snapshot.get_segment_snapshot(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSegmentSnapshot")
    )
    input_: capo_customer_profiles.types.get_segment_snapshot_request.GetSegmentSnapshotRequest = {
        "domain_name": domain_name,
        "segment_definition_name": segment_definition_name,
        "snapshot_id": snapshot_id,
    }

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