Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameters:
-
name
(Optional[identifier], default:
None
)
–
The name of the label or labels to get.
-
next_token
(Optional[string], default:
None
)
–
The next token for the subsequent request.
-
max_results
(Optional[labelsMaxResults], default:
None
)
–
The maximum number of objects to return for the request.
Raises:
Source code in docs_src/capo_frauddetector/_services/fraud_detector.py
| def get_labels(
self,
*,
config_overrides: Optional[FraudDetectorClientConfig] = None,
name: Optional["capo_frauddetector.types.identifier.identifier"] = None,
next_token: Optional["capo_frauddetector.types.string.string"] = None,
max_results: Optional[
"capo_frauddetector.types.labels_max_results.labelsMaxResults"
] = None,
) -> "capo_frauddetector.types.get_labels_result.GetLabelsResult":
"""<p>Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null <code>maxResults</code>, this action retrieves a maximum of 50 records per page. If you provide a <code>maxResults</code>, the value must be between 10 and 50. To get the next page results, provide the pagination token from the <code>GetGetLabelsResponse</code> as part of your request. A null pagination token fetches the records from the beginning. </p>
Args:
name: <p>The name of the label or labels to get.</p>
next_token: <p>The next token for the subsequent request.</p>
max_results: <p>The maximum number of objects to return for the request.</p>
Raises:
capo_frauddetector.errors.access_denied_exception.AccessDeniedException: <p>An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as <code>PutExternalModel</code>, that specifies a role that is not in your account.</p>
capo_frauddetector.errors.internal_server_exception.InternalServerException: <p>An exception indicating an internal server error.</p>
capo_frauddetector.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception indicating the specified resource was not found.</p>
capo_frauddetector.errors.throttling_exception.ThrottlingException: <p>An exception indicating a throttling error.</p>
capo_frauddetector.errors.validation_exception.ValidationException: <p>An exception indicating a specified value is not allowed.</p>
capo_frauddetector.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_frauddetector.types.get_labels_request.GetLabelsRequest]",
) -> OperationResponse[
"capo_frauddetector.types.get_labels_result.GetLabelsResult"
]:
import capo_frauddetector._operations.aws_hawks_nest_service_facade.get_labels
output, http_response = (
capo_frauddetector._operations.aws_hawks_nest_service_facade.get_labels.get_labels(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetLabels")
)
input_: capo_frauddetector.types.get_labels_request.GetLabelsRequest = {}
if name is not None:
input_["name"] = 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
|