describe_parameters async ¶

async def describe_parameters(
    self,
    parameter_group_name: "capo_dax.types.string.String",
    *,
    config_overrides: Optional[AsyncDAXClientConfig] = None,
    source: Optional["capo_dax.types.string.String"] = None,
    max_results: Optional["capo_dax.types.integer_optional.IntegerOptional"] = None,
    next_token: Optional["capo_dax.types.string.String"] = None,
) -> "capo_dax.types.describe_parameters_response.DescribeParametersResponse":
    """<p>Returns the detailed parameter list for a particular parameter group.</p>

    Args:
        parameter_group_name: <p>The name of the parameter group.</p>
        source: <p>How the parameter is defined. For example, <code>system</code> denotes a system-defined parameter.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_dax.types.describe_parameters_request.DescribeParametersRequest]",
    ) -> AsyncOperationResponse[
        "capo_dax.types.describe_parameters_response.DescribeParametersResponse"
    ]:
        import capo_dax._operations.amazon_daxv3.describe_parameters

        (
            output,
            http_response,
        ) = await capo_dax._operations.amazon_daxv3.describe_parameters.async_describe_parameters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeParameters")
    )
    input_: capo_dax.types.describe_parameters_request.DescribeParametersRequest = {
        "parameter_group_name": parameter_group_name
    }
    if source is not None:
        input_["source"] = source
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output