start_web_authn_registration async ¶

async def start_web_authn_registration(
    self,
    access_token: "capo_cognito_identity_provider.types.token_model_type.TokenModelType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.start_web_authn_registration_response.StartWebAuthnRegistrationResponse":
    """<p>Requests credential creation options from your user pool for the currently signed-in user. Returns information about the user pool, the user profile, and authentication requirements. Users must provide this information in their request to enroll your application with their passkey provider.</p> <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>

    Args:
        access_token: <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for <code>aws.cognito.signin.user.admin</code>.</p>

    Raises:
        capo_cognito_identity_provider.errors.forbidden_exception.ForbiddenException: <p>This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.</p>
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.limit_exceeded_exception.LimitExceededException: <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.operation_not_enabled_exception.OperationNotEnabledException: <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
        capo_cognito_identity_provider.errors.password_reset_required_exception.PasswordResetRequiredException: <p>This exception is thrown when a password reset is required.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.web_authn_configuration_missing_exception.WebAuthnConfigurationMissingException: <p>This exception is thrown when a user pool doesn't have a configured relying party id or a user pool domain.</p>
        capo_cognito_identity_provider.errors.web_authn_not_enabled_exception.WebAuthnNotEnabledException: <p>This exception is thrown when the passkey feature isn't enabled for the user pool.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity_provider.types.start_web_authn_registration_request.StartWebAuthnRegistrationRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.start_web_authn_registration_response.StartWebAuthnRegistrationResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.start_web_authn_registration

        (
            output,
            http_response,
        ) = await capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.start_web_authn_registration.async_start_web_authn_registration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_cognito_identity_provider.types.start_web_authn_registration_request.StartWebAuthnRegistrationRequest",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.start_web_authn_registration_request

        return capo_cognito_identity_provider.types.start_web_authn_registration_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StartWebAuthnRegistration", redact_input=_redact_input),
    )
    input_: capo_cognito_identity_provider.types.start_web_authn_registration_request.StartWebAuthnRegistrationRequest = {
        "access_token": access_token
    }

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