list_components async ¶

async def list_components(
    self,
    *,
    config_overrides: Optional[AsyncProtonClientConfig] = None,
    next_token: Optional["capo_proton.types.next_token.NextToken"] = None,
    environment_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
    service_name: Optional["capo_proton.types.resource_name.ResourceName"] = None,
    service_instance_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
    max_results: Optional[
        "capo_proton.types.max_page_results.MaxPageResults"
    ] = None,
) -> "capo_proton.types.list_components_output.ListComponentsOutput":
    """<p>List components with summary data. You can filter the result list by environment, service, or a single service instance.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>

    Args:
        next_token: <p>A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.</p>
        environment_name: <p>The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.</p>
        service_name: <p>The name of a service for result list filtering. Proton returns components attached to service instances of the service.</p>
        service_instance_name: <p>The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.</p>
        max_results: <p>The maximum number of components to list.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_proton.types.list_components_input.ListComponentsInput]",
    ) -> AsyncOperationResponse[
        "capo_proton.types.list_components_output.ListComponentsOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.list_components

        (
            output,
            http_response,
        ) = await capo_proton._operations.aws_proton20200720.list_components.async_list_components(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_proton.types.list_components_output.ListComponentsOutput",
    ) -> dict[str, Any]:
        import capo_proton.types.list_components_output

        return capo_proton.types.list_components_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListComponents", redact_output=_redact_output),
    )
    input_: capo_proton.types.list_components_input.ListComponentsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if environment_name is not None:
        input_["environment_name"] = environment_name
    if service_name is not None:
        input_["service_name"] = service_name
    if service_instance_name is not None:
        input_["service_instance_name"] = service_instance_name
    if max_results is not None:
        input_["max_results"] = max_results

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