get_segment_membership ¶

def get_segment_membership(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    segment_definition_name: "capo_customer_profiles.types.name.name",
    profile_ids: "capo_customer_profiles.types.profile_ids.ProfileIds",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
) -> "capo_customer_profiles.types.get_segment_membership_response.GetSegmentMembershipResponse":
    """<p>Determines if the given profiles are within a segment.</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        segment_definition_name: <p>The Id of the wanted segment. Needs to be a valid, and existing segment Id.</p>
        profile_ids: <p>The list of profile IDs to query for.</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_membership_request.GetSegmentMembershipRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.get_segment_membership_response.GetSegmentMembershipResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.get_segment_membership

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

    def _redact_output(
        output: "capo_customer_profiles.types.get_segment_membership_response.GetSegmentMembershipResponse",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.get_segment_membership_response

        return capo_customer_profiles.types.get_segment_membership_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetSegmentMembership", redact_output=_redact_output),
    )
    input_: capo_customer_profiles.types.get_segment_membership_request.GetSegmentMembershipRequest = {
        "domain_name": domain_name,
        "segment_definition_name": segment_definition_name,
        "profile_ids": profile_ids,
    }

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