Skip to content

list_configurations async

list_configurations(
    *,
    config_overrides: Optional[AsyncSSMQuickSetupClientConfig] = None,
    starting_token: Optional[str] = None,
    max_items: Optional[int] = None,
    filters: Optional[FiltersList] = None,
    manager_arn: Optional[str] = None,
    configuration_definition_id: Optional[str] = None,
) -> ListConfigurationsOutput

Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

Parameters:

  • starting_token (Optional[str], default: None ) –

    The token to use when requesting a specific set of items from a list.

  • max_items (Optional[int], default: None ) –

    Specifies the maximum number of configurations that are returned by the request.

  • filters (Optional[FiltersList], default: None ) –

    Filters the results returned by the request.

  • manager_arn (Optional[str], default: None ) –

    The ARN of the configuration manager.

  • configuration_definition_id (Optional[str], default: None ) –

    The ID of the configuration definition.

Raises:

Source code in docs_src/capo_ssm_quicksetup/_services/async_ssm_quick_setup.py
async def list_configurations(
    self,
    *,
    config_overrides: Optional[AsyncSSMQuickSetupClientConfig] = None,
    starting_token: Optional[str] = None,
    max_items: Optional[int] = None,
    filters: Optional["capo_ssm_quicksetup.types.filters_list.FiltersList"] = None,
    manager_arn: Optional[str] = None,
    configuration_definition_id: Optional[str] = None,
) -> (
    "capo_ssm_quicksetup.types.list_configurations_output.ListConfigurationsOutput"
):
    """<p>Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.</p>

    Args:
        starting_token: <p>The token to use when requesting a specific set of items from a list.</p>
        max_items: <p>Specifies the maximum number of configurations that are returned by the request.</p>
        filters: <p>Filters the results returned by the request.</p>
        manager_arn: <p>The ARN of the configuration manager.</p>
        configuration_definition_id: <p>The ID of the configuration definition.</p>

    Raises:
        capo_ssm_quicksetup.errors.access_denied_exception.AccessDeniedException: <p>The requester has insufficient permissions to perform the operation.</p>
        capo_ssm_quicksetup.errors.internal_server_exception.InternalServerException: <p>An error occurred on the server side.</p>
        capo_ssm_quicksetup.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource couldn't be found. Check the ID or name and try again.</p>
        capo_ssm_quicksetup.errors.throttling_exception.ThrottlingException: <p>The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.</p>
        capo_ssm_quicksetup.errors.validation_exception.ValidationException: <p>The request is invalid. Verify the values provided for the request parameters are accurate.</p>
        capo_ssm_quicksetup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm_quicksetup.types.list_configurations_input.ListConfigurationsInput]",
    ) -> AsyncOperationResponse[
        "capo_ssm_quicksetup.types.list_configurations_output.ListConfigurationsOutput"
    ]:
        import capo_ssm_quicksetup._operations.quick_setup.list_configurations

        (
            output,
            http_response,
        ) = await capo_ssm_quicksetup._operations.quick_setup.list_configurations.async_list_configurations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConfigurations")
    )
    input_: capo_ssm_quicksetup.types.list_configurations_input.ListConfigurationsInput = {}
    if starting_token is not None:
        input_["starting_token"] = starting_token
    if max_items is not None:
        input_["max_items"] = max_items
    if filters is not None:
        input_["filters"] = filters
    if manager_arn is not None:
        input_["manager_arn"] = manager_arn
    if configuration_definition_id is not None:
        input_["configuration_definition_id"] = configuration_definition_id

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