Returns a set of MatchIds that belong to the given domain.
Parameters:
-
next_token
(Optional[token], default:
None
)
–
The pagination token from the previous ListRuleBasedMatches API call.
-
max_results
(Optional[maxSize100], default:
None
)
–
The maximum number of MatchIds returned per page.
-
domain_name
(name)
–
The unique name of the domain.
Raises:
Source code in docs_src/capo_customer_profiles/_services/customer_profiles.py
| def list_rule_based_matches(
self,
domain_name: "capo_customer_profiles.types.name.name",
*,
config_overrides: Optional[CustomerProfilesClientConfig] = None,
next_token: Optional["capo_customer_profiles.types.token.token"] = None,
max_results: Optional[
"capo_customer_profiles.types.max_size100.maxSize100"
] = None,
) -> "capo_customer_profiles.types.list_rule_based_matches_response.ListRuleBasedMatchesResponse":
"""<p>Returns a set of <code>MatchIds</code> that belong to the given domain.</p>
Args:
next_token: <p>The pagination token from the previous <code>ListRuleBasedMatches</code> API call.</p>
max_results: <p>The maximum number of <code>MatchIds</code> returned per page.</p>
domain_name: <p>The unique name of the domain.</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_rule_based_matches_request.ListRuleBasedMatchesRequest]",
) -> OperationResponse[
"capo_customer_profiles.types.list_rule_based_matches_response.ListRuleBasedMatchesResponse"
]:
import capo_customer_profiles._operations.customer_profiles_20200815.list_rule_based_matches
output, http_response = (
capo_customer_profiles._operations.customer_profiles_20200815.list_rule_based_matches.list_rule_based_matches(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListRuleBasedMatches")
)
input_: capo_customer_profiles.types.list_rule_based_matches_request.ListRuleBasedMatchesRequest = {
"domain_name": domain_name
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|