Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transfer.TestIdentityProvider

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

If you provide any incorrect values for any parameters, the Response field is empty.
If you provide a server ID for a server that uses service-managed users, you get an error:
An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:
```
An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server
```

Synopsis

data TestIdentityProvider = TestIdentityProvider' {
- serverProtocol :: Maybe Protocol
- sourceIp :: Maybe Text
- userPassword :: Maybe (Sensitive Text)
- serverId :: Text
- userName :: Text
}
newTestIdentityProvider :: Text -> Text -> TestIdentityProvider
testIdentityProvider_serverProtocol :: Lens' TestIdentityProvider (Maybe Protocol)
testIdentityProvider_sourceIp :: Lens' TestIdentityProvider (Maybe Text)
testIdentityProvider_userPassword :: Lens' TestIdentityProvider (Maybe Text)
testIdentityProvider_serverId :: Lens' TestIdentityProvider Text
testIdentityProvider_userName :: Lens' TestIdentityProvider Text
data TestIdentityProviderResponse = TestIdentityProviderResponse' {
- message :: Maybe Text
- response :: Maybe Text
- httpStatus :: Int
- statusCode :: Int
- url :: Text
}
newTestIdentityProviderResponse :: Int -> Int -> Text -> TestIdentityProviderResponse
testIdentityProviderResponse_message :: Lens' TestIdentityProviderResponse (Maybe Text)
testIdentityProviderResponse_response :: Lens' TestIdentityProviderResponse (Maybe Text)
testIdentityProviderResponse_httpStatus :: Lens' TestIdentityProviderResponse Int
testIdentityProviderResponse_statusCode :: Lens' TestIdentityProviderResponse Int
testIdentityProviderResponse_url :: Lens' TestIdentityProviderResponse Text

Creating a Request

data TestIdentityProvider Source #

See: newTestIdentityProvider smart constructor.

Constructors

TestIdentityProvider'

Fields

serverProtocol :: Maybe Protocol
The type of file transfer protocol to be tested.
The available protocols are:
- Secure Shell (SSH) File Transfer Protocol (SFTP)
- File Transfer Protocol Secure (FTPS)
- File Transfer Protocol (FTP)
sourceIp :: Maybe Text
The source IP address of the user account to be tested.
userPassword :: Maybe (Sensitive Text)
The password of the user account to be tested.
serverId :: Text
A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
userName :: Text
The name of the user account to be tested.

Instances

Instances details

ToJSON TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods toJSON :: TestIdentityProvider -> Value # toEncoding :: TestIdentityProvider -> Encoding # toJSONList :: [TestIdentityProvider] -> Value # toEncodingList :: [TestIdentityProvider] -> Encoding #
ToHeaders TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods toHeaders :: TestIdentityProvider -> [Header] #
ToPath TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods toPath :: TestIdentityProvider -> ByteString #
ToQuery TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods toQuery :: TestIdentityProvider -> QueryString #
AWSRequest TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Associated Types type AWSResponse TestIdentityProvider # Methods request :: (Service -> Service) -> TestIdentityProvider -> Request TestIdentityProvider # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestIdentityProvider -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestIdentityProvider))) #
Generic TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Associated Types type Rep TestIdentityProvider :: Type -> Type # Methods from :: TestIdentityProvider -> Rep TestIdentityProvider x # to :: Rep TestIdentityProvider x -> TestIdentityProvider #
Show TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods showsPrec :: Int -> TestIdentityProvider -> ShowS # show :: TestIdentityProvider -> String # showList :: [TestIdentityProvider] -> ShowS #
NFData TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods rnf :: TestIdentityProvider -> () #
Eq TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods (==) :: TestIdentityProvider -> TestIdentityProvider -> Bool # (/=) :: TestIdentityProvider -> TestIdentityProvider -> Bool #
Hashable TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods hashWithSalt :: Int -> TestIdentityProvider -> Int # hash :: TestIdentityProvider -> Int #
type AWSResponse TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider type AWSResponse TestIdentityProvider = TestIdentityProviderResponse
type Rep TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider type Rep TestIdentityProvider = D1 ('MetaData "TestIdentityProvider" "Amazonka.Transfer.TestIdentityProvider" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TestIdentityProvider'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "serverProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protocol)) :: S1 ('MetaSel ('Just "sourceIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "userPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTestIdentityProvider Source #

Arguments

:: Text	`TestIdentityProvider`
-> Text	`TestIdentityProvider`
-> TestIdentityProvider

Create a value of TestIdentityProvider with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:serverProtocol:TestIdentityProvider', testIdentityProvider_serverProtocol - The type of file transfer protocol to be tested.

The available protocols are:

Secure Shell (SSH) File Transfer Protocol (SFTP)
File Transfer Protocol Secure (FTPS)
File Transfer Protocol (FTP)

$sel:sourceIp:TestIdentityProvider', testIdentityProvider_sourceIp - The source IP address of the user account to be tested.

$sel:userPassword:TestIdentityProvider', testIdentityProvider_userPassword - The password of the user account to be tested.

TestIdentityProvider, testIdentityProvider_serverId - A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

TestIdentityProvider, testIdentityProvider_userName - The name of the user account to be tested.

Request Lenses

testIdentityProvider_serverProtocol :: Lens' TestIdentityProvider (Maybe Protocol) Source #

The type of file transfer protocol to be tested.

The available protocols are:

Secure Shell (SSH) File Transfer Protocol (SFTP)
File Transfer Protocol Secure (FTPS)
File Transfer Protocol (FTP)

testIdentityProvider_sourceIp :: Lens' TestIdentityProvider (Maybe Text) Source #

The source IP address of the user account to be tested.

testIdentityProvider_userPassword :: Lens' TestIdentityProvider (Maybe Text) Source #

The password of the user account to be tested.

testIdentityProvider_serverId :: Lens' TestIdentityProvider Text Source #

A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

testIdentityProvider_userName :: Lens' TestIdentityProvider Text Source #

The name of the user account to be tested.

Destructuring the Response

data TestIdentityProviderResponse Source #

See: newTestIdentityProviderResponse smart constructor.

Constructors

TestIdentityProviderResponse'

Fields

message :: Maybe Text
A message that indicates whether the test was successful or not.
If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.
response :: Maybe Text
The response that is returned from your API Gateway.
httpStatus :: Int
The response's http status code.
statusCode :: Int
The HTTP status code that is the response from your API Gateway.
url :: Text
The endpoint of the service used to authenticate a user.

Instances

Instances details

Generic TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Associated Types type Rep TestIdentityProviderResponse :: Type -> Type # Methods from :: TestIdentityProviderResponse -> Rep TestIdentityProviderResponse x # to :: Rep TestIdentityProviderResponse x -> TestIdentityProviderResponse #
Read TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods readsPrec :: Int -> ReadS TestIdentityProviderResponse # readList :: ReadS [TestIdentityProviderResponse] # readPrec :: ReadPrec TestIdentityProviderResponse # readListPrec :: ReadPrec [TestIdentityProviderResponse] #
Show TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods showsPrec :: Int -> TestIdentityProviderResponse -> ShowS # show :: TestIdentityProviderResponse -> String # showList :: [TestIdentityProviderResponse] -> ShowS #
NFData TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods rnf :: TestIdentityProviderResponse -> () #
Eq TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods (==) :: TestIdentityProviderResponse -> TestIdentityProviderResponse -> Bool # (/=) :: TestIdentityProviderResponse -> TestIdentityProviderResponse -> Bool #
type Rep TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider type Rep TestIdentityProviderResponse = D1 ('MetaData "TestIdentityProviderResponse" "Amazonka.Transfer.TestIdentityProvider" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TestIdentityProviderResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "response") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTestIdentityProviderResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestIdentityProviderResponse'`
-> Int	`$sel:statusCode:TestIdentityProviderResponse'`
-> Text	`TestIdentityProviderResponse`
-> TestIdentityProviderResponse

Create a value of TestIdentityProviderResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TestIdentityProviderResponse, testIdentityProviderResponse_message - A message that indicates whether the test was successful or not.

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

$sel:response:TestIdentityProviderResponse', testIdentityProviderResponse_response - The response that is returned from your API Gateway.

$sel:httpStatus:TestIdentityProviderResponse', testIdentityProviderResponse_httpStatus - The response's http status code.

$sel:statusCode:TestIdentityProviderResponse', testIdentityProviderResponse_statusCode - The HTTP status code that is the response from your API Gateway.

TestIdentityProviderResponse, testIdentityProviderResponse_url - The endpoint of the service used to authenticate a user.

Response Lenses

testIdentityProviderResponse_message :: Lens' TestIdentityProviderResponse (Maybe Text) Source #

A message that indicates whether the test was successful or not.

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

testIdentityProviderResponse_response :: Lens' TestIdentityProviderResponse (Maybe Text) Source #

The response that is returned from your API Gateway.

testIdentityProviderResponse_httpStatus :: Lens' TestIdentityProviderResponse Int Source #

The response's http status code.

testIdentityProviderResponse_statusCode :: Lens' TestIdentityProviderResponse Int Source #

The HTTP status code that is the response from your API Gateway.

testIdentityProviderResponse_url :: Lens' TestIdentityProviderResponse Text Source #

The endpoint of the service used to authenticate a user.