Skip to content

list_app_instances async

list_app_instances(
    *,
    config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAppInstancesResponse

Lists all Amazon Chime AppInstances created under a single AWS account.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of AppInstances that you want to return.

  • next_token (Optional[NextToken], default: None ) –

    The token passed by previous API requests until you reach the maximum number of AppInstances.

Raises:

Source code in docs_src/capo_chime_sdk_identity/_services/async_chime_sdk_identity.py
async def list_app_instances(
    self,
    *,
    config_overrides: Optional[AsyncChimeSDKIdentityClientConfig] = None,
    max_results: Optional[
        "capo_chime_sdk_identity.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_chime_sdk_identity.types.next_token.NextToken"
    ] = None,
) -> "capo_chime_sdk_identity.types.list_app_instances_response.ListAppInstancesResponse":
    """<p>Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS account.</p>

    Args:
        max_results: <p>The maximum number of <code>AppInstance</code>s that you want to return.</p>
        next_token: <p>The token passed by previous API requests until you reach the maximum number of <code>AppInstances</code>.</p>

    Raises:
        capo_chime_sdk_identity.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_identity.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_identity.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_identity.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_identity.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime_sdk_identity.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime_sdk_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_identity.types.list_app_instances_request.ListAppInstancesRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_identity.types.list_app_instances_response.ListAppInstancesResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.list_app_instances

        (
            output,
            http_response,
        ) = await capo_chime_sdk_identity._operations.chime_identity_service.list_app_instances.async_list_app_instances(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_identity.types.list_app_instances_request.ListAppInstancesRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_identity.types.list_app_instances_request

        return capo_chime_sdk_identity.types.list_app_instances_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_chime_sdk_identity.types.list_app_instances_response.ListAppInstancesResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_identity.types.list_app_instances_response

        return capo_chime_sdk_identity.types.list_app_instances_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListAppInstances",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_identity.types.list_app_instances_request.ListAppInstancesRequest = {}
    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