Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
Parameters:
-
name
(Optional[string], default:
None
)
–
The name of the variable.
-
next_token
(Optional[string], default:
None
)
–
The next page token of the get variable request.
-
max_results
(Optional[VariablesMaxResults], default:
None
)
–
The max size per page determined for the get variable request.
Raises:
Source code in docs_src/capo_frauddetector/_services/fraud_detector.py
| def get_variables(
self,
*,
config_overrides: Optional[FraudDetectorClientConfig] = None,
name: Optional["capo_frauddetector.types.string.string"] = None,
next_token: Optional["capo_frauddetector.types.string.string"] = None,
max_results: Optional[
"capo_frauddetector.types.variables_max_results.VariablesMaxResults"
] = None,
) -> "capo_frauddetector.types.get_variables_result.GetVariablesResult":
"""<p>Gets all of the variables or the specific variable. This is a paginated API. Providing null <code>maxSizePerPage</code> results in retrieving maximum of 100 records per page. If you provide <code>maxSizePerPage</code> the value must be between 50 and 100. To get the next page result, a provide a pagination token from <code>GetVariablesResult</code> as part of your request. Null pagination token fetches the records from the beginning. </p>
Args:
name: <p>The name of the variable. </p>
next_token: <p>The next page token of the get variable request. </p>
max_results: <p>The max size per page determined for the get variable 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_variables_request.GetVariablesRequest]",
) -> OperationResponse[
"capo_frauddetector.types.get_variables_result.GetVariablesResult"
]:
import capo_frauddetector._operations.aws_hawks_nest_service_facade.get_variables
output, http_response = (
capo_frauddetector._operations.aws_hawks_nest_service_facade.get_variables.get_variables(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetVariables")
)
input_: capo_frauddetector.types.get_variables_request.GetVariablesRequest = {}
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
|