Skip to content

describe_app_instance_user_endpoint

describe_app_instance_user_endpoint(
    app_instance_user_arn: String1600,
    endpoint_id: String64,
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
) -> DescribeAppInstanceUserEndpointResponse

Returns the full details of an AppInstanceUserEndpoint.

Parameters:

  • app_instance_user_arn (String1600) –

    The ARN of the AppInstanceUser.

  • endpoint_id (String64) –

    The unique identifier of the AppInstanceUserEndpoint.

Raises:

Source code in docs_src/capo_chime_sdk_identity/_services/chime_sdk_identity.py
def describe_app_instance_user_endpoint(
    self,
    app_instance_user_arn: "capo_chime_sdk_identity.types.string1600.String1600",
    endpoint_id: "capo_chime_sdk_identity.types.string64.String64",
    *,
    config_overrides: Optional[ChimeSDKIdentityClientConfig] = None,
) -> "capo_chime_sdk_identity.types.describe_app_instance_user_endpoint_response.DescribeAppInstanceUserEndpointResponse":
    """<p>Returns the full details of an <code>AppInstanceUserEndpoint</code>.</p>

    Args:
        app_instance_user_arn: <p>The ARN of the <code>AppInstanceUser</code>.</p>
        endpoint_id: <p>The unique identifier of the <code>AppInstanceUserEndpoint</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.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_identity.types.describe_app_instance_user_endpoint_request.DescribeAppInstanceUserEndpointRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_identity.types.describe_app_instance_user_endpoint_response.DescribeAppInstanceUserEndpointResponse"
    ]:
        import capo_chime_sdk_identity._operations.chime_identity_service.describe_app_instance_user_endpoint

        output, http_response = (
            capo_chime_sdk_identity._operations.chime_identity_service.describe_app_instance_user_endpoint.describe_app_instance_user_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_chime_sdk_identity.types.describe_app_instance_user_endpoint_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeAppInstanceUserEndpoint", redact_output=_redact_output
        ),
    )
    input_: capo_chime_sdk_identity.types.describe_app_instance_user_endpoint_request.DescribeAppInstanceUserEndpointRequest = {
        "app_instance_user_arn": app_instance_user_arn,
        "endpoint_id": endpoint_id,
    }

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