Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
Parameters:
-
parameter_group_names
(Optional[ParameterGroupNameList], default:
None
)
–
The names of the parameter groups.
-
max_results
(Optional[IntegerOptional], default:
None
)
–
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
-
next_token
(Optional[String], default:
None
)
–
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
Raises:
Source code in docs_src/capo_dax/_services/dax.py
| def describe_parameter_groups(
self,
*,
config_overrides: Optional[DAXClientConfig] = None,
parameter_group_names: Optional[
"capo_dax.types.parameter_group_name_list.ParameterGroupNameList"
] = None,
max_results: Optional["capo_dax.types.integer_optional.IntegerOptional"] = None,
next_token: Optional["capo_dax.types.string.String"] = None,
) -> "capo_dax.types.describe_parameter_groups_response.DescribeParameterGroupsResponse":
"""<p>Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.</p>
Args:
parameter_group_names: <p>The names of the parameter groups.</p>
max_results: <p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
next_token: <p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>
Raises:
capo_dax.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
capo_dax.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
capo_dax.errors.parameter_group_not_found_fault.ParameterGroupNotFoundFault: <p>The specified parameter group does not exist.</p>
capo_dax.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The specified service linked role (SLR) was not found.</p>
capo_dax.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_dax.types.describe_parameter_groups_request.DescribeParameterGroupsRequest]",
) -> OperationResponse[
"capo_dax.types.describe_parameter_groups_response.DescribeParameterGroupsResponse"
]:
import capo_dax._operations.amazon_daxv3.describe_parameter_groups
output, http_response = (
capo_dax._operations.amazon_daxv3.describe_parameter_groups.describe_parameter_groups(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeParameterGroups")
)
input_: capo_dax.types.describe_parameter_groups_request.DescribeParameterGroupsRequest = {}
if parameter_group_names is not None:
input_["parameter_group_names"] = parameter_group_names
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
|