TestIdentityProvider

Source: src/AWS/Transfer/TestIdentityProvider.ts

Runtime binding for transfer:TestIdentityProvider.

Exercises the bound Server’s custom identity provider (API_GATEWAY, AWS_LAMBDA, or AWS_DIRECTORY_SERVICE) with a user name and optional password, returning the provider’s raw response and status code — the ServerId is injected from the binding. The password is Redacted end-to-end (distilled marks UserPassword sensitive). Calling it on a SERVICE_MANAGED server fails with the typed InvalidRequestException. Provide the implementation with Effect.provide(AWS.Transfer.TestIdentityProviderHttp).

Diagnosing Authentication

import * as Redacted from "effect/Redacted";

// init — bind the operation to the server
const testIdentityProvider = yield* AWS.Transfer.TestIdentityProvider(server);

// runtime
const result = yield* testIdentityProvider({
  UserName: "alice",
  UserPassword: Redacted.make("secret"),
  ServerProtocol: "SFTP",
});
yield* Effect.log(`identity provider replied ${result.StatusCode}`);