Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account.
Parameters:
-
configuration_aggregator_names
(Optional[ConfigurationAggregatorNameList], default:
None
)
–
The name of the configuration aggregators.
-
next_token
(Optional[String], default:
None
)
–
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
-
limit
(Optional[Limit], default:
None
)
–
The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.
Raises:
Source code in docs_src/capo_config_service/_services/config_service.py
| def describe_configuration_aggregators(
self,
*,
config_overrides: Optional[ConfigServiceClientConfig] = None,
configuration_aggregator_names: Optional[
"capo_config_service.types.configuration_aggregator_name_list.ConfigurationAggregatorNameList"
] = None,
next_token: Optional["capo_config_service.types.string.String"] = None,
limit: Optional["capo_config_service.types.limit.Limit"] = None,
) -> "capo_config_service.types.describe_configuration_aggregators_response.DescribeConfigurationAggregatorsResponse":
"""<p>Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account. </p>
Args:
configuration_aggregator_names: <p>The name of the configuration aggregators.</p>
next_token: <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
limit: <p>The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.</p>
Raises:
capo_config_service.errors.invalid_limit_exception.InvalidLimitException: <p>The specified limit is outside the allowable range.</p>
capo_config_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The specified next token is not valid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results.</p>
capo_config_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.</p>
capo_config_service.errors.no_such_configuration_aggregator_exception.NoSuchConfigurationAggregatorException: <p>You have specified a configuration aggregator that does not exist.</p>
capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_config_service.types.describe_configuration_aggregators_request.DescribeConfigurationAggregatorsRequest]",
) -> OperationResponse[
"capo_config_service.types.describe_configuration_aggregators_response.DescribeConfigurationAggregatorsResponse"
]:
import capo_config_service._operations.starling_dove_service.describe_configuration_aggregators
output, http_response = (
capo_config_service._operations.starling_dove_service.describe_configuration_aggregators.describe_configuration_aggregators(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeConfigurationAggregators")
)
input_: capo_config_service.types.describe_configuration_aggregators_request.DescribeConfigurationAggregatorsRequest = {}
if configuration_aggregator_names is not None:
input_["configuration_aggregator_names"] = configuration_aggregator_names
if next_token is not None:
input_["next_token"] = next_token
if limit is not None:
input_["limit"] = limit
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|