list_segment_definitions ¶

def list_segment_definitions(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    max_results: Optional[
        "capo_customer_profiles.types.max_size500.MaxSize500"
    ] = None,
    next_token: Optional["capo_customer_profiles.types.token.token"] = None,
) -> "capo_customer_profiles.types.list_segment_definitions_response.ListSegmentDefinitionsResponse":
    """<p>Lists all segment definitions under a domain.</p>

    Args:
        domain_name: <p>The unique identifier of the domain.</p>
        max_results: <p>The maximum number of objects returned per page.</p>
        next_token: <p>The pagination token from the previous call. </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.list_segment_definitions_request.ListSegmentDefinitionsRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.list_segment_definitions_response.ListSegmentDefinitionsResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.list_segment_definitions

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

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

        return capo_customer_profiles.types.list_segment_definitions_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListSegmentDefinitions", redact_output=_redact_output),
    )
    input_: capo_customer_profiles.types.list_segment_definitions_request.ListSegmentDefinitionsRequest = {
        "domain_name": domain_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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