list_service_instances ¶

def list_service_instances(
    self,
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    service_name: Optional["capo_proton.types.resource_name.ResourceName"] = None,
    next_token: Optional["capo_proton.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_proton.types.max_page_results.MaxPageResults"
    ] = None,
    filters: Optional[
        "capo_proton.types.list_service_instances_filter_list.ListServiceInstancesFilterList"
    ] = None,
    sort_by: Optional[
        "capo_proton.types.list_service_instances_sort_by.ListServiceInstancesSortBy"
    ] = None,
    sort_order: Optional["capo_proton.types.sort_order.SortOrder"] = None,
) -> "capo_proton.types.list_service_instances_output.ListServiceInstancesOutput":
    """<p>List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.</p>

    Args:
        service_name: <p>The name of the service that the service instance belongs to.</p>
        next_token: <p>A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.</p>
        max_results: <p>The maximum number of service instances to list.</p>
        filters: <p>An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.</p>
        sort_by: <p>The field that the result list is sorted by.</p> <p>When you choose to sort by <code>serviceName</code>, service instances within each service are sorted by service instance name.</p> <p>Default: <code>serviceName</code> </p>
        sort_order: <p>Result list sort order.</p> <p>Default: <code>ASCENDING</code> </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.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</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.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.list_service_instances_input.ListServiceInstancesInput]",
    ) -> OperationResponse[
        "capo_proton.types.list_service_instances_output.ListServiceInstancesOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.list_service_instances

        output, http_response = (
            capo_proton._operations.aws_proton20200720.list_service_instances.list_service_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_proton.types.list_service_instances_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListServiceInstances", redact_output=_redact_output),
    )
    input_: capo_proton.types.list_service_instances_input.ListServiceInstancesInput = {}
    if service_name is not None:
        input_["service_name"] = service_name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output