Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer

Contents

Service Configuration
Errors
Waiters
Operations
Types

Description

Derived from API version 2018-11-05 of the AWS service descriptions, licensed under Apache 2.0.

Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no infrastructure to buy and set up.

Synopsis

defaultService :: Service
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
data UpdateServer = UpdateServer' (Maybe ProtocolDetails) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (NonEmpty Protocol)) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe WorkflowDetails) (Maybe EndpointDetails) Text
newUpdateServer :: Text -> UpdateServer
data UpdateServerResponse = UpdateServerResponse' Int Text
newUpdateServerResponse :: Int -> Text -> UpdateServerResponse
data DeleteServer = DeleteServer' Text
newDeleteServer :: Text -> DeleteServer
data DeleteServerResponse = DeleteServerResponse' {
}
newDeleteServerResponse :: DeleteServerResponse
data CreateWorkflow = CreateWorkflow' (Maybe [WorkflowStep]) (Maybe Text) (Maybe (NonEmpty Tag)) [WorkflowStep]
newCreateWorkflow :: CreateWorkflow
data CreateWorkflowResponse = CreateWorkflowResponse' Int Text
newCreateWorkflowResponse :: Int -> Text -> CreateWorkflowResponse
data DeleteSshPublicKey = DeleteSshPublicKey' Text Text Text
newDeleteSshPublicKey :: Text -> Text -> Text -> DeleteSshPublicKey
data DeleteSshPublicKeyResponse = DeleteSshPublicKeyResponse' {
}
newDeleteSshPublicKeyResponse :: DeleteSshPublicKeyResponse
data ListSecurityPolicies = ListSecurityPolicies' (Maybe Text) (Maybe Natural)
newListSecurityPolicies :: ListSecurityPolicies
data ListSecurityPoliciesResponse = ListSecurityPoliciesResponse' (Maybe Text) Int [Text]
newListSecurityPoliciesResponse :: Int -> ListSecurityPoliciesResponse
data DeleteWorkflow = DeleteWorkflow' Text
newDeleteWorkflow :: Text -> DeleteWorkflow
data DeleteWorkflowResponse = DeleteWorkflowResponse' {
}
newDeleteWorkflowResponse :: DeleteWorkflowResponse
data ListTagsForResource = ListTagsForResource' (Maybe Text) (Maybe Natural) Text
newListTagsForResource :: Text -> ListTagsForResource
data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Int
newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
data SendWorkflowStepState = SendWorkflowStepState' Text Text Text CustomStepStatus
newSendWorkflowStepState :: Text -> Text -> Text -> CustomStepStatus -> SendWorkflowStepState
data SendWorkflowStepStateResponse = SendWorkflowStepStateResponse' Int
newSendWorkflowStepStateResponse :: Int -> SendWorkflowStepStateResponse
data StopServer = StopServer' Text
newStopServer :: Text -> StopServer
data StopServerResponse = StopServerResponse' {
}
newStopServerResponse :: StopServerResponse
data ListUsers = ListUsers' (Maybe Text) (Maybe Natural) Text
newListUsers :: Text -> ListUsers
data ListUsersResponse = ListUsersResponse' (Maybe Text) Int Text [ListedUser]
newListUsersResponse :: Int -> Text -> ListUsersResponse
data DescribeServer = DescribeServer' Text
newDescribeServer :: Text -> DescribeServer
data DescribeServerResponse = DescribeServerResponse' Int DescribedServer
newDescribeServerResponse :: Int -> DescribedServer -> DescribeServerResponse
data DescribeSecurityPolicy = DescribeSecurityPolicy' Text
newDescribeSecurityPolicy :: Text -> DescribeSecurityPolicy
data DescribeSecurityPolicyResponse = DescribeSecurityPolicyResponse' Int DescribedSecurityPolicy
newDescribeSecurityPolicyResponse :: Int -> DescribedSecurityPolicy -> DescribeSecurityPolicyResponse
data ImportSshPublicKey = ImportSshPublicKey' Text Text Text
newImportSshPublicKey :: Text -> Text -> Text -> ImportSshPublicKey
data ImportSshPublicKeyResponse = ImportSshPublicKeyResponse' Int Text Text Text
newImportSshPublicKeyResponse :: Int -> Text -> Text -> Text -> ImportSshPublicKeyResponse
data ListExecutions = ListExecutions' (Maybe Text) (Maybe Natural) Text
newListExecutions :: Text -> ListExecutions
data ListExecutionsResponse = ListExecutionsResponse' (Maybe Text) Int Text [ListedExecution]
newListExecutionsResponse :: Int -> Text -> ListExecutionsResponse
data CreateServer = CreateServer' (Maybe Text) (Maybe (Sensitive Text)) (Maybe IdentityProviderType) (Maybe (NonEmpty Protocol)) (Maybe Domain) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe WorkflowDetails) (Maybe (NonEmpty Tag)) (Maybe EndpointDetails)
newCreateServer :: CreateServer
data CreateServerResponse = CreateServerResponse' Int Text
newCreateServerResponse :: Int -> Text -> CreateServerResponse
data TestIdentityProvider = TestIdentityProvider' (Maybe Protocol) (Maybe (Sensitive Text)) (Maybe Text) Text Text
newTestIdentityProvider :: Text -> Text -> TestIdentityProvider
data TestIdentityProviderResponse = TestIdentityProviderResponse' (Maybe Text) (Maybe Text) Int Int Text
newTestIdentityProviderResponse :: Int -> Int -> Text -> TestIdentityProviderResponse
data ListServers = ListServers' (Maybe Text) (Maybe Natural)
newListServers :: ListServers
data ListServersResponse = ListServersResponse' (Maybe Text) Int [ListedServer]
newListServersResponse :: Int -> ListServersResponse
data DescribeUser = DescribeUser' Text Text
newDescribeUser :: Text -> Text -> DescribeUser
data DescribeUserResponse = DescribeUserResponse' Int Text DescribedUser
newDescribeUserResponse :: Int -> Text -> DescribedUser -> DescribeUserResponse
data DescribeExecution = DescribeExecution' Text Text
newDescribeExecution :: Text -> Text -> DescribeExecution
data DescribeExecutionResponse = DescribeExecutionResponse' Int Text DescribedExecution
newDescribeExecutionResponse :: Int -> Text -> DescribedExecution -> DescribeExecutionResponse
data ListWorkflows = ListWorkflows' (Maybe Text) (Maybe Natural)
newListWorkflows :: ListWorkflows
data ListWorkflowsResponse = ListWorkflowsResponse' (Maybe Text) Int [ListedWorkflow]
newListWorkflowsResponse :: Int -> ListWorkflowsResponse
data CreateUser = CreateUser' (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text Text Text
newCreateUser :: Text -> Text -> Text -> CreateUser
data CreateUserResponse = CreateUserResponse' Int Text Text
newCreateUserResponse :: Int -> Text -> Text -> CreateUserResponse
data StartServer = StartServer' Text
newStartServer :: Text -> StartServer
data StartServerResponse = StartServerResponse' {
}
newStartServerResponse :: StartServerResponse
data UpdateAccess = UpdateAccess' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
newUpdateAccess :: Text -> Text -> UpdateAccess
data UpdateAccessResponse = UpdateAccessResponse' Int Text Text
newUpdateAccessResponse :: Int -> Text -> Text -> UpdateAccessResponse
data DeleteAccess = DeleteAccess' Text Text
newDeleteAccess :: Text -> Text -> DeleteAccess
data DeleteAccessResponse = DeleteAccessResponse' {
}
newDeleteAccessResponse :: DeleteAccessResponse
data CreateAccess = CreateAccess' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) Text Text Text
newCreateAccess :: Text -> Text -> Text -> CreateAccess
data CreateAccessResponse = CreateAccessResponse' Int Text Text
newCreateAccessResponse :: Int -> Text -> Text -> CreateAccessResponse
data ListAccesses = ListAccesses' (Maybe Text) (Maybe Natural) Text
newListAccesses :: Text -> ListAccesses
data ListAccessesResponse = ListAccessesResponse' (Maybe Text) Int Text [ListedAccess]
newListAccessesResponse :: Int -> Text -> ListAccessesResponse
data UpdateUser = UpdateUser' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
newUpdateUser :: Text -> Text -> UpdateUser
data UpdateUserResponse = UpdateUserResponse' Int Text Text
newUpdateUserResponse :: Int -> Text -> Text -> UpdateUserResponse
data DeleteUser = DeleteUser' Text Text
newDeleteUser :: Text -> Text -> DeleteUser
data DeleteUserResponse = DeleteUserResponse' {
}
newDeleteUserResponse :: DeleteUserResponse
data TagResource = TagResource' Text (NonEmpty Tag)
newTagResource :: Text -> NonEmpty Tag -> TagResource
data TagResourceResponse = TagResourceResponse' {
}
newTagResourceResponse :: TagResourceResponse
data UntagResource = UntagResource' Text (NonEmpty Text)
newUntagResource :: Text -> NonEmpty Text -> UntagResource
data UntagResourceResponse = UntagResourceResponse' {
}
newUntagResourceResponse :: UntagResourceResponse
data DescribeWorkflow = DescribeWorkflow' Text
newDescribeWorkflow :: Text -> DescribeWorkflow
data DescribeWorkflowResponse = DescribeWorkflowResponse' Int DescribedWorkflow
newDescribeWorkflowResponse :: Int -> DescribedWorkflow -> DescribeWorkflowResponse
data DescribeAccess = DescribeAccess' Text Text
newDescribeAccess :: Text -> Text -> DescribeAccess
data DescribeAccessResponse = DescribeAccessResponse' Int Text DescribedAccess
newDescribeAccessResponse :: Int -> Text -> DescribedAccess -> DescribeAccessResponse
newtype CustomStepStatus where
- CustomStepStatus' {
  - fromCustomStepStatus :: Text
  }
- pattern CustomStepStatus_FAILURE :: CustomStepStatus
- pattern CustomStepStatus_SUCCESS :: CustomStepStatus
newtype Domain where
- Domain' {
  - fromDomain :: Text
  }
- pattern Domain_EFS :: Domain
- pattern Domain_S3 :: Domain
newtype EndpointType where
- EndpointType' {
  - fromEndpointType :: Text
  }
- pattern EndpointType_PUBLIC :: EndpointType
- pattern EndpointType_VPC :: EndpointType
- pattern EndpointType_VPC_ENDPOINT :: EndpointType
newtype ExecutionErrorType where
- ExecutionErrorType' {
  - fromExecutionErrorType :: Text
  }
- pattern ExecutionErrorType_PERMISSION_DENIED :: ExecutionErrorType
newtype ExecutionStatus where
- ExecutionStatus' {
  - fromExecutionStatus :: Text
  }
- pattern ExecutionStatus_COMPLETED :: ExecutionStatus
- pattern ExecutionStatus_EXCEPTION :: ExecutionStatus
- pattern ExecutionStatus_HANDLING_EXCEPTION :: ExecutionStatus
- pattern ExecutionStatus_IN_PROGRESS :: ExecutionStatus
newtype HomeDirectoryType where
- HomeDirectoryType' {
  - fromHomeDirectoryType :: Text
  }
- pattern HomeDirectoryType_LOGICAL :: HomeDirectoryType
- pattern HomeDirectoryType_PATH :: HomeDirectoryType
newtype IdentityProviderType where
- IdentityProviderType' {
  - fromIdentityProviderType :: Text
  }
- pattern IdentityProviderType_API_GATEWAY :: IdentityProviderType
- pattern IdentityProviderType_AWS_DIRECTORY_SERVICE :: IdentityProviderType
- pattern IdentityProviderType_SERVICE_MANAGED :: IdentityProviderType
newtype OverwriteExisting where
- OverwriteExisting' {
  - fromOverwriteExisting :: Text
  }
- pattern OverwriteExisting_FALSE :: OverwriteExisting
- pattern OverwriteExisting_TRUE :: OverwriteExisting
newtype Protocol where
- Protocol' {
  - fromProtocol :: Text
  }
- pattern Protocol_FTP :: Protocol
- pattern Protocol_FTPS :: Protocol
- pattern Protocol_SFTP :: Protocol
newtype State where
- State' {
  - fromState :: Text
  }
- pattern State_OFFLINE :: State
- pattern State_ONLINE :: State
- pattern State_STARTING :: State
- pattern State_START_FAILED :: State
- pattern State_STOPPING :: State
- pattern State_STOP_FAILED :: State
newtype WorkflowStepType where
- WorkflowStepType' {
  - fromWorkflowStepType :: Text
  }
- pattern WorkflowStepType_COPY :: WorkflowStepType
- pattern WorkflowStepType_CUSTOM :: WorkflowStepType
- pattern WorkflowStepType_DELETE :: WorkflowStepType
- pattern WorkflowStepType_TAG :: WorkflowStepType
data CopyStepDetails = CopyStepDetails' (Maybe InputFileLocation) (Maybe OverwriteExisting) (Maybe Text)
newCopyStepDetails :: CopyStepDetails
data CustomStepDetails = CustomStepDetails' (Maybe Text) (Maybe Natural) (Maybe Text)
newCustomStepDetails :: CustomStepDetails
data DeleteStepDetails = DeleteStepDetails' (Maybe Text)
newDeleteStepDetails :: DeleteStepDetails
data DescribedAccess = DescribedAccess' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newDescribedAccess :: DescribedAccess
data DescribedExecution = DescribedExecution' (Maybe ExecutionStatus) (Maybe Text) (Maybe ExecutionResults) (Maybe FileLocation) (Maybe PosixProfile) (Maybe ServiceMetadata) (Maybe LoggingConfiguration) (Maybe Text)
newDescribedExecution :: DescribedExecution
data DescribedSecurityPolicy = DescribedSecurityPolicy' (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text
newDescribedSecurityPolicy :: Text -> DescribedSecurityPolicy
data DescribedServer = DescribedServer' (Maybe ProtocolDetails) (Maybe Text) (Maybe State) (Maybe IdentityProviderType) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe Domain) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe WorkflowDetails) (Maybe (NonEmpty Tag)) (Maybe EndpointDetails) Text
newDescribedServer :: Text -> DescribedServer
data DescribedUser = DescribedUser' (Maybe [SshPublicKey]) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text
newDescribedUser :: Text -> DescribedUser
data DescribedWorkflow = DescribedWorkflow' (Maybe [WorkflowStep]) (Maybe [WorkflowStep]) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text
newDescribedWorkflow :: Text -> DescribedWorkflow
data EfsFileLocation = EfsFileLocation' (Maybe Text) (Maybe Text)
newEfsFileLocation :: EfsFileLocation
data EndpointDetails = EndpointDetails' (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text)
newEndpointDetails :: EndpointDetails
data ExecutionError = ExecutionError' ExecutionErrorType Text
newExecutionError :: ExecutionErrorType -> Text -> ExecutionError
data ExecutionResults = ExecutionResults' (Maybe (NonEmpty ExecutionStepResult)) (Maybe (NonEmpty ExecutionStepResult))
newExecutionResults :: ExecutionResults
data ExecutionStepResult = ExecutionStepResult' (Maybe WorkflowStepType) (Maybe ExecutionError) (Maybe Text)
newExecutionStepResult :: ExecutionStepResult
data FileLocation = FileLocation' (Maybe EfsFileLocation) (Maybe S3FileLocation)
newFileLocation :: FileLocation
data HomeDirectoryMapEntry = HomeDirectoryMapEntry' Text Text
newHomeDirectoryMapEntry :: Text -> Text -> HomeDirectoryMapEntry
data IdentityProviderDetails = IdentityProviderDetails' (Maybe Text) (Maybe Text) (Maybe Text)
newIdentityProviderDetails :: IdentityProviderDetails
data InputFileLocation = InputFileLocation' (Maybe EfsFileLocation) (Maybe S3InputFileLocation)
newInputFileLocation :: InputFileLocation
data ListedAccess = ListedAccess' (Maybe HomeDirectoryType) (Maybe Text) (Maybe Text) (Maybe Text)
newListedAccess :: ListedAccess
data ListedExecution = ListedExecution' (Maybe ExecutionStatus) (Maybe Text) (Maybe FileLocation) (Maybe ServiceMetadata)
newListedExecution :: ListedExecution
data ListedServer = ListedServer' (Maybe Text) (Maybe State) (Maybe IdentityProviderType) (Maybe Text) (Maybe Domain) (Maybe EndpointType) (Maybe Int) Text
newListedServer :: Text -> ListedServer
data ListedUser = ListedUser' (Maybe HomeDirectoryType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) Text
newListedUser :: Text -> ListedUser
data ListedWorkflow = ListedWorkflow' (Maybe Text) (Maybe Text) (Maybe Text)
newListedWorkflow :: ListedWorkflow
data LoggingConfiguration = LoggingConfiguration' (Maybe Text) (Maybe Text)
newLoggingConfiguration :: LoggingConfiguration
data PosixProfile = PosixProfile' (Maybe [Natural]) Natural Natural
newPosixProfile :: Natural -> Natural -> PosixProfile
data ProtocolDetails = ProtocolDetails' (Maybe Text)
newProtocolDetails :: ProtocolDetails
data S3FileLocation = S3FileLocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newS3FileLocation :: S3FileLocation
data S3InputFileLocation = S3InputFileLocation' (Maybe Text) (Maybe Text)
newS3InputFileLocation :: S3InputFileLocation
data S3Tag = S3Tag' Text Text
newS3Tag :: Text -> Text -> S3Tag
data ServiceMetadata = ServiceMetadata' UserDetails
newServiceMetadata :: UserDetails -> ServiceMetadata
data SshPublicKey = SshPublicKey' POSIX Text Text
newSshPublicKey :: UTCTime -> Text -> Text -> SshPublicKey
data Tag = Tag' Text Text
newTag :: Text -> Text -> Tag
data TagStepDetails = TagStepDetails' (Maybe Text) (Maybe (NonEmpty S3Tag))
newTagStepDetails :: TagStepDetails
data UserDetails = UserDetails' (Maybe Text) Text Text
newUserDetails :: Text -> Text -> UserDetails
data WorkflowDetail = WorkflowDetail' Text Text
newWorkflowDetail :: Text -> Text -> WorkflowDetail
data WorkflowDetails = WorkflowDetails' [WorkflowDetail]
newWorkflowDetails :: WorkflowDetails
data WorkflowStep = WorkflowStep' (Maybe TagStepDetails) (Maybe DeleteStepDetails) (Maybe CopyStepDetails) (Maybe WorkflowStepType) (Maybe CustomStepDetails)
newWorkflowStep :: WorkflowStep

Service Configuration

defaultService :: Service Source #

API version 2018-11-05 of the Amazon Transfer Family SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Transfer.

AccessDeniedException

_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You do not have sufficient access to perform this action.

InvalidRequestException

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

This exception is thrown when the client submits a malformed request.

ConflictException

_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #

This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.

ThrottlingException

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request was denied due to request throttling.

HTTP Status Code: 400

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The NextToken parameter that was passed is invalid.

InternalServiceError

_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError Source #

This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

ResourceExistsException

_ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The requested resource does not exist.

ServiceUnavailableException

_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

UpdateServer

data UpdateServer Source #

See: newUpdateServer smart constructor.

Constructors

UpdateServer' (Maybe ProtocolDetails) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (NonEmpty Protocol)) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe WorkflowDetails) (Maybe EndpointDetails) Text

Instances

Instances details

Eq UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods (==) :: UpdateServer -> UpdateServer -> Bool # (/=) :: UpdateServer -> UpdateServer -> Bool #
Show UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods showsPrec :: Int -> UpdateServer -> ShowS # show :: UpdateServer -> String # showList :: [UpdateServer] -> ShowS #
Generic UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Associated Types type Rep UpdateServer :: Type -> Type # Methods from :: UpdateServer -> Rep UpdateServer x # to :: Rep UpdateServer x -> UpdateServer #
NFData UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods rnf :: UpdateServer -> () #
Hashable UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods hashWithSalt :: Int -> UpdateServer -> Int # hash :: UpdateServer -> Int #
ToJSON UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods toJSON :: UpdateServer -> Value # toEncoding :: UpdateServer -> Encoding # toJSONList :: [UpdateServer] -> Value # toEncodingList :: [UpdateServer] -> Encoding #
AWSRequest UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Associated Types type AWSResponse UpdateServer # Methods request :: UpdateServer -> Request UpdateServer # response :: MonadResource m => Logger -> Service -> Proxy UpdateServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateServer))) #
ToHeaders UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods toHeaders :: UpdateServer -> [Header] #
ToPath UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods toPath :: UpdateServer -> ByteString #
ToQuery UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer Methods toQuery :: UpdateServer -> QueryString #
type Rep UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer type Rep UpdateServer = D1 ('MetaData "UpdateServer" "Amazonka.Transfer.UpdateServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "UpdateServer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "protocolDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolDetails)) :: S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "hostKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol))) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType))))) :: ((S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderDetails)))) :: (S1 ('MetaSel ('Just "workflowDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowDetails)) :: (S1 ('MetaSel ('Just "endpointDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDetails)) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateServer Source #
Instance details Defined in Amazonka.Transfer.UpdateServer type AWSResponse UpdateServer = UpdateServerResponse

newUpdateServer Source #

Arguments

:: Text	`$sel:serverId:UpdateServer'`
-> UpdateServer

Create a value of UpdateServer 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:protocolDetails:UpdateServer', updateServer_protocolDetails - The protocol settings that are configured for your server.

Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

$sel:loggingRole:UpdateServer', updateServer_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

$sel:hostKey:UpdateServer', updateServer_hostKey - The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the Amazon Web ServicesTransfer Family User Guide.

$sel:protocols:UpdateServer', updateServer_protocols - Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

$sel:endpointType:UpdateServer', updateServer_endpointType - The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

$sel:securityPolicyName:UpdateServer', updateServer_securityPolicyName - Specifies the name of the security policy that is attached to the server.

$sel:certificate:UpdateServer', updateServer_certificate - The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

$sel:identityProviderDetails:UpdateServer', updateServer_identityProviderDetails - An array containing all of the information required to call a customer's authentication API method.

$sel:workflowDetails:UpdateServer', updateServer_workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

$sel:endpointDetails:UpdateServer', updateServer_endpointDetails - The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

$sel:serverId:UpdateServer', updateServer_serverId - A system-assigned unique identifier for a server instance that the user account is assigned to.

data UpdateServerResponse Source #

See: newUpdateServerResponse smart constructor.

Constructors

UpdateServerResponse' Int Text

Instances

Instances details

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

newUpdateServerResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateServerResponse'`
-> Text	`$sel:serverId:UpdateServer'`
-> UpdateServerResponse

Create a value of UpdateServerResponse 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:httpStatus:UpdateServerResponse', updateServerResponse_httpStatus - The response's http status code.

$sel:serverId:UpdateServer', updateServerResponse_serverId - A system-assigned unique identifier for a server that the user account is assigned to.

DeleteServer

data DeleteServer Source #

See: newDeleteServer smart constructor.

Constructors

DeleteServer' Text

Instances

Instances details

Eq DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods (==) :: DeleteServer -> DeleteServer -> Bool # (/=) :: DeleteServer -> DeleteServer -> Bool #
Read DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods readsPrec :: Int -> ReadS DeleteServer # readList :: ReadS [DeleteServer] # readPrec :: ReadPrec DeleteServer # readListPrec :: ReadPrec [DeleteServer] #
Show DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods showsPrec :: Int -> DeleteServer -> ShowS # show :: DeleteServer -> String # showList :: [DeleteServer] -> ShowS #
Generic DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Associated Types type Rep DeleteServer :: Type -> Type # Methods from :: DeleteServer -> Rep DeleteServer x # to :: Rep DeleteServer x -> DeleteServer #
NFData DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods rnf :: DeleteServer -> () #
Hashable DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods hashWithSalt :: Int -> DeleteServer -> Int # hash :: DeleteServer -> Int #
ToJSON DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods toJSON :: DeleteServer -> Value # toEncoding :: DeleteServer -> Encoding # toJSONList :: [DeleteServer] -> Value # toEncodingList :: [DeleteServer] -> Encoding #
AWSRequest DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Associated Types type AWSResponse DeleteServer # Methods request :: DeleteServer -> Request DeleteServer # response :: MonadResource m => Logger -> Service -> Proxy DeleteServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteServer))) #
ToHeaders DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods toHeaders :: DeleteServer -> [Header] #
ToPath DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods toPath :: DeleteServer -> ByteString #
ToQuery DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods toQuery :: DeleteServer -> QueryString #
type Rep DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer type Rep DeleteServer = D1 ('MetaData "DeleteServer" "Amazonka.Transfer.DeleteServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteServer Source #
Instance details Defined in Amazonka.Transfer.DeleteServer type AWSResponse DeleteServer = DeleteServerResponse

newDeleteServer Source #

Arguments

:: Text	`$sel:serverId:DeleteServer'`
-> DeleteServer

Create a value of DeleteServer 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:serverId:DeleteServer', deleteServer_serverId - A unique system-assigned identifier for a server instance.

data DeleteServerResponse Source #

See: newDeleteServerResponse smart constructor.

Constructors

DeleteServerResponse'

Instances

Instances details

Eq DeleteServerResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods (==) :: DeleteServerResponse -> DeleteServerResponse -> Bool # (/=) :: DeleteServerResponse -> DeleteServerResponse -> Bool #
Read DeleteServerResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods readsPrec :: Int -> ReadS DeleteServerResponse # readList :: ReadS [DeleteServerResponse] # readPrec :: ReadPrec DeleteServerResponse # readListPrec :: ReadPrec [DeleteServerResponse] #
Show DeleteServerResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods showsPrec :: Int -> DeleteServerResponse -> ShowS # show :: DeleteServerResponse -> String # showList :: [DeleteServerResponse] -> ShowS #
Generic DeleteServerResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Associated Types type Rep DeleteServerResponse :: Type -> Type # Methods from :: DeleteServerResponse -> Rep DeleteServerResponse x # to :: Rep DeleteServerResponse x -> DeleteServerResponse #
NFData DeleteServerResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteServer Methods rnf :: DeleteServerResponse -> () #
type Rep DeleteServerResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteServer type Rep DeleteServerResponse = D1 ('MetaData "DeleteServerResponse" "Amazonka.Transfer.DeleteServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteServerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteServerResponse :: DeleteServerResponse Source #

Create a value of DeleteServerResponse with all optional fields omitted.

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

CreateWorkflow

data CreateWorkflow Source #

See: newCreateWorkflow smart constructor.

Constructors

CreateWorkflow' (Maybe [WorkflowStep]) (Maybe Text) (Maybe (NonEmpty Tag)) [WorkflowStep]

Instances

Instances details

Eq CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods (==) :: CreateWorkflow -> CreateWorkflow -> Bool # (/=) :: CreateWorkflow -> CreateWorkflow -> Bool #
Read CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods readsPrec :: Int -> ReadS CreateWorkflow # readList :: ReadS [CreateWorkflow] # readPrec :: ReadPrec CreateWorkflow # readListPrec :: ReadPrec [CreateWorkflow] #
Show CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods showsPrec :: Int -> CreateWorkflow -> ShowS # show :: CreateWorkflow -> String # showList :: [CreateWorkflow] -> ShowS #
Generic CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Associated Types type Rep CreateWorkflow :: Type -> Type # Methods from :: CreateWorkflow -> Rep CreateWorkflow x # to :: Rep CreateWorkflow x -> CreateWorkflow #
NFData CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods rnf :: CreateWorkflow -> () #
Hashable CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods hashWithSalt :: Int -> CreateWorkflow -> Int # hash :: CreateWorkflow -> Int #
ToJSON CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods toJSON :: CreateWorkflow -> Value # toEncoding :: CreateWorkflow -> Encoding # toJSONList :: [CreateWorkflow] -> Value # toEncodingList :: [CreateWorkflow] -> Encoding #
AWSRequest CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Associated Types type AWSResponse CreateWorkflow # Methods request :: CreateWorkflow -> Request CreateWorkflow # response :: MonadResource m => Logger -> Service -> Proxy CreateWorkflow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkflow))) #
ToHeaders CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods toHeaders :: CreateWorkflow -> [Header] #
ToPath CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods toPath :: CreateWorkflow -> ByteString #
ToQuery CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow Methods toQuery :: CreateWorkflow -> QueryString #
type Rep CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow type Rep CreateWorkflow = D1 ('MetaData "CreateWorkflow" "Amazonka.Transfer.CreateWorkflow" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "CreateWorkflow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WorkflowStep]))))
type AWSResponse CreateWorkflow Source #
Instance details Defined in Amazonka.Transfer.CreateWorkflow type AWSResponse CreateWorkflow = CreateWorkflowResponse

newCreateWorkflow :: CreateWorkflow Source #

Create a value of CreateWorkflow 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:onExceptionSteps:CreateWorkflow', createWorkflow_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

$sel:description:CreateWorkflow', createWorkflow_description - A textual description for the workflow.

$sel:tags:CreateWorkflow', createWorkflow_tags - Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

$sel:steps:CreateWorkflow', createWorkflow_steps - Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.

data CreateWorkflowResponse Source #

See: newCreateWorkflowResponse smart constructor.

Constructors

CreateWorkflowResponse' Int Text

Instances

Instances details

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

newCreateWorkflowResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWorkflowResponse'`
-> Text	`$sel:workflowId:CreateWorkflowResponse'`
-> CreateWorkflowResponse

Create a value of CreateWorkflowResponse 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:httpStatus:CreateWorkflowResponse', createWorkflowResponse_httpStatus - The response's http status code.

$sel:workflowId:CreateWorkflowResponse', createWorkflowResponse_workflowId - A unique identifier for the workflow.

DeleteSshPublicKey

data DeleteSshPublicKey Source #

See: newDeleteSshPublicKey smart constructor.

Constructors

DeleteSshPublicKey' Text Text Text

Instances

Instances details

Eq DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods (==) :: DeleteSshPublicKey -> DeleteSshPublicKey -> Bool # (/=) :: DeleteSshPublicKey -> DeleteSshPublicKey -> Bool #
Read DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods readsPrec :: Int -> ReadS DeleteSshPublicKey # readList :: ReadS [DeleteSshPublicKey] # readPrec :: ReadPrec DeleteSshPublicKey # readListPrec :: ReadPrec [DeleteSshPublicKey] #
Show DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods showsPrec :: Int -> DeleteSshPublicKey -> ShowS # show :: DeleteSshPublicKey -> String # showList :: [DeleteSshPublicKey] -> ShowS #
Generic DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Associated Types type Rep DeleteSshPublicKey :: Type -> Type # Methods from :: DeleteSshPublicKey -> Rep DeleteSshPublicKey x # to :: Rep DeleteSshPublicKey x -> DeleteSshPublicKey #
NFData DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods rnf :: DeleteSshPublicKey -> () #
Hashable DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods hashWithSalt :: Int -> DeleteSshPublicKey -> Int # hash :: DeleteSshPublicKey -> Int #
ToJSON DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods toJSON :: DeleteSshPublicKey -> Value # toEncoding :: DeleteSshPublicKey -> Encoding # toJSONList :: [DeleteSshPublicKey] -> Value # toEncodingList :: [DeleteSshPublicKey] -> Encoding #
AWSRequest DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Associated Types type AWSResponse DeleteSshPublicKey # Methods request :: DeleteSshPublicKey -> Request DeleteSshPublicKey # response :: MonadResource m => Logger -> Service -> Proxy DeleteSshPublicKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteSshPublicKey))) #
ToHeaders DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods toHeaders :: DeleteSshPublicKey -> [Header] #
ToPath DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods toPath :: DeleteSshPublicKey -> ByteString #
ToQuery DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods toQuery :: DeleteSshPublicKey -> QueryString #
type Rep DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey type Rep DeleteSshPublicKey = D1 ('MetaData "DeleteSshPublicKey" "Amazonka.Transfer.DeleteSshPublicKey" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteSshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey type AWSResponse DeleteSshPublicKey = DeleteSshPublicKeyResponse

newDeleteSshPublicKey Source #

Arguments

:: Text	`$sel:serverId:DeleteSshPublicKey'`
-> Text	`$sel:sshPublicKeyId:DeleteSshPublicKey'`
-> Text	`$sel:userName:DeleteSshPublicKey'`
-> DeleteSshPublicKey

Create a value of DeleteSshPublicKey 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:serverId:DeleteSshPublicKey', deleteSshPublicKey_serverId - A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

$sel:sshPublicKeyId:DeleteSshPublicKey', deleteSshPublicKey_sshPublicKeyId - A unique identifier used to reference your user's specific SSH key.

$sel:userName:DeleteSshPublicKey', deleteSshPublicKey_userName - A unique string that identifies a user whose public key is being deleted.

data DeleteSshPublicKeyResponse Source #

See: newDeleteSshPublicKeyResponse smart constructor.

Constructors

DeleteSshPublicKeyResponse'

Instances

Instances details

Eq DeleteSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods (==) :: DeleteSshPublicKeyResponse -> DeleteSshPublicKeyResponse -> Bool # (/=) :: DeleteSshPublicKeyResponse -> DeleteSshPublicKeyResponse -> Bool #
Read DeleteSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods readsPrec :: Int -> ReadS DeleteSshPublicKeyResponse # readList :: ReadS [DeleteSshPublicKeyResponse] # readPrec :: ReadPrec DeleteSshPublicKeyResponse # readListPrec :: ReadPrec [DeleteSshPublicKeyResponse] #
Show DeleteSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods showsPrec :: Int -> DeleteSshPublicKeyResponse -> ShowS # show :: DeleteSshPublicKeyResponse -> String # showList :: [DeleteSshPublicKeyResponse] -> ShowS #
Generic DeleteSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Associated Types type Rep DeleteSshPublicKeyResponse :: Type -> Type # Methods from :: DeleteSshPublicKeyResponse -> Rep DeleteSshPublicKeyResponse x # to :: Rep DeleteSshPublicKeyResponse x -> DeleteSshPublicKeyResponse #
NFData DeleteSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey Methods rnf :: DeleteSshPublicKeyResponse -> () #
type Rep DeleteSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteSshPublicKey type Rep DeleteSshPublicKeyResponse = D1 ('MetaData "DeleteSshPublicKeyResponse" "Amazonka.Transfer.DeleteSshPublicKey" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteSshPublicKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteSshPublicKeyResponse :: DeleteSshPublicKeyResponse Source #

Create a value of DeleteSshPublicKeyResponse with all optional fields omitted.

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

ListSecurityPolicies

data ListSecurityPolicies Source #

See: newListSecurityPolicies smart constructor.

Constructors

ListSecurityPolicies' (Maybe Text) (Maybe Natural)

Instances

Instances details

Eq ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods (==) :: ListSecurityPolicies -> ListSecurityPolicies -> Bool # (/=) :: ListSecurityPolicies -> ListSecurityPolicies -> Bool #
Read ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods readsPrec :: Int -> ReadS ListSecurityPolicies # readList :: ReadS [ListSecurityPolicies] # readPrec :: ReadPrec ListSecurityPolicies # readListPrec :: ReadPrec [ListSecurityPolicies] #
Show ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods showsPrec :: Int -> ListSecurityPolicies -> ShowS # show :: ListSecurityPolicies -> String # showList :: [ListSecurityPolicies] -> ShowS #
Generic ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Associated Types type Rep ListSecurityPolicies :: Type -> Type # Methods from :: ListSecurityPolicies -> Rep ListSecurityPolicies x # to :: Rep ListSecurityPolicies x -> ListSecurityPolicies #
NFData ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods rnf :: ListSecurityPolicies -> () #
Hashable ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods hashWithSalt :: Int -> ListSecurityPolicies -> Int # hash :: ListSecurityPolicies -> Int #
ToJSON ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods toJSON :: ListSecurityPolicies -> Value # toEncoding :: ListSecurityPolicies -> Encoding # toJSONList :: [ListSecurityPolicies] -> Value # toEncodingList :: [ListSecurityPolicies] -> Encoding #
AWSRequest ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Associated Types type AWSResponse ListSecurityPolicies # Methods request :: ListSecurityPolicies -> Request ListSecurityPolicies # response :: MonadResource m => Logger -> Service -> Proxy ListSecurityPolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSecurityPolicies))) #
ToHeaders ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods toHeaders :: ListSecurityPolicies -> [Header] #
ToPath ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods toPath :: ListSecurityPolicies -> ByteString #
ToQuery ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies Methods toQuery :: ListSecurityPolicies -> QueryString #
type Rep ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies type Rep ListSecurityPolicies = D1 ('MetaData "ListSecurityPolicies" "Amazonka.Transfer.ListSecurityPolicies" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListSecurityPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListSecurityPolicies Source #
Instance details Defined in Amazonka.Transfer.ListSecurityPolicies type AWSResponse ListSecurityPolicies = ListSecurityPoliciesResponse

newListSecurityPolicies :: ListSecurityPolicies Source #

Create a value of ListSecurityPolicies 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:nextToken:ListSecurityPolicies', listSecurityPolicies_nextToken - When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.

$sel:maxResults:ListSecurityPolicies', listSecurityPolicies_maxResults - Specifies the number of security policies to return as a response to the ListSecurityPolicies query.

data ListSecurityPoliciesResponse Source #

See: newListSecurityPoliciesResponse smart constructor.

Constructors

ListSecurityPoliciesResponse' (Maybe Text) Int [Text]

Instances

Instances details

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

newListSecurityPoliciesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSecurityPoliciesResponse'`
-> ListSecurityPoliciesResponse

Create a value of ListSecurityPoliciesResponse 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:nextToken:ListSecurityPolicies', listSecurityPoliciesResponse_nextToken - When you can get additional results from the ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies.

$sel:httpStatus:ListSecurityPoliciesResponse', listSecurityPoliciesResponse_httpStatus - The response's http status code.

$sel:securityPolicyNames:ListSecurityPoliciesResponse', listSecurityPoliciesResponse_securityPolicyNames - An array of security policies that were listed.

DeleteWorkflow

data DeleteWorkflow Source #

See: newDeleteWorkflow smart constructor.

Constructors

DeleteWorkflow' Text

Instances

Instances details

Eq DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods (==) :: DeleteWorkflow -> DeleteWorkflow -> Bool # (/=) :: DeleteWorkflow -> DeleteWorkflow -> Bool #
Read DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods readsPrec :: Int -> ReadS DeleteWorkflow # readList :: ReadS [DeleteWorkflow] # readPrec :: ReadPrec DeleteWorkflow # readListPrec :: ReadPrec [DeleteWorkflow] #
Show DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods showsPrec :: Int -> DeleteWorkflow -> ShowS # show :: DeleteWorkflow -> String # showList :: [DeleteWorkflow] -> ShowS #
Generic DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Associated Types type Rep DeleteWorkflow :: Type -> Type # Methods from :: DeleteWorkflow -> Rep DeleteWorkflow x # to :: Rep DeleteWorkflow x -> DeleteWorkflow #
NFData DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods rnf :: DeleteWorkflow -> () #
Hashable DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods hashWithSalt :: Int -> DeleteWorkflow -> Int # hash :: DeleteWorkflow -> Int #
ToJSON DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods toJSON :: DeleteWorkflow -> Value # toEncoding :: DeleteWorkflow -> Encoding # toJSONList :: [DeleteWorkflow] -> Value # toEncodingList :: [DeleteWorkflow] -> Encoding #
AWSRequest DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Associated Types type AWSResponse DeleteWorkflow # Methods request :: DeleteWorkflow -> Request DeleteWorkflow # response :: MonadResource m => Logger -> Service -> Proxy DeleteWorkflow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteWorkflow))) #
ToHeaders DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods toHeaders :: DeleteWorkflow -> [Header] #
ToPath DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods toPath :: DeleteWorkflow -> ByteString #
ToQuery DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods toQuery :: DeleteWorkflow -> QueryString #
type Rep DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow type Rep DeleteWorkflow = D1 ('MetaData "DeleteWorkflow" "Amazonka.Transfer.DeleteWorkflow" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteWorkflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteWorkflow Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow type AWSResponse DeleteWorkflow = DeleteWorkflowResponse

newDeleteWorkflow Source #

Arguments

:: Text	`$sel:workflowId:DeleteWorkflow'`
-> DeleteWorkflow

Create a value of DeleteWorkflow 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:workflowId:DeleteWorkflow', deleteWorkflow_workflowId - A unique identifier for the workflow.

data DeleteWorkflowResponse Source #

See: newDeleteWorkflowResponse smart constructor.

Constructors

DeleteWorkflowResponse'

Instances

Instances details

Eq DeleteWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods (==) :: DeleteWorkflowResponse -> DeleteWorkflowResponse -> Bool # (/=) :: DeleteWorkflowResponse -> DeleteWorkflowResponse -> Bool #
Read DeleteWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods readsPrec :: Int -> ReadS DeleteWorkflowResponse # readList :: ReadS [DeleteWorkflowResponse] # readPrec :: ReadPrec DeleteWorkflowResponse # readListPrec :: ReadPrec [DeleteWorkflowResponse] #
Show DeleteWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods showsPrec :: Int -> DeleteWorkflowResponse -> ShowS # show :: DeleteWorkflowResponse -> String # showList :: [DeleteWorkflowResponse] -> ShowS #
Generic DeleteWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Associated Types type Rep DeleteWorkflowResponse :: Type -> Type # Methods from :: DeleteWorkflowResponse -> Rep DeleteWorkflowResponse x # to :: Rep DeleteWorkflowResponse x -> DeleteWorkflowResponse #
NFData DeleteWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow Methods rnf :: DeleteWorkflowResponse -> () #
type Rep DeleteWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteWorkflow type Rep DeleteWorkflowResponse = D1 ('MetaData "DeleteWorkflowResponse" "Amazonka.Transfer.DeleteWorkflow" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteWorkflowResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteWorkflowResponse :: DeleteWorkflowResponse Source #

Create a value of DeleteWorkflowResponse with all optional fields omitted.

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

ListTagsForResource

data ListTagsForResource Source #

See: newListTagsForResource smart constructor.

Constructors

ListTagsForResource' (Maybe Text) (Maybe Natural) Text

Instances

Instances details

Eq ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods (==) :: ListTagsForResource -> ListTagsForResource -> Bool # (/=) :: ListTagsForResource -> ListTagsForResource -> Bool #
Read ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods readsPrec :: Int -> ReadS ListTagsForResource # readList :: ReadS [ListTagsForResource] # readPrec :: ReadPrec ListTagsForResource # readListPrec :: ReadPrec [ListTagsForResource] #
Show ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods showsPrec :: Int -> ListTagsForResource -> ShowS # show :: ListTagsForResource -> String # showList :: [ListTagsForResource] -> ShowS #
Generic ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Associated Types type Rep ListTagsForResource :: Type -> Type # Methods from :: ListTagsForResource -> Rep ListTagsForResource x # to :: Rep ListTagsForResource x -> ListTagsForResource #
NFData ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods rnf :: ListTagsForResource -> () #
Hashable ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods hashWithSalt :: Int -> ListTagsForResource -> Int # hash :: ListTagsForResource -> Int #
ToJSON ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods toJSON :: ListTagsForResource -> Value # toEncoding :: ListTagsForResource -> Encoding # toJSONList :: [ListTagsForResource] -> Value # toEncodingList :: [ListTagsForResource] -> Encoding #
AWSRequest ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Associated Types type AWSResponse ListTagsForResource # Methods request :: ListTagsForResource -> Request ListTagsForResource # response :: MonadResource m => Logger -> Service -> Proxy ListTagsForResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTagsForResource))) #
ToHeaders ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods toHeaders :: ListTagsForResource -> [Header] #
ToPath ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods toPath :: ListTagsForResource -> ByteString #
ToQuery ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods toQuery :: ListTagsForResource -> QueryString #
type Rep ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.Transfer.ListTagsForResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListTagsForResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListTagsForResource Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource type AWSResponse ListTagsForResource = ListTagsForResourceResponse

newListTagsForResource Source #

Arguments

:: Text	`$sel:arn:ListTagsForResource'`
-> ListTagsForResource

Create a value of ListTagsForResource 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:nextToken:ListTagsForResource', listTagsForResource_nextToken - When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

$sel:maxResults:ListTagsForResource', listTagsForResource_maxResults - Specifies the number of tags to return as a response to the ListTagsForResource request.

$sel:arn:ListTagsForResource', listTagsForResource_arn - Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

data ListTagsForResourceResponse Source #

See: newListTagsForResourceResponse smart constructor.

Constructors

ListTagsForResourceResponse' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Int

Instances

Instances details

Eq ListTagsForResourceResponse Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods (==) :: ListTagsForResourceResponse -> ListTagsForResourceResponse -> Bool # (/=) :: ListTagsForResourceResponse -> ListTagsForResourceResponse -> Bool #
Read ListTagsForResourceResponse Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods readsPrec :: Int -> ReadS ListTagsForResourceResponse # readList :: ReadS [ListTagsForResourceResponse] # readPrec :: ReadPrec ListTagsForResourceResponse # readListPrec :: ReadPrec [ListTagsForResourceResponse] #
Show ListTagsForResourceResponse Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods showsPrec :: Int -> ListTagsForResourceResponse -> ShowS # show :: ListTagsForResourceResponse -> String # showList :: [ListTagsForResourceResponse] -> ShowS #
Generic ListTagsForResourceResponse Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Associated Types type Rep ListTagsForResourceResponse :: Type -> Type # Methods from :: ListTagsForResourceResponse -> Rep ListTagsForResourceResponse x # to :: Rep ListTagsForResourceResponse x -> ListTagsForResourceResponse #
NFData ListTagsForResourceResponse Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource Methods rnf :: ListTagsForResourceResponse -> () #
type Rep ListTagsForResourceResponse Source #
Instance details Defined in Amazonka.Transfer.ListTagsForResource type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.Transfer.ListTagsForResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTagsForResourceResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTagsForResourceResponse'`
-> ListTagsForResourceResponse

Create a value of ListTagsForResourceResponse 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:arn:ListTagsForResource', listTagsForResourceResponse_arn - The ARN you specified to list the tags of.

$sel:nextToken:ListTagsForResource', listTagsForResourceResponse_nextToken - When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.

SendWorkflowStepState

data SendWorkflowStepState Source #

See: newSendWorkflowStepState smart constructor.

Constructors

SendWorkflowStepState' Text Text Text CustomStepStatus

Instances

Instances details

Eq SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods (==) :: SendWorkflowStepState -> SendWorkflowStepState -> Bool # (/=) :: SendWorkflowStepState -> SendWorkflowStepState -> Bool #
Read SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods readsPrec :: Int -> ReadS SendWorkflowStepState # readList :: ReadS [SendWorkflowStepState] # readPrec :: ReadPrec SendWorkflowStepState # readListPrec :: ReadPrec [SendWorkflowStepState] #
Show SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods showsPrec :: Int -> SendWorkflowStepState -> ShowS # show :: SendWorkflowStepState -> String # showList :: [SendWorkflowStepState] -> ShowS #
Generic SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Associated Types type Rep SendWorkflowStepState :: Type -> Type # Methods from :: SendWorkflowStepState -> Rep SendWorkflowStepState x # to :: Rep SendWorkflowStepState x -> SendWorkflowStepState #
NFData SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods rnf :: SendWorkflowStepState -> () #
Hashable SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods hashWithSalt :: Int -> SendWorkflowStepState -> Int # hash :: SendWorkflowStepState -> Int #
ToJSON SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods toJSON :: SendWorkflowStepState -> Value # toEncoding :: SendWorkflowStepState -> Encoding # toJSONList :: [SendWorkflowStepState] -> Value # toEncodingList :: [SendWorkflowStepState] -> Encoding #
AWSRequest SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Associated Types type AWSResponse SendWorkflowStepState # Methods request :: SendWorkflowStepState -> Request SendWorkflowStepState # response :: MonadResource m => Logger -> Service -> Proxy SendWorkflowStepState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendWorkflowStepState))) #
ToHeaders SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods toHeaders :: SendWorkflowStepState -> [Header] #
ToPath SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods toPath :: SendWorkflowStepState -> ByteString #
ToQuery SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState Methods toQuery :: SendWorkflowStepState -> QueryString #
type Rep SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState type Rep SendWorkflowStepState = D1 ('MetaData "SendWorkflowStepState" "Amazonka.Transfer.SendWorkflowStepState" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "SendWorkflowStepState'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CustomStepStatus))))
type AWSResponse SendWorkflowStepState Source #
Instance details Defined in Amazonka.Transfer.SendWorkflowStepState type AWSResponse SendWorkflowStepState = SendWorkflowStepStateResponse

newSendWorkflowStepState Source #

Arguments

:: Text	`$sel:workflowId:SendWorkflowStepState'`
-> Text	`$sel:executionId:SendWorkflowStepState'`
-> Text	`$sel:token:SendWorkflowStepState'`
-> CustomStepStatus	`$sel:status:SendWorkflowStepState'`
-> SendWorkflowStepState

Create a value of SendWorkflowStepState 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:workflowId:SendWorkflowStepState', sendWorkflowStepState_workflowId - A unique identifier for the workflow.

$sel:executionId:SendWorkflowStepState', sendWorkflowStepState_executionId - A unique identifier for the execution of a workflow.

$sel:token:SendWorkflowStepState', sendWorkflowStepState_token - Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.

$sel:status:SendWorkflowStepState', sendWorkflowStepState_status - Indicates whether the specified step succeeded or failed.

data SendWorkflowStepStateResponse Source #

See: newSendWorkflowStepStateResponse smart constructor.

Constructors

SendWorkflowStepStateResponse' Int

Instances

Instances details

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

newSendWorkflowStepStateResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendWorkflowStepStateResponse'`
-> SendWorkflowStepStateResponse

Create a value of SendWorkflowStepStateResponse 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:httpStatus:SendWorkflowStepStateResponse', sendWorkflowStepStateResponse_httpStatus - The response's http status code.

StopServer

data StopServer Source #

See: newStopServer smart constructor.

Constructors

StopServer' Text

Instances

Instances details

Eq StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods (==) :: StopServer -> StopServer -> Bool # (/=) :: StopServer -> StopServer -> Bool #
Read StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods readsPrec :: Int -> ReadS StopServer # readList :: ReadS [StopServer] # readPrec :: ReadPrec StopServer # readListPrec :: ReadPrec [StopServer] #
Show StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods showsPrec :: Int -> StopServer -> ShowS # show :: StopServer -> String # showList :: [StopServer] -> ShowS #
Generic StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Associated Types type Rep StopServer :: Type -> Type # Methods from :: StopServer -> Rep StopServer x # to :: Rep StopServer x -> StopServer #
NFData StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods rnf :: StopServer -> () #
Hashable StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods hashWithSalt :: Int -> StopServer -> Int # hash :: StopServer -> Int #
ToJSON StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toJSON :: StopServer -> Value # toEncoding :: StopServer -> Encoding # toJSONList :: [StopServer] -> Value # toEncodingList :: [StopServer] -> Encoding #
AWSRequest StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Associated Types type AWSResponse StopServer # Methods request :: StopServer -> Request StopServer # response :: MonadResource m => Logger -> Service -> Proxy StopServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopServer))) #
ToHeaders StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toHeaders :: StopServer -> [Header] #
ToPath StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toPath :: StopServer -> ByteString #
ToQuery StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods toQuery :: StopServer -> QueryString #
type Rep StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer type Rep StopServer = D1 ('MetaData "StopServer" "Amazonka.Transfer.StopServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "StopServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopServer Source #
Instance details Defined in Amazonka.Transfer.StopServer type AWSResponse StopServer = StopServerResponse

newStopServer Source #

Arguments

:: Text	`$sel:serverId:StopServer'`
-> StopServer

Create a value of StopServer 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:serverId:StopServer', stopServer_serverId - A system-assigned unique identifier for a server that you stopped.

data StopServerResponse Source #

See: newStopServerResponse smart constructor.

Constructors

StopServerResponse'

Instances

Instances details

Eq StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods (==) :: StopServerResponse -> StopServerResponse -> Bool # (/=) :: StopServerResponse -> StopServerResponse -> Bool #
Read StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods readsPrec :: Int -> ReadS StopServerResponse # readList :: ReadS [StopServerResponse] # readPrec :: ReadPrec StopServerResponse # readListPrec :: ReadPrec [StopServerResponse] #
Show StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods showsPrec :: Int -> StopServerResponse -> ShowS # show :: StopServerResponse -> String # showList :: [StopServerResponse] -> ShowS #
Generic StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Associated Types type Rep StopServerResponse :: Type -> Type # Methods from :: StopServerResponse -> Rep StopServerResponse x # to :: Rep StopServerResponse x -> StopServerResponse #
NFData StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer Methods rnf :: StopServerResponse -> () #
type Rep StopServerResponse Source #
Instance details Defined in Amazonka.Transfer.StopServer type Rep StopServerResponse = D1 ('MetaData "StopServerResponse" "Amazonka.Transfer.StopServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "StopServerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopServerResponse :: StopServerResponse Source #

Create a value of StopServerResponse with all optional fields omitted.

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

ListUsers

data ListUsers Source #

See: newListUsers smart constructor.

Constructors

ListUsers' (Maybe Text) (Maybe Natural) Text

Instances

Instances details

Eq ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods (==) :: ListUsers -> ListUsers -> Bool # (/=) :: ListUsers -> ListUsers -> Bool #
Read ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods readsPrec :: Int -> ReadS ListUsers # readList :: ReadS [ListUsers] # readPrec :: ReadPrec ListUsers # readListPrec :: ReadPrec [ListUsers] #
Show ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods showsPrec :: Int -> ListUsers -> ShowS # show :: ListUsers -> String # showList :: [ListUsers] -> ShowS #
Generic ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Associated Types type Rep ListUsers :: Type -> Type # Methods from :: ListUsers -> Rep ListUsers x # to :: Rep ListUsers x -> ListUsers #
NFData ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods rnf :: ListUsers -> () #
Hashable ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods hashWithSalt :: Int -> ListUsers -> Int # hash :: ListUsers -> Int #
ToJSON ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toJSON :: ListUsers -> Value # toEncoding :: ListUsers -> Encoding # toJSONList :: [ListUsers] -> Value # toEncodingList :: [ListUsers] -> Encoding #
AWSRequest ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Associated Types type AWSResponse ListUsers # Methods request :: ListUsers -> Request ListUsers # response :: MonadResource m => Logger -> Service -> Proxy ListUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUsers))) #
ToHeaders ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toHeaders :: ListUsers -> [Header] #
ToPath ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toPath :: ListUsers -> ByteString #
ToQuery ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toQuery :: ListUsers -> QueryString #
type Rep ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.Transfer.ListUsers" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers type AWSResponse ListUsers = ListUsersResponse

newListUsers Source #

Arguments

:: Text	`$sel:serverId:ListUsers'`
-> ListUsers

Create a value of ListUsers 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:nextToken:ListUsers', listUsers_nextToken - When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

$sel:maxResults:ListUsers', listUsers_maxResults - Specifies the number of users to return as a response to the ListUsers request.

$sel:serverId:ListUsers', listUsers_serverId - A system-assigned unique identifier for a server that has users assigned to it.

data ListUsersResponse Source #

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse' (Maybe Text) Int Text [ListedUser]

Instances

Instances details

Eq ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods (==) :: ListUsersResponse -> ListUsersResponse -> Bool # (/=) :: ListUsersResponse -> ListUsersResponse -> Bool #
Read ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods readsPrec :: Int -> ReadS ListUsersResponse # readList :: ReadS [ListUsersResponse] # readPrec :: ReadPrec ListUsersResponse # readListPrec :: ReadPrec [ListUsersResponse] #
Show ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods showsPrec :: Int -> ListUsersResponse -> ShowS # show :: ListUsersResponse -> String # showList :: [ListUsersResponse] -> ShowS #
Generic ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Associated Types type Rep ListUsersResponse :: Type -> Type # Methods from :: ListUsersResponse -> Rep ListUsersResponse x # to :: Rep ListUsersResponse x -> ListUsersResponse #
NFData ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods rnf :: ListUsersResponse -> () #
type Rep ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.Transfer.ListUsers" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedUser]))))

newListUsersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListUsersResponse'`
-> Text	`$sel:serverId:ListUsers'`
-> ListUsersResponse

Create a value of ListUsersResponse 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:nextToken:ListUsers', listUsersResponse_nextToken - When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.

$sel:serverId:ListUsers', listUsersResponse_serverId - A system-assigned unique identifier for a server that the users are assigned to.

$sel:users:ListUsersResponse', listUsersResponse_users - Returns the user accounts and their properties for the ServerId value that you specify.

DescribeServer

data DescribeServer Source #

See: newDescribeServer smart constructor.

Constructors

DescribeServer' Text

Instances

Instances details

Eq DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods (==) :: DescribeServer -> DescribeServer -> Bool # (/=) :: DescribeServer -> DescribeServer -> Bool #
Read DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods readsPrec :: Int -> ReadS DescribeServer # readList :: ReadS [DescribeServer] # readPrec :: ReadPrec DescribeServer # readListPrec :: ReadPrec [DescribeServer] #
Show DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods showsPrec :: Int -> DescribeServer -> ShowS # show :: DescribeServer -> String # showList :: [DescribeServer] -> ShowS #
Generic DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Associated Types type Rep DescribeServer :: Type -> Type # Methods from :: DescribeServer -> Rep DescribeServer x # to :: Rep DescribeServer x -> DescribeServer #
NFData DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods rnf :: DescribeServer -> () #
Hashable DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods hashWithSalt :: Int -> DescribeServer -> Int # hash :: DescribeServer -> Int #
ToJSON DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods toJSON :: DescribeServer -> Value # toEncoding :: DescribeServer -> Encoding # toJSONList :: [DescribeServer] -> Value # toEncodingList :: [DescribeServer] -> Encoding #
AWSRequest DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Associated Types type AWSResponse DescribeServer # Methods request :: DescribeServer -> Request DescribeServer # response :: MonadResource m => Logger -> Service -> Proxy DescribeServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeServer))) #
ToHeaders DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods toHeaders :: DescribeServer -> [Header] #
ToPath DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods toPath :: DescribeServer -> ByteString #
ToQuery DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods toQuery :: DescribeServer -> QueryString #
type Rep DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer type Rep DescribeServer = D1 ('MetaData "DescribeServer" "Amazonka.Transfer.DescribeServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeServer Source #
Instance details Defined in Amazonka.Transfer.DescribeServer type AWSResponse DescribeServer = DescribeServerResponse

newDescribeServer Source #

Arguments

:: Text	`$sel:serverId:DescribeServer'`
-> DescribeServer

Create a value of DescribeServer 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:serverId:DescribeServer', describeServer_serverId - A system-assigned unique identifier for a server.

data DescribeServerResponse Source #

See: newDescribeServerResponse smart constructor.

Constructors

DescribeServerResponse' Int DescribedServer

Instances

Instances details

Eq DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods (==) :: DescribeServerResponse -> DescribeServerResponse -> Bool # (/=) :: DescribeServerResponse -> DescribeServerResponse -> Bool #
Read DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods readsPrec :: Int -> ReadS DescribeServerResponse # readList :: ReadS [DescribeServerResponse] # readPrec :: ReadPrec DescribeServerResponse # readListPrec :: ReadPrec [DescribeServerResponse] #
Show DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods showsPrec :: Int -> DescribeServerResponse -> ShowS # show :: DescribeServerResponse -> String # showList :: [DescribeServerResponse] -> ShowS #
Generic DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Associated Types type Rep DescribeServerResponse :: Type -> Type # Methods from :: DescribeServerResponse -> Rep DescribeServerResponse x # to :: Rep DescribeServerResponse x -> DescribeServerResponse #
NFData DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer Methods rnf :: DescribeServerResponse -> () #
type Rep DescribeServerResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeServer type Rep DescribeServerResponse = D1 ('MetaData "DescribeServerResponse" "Amazonka.Transfer.DescribeServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "server") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedServer)))

newDescribeServerResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeServerResponse'`
-> DescribedServer	`$sel:server:DescribeServerResponse'`
-> DescribeServerResponse

Create a value of DescribeServerResponse 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:httpStatus:DescribeServerResponse', describeServerResponse_httpStatus - The response's http status code.

$sel:server:DescribeServerResponse', describeServerResponse_server - An array containing the properties of a server with the ServerID you specified.

DescribeSecurityPolicy

data DescribeSecurityPolicy Source #

See: newDescribeSecurityPolicy smart constructor.

Constructors

DescribeSecurityPolicy' Text

Instances

Instances details

Eq DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods (==) :: DescribeSecurityPolicy -> DescribeSecurityPolicy -> Bool # (/=) :: DescribeSecurityPolicy -> DescribeSecurityPolicy -> Bool #
Read DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods readsPrec :: Int -> ReadS DescribeSecurityPolicy # readList :: ReadS [DescribeSecurityPolicy] # readPrec :: ReadPrec DescribeSecurityPolicy # readListPrec :: ReadPrec [DescribeSecurityPolicy] #
Show DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods showsPrec :: Int -> DescribeSecurityPolicy -> ShowS # show :: DescribeSecurityPolicy -> String # showList :: [DescribeSecurityPolicy] -> ShowS #
Generic DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Associated Types type Rep DescribeSecurityPolicy :: Type -> Type # Methods from :: DescribeSecurityPolicy -> Rep DescribeSecurityPolicy x # to :: Rep DescribeSecurityPolicy x -> DescribeSecurityPolicy #
NFData DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods rnf :: DescribeSecurityPolicy -> () #
Hashable DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods hashWithSalt :: Int -> DescribeSecurityPolicy -> Int # hash :: DescribeSecurityPolicy -> Int #
ToJSON DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods toJSON :: DescribeSecurityPolicy -> Value # toEncoding :: DescribeSecurityPolicy -> Encoding # toJSONList :: [DescribeSecurityPolicy] -> Value # toEncodingList :: [DescribeSecurityPolicy] -> Encoding #
AWSRequest DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Associated Types type AWSResponse DescribeSecurityPolicy # Methods request :: DescribeSecurityPolicy -> Request DescribeSecurityPolicy # response :: MonadResource m => Logger -> Service -> Proxy DescribeSecurityPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSecurityPolicy))) #
ToHeaders DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods toHeaders :: DescribeSecurityPolicy -> [Header] #
ToPath DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods toPath :: DescribeSecurityPolicy -> ByteString #
ToQuery DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods toQuery :: DescribeSecurityPolicy -> QueryString #
type Rep DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy type Rep DescribeSecurityPolicy = D1 ('MetaData "DescribeSecurityPolicy" "Amazonka.Transfer.DescribeSecurityPolicy" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeSecurityPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy type AWSResponse DescribeSecurityPolicy = DescribeSecurityPolicyResponse

newDescribeSecurityPolicy Source #

Arguments

:: Text	`$sel:securityPolicyName:DescribeSecurityPolicy'`
-> DescribeSecurityPolicy

Create a value of DescribeSecurityPolicy 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:securityPolicyName:DescribeSecurityPolicy', describeSecurityPolicy_securityPolicyName - Specifies the name of the security policy that is attached to the server.

data DescribeSecurityPolicyResponse Source #

See: newDescribeSecurityPolicyResponse smart constructor.

Constructors

DescribeSecurityPolicyResponse' Int DescribedSecurityPolicy

Instances

Instances details

Eq DescribeSecurityPolicyResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods (==) :: DescribeSecurityPolicyResponse -> DescribeSecurityPolicyResponse -> Bool # (/=) :: DescribeSecurityPolicyResponse -> DescribeSecurityPolicyResponse -> Bool #
Read DescribeSecurityPolicyResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods readsPrec :: Int -> ReadS DescribeSecurityPolicyResponse # readList :: ReadS [DescribeSecurityPolicyResponse] # readPrec :: ReadPrec DescribeSecurityPolicyResponse # readListPrec :: ReadPrec [DescribeSecurityPolicyResponse] #
Show DescribeSecurityPolicyResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods showsPrec :: Int -> DescribeSecurityPolicyResponse -> ShowS # show :: DescribeSecurityPolicyResponse -> String # showList :: [DescribeSecurityPolicyResponse] -> ShowS #
Generic DescribeSecurityPolicyResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Associated Types type Rep DescribeSecurityPolicyResponse :: Type -> Type # Methods from :: DescribeSecurityPolicyResponse -> Rep DescribeSecurityPolicyResponse x # to :: Rep DescribeSecurityPolicyResponse x -> DescribeSecurityPolicyResponse #
NFData DescribeSecurityPolicyResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy Methods rnf :: DescribeSecurityPolicyResponse -> () #
type Rep DescribeSecurityPolicyResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeSecurityPolicy type Rep DescribeSecurityPolicyResponse = D1 ('MetaData "DescribeSecurityPolicyResponse" "Amazonka.Transfer.DescribeSecurityPolicy" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeSecurityPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedSecurityPolicy)))

newDescribeSecurityPolicyResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSecurityPolicyResponse'`
-> DescribedSecurityPolicy	`$sel:securityPolicy:DescribeSecurityPolicyResponse'`
-> DescribeSecurityPolicyResponse

Create a value of DescribeSecurityPolicyResponse 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:httpStatus:DescribeSecurityPolicyResponse', describeSecurityPolicyResponse_httpStatus - The response's http status code.

$sel:securityPolicy:DescribeSecurityPolicyResponse', describeSecurityPolicyResponse_securityPolicy - An array containing the properties of the security policy.

ImportSshPublicKey

data ImportSshPublicKey Source #

See: newImportSshPublicKey smart constructor.

Constructors

ImportSshPublicKey' Text Text Text

Instances

Instances details

Eq ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods (==) :: ImportSshPublicKey -> ImportSshPublicKey -> Bool # (/=) :: ImportSshPublicKey -> ImportSshPublicKey -> Bool #
Read ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods readsPrec :: Int -> ReadS ImportSshPublicKey # readList :: ReadS [ImportSshPublicKey] # readPrec :: ReadPrec ImportSshPublicKey # readListPrec :: ReadPrec [ImportSshPublicKey] #
Show ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods showsPrec :: Int -> ImportSshPublicKey -> ShowS # show :: ImportSshPublicKey -> String # showList :: [ImportSshPublicKey] -> ShowS #
Generic ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Associated Types type Rep ImportSshPublicKey :: Type -> Type # Methods from :: ImportSshPublicKey -> Rep ImportSshPublicKey x # to :: Rep ImportSshPublicKey x -> ImportSshPublicKey #
NFData ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods rnf :: ImportSshPublicKey -> () #
Hashable ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods hashWithSalt :: Int -> ImportSshPublicKey -> Int # hash :: ImportSshPublicKey -> Int #
ToJSON ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods toJSON :: ImportSshPublicKey -> Value # toEncoding :: ImportSshPublicKey -> Encoding # toJSONList :: [ImportSshPublicKey] -> Value # toEncodingList :: [ImportSshPublicKey] -> Encoding #
AWSRequest ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Associated Types type AWSResponse ImportSshPublicKey # Methods request :: ImportSshPublicKey -> Request ImportSshPublicKey # response :: MonadResource m => Logger -> Service -> Proxy ImportSshPublicKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportSshPublicKey))) #
ToHeaders ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods toHeaders :: ImportSshPublicKey -> [Header] #
ToPath ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods toPath :: ImportSshPublicKey -> ByteString #
ToQuery ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods toQuery :: ImportSshPublicKey -> QueryString #
type Rep ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey type Rep ImportSshPublicKey = D1 ('MetaData "ImportSshPublicKey" "Amazonka.Transfer.ImportSshPublicKey" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ImportSshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sshPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ImportSshPublicKey Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey type AWSResponse ImportSshPublicKey = ImportSshPublicKeyResponse

newImportSshPublicKey Source #

Arguments

:: Text	`$sel:serverId:ImportSshPublicKey'`
-> Text	`$sel:sshPublicKeyBody:ImportSshPublicKey'`
-> Text	`$sel:userName:ImportSshPublicKey'`
-> ImportSshPublicKey

Create a value of ImportSshPublicKey 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:serverId:ImportSshPublicKey', importSshPublicKey_serverId - A system-assigned unique identifier for a server.

$sel:sshPublicKeyBody:ImportSshPublicKey', importSshPublicKey_sshPublicKeyBody - The public key portion of an SSH key pair.

$sel:userName:ImportSshPublicKey', importSshPublicKey_userName - The name of the user account that is assigned to one or more servers.

data ImportSshPublicKeyResponse Source #

Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

See: newImportSshPublicKeyResponse smart constructor.

Constructors

ImportSshPublicKeyResponse' Int Text Text Text

Instances

Instances details

Eq ImportSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods (==) :: ImportSshPublicKeyResponse -> ImportSshPublicKeyResponse -> Bool # (/=) :: ImportSshPublicKeyResponse -> ImportSshPublicKeyResponse -> Bool #
Read ImportSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods readsPrec :: Int -> ReadS ImportSshPublicKeyResponse # readList :: ReadS [ImportSshPublicKeyResponse] # readPrec :: ReadPrec ImportSshPublicKeyResponse # readListPrec :: ReadPrec [ImportSshPublicKeyResponse] #
Show ImportSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods showsPrec :: Int -> ImportSshPublicKeyResponse -> ShowS # show :: ImportSshPublicKeyResponse -> String # showList :: [ImportSshPublicKeyResponse] -> ShowS #
Generic ImportSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Associated Types type Rep ImportSshPublicKeyResponse :: Type -> Type # Methods from :: ImportSshPublicKeyResponse -> Rep ImportSshPublicKeyResponse x # to :: Rep ImportSshPublicKeyResponse x -> ImportSshPublicKeyResponse #
NFData ImportSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey Methods rnf :: ImportSshPublicKeyResponse -> () #
type Rep ImportSshPublicKeyResponse Source #
Instance details Defined in Amazonka.Transfer.ImportSshPublicKey type Rep ImportSshPublicKeyResponse = D1 ('MetaData "ImportSshPublicKeyResponse" "Amazonka.Transfer.ImportSshPublicKey" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ImportSshPublicKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImportSshPublicKeyResponse Source #

Arguments

:: Int	`$sel:httpStatus:ImportSshPublicKeyResponse'`
-> Text	`$sel:serverId:ImportSshPublicKey'`
-> Text	`$sel:sshPublicKeyId:ImportSshPublicKeyResponse'`
-> Text	`$sel:userName:ImportSshPublicKey'`
-> ImportSshPublicKeyResponse

Create a value of ImportSshPublicKeyResponse 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:httpStatus:ImportSshPublicKeyResponse', importSshPublicKeyResponse_httpStatus - The response's http status code.

$sel:serverId:ImportSshPublicKey', importSshPublicKeyResponse_serverId - A system-assigned unique identifier for a server.

$sel:sshPublicKeyId:ImportSshPublicKeyResponse', importSshPublicKeyResponse_sshPublicKeyId - The name given to a public key by the system that was imported.

$sel:userName:ImportSshPublicKey', importSshPublicKeyResponse_userName - A user name assigned to the ServerID value that you specified.

ListExecutions

data ListExecutions Source #

See: newListExecutions smart constructor.

Constructors

ListExecutions' (Maybe Text) (Maybe Natural) Text

Instances

Instances details

Eq ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods (==) :: ListExecutions -> ListExecutions -> Bool # (/=) :: ListExecutions -> ListExecutions -> Bool #
Read ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods readsPrec :: Int -> ReadS ListExecutions # readList :: ReadS [ListExecutions] # readPrec :: ReadPrec ListExecutions # readListPrec :: ReadPrec [ListExecutions] #
Show ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods showsPrec :: Int -> ListExecutions -> ShowS # show :: ListExecutions -> String # showList :: [ListExecutions] -> ShowS #
Generic ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Associated Types type Rep ListExecutions :: Type -> Type # Methods from :: ListExecutions -> Rep ListExecutions x # to :: Rep ListExecutions x -> ListExecutions #
NFData ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods rnf :: ListExecutions -> () #
Hashable ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods hashWithSalt :: Int -> ListExecutions -> Int # hash :: ListExecutions -> Int #
ToJSON ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toJSON :: ListExecutions -> Value # toEncoding :: ListExecutions -> Encoding # toJSONList :: [ListExecutions] -> Value # toEncodingList :: [ListExecutions] -> Encoding #
AWSRequest ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Associated Types type AWSResponse ListExecutions # Methods request :: ListExecutions -> Request ListExecutions # response :: MonadResource m => Logger -> Service -> Proxy ListExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExecutions))) #
ToHeaders ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toHeaders :: ListExecutions -> [Header] #
ToPath ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toPath :: ListExecutions -> ByteString #
ToQuery ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods toQuery :: ListExecutions -> QueryString #
type Rep ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions type Rep ListExecutions = D1 ('MetaData "ListExecutions" "Amazonka.Transfer.ListExecutions" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListExecutions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListExecutions Source #
Instance details Defined in Amazonka.Transfer.ListExecutions type AWSResponse ListExecutions = ListExecutionsResponse

newListExecutions Source #

Arguments

:: Text	`$sel:workflowId:ListExecutions'`
-> ListExecutions

Create a value of ListExecutions 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:nextToken:ListExecutions', listExecutions_nextToken - ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

$sel:maxResults:ListExecutions', listExecutions_maxResults - Specifies the aximum number of executions to return.

$sel:workflowId:ListExecutions', listExecutions_workflowId - A unique identifier for the workflow.

data ListExecutionsResponse Source #

See: newListExecutionsResponse smart constructor.

Constructors

ListExecutionsResponse' (Maybe Text) Int Text [ListedExecution]

Instances

Instances details

Eq ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods (==) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool # (/=) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool #
Read ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods readsPrec :: Int -> ReadS ListExecutionsResponse # readList :: ReadS [ListExecutionsResponse] # readPrec :: ReadPrec ListExecutionsResponse # readListPrec :: ReadPrec [ListExecutionsResponse] #
Show ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods showsPrec :: Int -> ListExecutionsResponse -> ShowS # show :: ListExecutionsResponse -> String # showList :: [ListExecutionsResponse] -> ShowS #
Generic ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Associated Types type Rep ListExecutionsResponse :: Type -> Type # Methods from :: ListExecutionsResponse -> Rep ListExecutionsResponse x # to :: Rep ListExecutionsResponse x -> ListExecutionsResponse #
NFData ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions Methods rnf :: ListExecutionsResponse -> () #
type Rep ListExecutionsResponse Source #
Instance details Defined in Amazonka.Transfer.ListExecutions type Rep ListExecutionsResponse = D1 ('MetaData "ListExecutionsResponse" "Amazonka.Transfer.ListExecutions" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListExecutionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedExecution]))))

newListExecutionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListExecutionsResponse'`
-> Text	`$sel:workflowId:ListExecutions'`
-> ListExecutionsResponse

Create a value of ListExecutionsResponse 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:nextToken:ListExecutions', listExecutionsResponse_nextToken - ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

$sel:httpStatus:ListExecutionsResponse', listExecutionsResponse_httpStatus - The response's http status code.

$sel:workflowId:ListExecutions', listExecutionsResponse_workflowId - A unique identifier for the workflow.

$sel:executions:ListExecutionsResponse', listExecutionsResponse_executions - Returns the details for each execution.

NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
StartTime: timestamp indicating when the execution began.
Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
Status: one of the following values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION.

CreateServer

data CreateServer Source #

See: newCreateServer smart constructor.

Constructors

CreateServer' (Maybe Text) (Maybe (Sensitive Text)) (Maybe IdentityProviderType) (Maybe (NonEmpty Protocol)) (Maybe Domain) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe WorkflowDetails) (Maybe (NonEmpty Tag)) (Maybe EndpointDetails)

Instances

Instances details

Eq CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods (==) :: CreateServer -> CreateServer -> Bool # (/=) :: CreateServer -> CreateServer -> Bool #
Show CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods showsPrec :: Int -> CreateServer -> ShowS # show :: CreateServer -> String # showList :: [CreateServer] -> ShowS #
Generic CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Associated Types type Rep CreateServer :: Type -> Type # Methods from :: CreateServer -> Rep CreateServer x # to :: Rep CreateServer x -> CreateServer #
NFData CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods rnf :: CreateServer -> () #
Hashable CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods hashWithSalt :: Int -> CreateServer -> Int # hash :: CreateServer -> Int #
ToJSON CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods toJSON :: CreateServer -> Value # toEncoding :: CreateServer -> Encoding # toJSONList :: [CreateServer] -> Value # toEncodingList :: [CreateServer] -> Encoding #
AWSRequest CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Associated Types type AWSResponse CreateServer # Methods request :: CreateServer -> Request CreateServer # response :: MonadResource m => Logger -> Service -> Proxy CreateServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateServer))) #
ToHeaders CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods toHeaders :: CreateServer -> [Header] #
ToPath CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods toPath :: CreateServer -> ByteString #
ToQuery CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer Methods toQuery :: CreateServer -> QueryString #
type Rep CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer type Rep CreateServer = D1 ('MetaData "CreateServer" "Amazonka.Transfer.CreateServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "CreateServer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hostKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderType)))) :: (S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol))) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType))))) :: ((S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderDetails)))) :: (S1 ('MetaSel ('Just "workflowDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowDetails)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "endpointDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDetails)))))))
type AWSResponse CreateServer Source #
Instance details Defined in Amazonka.Transfer.CreateServer type AWSResponse CreateServer = CreateServerResponse

newCreateServer :: CreateServer Source #

Create a value of CreateServer 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:loggingRole:CreateServer', createServer_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

$sel:hostKey:CreateServer', createServer_hostKey - The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command.

If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the Amazon Web Services Transfer Family User Guide.

$sel:identityProviderType:CreateServer', createServer_identityProviderType - Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

$sel:protocols:CreateServer', createServer_protocols - Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

$sel:domain:CreateServer', createServer_domain - The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

$sel:endpointType:CreateServer', createServer_endpointType - The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

$sel:securityPolicyName:CreateServer', createServer_securityPolicyName - Specifies the name of the security policy that is attached to the server.

$sel:certificate:CreateServer', createServer_certificate - The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the Amazon Web Services Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web Services Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

$sel:identityProviderDetails:CreateServer', createServer_identityProviderDetails - Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

$sel:workflowDetails:CreateServer', createServer_workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

$sel:tags:CreateServer', createServer_tags - Key-value pairs that can be used to group and search for servers.

$sel:endpointDetails:CreateServer', createServer_endpointDetails - The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

data CreateServerResponse Source #

See: newCreateServerResponse smart constructor.

Constructors

CreateServerResponse' Int Text

Instances

Instances details

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

newCreateServerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateServerResponse'`
-> Text	`$sel:serverId:CreateServerResponse'`
-> CreateServerResponse

Create a value of CreateServerResponse 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:httpStatus:CreateServerResponse', createServerResponse_httpStatus - The response's http status code.

$sel:serverId:CreateServerResponse', createServerResponse_serverId - The service-assigned ID of the server that is created.

TestIdentityProvider

data TestIdentityProvider Source #

See: newTestIdentityProvider smart constructor.

Constructors

TestIdentityProvider' (Maybe Protocol) (Maybe (Sensitive Text)) (Maybe Text) Text Text

Instances

Instances details

Eq TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods (==) :: TestIdentityProvider -> TestIdentityProvider -> Bool # (/=) :: TestIdentityProvider -> TestIdentityProvider -> Bool #
Show TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods showsPrec :: Int -> TestIdentityProvider -> ShowS # show :: TestIdentityProvider -> String # showList :: [TestIdentityProvider] -> ShowS #
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 #
NFData TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods rnf :: TestIdentityProvider -> () #
Hashable TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods hashWithSalt :: Int -> TestIdentityProvider -> Int # hash :: TestIdentityProvider -> Int #
ToJSON TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods toJSON :: TestIdentityProvider -> Value # toEncoding :: TestIdentityProvider -> Encoding # toJSONList :: [TestIdentityProvider] -> Value # toEncodingList :: [TestIdentityProvider] -> Encoding #
AWSRequest TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Associated Types type AWSResponse TestIdentityProvider # Methods request :: TestIdentityProvider -> Request TestIdentityProvider # response :: MonadResource m => Logger -> Service -> Proxy TestIdentityProvider -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestIdentityProvider))) #
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 #
type Rep TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider type Rep TestIdentityProvider = D1 ('MetaData "TestIdentityProvider" "Amazonka.Transfer.TestIdentityProvider" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "TestIdentityProvider'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "serverProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protocol)) :: S1 ('MetaSel ('Just "userPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "sourceIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse TestIdentityProvider Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider type AWSResponse TestIdentityProvider = TestIdentityProviderResponse

newTestIdentityProvider Source #

Arguments

:: Text	`$sel:serverId:TestIdentityProvider'`
-> Text	`$sel:userName: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:userPassword:TestIdentityProvider', testIdentityProvider_userPassword - The password of the user account to be tested.

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

$sel:serverId: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.

$sel:userName:TestIdentityProvider', testIdentityProvider_userName - The name of the user account to be tested.

data TestIdentityProviderResponse Source #

See: newTestIdentityProviderResponse smart constructor.

Constructors

TestIdentityProviderResponse' (Maybe Text) (Maybe Text) Int Int Text

Instances

Instances details

Eq TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods (==) :: TestIdentityProviderResponse -> TestIdentityProviderResponse -> Bool # (/=) :: TestIdentityProviderResponse -> TestIdentityProviderResponse -> Bool #
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 #
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 #
NFData TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider Methods rnf :: TestIdentityProviderResponse -> () #
type Rep TestIdentityProviderResponse Source #
Instance details Defined in Amazonka.Transfer.TestIdentityProvider type Rep TestIdentityProviderResponse = D1 ('MetaData "TestIdentityProviderResponse" "Amazonka.Transfer.TestIdentityProvider" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "TestIdentityProviderResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "response") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "message") '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	`$sel:url: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:

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

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

$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.

$sel:url:TestIdentityProviderResponse', testIdentityProviderResponse_url - The endpoint of the service used to authenticate a user.

ListServers (Paginated)

data ListServers Source #

See: newListServers smart constructor.

Constructors

ListServers' (Maybe Text) (Maybe Natural)

Instances

Instances details

Eq ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods (==) :: ListServers -> ListServers -> Bool # (/=) :: ListServers -> ListServers -> Bool #
Read ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods readsPrec :: Int -> ReadS ListServers # readList :: ReadS [ListServers] # readPrec :: ReadPrec ListServers # readListPrec :: ReadPrec [ListServers] #
Show ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods showsPrec :: Int -> ListServers -> ShowS # show :: ListServers -> String # showList :: [ListServers] -> ShowS #
Generic ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Associated Types type Rep ListServers :: Type -> Type # Methods from :: ListServers -> Rep ListServers x # to :: Rep ListServers x -> ListServers #
NFData ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods rnf :: ListServers -> () #
Hashable ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods hashWithSalt :: Int -> ListServers -> Int # hash :: ListServers -> Int #
ToJSON ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods toJSON :: ListServers -> Value # toEncoding :: ListServers -> Encoding # toJSONList :: [ListServers] -> Value # toEncodingList :: [ListServers] -> Encoding #
AWSPager ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods page :: ListServers -> AWSResponse ListServers -> Maybe ListServers #
AWSRequest ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Associated Types type AWSResponse ListServers # Methods request :: ListServers -> Request ListServers # response :: MonadResource m => Logger -> Service -> Proxy ListServers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListServers))) #
ToHeaders ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods toHeaders :: ListServers -> [Header] #
ToPath ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods toPath :: ListServers -> ByteString #
ToQuery ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers Methods toQuery :: ListServers -> QueryString #
type Rep ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers type Rep ListServers = D1 ('MetaData "ListServers" "Amazonka.Transfer.ListServers" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListServers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListServers Source #
Instance details Defined in Amazonka.Transfer.ListServers type AWSResponse ListServers = ListServersResponse

newListServers :: ListServers Source #

Create a value of ListServers 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:nextToken:ListServers', listServers_nextToken - When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

$sel:maxResults:ListServers', listServers_maxResults - Specifies the number of servers to return as a response to the ListServers query.

data ListServersResponse Source #

See: newListServersResponse smart constructor.

Constructors

ListServersResponse' (Maybe Text) Int [ListedServer]

Instances

Instances details

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

newListServersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListServersResponse'`
-> ListServersResponse

Create a value of ListServersResponse 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:nextToken:ListServers', listServersResponse_nextToken - When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

$sel:httpStatus:ListServersResponse', listServersResponse_httpStatus - The response's http status code.

$sel:servers:ListServersResponse', listServersResponse_servers - An array of servers that were listed.

DescribeUser

data DescribeUser Source #

See: newDescribeUser smart constructor.

Constructors

DescribeUser' Text Text

Instances

Instances details

Eq DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods (==) :: DescribeUser -> DescribeUser -> Bool # (/=) :: DescribeUser -> DescribeUser -> Bool #
Read DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUser # readList :: ReadS [DescribeUser] # readPrec :: ReadPrec DescribeUser # readListPrec :: ReadPrec [DescribeUser] #
Show DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods showsPrec :: Int -> DescribeUser -> ShowS # show :: DescribeUser -> String # showList :: [DescribeUser] -> ShowS #
Generic DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Associated Types type Rep DescribeUser :: Type -> Type # Methods from :: DescribeUser -> Rep DescribeUser x # to :: Rep DescribeUser x -> DescribeUser #
NFData DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods rnf :: DescribeUser -> () #
Hashable DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods hashWithSalt :: Int -> DescribeUser -> Int # hash :: DescribeUser -> Int #
ToJSON DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods toJSON :: DescribeUser -> Value # toEncoding :: DescribeUser -> Encoding # toJSONList :: [DescribeUser] -> Value # toEncodingList :: [DescribeUser] -> Encoding #
AWSRequest DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Associated Types type AWSResponse DescribeUser # Methods request :: DescribeUser -> Request DescribeUser # response :: MonadResource m => Logger -> Service -> Proxy DescribeUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUser))) #
ToHeaders DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods toHeaders :: DescribeUser -> [Header] #
ToPath DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods toPath :: DescribeUser -> ByteString #
ToQuery DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods toQuery :: DescribeUser -> QueryString #
type Rep DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.Transfer.DescribeUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeUser Source #
Instance details Defined in Amazonka.Transfer.DescribeUser type AWSResponse DescribeUser = DescribeUserResponse

newDescribeUser Source #

Arguments

:: Text	`$sel:serverId:DescribeUser'`
-> Text	`$sel:userName:DescribeUser'`
-> DescribeUser

Create a value of DescribeUser 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:serverId:DescribeUser', describeUser_serverId - A system-assigned unique identifier for a server that has this user assigned.

$sel:userName:DescribeUser', describeUser_userName - The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.

data DescribeUserResponse Source #

See: newDescribeUserResponse smart constructor.

Constructors

DescribeUserResponse' Int Text DescribedUser

Instances

Instances details

Eq DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods (==) :: DescribeUserResponse -> DescribeUserResponse -> Bool # (/=) :: DescribeUserResponse -> DescribeUserResponse -> Bool #
Read DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUserResponse # readList :: ReadS [DescribeUserResponse] # readPrec :: ReadPrec DescribeUserResponse # readListPrec :: ReadPrec [DescribeUserResponse] #
Show DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods showsPrec :: Int -> DescribeUserResponse -> ShowS # show :: DescribeUserResponse -> String # showList :: [DescribeUserResponse] -> ShowS #
Generic DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Associated Types type Rep DescribeUserResponse :: Type -> Type # Methods from :: DescribeUserResponse -> Rep DescribeUserResponse x # to :: Rep DescribeUserResponse x -> DescribeUserResponse #
NFData DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods rnf :: DescribeUserResponse -> () #
type Rep DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.Transfer.DescribeUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedUser))))

newDescribeUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUserResponse'`
-> Text	`$sel:serverId:DescribeUser'`
-> DescribedUser	`$sel:user:DescribeUserResponse'`
-> DescribeUserResponse

Create a value of DescribeUserResponse 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:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

$sel:serverId:DescribeUser', describeUserResponse_serverId - A system-assigned unique identifier for a server that has this user assigned.

$sel:user:DescribeUserResponse', describeUserResponse_user - An array containing the properties of the user account for the ServerID value that you specified.

DescribeExecution

data DescribeExecution Source #

See: newDescribeExecution smart constructor.

Constructors

DescribeExecution' Text Text

Instances

Instances details

Eq DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods (==) :: DescribeExecution -> DescribeExecution -> Bool # (/=) :: DescribeExecution -> DescribeExecution -> Bool #
Read DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods readsPrec :: Int -> ReadS DescribeExecution # readList :: ReadS [DescribeExecution] # readPrec :: ReadPrec DescribeExecution # readListPrec :: ReadPrec [DescribeExecution] #
Show DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods showsPrec :: Int -> DescribeExecution -> ShowS # show :: DescribeExecution -> String # showList :: [DescribeExecution] -> ShowS #
Generic DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Associated Types type Rep DescribeExecution :: Type -> Type # Methods from :: DescribeExecution -> Rep DescribeExecution x # to :: Rep DescribeExecution x -> DescribeExecution #
NFData DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods rnf :: DescribeExecution -> () #
Hashable DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods hashWithSalt :: Int -> DescribeExecution -> Int # hash :: DescribeExecution -> Int #
ToJSON DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods toJSON :: DescribeExecution -> Value # toEncoding :: DescribeExecution -> Encoding # toJSONList :: [DescribeExecution] -> Value # toEncodingList :: [DescribeExecution] -> Encoding #
AWSRequest DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Associated Types type AWSResponse DescribeExecution # Methods request :: DescribeExecution -> Request DescribeExecution # response :: MonadResource m => Logger -> Service -> Proxy DescribeExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeExecution))) #
ToHeaders DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods toHeaders :: DescribeExecution -> [Header] #
ToPath DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods toPath :: DescribeExecution -> ByteString #
ToQuery DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods toQuery :: DescribeExecution -> QueryString #
type Rep DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution type Rep DescribeExecution = D1 ('MetaData "DescribeExecution" "Amazonka.Transfer.DescribeExecution" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeExecution Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution type AWSResponse DescribeExecution = DescribeExecutionResponse

newDescribeExecution Source #

Arguments

:: Text	`$sel:executionId:DescribeExecution'`
-> Text	`$sel:workflowId:DescribeExecution'`
-> DescribeExecution

Create a value of DescribeExecution 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:executionId:DescribeExecution', describeExecution_executionId - A unique identifier for the execution of a workflow.

$sel:workflowId:DescribeExecution', describeExecution_workflowId - A unique identifier for the workflow.

data DescribeExecutionResponse Source #

See: newDescribeExecutionResponse smart constructor.

Constructors

DescribeExecutionResponse' Int Text DescribedExecution

Instances

Instances details

Eq DescribeExecutionResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods (==) :: DescribeExecutionResponse -> DescribeExecutionResponse -> Bool # (/=) :: DescribeExecutionResponse -> DescribeExecutionResponse -> Bool #
Read DescribeExecutionResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods readsPrec :: Int -> ReadS DescribeExecutionResponse # readList :: ReadS [DescribeExecutionResponse] # readPrec :: ReadPrec DescribeExecutionResponse # readListPrec :: ReadPrec [DescribeExecutionResponse] #
Show DescribeExecutionResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods showsPrec :: Int -> DescribeExecutionResponse -> ShowS # show :: DescribeExecutionResponse -> String # showList :: [DescribeExecutionResponse] -> ShowS #
Generic DescribeExecutionResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Associated Types type Rep DescribeExecutionResponse :: Type -> Type # Methods from :: DescribeExecutionResponse -> Rep DescribeExecutionResponse x # to :: Rep DescribeExecutionResponse x -> DescribeExecutionResponse #
NFData DescribeExecutionResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution Methods rnf :: DescribeExecutionResponse -> () #
type Rep DescribeExecutionResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeExecution type Rep DescribeExecutionResponse = D1 ('MetaData "DescribeExecutionResponse" "Amazonka.Transfer.DescribeExecution" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "execution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedExecution))))

newDescribeExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeExecutionResponse'`
-> Text	`$sel:workflowId:DescribeExecution'`
-> DescribedExecution	`$sel:execution:DescribeExecutionResponse'`
-> DescribeExecutionResponse

Create a value of DescribeExecutionResponse 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:httpStatus:DescribeExecutionResponse', describeExecutionResponse_httpStatus - The response's http status code.

$sel:workflowId:DescribeExecution', describeExecutionResponse_workflowId - A unique identifier for the workflow.

$sel:execution:DescribeExecutionResponse', describeExecutionResponse_execution - The structure that contains the details of the workflow' execution.

ListWorkflows

data ListWorkflows Source #

See: newListWorkflows smart constructor.

Constructors

ListWorkflows' (Maybe Text) (Maybe Natural)

Instances

Instances details

Eq ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods (==) :: ListWorkflows -> ListWorkflows -> Bool # (/=) :: ListWorkflows -> ListWorkflows -> Bool #
Read ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods readsPrec :: Int -> ReadS ListWorkflows # readList :: ReadS [ListWorkflows] # readPrec :: ReadPrec ListWorkflows # readListPrec :: ReadPrec [ListWorkflows] #
Show ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods showsPrec :: Int -> ListWorkflows -> ShowS # show :: ListWorkflows -> String # showList :: [ListWorkflows] -> ShowS #
Generic ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Associated Types type Rep ListWorkflows :: Type -> Type # Methods from :: ListWorkflows -> Rep ListWorkflows x # to :: Rep ListWorkflows x -> ListWorkflows #
NFData ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods rnf :: ListWorkflows -> () #
Hashable ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods hashWithSalt :: Int -> ListWorkflows -> Int # hash :: ListWorkflows -> Int #
ToJSON ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods toJSON :: ListWorkflows -> Value # toEncoding :: ListWorkflows -> Encoding # toJSONList :: [ListWorkflows] -> Value # toEncodingList :: [ListWorkflows] -> Encoding #
AWSRequest ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Associated Types type AWSResponse ListWorkflows # Methods request :: ListWorkflows -> Request ListWorkflows # response :: MonadResource m => Logger -> Service -> Proxy ListWorkflows -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorkflows))) #
ToHeaders ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods toHeaders :: ListWorkflows -> [Header] #
ToPath ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods toPath :: ListWorkflows -> ByteString #
ToQuery ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows Methods toQuery :: ListWorkflows -> QueryString #
type Rep ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows type Rep ListWorkflows = D1 ('MetaData "ListWorkflows" "Amazonka.Transfer.ListWorkflows" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListWorkflows'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListWorkflows Source #
Instance details Defined in Amazonka.Transfer.ListWorkflows type AWSResponse ListWorkflows = ListWorkflowsResponse

newListWorkflows :: ListWorkflows Source #

Create a value of ListWorkflows 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:nextToken:ListWorkflows', listWorkflows_nextToken - ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

$sel:maxResults:ListWorkflows', listWorkflows_maxResults - Specifies the maximum number of workflows to return.

data ListWorkflowsResponse Source #

See: newListWorkflowsResponse smart constructor.

Constructors

ListWorkflowsResponse' (Maybe Text) Int [ListedWorkflow]

Instances

Instances details

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

newListWorkflowsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListWorkflowsResponse'`
-> ListWorkflowsResponse

Create a value of ListWorkflowsResponse 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:nextToken:ListWorkflows', listWorkflowsResponse_nextToken - ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

$sel:httpStatus:ListWorkflowsResponse', listWorkflowsResponse_httpStatus - The response's http status code.

$sel:workflows:ListWorkflowsResponse', listWorkflowsResponse_workflows - Returns the Arn, WorkflowId, and Description for each workflow.

CreateUser

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser' (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text Text Text

Instances

Instances details

Eq CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Read CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods readsPrec :: Int -> ReadS CreateUser # readList :: ReadS [CreateUser] # readPrec :: ReadPrec CreateUser # readListPrec :: ReadPrec [CreateUser] #
Show CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
Generic CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Associated Types type Rep CreateUser :: Type -> Type # Methods from :: CreateUser -> Rep CreateUser x # to :: Rep CreateUser x -> CreateUser #
NFData CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods rnf :: CreateUser -> () #
Hashable CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
ToJSON CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods toJSON :: CreateUser -> Value # toEncoding :: CreateUser -> Encoding # toJSONList :: [CreateUser] -> Value # toEncodingList :: [CreateUser] -> Encoding #
AWSRequest CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Associated Types type AWSResponse CreateUser # Methods request :: CreateUser -> Request CreateUser # response :: MonadResource m => Logger -> Service -> Proxy CreateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUser))) #
ToHeaders CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser Methods toQuery :: CreateUser -> QueryString #
type Rep CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.Transfer.CreateUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :: S1 ('MetaSel ('Just "sshPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile)) :: (S1 ('MetaSel ('Just "homeDirectoryMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HomeDirectoryMapEntry))) :: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateUser Source #
Instance details Defined in Amazonka.Transfer.CreateUser type AWSResponse CreateUser = CreateUserResponse

newCreateUser Source #

Arguments

:: Text	`$sel:role':CreateUser'`
-> Text	`$sel:serverId:CreateUser'`
-> Text	`$sel:userName:CreateUser'`
-> CreateUser

Create a value of CreateUser 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:homeDirectoryType:CreateUser', createUser_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:sshPublicKeyBody:CreateUser', createUser_sshPublicKeyBody - The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

$sel:posixProfile:CreateUser', createUser_posixProfile - Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

$sel:homeDirectoryMappings:CreateUser', createUser_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

$sel:policy:CreateUser', createUser_policy - A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

$sel:homeDirectory:CreateUser', createUser_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

$sel:tags:CreateUser', createUser_tags - Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

$sel:role':CreateUser', createUser_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

$sel:serverId:CreateUser', createUser_serverId - A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

$sel:userName:CreateUser', createUser_userName - A unique string that identifies a user and is associated with a ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse' Int Text Text

Instances

Instances details

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

newCreateUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateUserResponse'`
-> Text	`$sel:serverId:CreateUser'`
-> Text	`$sel:userName:CreateUser'`
-> CreateUserResponse

Create a value of CreateUserResponse 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:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.

$sel:serverId:CreateUser', createUserResponse_serverId - The ID of the server that the user is attached to.

$sel:userName:CreateUser', createUserResponse_userName - A unique string that identifies a user account associated with a server.

StartServer

data StartServer Source #

See: newStartServer smart constructor.

Constructors

StartServer' Text

Instances

Instances details

Eq StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods (==) :: StartServer -> StartServer -> Bool # (/=) :: StartServer -> StartServer -> Bool #
Read StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods readsPrec :: Int -> ReadS StartServer # readList :: ReadS [StartServer] # readPrec :: ReadPrec StartServer # readListPrec :: ReadPrec [StartServer] #
Show StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods showsPrec :: Int -> StartServer -> ShowS # show :: StartServer -> String # showList :: [StartServer] -> ShowS #
Generic StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Associated Types type Rep StartServer :: Type -> Type # Methods from :: StartServer -> Rep StartServer x # to :: Rep StartServer x -> StartServer #
NFData StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods rnf :: StartServer -> () #
Hashable StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods hashWithSalt :: Int -> StartServer -> Int # hash :: StartServer -> Int #
ToJSON StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods toJSON :: StartServer -> Value # toEncoding :: StartServer -> Encoding # toJSONList :: [StartServer] -> Value # toEncodingList :: [StartServer] -> Encoding #
AWSRequest StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Associated Types type AWSResponse StartServer # Methods request :: StartServer -> Request StartServer # response :: MonadResource m => Logger -> Service -> Proxy StartServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartServer))) #
ToHeaders StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods toHeaders :: StartServer -> [Header] #
ToPath StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods toPath :: StartServer -> ByteString #
ToQuery StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods toQuery :: StartServer -> QueryString #
type Rep StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer type Rep StartServer = D1 ('MetaData "StartServer" "Amazonka.Transfer.StartServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "StartServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StartServer Source #
Instance details Defined in Amazonka.Transfer.StartServer type AWSResponse StartServer = StartServerResponse

newStartServer Source #

Arguments

:: Text	`$sel:serverId:StartServer'`
-> StartServer

Create a value of StartServer 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:serverId:StartServer', startServer_serverId - A system-assigned unique identifier for a server that you start.

data StartServerResponse Source #

See: newStartServerResponse smart constructor.

Constructors

StartServerResponse'

Instances

Instances details

Eq StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods (==) :: StartServerResponse -> StartServerResponse -> Bool # (/=) :: StartServerResponse -> StartServerResponse -> Bool #
Read StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods readsPrec :: Int -> ReadS StartServerResponse # readList :: ReadS [StartServerResponse] # readPrec :: ReadPrec StartServerResponse # readListPrec :: ReadPrec [StartServerResponse] #
Show StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods showsPrec :: Int -> StartServerResponse -> ShowS # show :: StartServerResponse -> String # showList :: [StartServerResponse] -> ShowS #
Generic StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Associated Types type Rep StartServerResponse :: Type -> Type # Methods from :: StartServerResponse -> Rep StartServerResponse x # to :: Rep StartServerResponse x -> StartServerResponse #
NFData StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer Methods rnf :: StartServerResponse -> () #
type Rep StartServerResponse Source #
Instance details Defined in Amazonka.Transfer.StartServer type Rep StartServerResponse = D1 ('MetaData "StartServerResponse" "Amazonka.Transfer.StartServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "StartServerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStartServerResponse :: StartServerResponse Source #

Create a value of StartServerResponse with all optional fields omitted.

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

UpdateAccess

data UpdateAccess Source #

See: newUpdateAccess smart constructor.

Constructors

UpdateAccess' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text

Instances

Instances details

Eq UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods (==) :: UpdateAccess -> UpdateAccess -> Bool # (/=) :: UpdateAccess -> UpdateAccess -> Bool #
Read UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods readsPrec :: Int -> ReadS UpdateAccess # readList :: ReadS [UpdateAccess] # readPrec :: ReadPrec UpdateAccess # readListPrec :: ReadPrec [UpdateAccess] #
Show UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods showsPrec :: Int -> UpdateAccess -> ShowS # show :: UpdateAccess -> String # showList :: [UpdateAccess] -> ShowS #
Generic UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Associated Types type Rep UpdateAccess :: Type -> Type # Methods from :: UpdateAccess -> Rep UpdateAccess x # to :: Rep UpdateAccess x -> UpdateAccess #
NFData UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods rnf :: UpdateAccess -> () #
Hashable UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods hashWithSalt :: Int -> UpdateAccess -> Int # hash :: UpdateAccess -> Int #
ToJSON UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods toJSON :: UpdateAccess -> Value # toEncoding :: UpdateAccess -> Encoding # toJSONList :: [UpdateAccess] -> Value # toEncodingList :: [UpdateAccess] -> Encoding #
AWSRequest UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Associated Types type AWSResponse UpdateAccess # Methods request :: UpdateAccess -> Request UpdateAccess # response :: MonadResource m => Logger -> Service -> Proxy UpdateAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAccess))) #
ToHeaders UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods toHeaders :: UpdateAccess -> [Header] #
ToPath UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods toPath :: UpdateAccess -> ByteString #
ToQuery UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess Methods toQuery :: UpdateAccess -> QueryString #
type Rep UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess type Rep UpdateAccess = D1 ('MetaData "UpdateAccess" "Amazonka.Transfer.UpdateAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "UpdateAccess'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :: S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile))) :: (S1 ('MetaSel ('Just "homeDirectoryMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HomeDirectoryMapEntry))) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateAccess Source #
Instance details Defined in Amazonka.Transfer.UpdateAccess type AWSResponse UpdateAccess = UpdateAccessResponse

newUpdateAccess Source #

Arguments

:: Text	`$sel:serverId:UpdateAccess'`
-> Text	`$sel:externalId:UpdateAccess'`
-> UpdateAccess

Create a value of UpdateAccess 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:homeDirectoryType:UpdateAccess', updateAccess_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:posixProfile:UpdateAccess', updateAccess_posixProfile - Undocumented member.

$sel:homeDirectoryMappings:UpdateAccess', updateAccess_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

$sel:role':UpdateAccess', updateAccess_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

$sel:policy:UpdateAccess', updateAccess_policy - A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

$sel:homeDirectory:UpdateAccess', updateAccess_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

$sel:serverId:UpdateAccess', updateAccess_serverId - A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

$sel:externalId:UpdateAccess', updateAccess_externalId - A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

data UpdateAccessResponse Source #

See: newUpdateAccessResponse smart constructor.

Constructors

UpdateAccessResponse' Int Text Text

Instances

Instances details

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

newUpdateAccessResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateAccessResponse'`
-> Text	`$sel:serverId:UpdateAccess'`
-> Text	`$sel:externalId:UpdateAccess'`
-> UpdateAccessResponse

Create a value of UpdateAccessResponse 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:httpStatus:UpdateAccessResponse', updateAccessResponse_httpStatus - The response's http status code.

$sel:serverId:UpdateAccess', updateAccessResponse_serverId - The ID of the server that the user is attached to.

$sel:externalId:UpdateAccess', updateAccessResponse_externalId - The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.

DeleteAccess

data DeleteAccess Source #

See: newDeleteAccess smart constructor.

Constructors

DeleteAccess' Text Text

Instances

Instances details

Eq DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods (==) :: DeleteAccess -> DeleteAccess -> Bool # (/=) :: DeleteAccess -> DeleteAccess -> Bool #
Read DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods readsPrec :: Int -> ReadS DeleteAccess # readList :: ReadS [DeleteAccess] # readPrec :: ReadPrec DeleteAccess # readListPrec :: ReadPrec [DeleteAccess] #
Show DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods showsPrec :: Int -> DeleteAccess -> ShowS # show :: DeleteAccess -> String # showList :: [DeleteAccess] -> ShowS #
Generic DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Associated Types type Rep DeleteAccess :: Type -> Type # Methods from :: DeleteAccess -> Rep DeleteAccess x # to :: Rep DeleteAccess x -> DeleteAccess #
NFData DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods rnf :: DeleteAccess -> () #
Hashable DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods hashWithSalt :: Int -> DeleteAccess -> Int # hash :: DeleteAccess -> Int #
ToJSON DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods toJSON :: DeleteAccess -> Value # toEncoding :: DeleteAccess -> Encoding # toJSONList :: [DeleteAccess] -> Value # toEncodingList :: [DeleteAccess] -> Encoding #
AWSRequest DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Associated Types type AWSResponse DeleteAccess # Methods request :: DeleteAccess -> Request DeleteAccess # response :: MonadResource m => Logger -> Service -> Proxy DeleteAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteAccess))) #
ToHeaders DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods toHeaders :: DeleteAccess -> [Header] #
ToPath DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods toPath :: DeleteAccess -> ByteString #
ToQuery DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods toQuery :: DeleteAccess -> QueryString #
type Rep DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess type Rep DeleteAccess = D1 ('MetaData "DeleteAccess" "Amazonka.Transfer.DeleteAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteAccess Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess type AWSResponse DeleteAccess = DeleteAccessResponse

newDeleteAccess Source #

Arguments

:: Text	`$sel:serverId:DeleteAccess'`
-> Text	`$sel:externalId:DeleteAccess'`
-> DeleteAccess

Create a value of DeleteAccess 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:serverId:DeleteAccess', deleteAccess_serverId - A system-assigned unique identifier for a server that has this user assigned.

$sel:externalId:DeleteAccess', deleteAccess_externalId - A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

data DeleteAccessResponse Source #

See: newDeleteAccessResponse smart constructor.

Constructors

DeleteAccessResponse'

Instances

Instances details

Eq DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods (==) :: DeleteAccessResponse -> DeleteAccessResponse -> Bool # (/=) :: DeleteAccessResponse -> DeleteAccessResponse -> Bool #
Read DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods readsPrec :: Int -> ReadS DeleteAccessResponse # readList :: ReadS [DeleteAccessResponse] # readPrec :: ReadPrec DeleteAccessResponse # readListPrec :: ReadPrec [DeleteAccessResponse] #
Show DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods showsPrec :: Int -> DeleteAccessResponse -> ShowS # show :: DeleteAccessResponse -> String # showList :: [DeleteAccessResponse] -> ShowS #
Generic DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Associated Types type Rep DeleteAccessResponse :: Type -> Type # Methods from :: DeleteAccessResponse -> Rep DeleteAccessResponse x # to :: Rep DeleteAccessResponse x -> DeleteAccessResponse #
NFData DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess Methods rnf :: DeleteAccessResponse -> () #
type Rep DeleteAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteAccess type Rep DeleteAccessResponse = D1 ('MetaData "DeleteAccessResponse" "Amazonka.Transfer.DeleteAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteAccessResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAccessResponse :: DeleteAccessResponse Source #

Create a value of DeleteAccessResponse with all optional fields omitted.

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

CreateAccess

data CreateAccess Source #

See: newCreateAccess smart constructor.

Constructors

CreateAccess' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) Text Text Text

Instances

Instances details

Eq CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods (==) :: CreateAccess -> CreateAccess -> Bool # (/=) :: CreateAccess -> CreateAccess -> Bool #
Read CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods readsPrec :: Int -> ReadS CreateAccess # readList :: ReadS [CreateAccess] # readPrec :: ReadPrec CreateAccess # readListPrec :: ReadPrec [CreateAccess] #
Show CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods showsPrec :: Int -> CreateAccess -> ShowS # show :: CreateAccess -> String # showList :: [CreateAccess] -> ShowS #
Generic CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Associated Types type Rep CreateAccess :: Type -> Type # Methods from :: CreateAccess -> Rep CreateAccess x # to :: Rep CreateAccess x -> CreateAccess #
NFData CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods rnf :: CreateAccess -> () #
Hashable CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods hashWithSalt :: Int -> CreateAccess -> Int # hash :: CreateAccess -> Int #
ToJSON CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods toJSON :: CreateAccess -> Value # toEncoding :: CreateAccess -> Encoding # toJSONList :: [CreateAccess] -> Value # toEncodingList :: [CreateAccess] -> Encoding #
AWSRequest CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Associated Types type AWSResponse CreateAccess # Methods request :: CreateAccess -> Request CreateAccess # response :: MonadResource m => Logger -> Service -> Proxy CreateAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAccess))) #
ToHeaders CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods toHeaders :: CreateAccess -> [Header] #
ToPath CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods toPath :: CreateAccess -> ByteString #
ToQuery CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess Methods toQuery :: CreateAccess -> QueryString #
type Rep CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess type Rep CreateAccess = D1 ('MetaData "CreateAccess" "Amazonka.Transfer.CreateAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "CreateAccess'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :: S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile))) :: (S1 ('MetaSel ('Just "homeDirectoryMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HomeDirectoryMapEntry))) :: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateAccess Source #
Instance details Defined in Amazonka.Transfer.CreateAccess type AWSResponse CreateAccess = CreateAccessResponse

newCreateAccess Source #

Arguments

:: Text	`$sel:role':CreateAccess'`
-> Text	`$sel:serverId:CreateAccess'`
-> Text	`$sel:externalId:CreateAccess'`
-> CreateAccess

Create a value of CreateAccess 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:homeDirectoryType:CreateAccess', createAccess_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:posixProfile:CreateAccess', createAccess_posixProfile - Undocumented member.

$sel:homeDirectoryMappings:CreateAccess', createAccess_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

$sel:policy:CreateAccess', createAccess_policy - A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

$sel:homeDirectory:CreateAccess', createAccess_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

$sel:role':CreateAccess', createAccess_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

$sel:serverId:CreateAccess', createAccess_serverId - A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

$sel:externalId:CreateAccess', createAccess_externalId - A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

data CreateAccessResponse Source #

See: newCreateAccessResponse smart constructor.

Constructors

CreateAccessResponse' Int Text Text

Instances

Instances details

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

newCreateAccessResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAccessResponse'`
-> Text	`$sel:serverId:CreateAccess'`
-> Text	`$sel:externalId:CreateAccess'`
-> CreateAccessResponse

Create a value of CreateAccessResponse 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:httpStatus:CreateAccessResponse', createAccessResponse_httpStatus - The response's http status code.

$sel:serverId:CreateAccess', createAccessResponse_serverId - The ID of the server that the user is attached to.

$sel:externalId:CreateAccess', createAccessResponse_externalId - The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family.

ListAccesses

data ListAccesses Source #

See: newListAccesses smart constructor.

Constructors

ListAccesses' (Maybe Text) (Maybe Natural) Text

Instances

Instances details

Eq ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods (==) :: ListAccesses -> ListAccesses -> Bool # (/=) :: ListAccesses -> ListAccesses -> Bool #
Read ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods readsPrec :: Int -> ReadS ListAccesses # readList :: ReadS [ListAccesses] # readPrec :: ReadPrec ListAccesses # readListPrec :: ReadPrec [ListAccesses] #
Show ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods showsPrec :: Int -> ListAccesses -> ShowS # show :: ListAccesses -> String # showList :: [ListAccesses] -> ShowS #
Generic ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Associated Types type Rep ListAccesses :: Type -> Type # Methods from :: ListAccesses -> Rep ListAccesses x # to :: Rep ListAccesses x -> ListAccesses #
NFData ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods rnf :: ListAccesses -> () #
Hashable ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods hashWithSalt :: Int -> ListAccesses -> Int # hash :: ListAccesses -> Int #
ToJSON ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods toJSON :: ListAccesses -> Value # toEncoding :: ListAccesses -> Encoding # toJSONList :: [ListAccesses] -> Value # toEncodingList :: [ListAccesses] -> Encoding #
AWSRequest ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Associated Types type AWSResponse ListAccesses # Methods request :: ListAccesses -> Request ListAccesses # response :: MonadResource m => Logger -> Service -> Proxy ListAccesses -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccesses))) #
ToHeaders ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods toHeaders :: ListAccesses -> [Header] #
ToPath ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods toPath :: ListAccesses -> ByteString #
ToQuery ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods toQuery :: ListAccesses -> QueryString #
type Rep ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses type Rep ListAccesses = D1 ('MetaData "ListAccesses" "Amazonka.Transfer.ListAccesses" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListAccesses'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListAccesses Source #
Instance details Defined in Amazonka.Transfer.ListAccesses type AWSResponse ListAccesses = ListAccessesResponse

newListAccesses Source #

Arguments

:: Text	`$sel:serverId:ListAccesses'`
-> ListAccesses

Create a value of ListAccesses 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:nextToken:ListAccesses', listAccesses_nextToken - When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

$sel:maxResults:ListAccesses', listAccesses_maxResults - Specifies the maximum number of access SIDs to return.

$sel:serverId:ListAccesses', listAccesses_serverId - A system-assigned unique identifier for a server that has users assigned to it.

data ListAccessesResponse Source #

See: newListAccessesResponse smart constructor.

Constructors

ListAccessesResponse' (Maybe Text) Int Text [ListedAccess]

Instances

Instances details

Eq ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods (==) :: ListAccessesResponse -> ListAccessesResponse -> Bool # (/=) :: ListAccessesResponse -> ListAccessesResponse -> Bool #
Read ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods readsPrec :: Int -> ReadS ListAccessesResponse # readList :: ReadS [ListAccessesResponse] # readPrec :: ReadPrec ListAccessesResponse # readListPrec :: ReadPrec [ListAccessesResponse] #
Show ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods showsPrec :: Int -> ListAccessesResponse -> ShowS # show :: ListAccessesResponse -> String # showList :: [ListAccessesResponse] -> ShowS #
Generic ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Associated Types type Rep ListAccessesResponse :: Type -> Type # Methods from :: ListAccessesResponse -> Rep ListAccessesResponse x # to :: Rep ListAccessesResponse x -> ListAccessesResponse #
NFData ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods rnf :: ListAccessesResponse -> () #
type Rep ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses type Rep ListAccessesResponse = D1 ('MetaData "ListAccessesResponse" "Amazonka.Transfer.ListAccesses" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListAccessesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accesses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedAccess]))))

newListAccessesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAccessesResponse'`
-> Text	`$sel:serverId:ListAccesses'`
-> ListAccessesResponse

Create a value of ListAccessesResponse 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:nextToken:ListAccesses', listAccessesResponse_nextToken - When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

$sel:httpStatus:ListAccessesResponse', listAccessesResponse_httpStatus - The response's http status code.

$sel:serverId:ListAccesses', listAccessesResponse_serverId - A system-assigned unique identifier for a server that has users assigned to it.

$sel:accesses:ListAccessesResponse', listAccessesResponse_accesses - Returns the accesses and their properties for the ServerId value that you specify.

UpdateUser

data UpdateUser Source #

See: newUpdateUser smart constructor.

Constructors

UpdateUser' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text

Instances

Instances details

Eq UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods (==) :: UpdateUser -> UpdateUser -> Bool # (/=) :: UpdateUser -> UpdateUser -> Bool #
Read UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods readsPrec :: Int -> ReadS UpdateUser # readList :: ReadS [UpdateUser] # readPrec :: ReadPrec UpdateUser # readListPrec :: ReadPrec [UpdateUser] #
Show UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods showsPrec :: Int -> UpdateUser -> ShowS # show :: UpdateUser -> String # showList :: [UpdateUser] -> ShowS #
Generic UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Associated Types type Rep UpdateUser :: Type -> Type # Methods from :: UpdateUser -> Rep UpdateUser x # to :: Rep UpdateUser x -> UpdateUser #
NFData UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods rnf :: UpdateUser -> () #
Hashable UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods hashWithSalt :: Int -> UpdateUser -> Int # hash :: UpdateUser -> Int #
ToJSON UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods toJSON :: UpdateUser -> Value # toEncoding :: UpdateUser -> Encoding # toJSONList :: [UpdateUser] -> Value # toEncodingList :: [UpdateUser] -> Encoding #
AWSRequest UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Associated Types type AWSResponse UpdateUser # Methods request :: UpdateUser -> Request UpdateUser # response :: MonadResource m => Logger -> Service -> Proxy UpdateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUser))) #
ToHeaders UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods toHeaders :: UpdateUser -> [Header] #
ToPath UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods toPath :: UpdateUser -> ByteString #
ToQuery UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser Methods toQuery :: UpdateUser -> QueryString #
type Rep UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser type Rep UpdateUser = D1 ('MetaData "UpdateUser" "Amazonka.Transfer.UpdateUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "UpdateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :: S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile))) :: (S1 ('MetaSel ('Just "homeDirectoryMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HomeDirectoryMapEntry))) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateUser Source #
Instance details Defined in Amazonka.Transfer.UpdateUser type AWSResponse UpdateUser = UpdateUserResponse

newUpdateUser Source #

Arguments

:: Text	`$sel:serverId:UpdateUser'`
-> Text	`$sel:userName:UpdateUser'`
-> UpdateUser

Create a value of UpdateUser 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:homeDirectoryType:UpdateUser', updateUser_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:posixProfile:UpdateUser', updateUser_posixProfile - Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

$sel:homeDirectoryMappings:UpdateUser', updateUser_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

$sel:role':UpdateUser', updateUser_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

$sel:policy:UpdateUser', updateUser_policy - A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Creating a session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

$sel:homeDirectory:UpdateUser', updateUser_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

$sel:serverId:UpdateUser', updateUser_serverId - A system-assigned unique identifier for a server instance that the user account is assigned to.

$sel:userName:UpdateUser', updateUser_userName - A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

data UpdateUserResponse Source #

UpdateUserResponse returns the user name and identifier for the request to update a user's properties.

See: newUpdateUserResponse smart constructor.

Constructors

UpdateUserResponse' Int Text Text

Instances

Instances details

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

newUpdateUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateUserResponse'`
-> Text	`$sel:serverId:UpdateUser'`
-> Text	`$sel:userName:UpdateUser'`
-> UpdateUserResponse

Create a value of UpdateUserResponse 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:httpStatus:UpdateUserResponse', updateUserResponse_httpStatus - The response's http status code.

$sel:serverId:UpdateUser', updateUserResponse_serverId - A system-assigned unique identifier for a server instance that the user account is assigned to.

$sel:userName:UpdateUser', updateUserResponse_userName - The unique identifier for a user that is assigned to a server instance that was specified in the request.

DeleteUser

data DeleteUser Source #

See: newDeleteUser smart constructor.

Constructors

DeleteUser' Text Text

Instances

Instances details

Eq DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods (==) :: DeleteUser -> DeleteUser -> Bool # (/=) :: DeleteUser -> DeleteUser -> Bool #
Read DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods readsPrec :: Int -> ReadS DeleteUser # readList :: ReadS [DeleteUser] # readPrec :: ReadPrec DeleteUser # readListPrec :: ReadPrec [DeleteUser] #
Show DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods showsPrec :: Int -> DeleteUser -> ShowS # show :: DeleteUser -> String # showList :: [DeleteUser] -> ShowS #
Generic DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Associated Types type Rep DeleteUser :: Type -> Type # Methods from :: DeleteUser -> Rep DeleteUser x # to :: Rep DeleteUser x -> DeleteUser #
NFData DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods rnf :: DeleteUser -> () #
Hashable DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods hashWithSalt :: Int -> DeleteUser -> Int # hash :: DeleteUser -> Int #
ToJSON DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toJSON :: DeleteUser -> Value # toEncoding :: DeleteUser -> Encoding # toJSONList :: [DeleteUser] -> Value # toEncodingList :: [DeleteUser] -> Encoding #
AWSRequest DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Associated Types type AWSResponse DeleteUser # Methods request :: DeleteUser -> Request DeleteUser # response :: MonadResource m => Logger -> Service -> Proxy DeleteUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteUser))) #
ToHeaders DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toHeaders :: DeleteUser -> [Header] #
ToPath DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toPath :: DeleteUser -> ByteString #
ToQuery DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toQuery :: DeleteUser -> QueryString #
type Rep DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser type Rep DeleteUser = D1 ('MetaData "DeleteUser" "Amazonka.Transfer.DeleteUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser type AWSResponse DeleteUser = DeleteUserResponse

newDeleteUser Source #

Arguments

:: Text	`$sel:serverId:DeleteUser'`
-> Text	`$sel:userName:DeleteUser'`
-> DeleteUser

Create a value of DeleteUser 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:serverId:DeleteUser', deleteUser_serverId - A system-assigned unique identifier for a server instance that has the user assigned to it.

$sel:userName:DeleteUser', deleteUser_userName - A unique string that identifies a user that is being deleted from a server.

data DeleteUserResponse Source #

See: newDeleteUserResponse smart constructor.

Constructors

DeleteUserResponse'

Instances

Instances details

Eq DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods (==) :: DeleteUserResponse -> DeleteUserResponse -> Bool # (/=) :: DeleteUserResponse -> DeleteUserResponse -> Bool #
Read DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods readsPrec :: Int -> ReadS DeleteUserResponse # readList :: ReadS [DeleteUserResponse] # readPrec :: ReadPrec DeleteUserResponse # readListPrec :: ReadPrec [DeleteUserResponse] #
Show DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods showsPrec :: Int -> DeleteUserResponse -> ShowS # show :: DeleteUserResponse -> String # showList :: [DeleteUserResponse] -> ShowS #
Generic DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Associated Types type Rep DeleteUserResponse :: Type -> Type # Methods from :: DeleteUserResponse -> Rep DeleteUserResponse x # to :: Rep DeleteUserResponse x -> DeleteUserResponse #
NFData DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods rnf :: DeleteUserResponse -> () #
type Rep DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser type Rep DeleteUserResponse = D1 ('MetaData "DeleteUserResponse" "Amazonka.Transfer.DeleteUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteUserResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteUserResponse :: DeleteUserResponse Source #

Create a value of DeleteUserResponse with all optional fields omitted.

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

TagResource

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' Text (NonEmpty Tag)

Instances

Instances details

Eq TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods (==) :: TagResource -> TagResource -> Bool # (/=) :: TagResource -> TagResource -> Bool #
Read TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods readsPrec :: Int -> ReadS TagResource # readList :: ReadS [TagResource] # readPrec :: ReadPrec TagResource # readListPrec :: ReadPrec [TagResource] #
Show TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods showsPrec :: Int -> TagResource -> ShowS # show :: TagResource -> String # showList :: [TagResource] -> ShowS #
Generic TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Associated Types type Rep TagResource :: Type -> Type # Methods from :: TagResource -> Rep TagResource x # to :: Rep TagResource x -> TagResource #
NFData TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods rnf :: TagResource -> () #
Hashable TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods hashWithSalt :: Int -> TagResource -> Int # hash :: TagResource -> Int #
ToJSON TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toJSON :: TagResource -> Value # toEncoding :: TagResource -> Encoding # toJSONList :: [TagResource] -> Value # toEncodingList :: [TagResource] -> Encoding #
AWSRequest TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Associated Types type AWSResponse TagResource # Methods request :: TagResource -> Request TagResource # response :: MonadResource m => Logger -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource))) #
ToHeaders TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toHeaders :: TagResource -> [Header] #
ToPath TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toPath :: TagResource -> ByteString #
ToQuery TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods toQuery :: TagResource -> QueryString #
type Rep TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Transfer.TagResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Tag))))
type AWSResponse TagResource Source #
Instance details Defined in Amazonka.Transfer.TagResource type AWSResponse TagResource = TagResourceResponse

newTagResource Source #

Arguments

:: Text	`$sel:arn:TagResource'`
-> NonEmpty Tag	`$sel:tags:TagResource'`
-> TagResource

Create a value of TagResource 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:arn:TagResource', tagResource_arn - An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

$sel:tags:TagResource', tagResource_tags - Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Instances details

Eq TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool #
Read TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # readPrec :: ReadPrec TagResourceResponse # readListPrec :: ReadPrec [TagResourceResponse] #
Show TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS #
Generic TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Associated Types type Rep TagResourceResponse :: Type -> Type # Methods from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse #
NFData TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource Methods rnf :: TagResourceResponse -> () #
type Rep TagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.TagResource type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Transfer.TagResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagResourceResponse :: TagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

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

UntagResource

data UntagResource Source #

See: newUntagResource smart constructor.

Constructors

UntagResource' Text (NonEmpty Text)

Instances

Instances details

Eq UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods (==) :: UntagResource -> UntagResource -> Bool # (/=) :: UntagResource -> UntagResource -> Bool #
Read UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods readsPrec :: Int -> ReadS UntagResource # readList :: ReadS [UntagResource] # readPrec :: ReadPrec UntagResource # readListPrec :: ReadPrec [UntagResource] #
Show UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods showsPrec :: Int -> UntagResource -> ShowS # show :: UntagResource -> String # showList :: [UntagResource] -> ShowS #
Generic UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Associated Types type Rep UntagResource :: Type -> Type # Methods from :: UntagResource -> Rep UntagResource x # to :: Rep UntagResource x -> UntagResource #
NFData UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods rnf :: UntagResource -> () #
Hashable UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods hashWithSalt :: Int -> UntagResource -> Int # hash :: UntagResource -> Int #
ToJSON UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods toJSON :: UntagResource -> Value # toEncoding :: UntagResource -> Encoding # toJSONList :: [UntagResource] -> Value # toEncodingList :: [UntagResource] -> Encoding #
AWSRequest UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Associated Types type AWSResponse UntagResource # Methods request :: UntagResource -> Request UntagResource # response :: MonadResource m => Logger -> Service -> Proxy UntagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UntagResource))) #
ToHeaders UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods toHeaders :: UntagResource -> [Header] #
ToPath UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods toPath :: UntagResource -> ByteString #
ToQuery UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods toQuery :: UntagResource -> QueryString #
type Rep UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.Transfer.UntagResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))
type AWSResponse UntagResource Source #
Instance details Defined in Amazonka.Transfer.UntagResource type AWSResponse UntagResource = UntagResourceResponse

newUntagResource Source #

Arguments

:: Text	`$sel:arn:UntagResource'`
-> NonEmpty Text	`$sel:tagKeys:UntagResource'`
-> UntagResource

Create a value of UntagResource 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:arn:UntagResource', untagResource_arn - The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

$sel:tagKeys:UntagResource', untagResource_tagKeys - TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Constructors

UntagResourceResponse'

Instances

Instances details

Eq UntagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool #
Read UntagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods readsPrec :: Int -> ReadS UntagResourceResponse # readList :: ReadS [UntagResourceResponse] # readPrec :: ReadPrec UntagResourceResponse # readListPrec :: ReadPrec [UntagResourceResponse] #
Show UntagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS #
Generic UntagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.UntagResource Associated Types type Rep UntagResourceResponse :: Type -> Type # Methods from :: UntagResourceResponse -> Rep UntagResourceResponse x # to :: Rep UntagResourceResponse x -> UntagResourceResponse #
NFData UntagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.UntagResource Methods rnf :: UntagResourceResponse -> () #
type Rep UntagResourceResponse Source #
Instance details Defined in Amazonka.Transfer.UntagResource type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.Transfer.UntagResource" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUntagResourceResponse :: UntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

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

DescribeWorkflow

data DescribeWorkflow Source #

See: newDescribeWorkflow smart constructor.

Constructors

DescribeWorkflow' Text

Instances

Instances details

Eq DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods (==) :: DescribeWorkflow -> DescribeWorkflow -> Bool # (/=) :: DescribeWorkflow -> DescribeWorkflow -> Bool #
Read DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods readsPrec :: Int -> ReadS DescribeWorkflow # readList :: ReadS [DescribeWorkflow] # readPrec :: ReadPrec DescribeWorkflow # readListPrec :: ReadPrec [DescribeWorkflow] #
Show DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods showsPrec :: Int -> DescribeWorkflow -> ShowS # show :: DescribeWorkflow -> String # showList :: [DescribeWorkflow] -> ShowS #
Generic DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Associated Types type Rep DescribeWorkflow :: Type -> Type # Methods from :: DescribeWorkflow -> Rep DescribeWorkflow x # to :: Rep DescribeWorkflow x -> DescribeWorkflow #
NFData DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods rnf :: DescribeWorkflow -> () #
Hashable DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods hashWithSalt :: Int -> DescribeWorkflow -> Int # hash :: DescribeWorkflow -> Int #
ToJSON DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods toJSON :: DescribeWorkflow -> Value # toEncoding :: DescribeWorkflow -> Encoding # toJSONList :: [DescribeWorkflow] -> Value # toEncodingList :: [DescribeWorkflow] -> Encoding #
AWSRequest DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Associated Types type AWSResponse DescribeWorkflow # Methods request :: DescribeWorkflow -> Request DescribeWorkflow # response :: MonadResource m => Logger -> Service -> Proxy DescribeWorkflow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeWorkflow))) #
ToHeaders DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods toHeaders :: DescribeWorkflow -> [Header] #
ToPath DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods toPath :: DescribeWorkflow -> ByteString #
ToQuery DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods toQuery :: DescribeWorkflow -> QueryString #
type Rep DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow type Rep DescribeWorkflow = D1 ('MetaData "DescribeWorkflow" "Amazonka.Transfer.DescribeWorkflow" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeWorkflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeWorkflow Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow type AWSResponse DescribeWorkflow = DescribeWorkflowResponse

newDescribeWorkflow Source #

Arguments

:: Text	`$sel:workflowId:DescribeWorkflow'`
-> DescribeWorkflow

Create a value of DescribeWorkflow 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:workflowId:DescribeWorkflow', describeWorkflow_workflowId - A unique identifier for the workflow.

data DescribeWorkflowResponse Source #

See: newDescribeWorkflowResponse smart constructor.

Constructors

DescribeWorkflowResponse' Int DescribedWorkflow

Instances

Instances details

Eq DescribeWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods (==) :: DescribeWorkflowResponse -> DescribeWorkflowResponse -> Bool # (/=) :: DescribeWorkflowResponse -> DescribeWorkflowResponse -> Bool #
Read DescribeWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods readsPrec :: Int -> ReadS DescribeWorkflowResponse # readList :: ReadS [DescribeWorkflowResponse] # readPrec :: ReadPrec DescribeWorkflowResponse # readListPrec :: ReadPrec [DescribeWorkflowResponse] #
Show DescribeWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods showsPrec :: Int -> DescribeWorkflowResponse -> ShowS # show :: DescribeWorkflowResponse -> String # showList :: [DescribeWorkflowResponse] -> ShowS #
Generic DescribeWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Associated Types type Rep DescribeWorkflowResponse :: Type -> Type # Methods from :: DescribeWorkflowResponse -> Rep DescribeWorkflowResponse x # to :: Rep DescribeWorkflowResponse x -> DescribeWorkflowResponse #
NFData DescribeWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow Methods rnf :: DescribeWorkflowResponse -> () #
type Rep DescribeWorkflowResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeWorkflow type Rep DescribeWorkflowResponse = D1 ('MetaData "DescribeWorkflowResponse" "Amazonka.Transfer.DescribeWorkflow" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeWorkflowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workflow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedWorkflow)))

newDescribeWorkflowResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeWorkflowResponse'`
-> DescribedWorkflow	`$sel:workflow:DescribeWorkflowResponse'`
-> DescribeWorkflowResponse

Create a value of DescribeWorkflowResponse 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:httpStatus:DescribeWorkflowResponse', describeWorkflowResponse_httpStatus - The response's http status code.

$sel:workflow:DescribeWorkflowResponse', describeWorkflowResponse_workflow - The structure that contains the details of the workflow.

DescribeAccess

data DescribeAccess Source #

See: newDescribeAccess smart constructor.

Constructors

DescribeAccess' Text Text

Instances

Instances details

Eq DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods (==) :: DescribeAccess -> DescribeAccess -> Bool # (/=) :: DescribeAccess -> DescribeAccess -> Bool #
Read DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods readsPrec :: Int -> ReadS DescribeAccess # readList :: ReadS [DescribeAccess] # readPrec :: ReadPrec DescribeAccess # readListPrec :: ReadPrec [DescribeAccess] #
Show DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods showsPrec :: Int -> DescribeAccess -> ShowS # show :: DescribeAccess -> String # showList :: [DescribeAccess] -> ShowS #
Generic DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Associated Types type Rep DescribeAccess :: Type -> Type # Methods from :: DescribeAccess -> Rep DescribeAccess x # to :: Rep DescribeAccess x -> DescribeAccess #
NFData DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods rnf :: DescribeAccess -> () #
Hashable DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods hashWithSalt :: Int -> DescribeAccess -> Int # hash :: DescribeAccess -> Int #
ToJSON DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toJSON :: DescribeAccess -> Value # toEncoding :: DescribeAccess -> Encoding # toJSONList :: [DescribeAccess] -> Value # toEncodingList :: [DescribeAccess] -> Encoding #
AWSRequest DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Associated Types type AWSResponse DescribeAccess # Methods request :: DescribeAccess -> Request DescribeAccess # response :: MonadResource m => Logger -> Service -> Proxy DescribeAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAccess))) #
ToHeaders DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toHeaders :: DescribeAccess -> [Header] #
ToPath DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toPath :: DescribeAccess -> ByteString #
ToQuery DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods toQuery :: DescribeAccess -> QueryString #
type Rep DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess type Rep DescribeAccess = D1 ('MetaData "DescribeAccess" "Amazonka.Transfer.DescribeAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeAccess Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess type AWSResponse DescribeAccess = DescribeAccessResponse

newDescribeAccess Source #

Arguments

:: Text	`$sel:serverId:DescribeAccess'`
-> Text	`$sel:externalId:DescribeAccess'`
-> DescribeAccess

Create a value of DescribeAccess 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:serverId:DescribeAccess', describeAccess_serverId - A system-assigned unique identifier for a server that has this access assigned.

$sel:externalId:DescribeAccess', describeAccess_externalId - A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

data DescribeAccessResponse Source #

See: newDescribeAccessResponse smart constructor.

Constructors

DescribeAccessResponse' Int Text DescribedAccess

Instances

Instances details

Eq DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods (==) :: DescribeAccessResponse -> DescribeAccessResponse -> Bool # (/=) :: DescribeAccessResponse -> DescribeAccessResponse -> Bool #
Read DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods readsPrec :: Int -> ReadS DescribeAccessResponse # readList :: ReadS [DescribeAccessResponse] # readPrec :: ReadPrec DescribeAccessResponse # readListPrec :: ReadPrec [DescribeAccessResponse] #
Show DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods showsPrec :: Int -> DescribeAccessResponse -> ShowS # show :: DescribeAccessResponse -> String # showList :: [DescribeAccessResponse] -> ShowS #
Generic DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Associated Types type Rep DescribeAccessResponse :: Type -> Type # Methods from :: DescribeAccessResponse -> Rep DescribeAccessResponse x # to :: Rep DescribeAccessResponse x -> DescribeAccessResponse #
NFData DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess Methods rnf :: DescribeAccessResponse -> () #
type Rep DescribeAccessResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeAccess type Rep DescribeAccessResponse = D1 ('MetaData "DescribeAccessResponse" "Amazonka.Transfer.DescribeAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "access") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedAccess))))

newDescribeAccessResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAccessResponse'`
-> Text	`$sel:serverId:DescribeAccess'`
-> DescribedAccess	`$sel:access:DescribeAccessResponse'`
-> DescribeAccessResponse

Create a value of DescribeAccessResponse 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:httpStatus:DescribeAccessResponse', describeAccessResponse_httpStatus - The response's http status code.

$sel:serverId:DescribeAccess', describeAccessResponse_serverId - A system-assigned unique identifier for a server that has this access assigned.

$sel:access:DescribeAccessResponse', describeAccessResponse_access - The external ID of the server that the access is attached to.

Types

CustomStepStatus

newtype CustomStepStatus Source #

Constructors

CustomStepStatus'
Fields fromCustomStepStatus :: Text

Bundled Patterns

pattern CustomStepStatus_FAILURE :: CustomStepStatus
pattern CustomStepStatus_SUCCESS :: CustomStepStatus

Instances

Instances details

Eq CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods (==) :: CustomStepStatus -> CustomStepStatus -> Bool # (/=) :: CustomStepStatus -> CustomStepStatus -> Bool #
Ord CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods compare :: CustomStepStatus -> CustomStepStatus -> Ordering # (<) :: CustomStepStatus -> CustomStepStatus -> Bool # (<=) :: CustomStepStatus -> CustomStepStatus -> Bool # (>) :: CustomStepStatus -> CustomStepStatus -> Bool # (>=) :: CustomStepStatus -> CustomStepStatus -> Bool # max :: CustomStepStatus -> CustomStepStatus -> CustomStepStatus # min :: CustomStepStatus -> CustomStepStatus -> CustomStepStatus #
Read CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods readsPrec :: Int -> ReadS CustomStepStatus # readList :: ReadS [CustomStepStatus] # readPrec :: ReadPrec CustomStepStatus # readListPrec :: ReadPrec [CustomStepStatus] #
Show CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods showsPrec :: Int -> CustomStepStatus -> ShowS # show :: CustomStepStatus -> String # showList :: [CustomStepStatus] -> ShowS #
Generic CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Associated Types type Rep CustomStepStatus :: Type -> Type # Methods from :: CustomStepStatus -> Rep CustomStepStatus x # to :: Rep CustomStepStatus x -> CustomStepStatus #
NFData CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods rnf :: CustomStepStatus -> () #
Hashable CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods hashWithSalt :: Int -> CustomStepStatus -> Int # hash :: CustomStepStatus -> Int #
ToJSON CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods toJSON :: CustomStepStatus -> Value # toEncoding :: CustomStepStatus -> Encoding # toJSONList :: [CustomStepStatus] -> Value # toEncodingList :: [CustomStepStatus] -> Encoding #
ToJSONKey CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods toJSONKey :: ToJSONKeyFunction CustomStepStatus # toJSONKeyList :: ToJSONKeyFunction [CustomStepStatus] #
FromJSON CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods parseJSON :: Value -> Parser CustomStepStatus # parseJSONList :: Value -> Parser [CustomStepStatus] #
FromJSONKey CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods fromJSONKey :: FromJSONKeyFunction CustomStepStatus # fromJSONKeyList :: FromJSONKeyFunction [CustomStepStatus] #
ToLog CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods build :: CustomStepStatus -> ByteStringBuilder #
ToHeader CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods toHeader :: HeaderName -> CustomStepStatus -> [Header] #
ToQuery CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods toQuery :: CustomStepStatus -> QueryString #
FromXML CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods parseXML :: [Node] -> Either String CustomStepStatus #
ToXML CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods toXML :: CustomStepStatus -> XML #
ToByteString CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods toBS :: CustomStepStatus -> ByteString #
FromText CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods fromText :: Text -> Either String CustomStepStatus #
ToText CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus Methods toText :: CustomStepStatus -> Text #
type Rep CustomStepStatus Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepStatus type Rep CustomStepStatus = D1 ('MetaData "CustomStepStatus" "Amazonka.Transfer.Types.CustomStepStatus" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "CustomStepStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCustomStepStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Domain

newtype Domain Source #

Constructors

Domain'
Fields fromDomain :: Text

Bundled Patterns

pattern Domain_EFS :: Domain
pattern Domain_S3 :: Domain

Instances

Instances details

Eq Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods (==) :: Domain -> Domain -> Bool # (/=) :: Domain -> Domain -> Bool #
Ord Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods compare :: Domain -> Domain -> Ordering # (<) :: Domain -> Domain -> Bool # (<=) :: Domain -> Domain -> Bool # (>) :: Domain -> Domain -> Bool # (>=) :: Domain -> Domain -> Bool # max :: Domain -> Domain -> Domain # min :: Domain -> Domain -> Domain #
Read Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods readsPrec :: Int -> ReadS Domain # readList :: ReadS [Domain] # readPrec :: ReadPrec Domain # readListPrec :: ReadPrec [Domain] #
Show Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods showsPrec :: Int -> Domain -> ShowS # show :: Domain -> String # showList :: [Domain] -> ShowS #
Generic Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Associated Types type Rep Domain :: Type -> Type # Methods from :: Domain -> Rep Domain x # to :: Rep Domain x -> Domain #
NFData Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods rnf :: Domain -> () #
Hashable Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods hashWithSalt :: Int -> Domain -> Int # hash :: Domain -> Int #
ToJSON Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods toJSON :: Domain -> Value # toEncoding :: Domain -> Encoding # toJSONList :: [Domain] -> Value # toEncodingList :: [Domain] -> Encoding #
ToJSONKey Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods toJSONKey :: ToJSONKeyFunction Domain # toJSONKeyList :: ToJSONKeyFunction [Domain] #
FromJSON Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods parseJSON :: Value -> Parser Domain # parseJSONList :: Value -> Parser [Domain] #
FromJSONKey Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods fromJSONKey :: FromJSONKeyFunction Domain # fromJSONKeyList :: FromJSONKeyFunction [Domain] #
ToLog Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods build :: Domain -> ByteStringBuilder #
ToHeader Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods toHeader :: HeaderName -> Domain -> [Header] #
ToQuery Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods toQuery :: Domain -> QueryString #
FromXML Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods parseXML :: [Node] -> Either String Domain #
ToXML Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods toXML :: Domain -> XML #
ToByteString Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods toBS :: Domain -> ByteString #
FromText Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods fromText :: Text -> Either String Domain #
ToText Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain Methods toText :: Domain -> Text #
type Rep Domain Source #
Instance details Defined in Amazonka.Transfer.Types.Domain type Rep Domain = D1 ('MetaData "Domain" "Amazonka.Transfer.Types.Domain" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "Domain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EndpointType

newtype EndpointType Source #

Constructors

EndpointType'
Fields fromEndpointType :: Text

Bundled Patterns

pattern EndpointType_PUBLIC :: EndpointType
pattern EndpointType_VPC :: EndpointType
pattern EndpointType_VPC_ENDPOINT :: EndpointType

Instances

Instances details

Eq EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods (==) :: EndpointType -> EndpointType -> Bool # (/=) :: EndpointType -> EndpointType -> Bool #
Ord EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods compare :: EndpointType -> EndpointType -> Ordering # (<) :: EndpointType -> EndpointType -> Bool # (<=) :: EndpointType -> EndpointType -> Bool # (>) :: EndpointType -> EndpointType -> Bool # (>=) :: EndpointType -> EndpointType -> Bool # max :: EndpointType -> EndpointType -> EndpointType # min :: EndpointType -> EndpointType -> EndpointType #
Read EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods readsPrec :: Int -> ReadS EndpointType # readList :: ReadS [EndpointType] # readPrec :: ReadPrec EndpointType # readListPrec :: ReadPrec [EndpointType] #
Show EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods showsPrec :: Int -> EndpointType -> ShowS # show :: EndpointType -> String # showList :: [EndpointType] -> ShowS #
Generic EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Associated Types type Rep EndpointType :: Type -> Type # Methods from :: EndpointType -> Rep EndpointType x # to :: Rep EndpointType x -> EndpointType #
NFData EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods rnf :: EndpointType -> () #
Hashable EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods hashWithSalt :: Int -> EndpointType -> Int # hash :: EndpointType -> Int #
ToJSON EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods toJSON :: EndpointType -> Value # toEncoding :: EndpointType -> Encoding # toJSONList :: [EndpointType] -> Value # toEncodingList :: [EndpointType] -> Encoding #
ToJSONKey EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods toJSONKey :: ToJSONKeyFunction EndpointType # toJSONKeyList :: ToJSONKeyFunction [EndpointType] #
FromJSON EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods parseJSON :: Value -> Parser EndpointType # parseJSONList :: Value -> Parser [EndpointType] #
FromJSONKey EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods fromJSONKey :: FromJSONKeyFunction EndpointType # fromJSONKeyList :: FromJSONKeyFunction [EndpointType] #
ToLog EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods build :: EndpointType -> ByteStringBuilder #
ToHeader EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods toHeader :: HeaderName -> EndpointType -> [Header] #
ToQuery EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods toQuery :: EndpointType -> QueryString #
FromXML EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods parseXML :: [Node] -> Either String EndpointType #
ToXML EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods toXML :: EndpointType -> XML #
ToByteString EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods toBS :: EndpointType -> ByteString #
FromText EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods fromText :: Text -> Either String EndpointType #
ToText EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType Methods toText :: EndpointType -> Text #
type Rep EndpointType Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointType type Rep EndpointType = D1 ('MetaData "EndpointType" "Amazonka.Transfer.Types.EndpointType" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "EndpointType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExecutionErrorType

newtype ExecutionErrorType Source #

Constructors

ExecutionErrorType'
Fields fromExecutionErrorType :: Text

Bundled Patterns

pattern ExecutionErrorType_PERMISSION_DENIED :: ExecutionErrorType

Instances

Instances details

Eq ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods (==) :: ExecutionErrorType -> ExecutionErrorType -> Bool # (/=) :: ExecutionErrorType -> ExecutionErrorType -> Bool #
Ord ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods compare :: ExecutionErrorType -> ExecutionErrorType -> Ordering # (<) :: ExecutionErrorType -> ExecutionErrorType -> Bool # (<=) :: ExecutionErrorType -> ExecutionErrorType -> Bool # (>) :: ExecutionErrorType -> ExecutionErrorType -> Bool # (>=) :: ExecutionErrorType -> ExecutionErrorType -> Bool # max :: ExecutionErrorType -> ExecutionErrorType -> ExecutionErrorType # min :: ExecutionErrorType -> ExecutionErrorType -> ExecutionErrorType #
Read ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods readsPrec :: Int -> ReadS ExecutionErrorType # readList :: ReadS [ExecutionErrorType] # readPrec :: ReadPrec ExecutionErrorType # readListPrec :: ReadPrec [ExecutionErrorType] #
Show ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods showsPrec :: Int -> ExecutionErrorType -> ShowS # show :: ExecutionErrorType -> String # showList :: [ExecutionErrorType] -> ShowS #
Generic ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Associated Types type Rep ExecutionErrorType :: Type -> Type # Methods from :: ExecutionErrorType -> Rep ExecutionErrorType x # to :: Rep ExecutionErrorType x -> ExecutionErrorType #
NFData ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods rnf :: ExecutionErrorType -> () #
Hashable ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods hashWithSalt :: Int -> ExecutionErrorType -> Int # hash :: ExecutionErrorType -> Int #
ToJSON ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods toJSON :: ExecutionErrorType -> Value # toEncoding :: ExecutionErrorType -> Encoding # toJSONList :: [ExecutionErrorType] -> Value # toEncodingList :: [ExecutionErrorType] -> Encoding #
ToJSONKey ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods toJSONKey :: ToJSONKeyFunction ExecutionErrorType # toJSONKeyList :: ToJSONKeyFunction [ExecutionErrorType] #
FromJSON ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods parseJSON :: Value -> Parser ExecutionErrorType # parseJSONList :: Value -> Parser [ExecutionErrorType] #
FromJSONKey ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods fromJSONKey :: FromJSONKeyFunction ExecutionErrorType # fromJSONKeyList :: FromJSONKeyFunction [ExecutionErrorType] #
ToLog ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods build :: ExecutionErrorType -> ByteStringBuilder #
ToHeader ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods toHeader :: HeaderName -> ExecutionErrorType -> [Header] #
ToQuery ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods toQuery :: ExecutionErrorType -> QueryString #
FromXML ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods parseXML :: [Node] -> Either String ExecutionErrorType #
ToXML ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods toXML :: ExecutionErrorType -> XML #
ToByteString ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods toBS :: ExecutionErrorType -> ByteString #
FromText ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods fromText :: Text -> Either String ExecutionErrorType #
ToText ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType Methods toText :: ExecutionErrorType -> Text #
type Rep ExecutionErrorType Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionErrorType type Rep ExecutionErrorType = D1 ('MetaData "ExecutionErrorType" "Amazonka.Transfer.Types.ExecutionErrorType" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "ExecutionErrorType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExecutionErrorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExecutionStatus

newtype ExecutionStatus Source #

Constructors

ExecutionStatus'
Fields fromExecutionStatus :: Text

Bundled Patterns

pattern ExecutionStatus_COMPLETED :: ExecutionStatus
pattern ExecutionStatus_EXCEPTION :: ExecutionStatus
pattern ExecutionStatus_HANDLING_EXCEPTION :: ExecutionStatus
pattern ExecutionStatus_IN_PROGRESS :: ExecutionStatus

Instances

Instances details

Eq ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods (==) :: ExecutionStatus -> ExecutionStatus -> Bool # (/=) :: ExecutionStatus -> ExecutionStatus -> Bool #
Ord ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods compare :: ExecutionStatus -> ExecutionStatus -> Ordering # (<) :: ExecutionStatus -> ExecutionStatus -> Bool # (<=) :: ExecutionStatus -> ExecutionStatus -> Bool # (>) :: ExecutionStatus -> ExecutionStatus -> Bool # (>=) :: ExecutionStatus -> ExecutionStatus -> Bool # max :: ExecutionStatus -> ExecutionStatus -> ExecutionStatus # min :: ExecutionStatus -> ExecutionStatus -> ExecutionStatus #
Read ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods readsPrec :: Int -> ReadS ExecutionStatus # readList :: ReadS [ExecutionStatus] # readPrec :: ReadPrec ExecutionStatus # readListPrec :: ReadPrec [ExecutionStatus] #
Show ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods showsPrec :: Int -> ExecutionStatus -> ShowS # show :: ExecutionStatus -> String # showList :: [ExecutionStatus] -> ShowS #
Generic ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Associated Types type Rep ExecutionStatus :: Type -> Type # Methods from :: ExecutionStatus -> Rep ExecutionStatus x # to :: Rep ExecutionStatus x -> ExecutionStatus #
NFData ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods rnf :: ExecutionStatus -> () #
Hashable ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods hashWithSalt :: Int -> ExecutionStatus -> Int # hash :: ExecutionStatus -> Int #
ToJSON ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods toJSON :: ExecutionStatus -> Value # toEncoding :: ExecutionStatus -> Encoding # toJSONList :: [ExecutionStatus] -> Value # toEncodingList :: [ExecutionStatus] -> Encoding #
ToJSONKey ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods toJSONKey :: ToJSONKeyFunction ExecutionStatus # toJSONKeyList :: ToJSONKeyFunction [ExecutionStatus] #
FromJSON ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods parseJSON :: Value -> Parser ExecutionStatus # parseJSONList :: Value -> Parser [ExecutionStatus] #
FromJSONKey ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods fromJSONKey :: FromJSONKeyFunction ExecutionStatus # fromJSONKeyList :: FromJSONKeyFunction [ExecutionStatus] #
ToLog ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods build :: ExecutionStatus -> ByteStringBuilder #
ToHeader ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods toHeader :: HeaderName -> ExecutionStatus -> [Header] #
ToQuery ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods toQuery :: ExecutionStatus -> QueryString #
FromXML ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods parseXML :: [Node] -> Either String ExecutionStatus #
ToXML ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods toXML :: ExecutionStatus -> XML #
ToByteString ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods toBS :: ExecutionStatus -> ByteString #
FromText ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods fromText :: Text -> Either String ExecutionStatus #
ToText ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus Methods toText :: ExecutionStatus -> Text #
type Rep ExecutionStatus Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStatus type Rep ExecutionStatus = D1 ('MetaData "ExecutionStatus" "Amazonka.Transfer.Types.ExecutionStatus" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "ExecutionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExecutionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

HomeDirectoryType

newtype HomeDirectoryType Source #

Constructors

HomeDirectoryType'
Fields fromHomeDirectoryType :: Text

Bundled Patterns

pattern HomeDirectoryType_LOGICAL :: HomeDirectoryType
pattern HomeDirectoryType_PATH :: HomeDirectoryType

Instances

Instances details

Eq HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods (==) :: HomeDirectoryType -> HomeDirectoryType -> Bool # (/=) :: HomeDirectoryType -> HomeDirectoryType -> Bool #
Ord HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods compare :: HomeDirectoryType -> HomeDirectoryType -> Ordering # (<) :: HomeDirectoryType -> HomeDirectoryType -> Bool # (<=) :: HomeDirectoryType -> HomeDirectoryType -> Bool # (>) :: HomeDirectoryType -> HomeDirectoryType -> Bool # (>=) :: HomeDirectoryType -> HomeDirectoryType -> Bool # max :: HomeDirectoryType -> HomeDirectoryType -> HomeDirectoryType # min :: HomeDirectoryType -> HomeDirectoryType -> HomeDirectoryType #
Read HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods readsPrec :: Int -> ReadS HomeDirectoryType # readList :: ReadS [HomeDirectoryType] # readPrec :: ReadPrec HomeDirectoryType # readListPrec :: ReadPrec [HomeDirectoryType] #
Show HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods showsPrec :: Int -> HomeDirectoryType -> ShowS # show :: HomeDirectoryType -> String # showList :: [HomeDirectoryType] -> ShowS #
Generic HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Associated Types type Rep HomeDirectoryType :: Type -> Type # Methods from :: HomeDirectoryType -> Rep HomeDirectoryType x # to :: Rep HomeDirectoryType x -> HomeDirectoryType #
NFData HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods rnf :: HomeDirectoryType -> () #
Hashable HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods hashWithSalt :: Int -> HomeDirectoryType -> Int # hash :: HomeDirectoryType -> Int #
ToJSON HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods toJSON :: HomeDirectoryType -> Value # toEncoding :: HomeDirectoryType -> Encoding # toJSONList :: [HomeDirectoryType] -> Value # toEncodingList :: [HomeDirectoryType] -> Encoding #
ToJSONKey HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods toJSONKey :: ToJSONKeyFunction HomeDirectoryType # toJSONKeyList :: ToJSONKeyFunction [HomeDirectoryType] #
FromJSON HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods parseJSON :: Value -> Parser HomeDirectoryType # parseJSONList :: Value -> Parser [HomeDirectoryType] #
FromJSONKey HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods fromJSONKey :: FromJSONKeyFunction HomeDirectoryType # fromJSONKeyList :: FromJSONKeyFunction [HomeDirectoryType] #
ToLog HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods build :: HomeDirectoryType -> ByteStringBuilder #
ToHeader HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods toHeader :: HeaderName -> HomeDirectoryType -> [Header] #
ToQuery HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods toQuery :: HomeDirectoryType -> QueryString #
FromXML HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods parseXML :: [Node] -> Either String HomeDirectoryType #
ToXML HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods toXML :: HomeDirectoryType -> XML #
ToByteString HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods toBS :: HomeDirectoryType -> ByteString #
FromText HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods fromText :: Text -> Either String HomeDirectoryType #
ToText HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType Methods toText :: HomeDirectoryType -> Text #
type Rep HomeDirectoryType Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryType type Rep HomeDirectoryType = D1 ('MetaData "HomeDirectoryType" "Amazonka.Transfer.Types.HomeDirectoryType" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "HomeDirectoryType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromHomeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IdentityProviderType

newtype IdentityProviderType Source #

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. For AWS_DIRECTORY_SERVICE or SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on the server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. The server can have only one method of authentication.

Constructors

IdentityProviderType'
Fields fromIdentityProviderType :: Text

Bundled Patterns

pattern IdentityProviderType_API_GATEWAY :: IdentityProviderType
pattern IdentityProviderType_AWS_DIRECTORY_SERVICE :: IdentityProviderType
pattern IdentityProviderType_SERVICE_MANAGED :: IdentityProviderType

Instances

Instances details

Eq IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods (==) :: IdentityProviderType -> IdentityProviderType -> Bool # (/=) :: IdentityProviderType -> IdentityProviderType -> Bool #
Ord IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods compare :: IdentityProviderType -> IdentityProviderType -> Ordering # (<) :: IdentityProviderType -> IdentityProviderType -> Bool # (<=) :: IdentityProviderType -> IdentityProviderType -> Bool # (>) :: IdentityProviderType -> IdentityProviderType -> Bool # (>=) :: IdentityProviderType -> IdentityProviderType -> Bool # max :: IdentityProviderType -> IdentityProviderType -> IdentityProviderType # min :: IdentityProviderType -> IdentityProviderType -> IdentityProviderType #
Read IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods readsPrec :: Int -> ReadS IdentityProviderType # readList :: ReadS [IdentityProviderType] # readPrec :: ReadPrec IdentityProviderType # readListPrec :: ReadPrec [IdentityProviderType] #
Show IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods showsPrec :: Int -> IdentityProviderType -> ShowS # show :: IdentityProviderType -> String # showList :: [IdentityProviderType] -> ShowS #
Generic IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Associated Types type Rep IdentityProviderType :: Type -> Type # Methods from :: IdentityProviderType -> Rep IdentityProviderType x # to :: Rep IdentityProviderType x -> IdentityProviderType #
NFData IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods rnf :: IdentityProviderType -> () #
Hashable IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods hashWithSalt :: Int -> IdentityProviderType -> Int # hash :: IdentityProviderType -> Int #
ToJSON IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods toJSON :: IdentityProviderType -> Value # toEncoding :: IdentityProviderType -> Encoding # toJSONList :: [IdentityProviderType] -> Value # toEncodingList :: [IdentityProviderType] -> Encoding #
ToJSONKey IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods toJSONKey :: ToJSONKeyFunction IdentityProviderType # toJSONKeyList :: ToJSONKeyFunction [IdentityProviderType] #
FromJSON IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods parseJSON :: Value -> Parser IdentityProviderType # parseJSONList :: Value -> Parser [IdentityProviderType] #
FromJSONKey IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods fromJSONKey :: FromJSONKeyFunction IdentityProviderType # fromJSONKeyList :: FromJSONKeyFunction [IdentityProviderType] #
ToLog IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods build :: IdentityProviderType -> ByteStringBuilder #
ToHeader IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods toHeader :: HeaderName -> IdentityProviderType -> [Header] #
ToQuery IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods toQuery :: IdentityProviderType -> QueryString #
FromXML IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods parseXML :: [Node] -> Either String IdentityProviderType #
ToXML IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods toXML :: IdentityProviderType -> XML #
ToByteString IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods toBS :: IdentityProviderType -> ByteString #
FromText IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods fromText :: Text -> Either String IdentityProviderType #
ToText IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType Methods toText :: IdentityProviderType -> Text #
type Rep IdentityProviderType Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderType type Rep IdentityProviderType = D1 ('MetaData "IdentityProviderType" "Amazonka.Transfer.Types.IdentityProviderType" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "IdentityProviderType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIdentityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OverwriteExisting

newtype OverwriteExisting Source #

Constructors

OverwriteExisting'
Fields fromOverwriteExisting :: Text

Bundled Patterns

pattern OverwriteExisting_FALSE :: OverwriteExisting
pattern OverwriteExisting_TRUE :: OverwriteExisting

Instances

Instances details

Eq OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods (==) :: OverwriteExisting -> OverwriteExisting -> Bool # (/=) :: OverwriteExisting -> OverwriteExisting -> Bool #
Ord OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods compare :: OverwriteExisting -> OverwriteExisting -> Ordering # (<) :: OverwriteExisting -> OverwriteExisting -> Bool # (<=) :: OverwriteExisting -> OverwriteExisting -> Bool # (>) :: OverwriteExisting -> OverwriteExisting -> Bool # (>=) :: OverwriteExisting -> OverwriteExisting -> Bool # max :: OverwriteExisting -> OverwriteExisting -> OverwriteExisting # min :: OverwriteExisting -> OverwriteExisting -> OverwriteExisting #
Read OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods readsPrec :: Int -> ReadS OverwriteExisting # readList :: ReadS [OverwriteExisting] # readPrec :: ReadPrec OverwriteExisting # readListPrec :: ReadPrec [OverwriteExisting] #
Show OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods showsPrec :: Int -> OverwriteExisting -> ShowS # show :: OverwriteExisting -> String # showList :: [OverwriteExisting] -> ShowS #
Generic OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Associated Types type Rep OverwriteExisting :: Type -> Type # Methods from :: OverwriteExisting -> Rep OverwriteExisting x # to :: Rep OverwriteExisting x -> OverwriteExisting #
NFData OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods rnf :: OverwriteExisting -> () #
Hashable OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods hashWithSalt :: Int -> OverwriteExisting -> Int # hash :: OverwriteExisting -> Int #
ToJSON OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods toJSON :: OverwriteExisting -> Value # toEncoding :: OverwriteExisting -> Encoding # toJSONList :: [OverwriteExisting] -> Value # toEncodingList :: [OverwriteExisting] -> Encoding #
ToJSONKey OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods toJSONKey :: ToJSONKeyFunction OverwriteExisting # toJSONKeyList :: ToJSONKeyFunction [OverwriteExisting] #
FromJSON OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods parseJSON :: Value -> Parser OverwriteExisting # parseJSONList :: Value -> Parser [OverwriteExisting] #
FromJSONKey OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods fromJSONKey :: FromJSONKeyFunction OverwriteExisting # fromJSONKeyList :: FromJSONKeyFunction [OverwriteExisting] #
ToLog OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods build :: OverwriteExisting -> ByteStringBuilder #
ToHeader OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods toHeader :: HeaderName -> OverwriteExisting -> [Header] #
ToQuery OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods toQuery :: OverwriteExisting -> QueryString #
FromXML OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods parseXML :: [Node] -> Either String OverwriteExisting #
ToXML OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods toXML :: OverwriteExisting -> XML #
ToByteString OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods toBS :: OverwriteExisting -> ByteString #
FromText OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods fromText :: Text -> Either String OverwriteExisting #
ToText OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting Methods toText :: OverwriteExisting -> Text #
type Rep OverwriteExisting Source #
Instance details Defined in Amazonka.Transfer.Types.OverwriteExisting type Rep OverwriteExisting = D1 ('MetaData "OverwriteExisting" "Amazonka.Transfer.Types.OverwriteExisting" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "OverwriteExisting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOverwriteExisting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Protocol

newtype Protocol Source #

Constructors

Protocol'
Fields fromProtocol :: Text

Bundled Patterns

pattern Protocol_FTP :: Protocol
pattern Protocol_FTPS :: Protocol
pattern Protocol_SFTP :: Protocol

Instances

Instances details

Eq Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
Ord Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods compare :: Protocol -> Protocol -> Ordering # (<) :: Protocol -> Protocol -> Bool # (<=) :: Protocol -> Protocol -> Bool # (>) :: Protocol -> Protocol -> Bool # (>=) :: Protocol -> Protocol -> Bool # max :: Protocol -> Protocol -> Protocol # min :: Protocol -> Protocol -> Protocol #
Read Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods readsPrec :: Int -> ReadS Protocol # readList :: ReadS [Protocol] # readPrec :: ReadPrec Protocol # readListPrec :: ReadPrec [Protocol] #
Show Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #
Generic Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Associated Types type Rep Protocol :: Type -> Type # Methods from :: Protocol -> Rep Protocol x # to :: Rep Protocol x -> Protocol #
NFData Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods rnf :: Protocol -> () #
Hashable Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods hashWithSalt :: Int -> Protocol -> Int # hash :: Protocol -> Int #
ToJSON Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods toJSON :: Protocol -> Value # toEncoding :: Protocol -> Encoding # toJSONList :: [Protocol] -> Value # toEncodingList :: [Protocol] -> Encoding #
ToJSONKey Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods toJSONKey :: ToJSONKeyFunction Protocol # toJSONKeyList :: ToJSONKeyFunction [Protocol] #
FromJSON Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods parseJSON :: Value -> Parser Protocol # parseJSONList :: Value -> Parser [Protocol] #
FromJSONKey Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods fromJSONKey :: FromJSONKeyFunction Protocol # fromJSONKeyList :: FromJSONKeyFunction [Protocol] #
ToLog Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods build :: Protocol -> ByteStringBuilder #
ToHeader Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods toHeader :: HeaderName -> Protocol -> [Header] #
ToQuery Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods toQuery :: Protocol -> QueryString #
FromXML Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods parseXML :: [Node] -> Either String Protocol #
ToXML Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods toXML :: Protocol -> XML #
ToByteString Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods toBS :: Protocol -> ByteString #
FromText Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods fromText :: Text -> Either String Protocol #
ToText Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol Methods toText :: Protocol -> Text #
type Rep Protocol Source #
Instance details Defined in Amazonka.Transfer.Types.Protocol type Rep Protocol = D1 ('MetaData "Protocol" "Amazonka.Transfer.Types.Protocol" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "Protocol'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

State

newtype State Source #

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

Constructors

State'
Fields fromState :: Text

Bundled Patterns

pattern State_OFFLINE :: State
pattern State_ONLINE :: State
pattern State_STARTING :: State
pattern State_START_FAILED :: State
pattern State_STOPPING :: State
pattern State_STOP_FAILED :: State

Instances

Instances details

Eq State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods (==) :: State -> State -> Bool # (/=) :: State -> State -> Bool #
Ord State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods compare :: State -> State -> Ordering # (<) :: State -> State -> Bool # (<=) :: State -> State -> Bool # (>) :: State -> State -> Bool # (>=) :: State -> State -> Bool # max :: State -> State -> State # min :: State -> State -> State #
Read State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods readsPrec :: Int -> ReadS State # readList :: ReadS [State] # readPrec :: ReadPrec State # readListPrec :: ReadPrec [State] #
Show State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods showsPrec :: Int -> State -> ShowS # show :: State -> String # showList :: [State] -> ShowS #
Generic State Source #
Instance details Defined in Amazonka.Transfer.Types.State Associated Types type Rep State :: Type -> Type # Methods from :: State -> Rep State x # to :: Rep State x -> State #
NFData State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods rnf :: State -> () #
Hashable State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods hashWithSalt :: Int -> State -> Int # hash :: State -> Int #
ToJSON State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toJSON :: State -> Value # toEncoding :: State -> Encoding # toJSONList :: [State] -> Value # toEncodingList :: [State] -> Encoding #
ToJSONKey State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toJSONKey :: ToJSONKeyFunction State # toJSONKeyList :: ToJSONKeyFunction [State] #
FromJSON State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods parseJSON :: Value -> Parser State # parseJSONList :: Value -> Parser [State] #
FromJSONKey State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods fromJSONKey :: FromJSONKeyFunction State # fromJSONKeyList :: FromJSONKeyFunction [State] #
ToLog State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods build :: State -> ByteStringBuilder #
ToHeader State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toHeader :: HeaderName -> State -> [Header] #
ToQuery State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toQuery :: State -> QueryString #
FromXML State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods parseXML :: [Node] -> Either String State #
ToXML State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toXML :: State -> XML #
ToByteString State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toBS :: State -> ByteString #
FromText State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods fromText :: Text -> Either String State #
ToText State Source #
Instance details Defined in Amazonka.Transfer.Types.State Methods toText :: State -> Text #
type Rep State Source #
Instance details Defined in Amazonka.Transfer.Types.State type Rep State = D1 ('MetaData "State" "Amazonka.Transfer.Types.State" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "State'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WorkflowStepType

newtype WorkflowStepType Source #

Constructors

WorkflowStepType'
Fields fromWorkflowStepType :: Text

Bundled Patterns

pattern WorkflowStepType_COPY :: WorkflowStepType
pattern WorkflowStepType_CUSTOM :: WorkflowStepType
pattern WorkflowStepType_DELETE :: WorkflowStepType
pattern WorkflowStepType_TAG :: WorkflowStepType

Instances

Instances details

Eq WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods (==) :: WorkflowStepType -> WorkflowStepType -> Bool # (/=) :: WorkflowStepType -> WorkflowStepType -> Bool #
Ord WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods compare :: WorkflowStepType -> WorkflowStepType -> Ordering # (<) :: WorkflowStepType -> WorkflowStepType -> Bool # (<=) :: WorkflowStepType -> WorkflowStepType -> Bool # (>) :: WorkflowStepType -> WorkflowStepType -> Bool # (>=) :: WorkflowStepType -> WorkflowStepType -> Bool # max :: WorkflowStepType -> WorkflowStepType -> WorkflowStepType # min :: WorkflowStepType -> WorkflowStepType -> WorkflowStepType #
Read WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods readsPrec :: Int -> ReadS WorkflowStepType # readList :: ReadS [WorkflowStepType] # readPrec :: ReadPrec WorkflowStepType # readListPrec :: ReadPrec [WorkflowStepType] #
Show WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods showsPrec :: Int -> WorkflowStepType -> ShowS # show :: WorkflowStepType -> String # showList :: [WorkflowStepType] -> ShowS #
Generic WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Associated Types type Rep WorkflowStepType :: Type -> Type # Methods from :: WorkflowStepType -> Rep WorkflowStepType x # to :: Rep WorkflowStepType x -> WorkflowStepType #
NFData WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods rnf :: WorkflowStepType -> () #
Hashable WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods hashWithSalt :: Int -> WorkflowStepType -> Int # hash :: WorkflowStepType -> Int #
ToJSON WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods toJSON :: WorkflowStepType -> Value # toEncoding :: WorkflowStepType -> Encoding # toJSONList :: [WorkflowStepType] -> Value # toEncodingList :: [WorkflowStepType] -> Encoding #
ToJSONKey WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods toJSONKey :: ToJSONKeyFunction WorkflowStepType # toJSONKeyList :: ToJSONKeyFunction [WorkflowStepType] #
FromJSON WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods parseJSON :: Value -> Parser WorkflowStepType # parseJSONList :: Value -> Parser [WorkflowStepType] #
FromJSONKey WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods fromJSONKey :: FromJSONKeyFunction WorkflowStepType # fromJSONKeyList :: FromJSONKeyFunction [WorkflowStepType] #
ToLog WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods build :: WorkflowStepType -> ByteStringBuilder #
ToHeader WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods toHeader :: HeaderName -> WorkflowStepType -> [Header] #
ToQuery WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods toQuery :: WorkflowStepType -> QueryString #
FromXML WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods parseXML :: [Node] -> Either String WorkflowStepType #
ToXML WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods toXML :: WorkflowStepType -> XML #
ToByteString WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods toBS :: WorkflowStepType -> ByteString #
FromText WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods fromText :: Text -> Either String WorkflowStepType #
ToText WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType Methods toText :: WorkflowStepType -> Text #
type Rep WorkflowStepType Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStepType type Rep WorkflowStepType = D1 ('MetaData "WorkflowStepType" "Amazonka.Transfer.Types.WorkflowStepType" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'True) (C1 ('MetaCons "WorkflowStepType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWorkflowStepType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CopyStepDetails

data CopyStepDetails Source #

Each step type has its own StepDetails structure.

See: newCopyStepDetails smart constructor.

Constructors

CopyStepDetails' (Maybe InputFileLocation) (Maybe OverwriteExisting) (Maybe Text)

Instances

Instances details

Eq CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Methods (==) :: CopyStepDetails -> CopyStepDetails -> Bool # (/=) :: CopyStepDetails -> CopyStepDetails -> Bool #
Read CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Methods readsPrec :: Int -> ReadS CopyStepDetails # readList :: ReadS [CopyStepDetails] # readPrec :: ReadPrec CopyStepDetails # readListPrec :: ReadPrec [CopyStepDetails] #
Show CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Methods showsPrec :: Int -> CopyStepDetails -> ShowS # show :: CopyStepDetails -> String # showList :: [CopyStepDetails] -> ShowS #
Generic CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Associated Types type Rep CopyStepDetails :: Type -> Type # Methods from :: CopyStepDetails -> Rep CopyStepDetails x # to :: Rep CopyStepDetails x -> CopyStepDetails #
NFData CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Methods rnf :: CopyStepDetails -> () #
Hashable CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Methods hashWithSalt :: Int -> CopyStepDetails -> Int # hash :: CopyStepDetails -> Int #
ToJSON CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Methods toJSON :: CopyStepDetails -> Value # toEncoding :: CopyStepDetails -> Encoding # toJSONList :: [CopyStepDetails] -> Value # toEncodingList :: [CopyStepDetails] -> Encoding #
FromJSON CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails Methods parseJSON :: Value -> Parser CopyStepDetails # parseJSONList :: Value -> Parser [CopyStepDetails] #
type Rep CopyStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CopyStepDetails type Rep CopyStepDetails = D1 ('MetaData "CopyStepDetails" "Amazonka.Transfer.Types.CopyStepDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "CopyStepDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "destinationFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFileLocation)) :: (S1 ('MetaSel ('Just "overwriteExisting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OverwriteExisting)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCopyStepDetails :: CopyStepDetails Source #

Create a value of CopyStepDetails 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:destinationFileLocation:CopyStepDetails', copyStepDetails_destinationFileLocation - Undocumented member.

$sel:overwriteExisting:CopyStepDetails', copyStepDetails_overwriteExisting - A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

$sel:name:CopyStepDetails', copyStepDetails_name - The name of the step, used as an identifier.

CustomStepDetails

data CustomStepDetails Source #

Each step type has its own StepDetails structure.

See: newCustomStepDetails smart constructor.

Constructors

CustomStepDetails' (Maybe Text) (Maybe Natural) (Maybe Text)

Instances

Instances details

Eq CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Methods (==) :: CustomStepDetails -> CustomStepDetails -> Bool # (/=) :: CustomStepDetails -> CustomStepDetails -> Bool #
Read CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Methods readsPrec :: Int -> ReadS CustomStepDetails # readList :: ReadS [CustomStepDetails] # readPrec :: ReadPrec CustomStepDetails # readListPrec :: ReadPrec [CustomStepDetails] #
Show CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Methods showsPrec :: Int -> CustomStepDetails -> ShowS # show :: CustomStepDetails -> String # showList :: [CustomStepDetails] -> ShowS #
Generic CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Associated Types type Rep CustomStepDetails :: Type -> Type # Methods from :: CustomStepDetails -> Rep CustomStepDetails x # to :: Rep CustomStepDetails x -> CustomStepDetails #
NFData CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Methods rnf :: CustomStepDetails -> () #
Hashable CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Methods hashWithSalt :: Int -> CustomStepDetails -> Int # hash :: CustomStepDetails -> Int #
ToJSON CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Methods toJSON :: CustomStepDetails -> Value # toEncoding :: CustomStepDetails -> Encoding # toJSONList :: [CustomStepDetails] -> Value # toEncodingList :: [CustomStepDetails] -> Encoding #
FromJSON CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails Methods parseJSON :: Value -> Parser CustomStepDetails # parseJSONList :: Value -> Parser [CustomStepDetails] #
type Rep CustomStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.CustomStepDetails type Rep CustomStepDetails = D1 ('MetaData "CustomStepDetails" "Amazonka.Transfer.Types.CustomStepDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "CustomStepDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCustomStepDetails :: CustomStepDetails Source #

Create a value of CustomStepDetails 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:name:CustomStepDetails', customStepDetails_name - The name of the step, used as an identifier.

$sel:timeoutSeconds:CustomStepDetails', customStepDetails_timeoutSeconds - Timeout, in seconds, for the step.

$sel:target:CustomStepDetails', customStepDetails_target - The ARN for the lambda function that is being called.

DeleteStepDetails

data DeleteStepDetails Source #

The name of the step, used to identify the delete step.

See: newDeleteStepDetails smart constructor.

Constructors

DeleteStepDetails' (Maybe Text)

Instances

Instances details

Eq DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Methods (==) :: DeleteStepDetails -> DeleteStepDetails -> Bool # (/=) :: DeleteStepDetails -> DeleteStepDetails -> Bool #
Read DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Methods readsPrec :: Int -> ReadS DeleteStepDetails # readList :: ReadS [DeleteStepDetails] # readPrec :: ReadPrec DeleteStepDetails # readListPrec :: ReadPrec [DeleteStepDetails] #
Show DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Methods showsPrec :: Int -> DeleteStepDetails -> ShowS # show :: DeleteStepDetails -> String # showList :: [DeleteStepDetails] -> ShowS #
Generic DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Associated Types type Rep DeleteStepDetails :: Type -> Type # Methods from :: DeleteStepDetails -> Rep DeleteStepDetails x # to :: Rep DeleteStepDetails x -> DeleteStepDetails #
NFData DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Methods rnf :: DeleteStepDetails -> () #
Hashable DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Methods hashWithSalt :: Int -> DeleteStepDetails -> Int # hash :: DeleteStepDetails -> Int #
ToJSON DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Methods toJSON :: DeleteStepDetails -> Value # toEncoding :: DeleteStepDetails -> Encoding # toJSONList :: [DeleteStepDetails] -> Value # toEncodingList :: [DeleteStepDetails] -> Encoding #
FromJSON DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails Methods parseJSON :: Value -> Parser DeleteStepDetails # parseJSONList :: Value -> Parser [DeleteStepDetails] #
type Rep DeleteStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.DeleteStepDetails type Rep DeleteStepDetails = D1 ('MetaData "DeleteStepDetails" "Amazonka.Transfer.Types.DeleteStepDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DeleteStepDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDeleteStepDetails :: DeleteStepDetails Source #

Create a value of DeleteStepDetails 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:name:DeleteStepDetails', deleteStepDetails_name - The name of the step, used as an identifier.

DescribedAccess

data DescribedAccess Source #

Describes the properties of the access that was specified.

See: newDescribedAccess smart constructor.

Constructors

DescribedAccess' (Maybe HomeDirectoryType) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess Methods (==) :: DescribedAccess -> DescribedAccess -> Bool # (/=) :: DescribedAccess -> DescribedAccess -> Bool #
Read DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess Methods readsPrec :: Int -> ReadS DescribedAccess # readList :: ReadS [DescribedAccess] # readPrec :: ReadPrec DescribedAccess # readListPrec :: ReadPrec [DescribedAccess] #
Show DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess Methods showsPrec :: Int -> DescribedAccess -> ShowS # show :: DescribedAccess -> String # showList :: [DescribedAccess] -> ShowS #
Generic DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess Associated Types type Rep DescribedAccess :: Type -> Type # Methods from :: DescribedAccess -> Rep DescribedAccess x # to :: Rep DescribedAccess x -> DescribedAccess #
NFData DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess Methods rnf :: DescribedAccess -> () #
Hashable DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess Methods hashWithSalt :: Int -> DescribedAccess -> Int # hash :: DescribedAccess -> Int #
FromJSON DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess Methods parseJSON :: Value -> Parser DescribedAccess # parseJSONList :: Value -> Parser [DescribedAccess] #
type Rep DescribedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedAccess type Rep DescribedAccess = D1 ('MetaData "DescribedAccess" "Amazonka.Transfer.Types.DescribedAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribedAccess'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :: (S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile)) :: S1 ('MetaSel ('Just "homeDirectoryMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HomeDirectoryMapEntry))))) :: ((S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribedAccess :: DescribedAccess Source #

Create a value of DescribedAccess 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:homeDirectoryType:DescribedAccess', describedAccess_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:posixProfile:DescribedAccess', describedAccess_posixProfile - Undocumented member.

$sel:homeDirectoryMappings:DescribedAccess', describedAccess_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

$sel:role':DescribedAccess', describedAccess_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

$sel:policy:DescribedAccess', describedAccess_policy - A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

$sel:externalId:DescribedAccess', describedAccess_externalId - A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

$sel:homeDirectory:DescribedAccess', describedAccess_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

DescribedExecution

data DescribedExecution Source #

The details for an execution object.

See: newDescribedExecution smart constructor.

Constructors

DescribedExecution' (Maybe ExecutionStatus) (Maybe Text) (Maybe ExecutionResults) (Maybe FileLocation) (Maybe PosixProfile) (Maybe ServiceMetadata) (Maybe LoggingConfiguration) (Maybe Text)

Instances

Instances details

Eq DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods (==) :: DescribedExecution -> DescribedExecution -> Bool # (/=) :: DescribedExecution -> DescribedExecution -> Bool #
Read DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods readsPrec :: Int -> ReadS DescribedExecution # readList :: ReadS [DescribedExecution] # readPrec :: ReadPrec DescribedExecution # readListPrec :: ReadPrec [DescribedExecution] #
Show DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods showsPrec :: Int -> DescribedExecution -> ShowS # show :: DescribedExecution -> String # showList :: [DescribedExecution] -> ShowS #
Generic DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Associated Types type Rep DescribedExecution :: Type -> Type # Methods from :: DescribedExecution -> Rep DescribedExecution x # to :: Rep DescribedExecution x -> DescribedExecution #
NFData DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods rnf :: DescribedExecution -> () #
Hashable DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods hashWithSalt :: Int -> DescribedExecution -> Int # hash :: DescribedExecution -> Int #
FromJSON DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods parseJSON :: Value -> Parser DescribedExecution # parseJSONList :: Value -> Parser [DescribedExecution] #
type Rep DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution type Rep DescribedExecution = D1 ('MetaData "DescribedExecution" "Amazonka.Transfer.Types.DescribedExecution" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribedExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus)) :: S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionResults)) :: S1 ('MetaSel ('Just "initialFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileLocation)))) :: ((S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile)) :: S1 ('MetaSel ('Just "serviceMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceMetadata))) :: (S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration)) :*: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribedExecution :: DescribedExecution Source #

Create a value of DescribedExecution 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:status:DescribedExecution', describedExecution_status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

$sel:executionId:DescribedExecution', describedExecution_executionId - A unique identifier for the execution of a workflow.

$sel:results:DescribedExecution', describedExecution_results - A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

$sel:initialFileLocation:DescribedExecution', describedExecution_initialFileLocation - A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

$sel:posixProfile:DescribedExecution', describedExecution_posixProfile - Undocumented member.

$sel:serviceMetadata:DescribedExecution', describedExecution_serviceMetadata - A container object for the session details associated with a workflow.

$sel:loggingConfiguration:DescribedExecution', describedExecution_loggingConfiguration - The IAM logging role associated with the execution.

$sel:executionRole:DescribedExecution', describedExecution_executionRole - The IAM role associated with the execution.

DescribedSecurityPolicy

data DescribedSecurityPolicy Source #

Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.

See: newDescribedSecurityPolicy smart constructor.

Constructors

DescribedSecurityPolicy' (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text

Instances

Instances details

Eq DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy Methods (==) :: DescribedSecurityPolicy -> DescribedSecurityPolicy -> Bool # (/=) :: DescribedSecurityPolicy -> DescribedSecurityPolicy -> Bool #
Read DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy Methods readsPrec :: Int -> ReadS DescribedSecurityPolicy # readList :: ReadS [DescribedSecurityPolicy] # readPrec :: ReadPrec DescribedSecurityPolicy # readListPrec :: ReadPrec [DescribedSecurityPolicy] #
Show DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy Methods showsPrec :: Int -> DescribedSecurityPolicy -> ShowS # show :: DescribedSecurityPolicy -> String # showList :: [DescribedSecurityPolicy] -> ShowS #
Generic DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy Associated Types type Rep DescribedSecurityPolicy :: Type -> Type # Methods from :: DescribedSecurityPolicy -> Rep DescribedSecurityPolicy x # to :: Rep DescribedSecurityPolicy x -> DescribedSecurityPolicy #
NFData DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy Methods rnf :: DescribedSecurityPolicy -> () #
Hashable DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy Methods hashWithSalt :: Int -> DescribedSecurityPolicy -> Int # hash :: DescribedSecurityPolicy -> Int #
FromJSON DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy Methods parseJSON :: Value -> Parser DescribedSecurityPolicy # parseJSONList :: Value -> Parser [DescribedSecurityPolicy] #
type Rep DescribedSecurityPolicy Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy type Rep DescribedSecurityPolicy = D1 ('MetaData "DescribedSecurityPolicy" "Amazonka.Transfer.Types.DescribedSecurityPolicy" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribedSecurityPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fips") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "sshMacs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "sshKexs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "tlsCiphers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "sshCiphers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedSecurityPolicy Source #

Arguments

:: Text	`$sel:securityPolicyName:DescribedSecurityPolicy'`
-> DescribedSecurityPolicy

Create a value of DescribedSecurityPolicy 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:fips:DescribedSecurityPolicy', describedSecurityPolicy_fips - Specifies whether this policy enables Federal Information Processing Standards (FIPS).

$sel:sshMacs:DescribedSecurityPolicy', describedSecurityPolicy_sshMacs - Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.

$sel:sshKexs:DescribedSecurityPolicy', describedSecurityPolicy_sshKexs - Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.

$sel:tlsCiphers:DescribedSecurityPolicy', describedSecurityPolicy_tlsCiphers - Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

$sel:sshCiphers:DescribedSecurityPolicy', describedSecurityPolicy_sshCiphers - Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.

$sel:securityPolicyName:DescribedSecurityPolicy', describedSecurityPolicy_securityPolicyName - Specifies the name of the security policy that is attached to the server.

DescribedServer

data DescribedServer Source #

Describes the properties of a file transfer protocol-enabled server that was specified.

See: newDescribedServer smart constructor.

Constructors

DescribedServer' (Maybe ProtocolDetails) (Maybe Text) (Maybe State) (Maybe IdentityProviderType) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe Domain) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe WorkflowDetails) (Maybe (NonEmpty Tag)) (Maybe EndpointDetails) Text

Instances

Instances details

Eq DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer Methods (==) :: DescribedServer -> DescribedServer -> Bool # (/=) :: DescribedServer -> DescribedServer -> Bool #
Read DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer Methods readsPrec :: Int -> ReadS DescribedServer # readList :: ReadS [DescribedServer] # readPrec :: ReadPrec DescribedServer # readListPrec :: ReadPrec [DescribedServer] #
Show DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer Methods showsPrec :: Int -> DescribedServer -> ShowS # show :: DescribedServer -> String # showList :: [DescribedServer] -> ShowS #
Generic DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer Associated Types type Rep DescribedServer :: Type -> Type # Methods from :: DescribedServer -> Rep DescribedServer x # to :: Rep DescribedServer x -> DescribedServer #
NFData DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer Methods rnf :: DescribedServer -> () #
Hashable DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer Methods hashWithSalt :: Int -> DescribedServer -> Int # hash :: DescribedServer -> Int #
FromJSON DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer Methods parseJSON :: Value -> Parser DescribedServer # parseJSONList :: Value -> Parser [DescribedServer] #
type Rep DescribedServer Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedServer type Rep DescribedServer = D1 ('MetaData "DescribedServer" "Amazonka.Transfer.Types.DescribedServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribedServer'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "protocolDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolDetails)) :: S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State)) :: S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderType)))) :: ((S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol))) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType))))) :: (((S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hostKeyFingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "userCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderDetails)) :: S1 ('MetaSel ('Just "workflowDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowDetails))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: (S1 ('MetaSel ('Just "endpointDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDetails)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newDescribedServer Source #

Arguments

:: Text	`$sel:arn:DescribedServer'`
-> DescribedServer

Create a value of DescribedServer 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:protocolDetails:DescribedServer', describedServer_protocolDetails - The protocol settings that are configured for your server.

Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

$sel:loggingRole:DescribedServer', describedServer_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

$sel:state:DescribedServer', describedServer_state - Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

$sel:identityProviderType:DescribedServer', describedServer_identityProviderType - Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

$sel:protocols:DescribedServer', describedServer_protocols - Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer

$sel:serverId:DescribedServer', describedServer_serverId - Specifies the unique system-assigned identifier for a server that you instantiate.

$sel:domain:DescribedServer', describedServer_domain - Specifies the domain of the storage system that is used for file transfers.

$sel:endpointType:DescribedServer', describedServer_endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

$sel:securityPolicyName:DescribedServer', describedServer_securityPolicyName - Specifies the name of the security policy that is attached to the server.

$sel:hostKeyFingerprint:DescribedServer', describedServer_hostKeyFingerprint - Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

$sel:userCount:DescribedServer', describedServer_userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.

$sel:certificate:DescribedServer', describedServer_certificate - Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

$sel:identityProviderDetails:DescribedServer', describedServer_identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

$sel:workflowDetails:DescribedServer', describedServer_workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

$sel:tags:DescribedServer', describedServer_tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

$sel:endpointDetails:DescribedServer', describedServer_endpointDetails - The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

$sel:arn:DescribedServer', describedServer_arn - Specifies the unique Amazon Resource Name (ARN) of the server.

DescribedUser

data DescribedUser Source #

Describes the properties of a user that was specified.

See: newDescribedUser smart constructor.

Constructors

DescribedUser' (Maybe [SshPublicKey]) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text

Instances

Instances details

Eq DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser Methods (==) :: DescribedUser -> DescribedUser -> Bool # (/=) :: DescribedUser -> DescribedUser -> Bool #
Read DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser Methods readsPrec :: Int -> ReadS DescribedUser # readList :: ReadS [DescribedUser] # readPrec :: ReadPrec DescribedUser # readListPrec :: ReadPrec [DescribedUser] #
Show DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser Methods showsPrec :: Int -> DescribedUser -> ShowS # show :: DescribedUser -> String # showList :: [DescribedUser] -> ShowS #
Generic DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser Associated Types type Rep DescribedUser :: Type -> Type # Methods from :: DescribedUser -> Rep DescribedUser x # to :: Rep DescribedUser x -> DescribedUser #
NFData DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser Methods rnf :: DescribedUser -> () #
Hashable DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser Methods hashWithSalt :: Int -> DescribedUser -> Int # hash :: DescribedUser -> Int #
FromJSON DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser Methods parseJSON :: Value -> Parser DescribedUser # parseJSONList :: Value -> Parser [DescribedUser] #
type Rep DescribedUser Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedUser type Rep DescribedUser = D1 ('MetaData "DescribedUser" "Amazonka.Transfer.Types.DescribedUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribedUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sshPublicKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SshPublicKey])) :: S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType))) :: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile)) :: S1 ('MetaSel ('Just "homeDirectoryMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HomeDirectoryMapEntry)))))) :: ((S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribedUser Source #

Arguments

:: Text	`$sel:arn:DescribedUser'`
-> DescribedUser

Create a value of DescribedUser 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:sshPublicKeys:DescribedUser', describedUser_sshPublicKeys - Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

$sel:homeDirectoryType:DescribedUser', describedUser_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:userName:DescribedUser', describedUser_userName - Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

$sel:posixProfile:DescribedUser', describedUser_posixProfile - Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

$sel:homeDirectoryMappings:DescribedUser', describedUser_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

$sel:role':DescribedUser', describedUser_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

$sel:policy:DescribedUser', describedUser_policy - A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

$sel:homeDirectory:DescribedUser', describedUser_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

$sel:tags:DescribedUser', describedUser_tags - Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

$sel:arn:DescribedUser', describedUser_arn - Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

DescribedWorkflow

data DescribedWorkflow Source #

Describes the properties of the specified workflow

See: newDescribedWorkflow smart constructor.

Constructors

DescribedWorkflow' (Maybe [WorkflowStep]) (Maybe [WorkflowStep]) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text

Instances

Instances details

Eq DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods (==) :: DescribedWorkflow -> DescribedWorkflow -> Bool # (/=) :: DescribedWorkflow -> DescribedWorkflow -> Bool #
Read DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods readsPrec :: Int -> ReadS DescribedWorkflow # readList :: ReadS [DescribedWorkflow] # readPrec :: ReadPrec DescribedWorkflow # readListPrec :: ReadPrec [DescribedWorkflow] #
Show DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods showsPrec :: Int -> DescribedWorkflow -> ShowS # show :: DescribedWorkflow -> String # showList :: [DescribedWorkflow] -> ShowS #
Generic DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Associated Types type Rep DescribedWorkflow :: Type -> Type # Methods from :: DescribedWorkflow -> Rep DescribedWorkflow x # to :: Rep DescribedWorkflow x -> DescribedWorkflow #
NFData DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods rnf :: DescribedWorkflow -> () #
Hashable DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods hashWithSalt :: Int -> DescribedWorkflow -> Int # hash :: DescribedWorkflow -> Int #
FromJSON DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods parseJSON :: Value -> Parser DescribedWorkflow # parseJSONList :: Value -> Parser [DescribedWorkflow] #
type Rep DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow type Rep DescribedWorkflow = D1 ('MetaData "DescribedWorkflow" "Amazonka.Transfer.Types.DescribedWorkflow" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribedWorkflow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep])) :: (S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep])) :: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedWorkflow Source #

Arguments

:: Text	`$sel:arn:DescribedWorkflow'`
-> DescribedWorkflow

Create a value of DescribedWorkflow 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:onExceptionSteps:DescribedWorkflow', describedWorkflow_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

$sel:steps:DescribedWorkflow', describedWorkflow_steps - Specifies the details for the steps that are in the specified workflow.

$sel:workflowId:DescribedWorkflow', describedWorkflow_workflowId - A unique identifier for the workflow.

$sel:description:DescribedWorkflow', describedWorkflow_description - Specifies the text description for the workflow.

$sel:tags:DescribedWorkflow', describedWorkflow_tags - Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

$sel:arn:DescribedWorkflow', describedWorkflow_arn - Specifies the unique Amazon Resource Name (ARN) for the workflow.

EfsFileLocation

data EfsFileLocation Source #

Reserved for future use.

See: newEfsFileLocation smart constructor.

Constructors

EfsFileLocation' (Maybe Text) (Maybe Text)

Instances

Instances details

Eq EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Methods (==) :: EfsFileLocation -> EfsFileLocation -> Bool # (/=) :: EfsFileLocation -> EfsFileLocation -> Bool #
Read EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Methods readsPrec :: Int -> ReadS EfsFileLocation # readList :: ReadS [EfsFileLocation] # readPrec :: ReadPrec EfsFileLocation # readListPrec :: ReadPrec [EfsFileLocation] #
Show EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Methods showsPrec :: Int -> EfsFileLocation -> ShowS # show :: EfsFileLocation -> String # showList :: [EfsFileLocation] -> ShowS #
Generic EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Associated Types type Rep EfsFileLocation :: Type -> Type # Methods from :: EfsFileLocation -> Rep EfsFileLocation x # to :: Rep EfsFileLocation x -> EfsFileLocation #
NFData EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Methods rnf :: EfsFileLocation -> () #
Hashable EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Methods hashWithSalt :: Int -> EfsFileLocation -> Int # hash :: EfsFileLocation -> Int #
ToJSON EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Methods toJSON :: EfsFileLocation -> Value # toEncoding :: EfsFileLocation -> Encoding # toJSONList :: [EfsFileLocation] -> Value # toEncodingList :: [EfsFileLocation] -> Encoding #
FromJSON EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation Methods parseJSON :: Value -> Parser EfsFileLocation # parseJSONList :: Value -> Parser [EfsFileLocation] #
type Rep EfsFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.EfsFileLocation type Rep EfsFileLocation = D1 ('MetaData "EfsFileLocation" "Amazonka.Transfer.Types.EfsFileLocation" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "EfsFileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEfsFileLocation :: EfsFileLocation Source #

Create a value of EfsFileLocation 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:path:EfsFileLocation', efsFileLocation_path - The pathname for the folder being used by a workflow.

$sel:fileSystemId:EfsFileLocation', efsFileLocation_fileSystemId - The ID of the file system, assigned by Amazon EFS.

EndpointDetails

data EndpointDetails Source #

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

See: newEndpointDetails smart constructor.

Constructors

EndpointDetails' (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text)

Instances

Instances details

Eq EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods (==) :: EndpointDetails -> EndpointDetails -> Bool # (/=) :: EndpointDetails -> EndpointDetails -> Bool #
Read EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods readsPrec :: Int -> ReadS EndpointDetails # readList :: ReadS [EndpointDetails] # readPrec :: ReadPrec EndpointDetails # readListPrec :: ReadPrec [EndpointDetails] #
Show EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods showsPrec :: Int -> EndpointDetails -> ShowS # show :: EndpointDetails -> String # showList :: [EndpointDetails] -> ShowS #
Generic EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Associated Types type Rep EndpointDetails :: Type -> Type # Methods from :: EndpointDetails -> Rep EndpointDetails x # to :: Rep EndpointDetails x -> EndpointDetails #
NFData EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods rnf :: EndpointDetails -> () #
Hashable EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods hashWithSalt :: Int -> EndpointDetails -> Int # hash :: EndpointDetails -> Int #
ToJSON EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods toJSON :: EndpointDetails -> Value # toEncoding :: EndpointDetails -> Encoding # toJSONList :: [EndpointDetails] -> Value # toEncodingList :: [EndpointDetails] -> Encoding #
FromJSON EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails Methods parseJSON :: Value -> Parser EndpointDetails # parseJSONList :: Value -> Parser [EndpointDetails] #
type Rep EndpointDetails Source #
Instance details Defined in Amazonka.Transfer.Types.EndpointDetails type Rep EndpointDetails = D1 ('MetaData "EndpointDetails" "Amazonka.Transfer.Types.EndpointDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "EndpointDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "addressAllocationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "vpcEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEndpointDetails :: EndpointDetails Source #

Create a value of EndpointDetails 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:securityGroupIds:EndpointDetails', endpointDetails_securityGroupIds - A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

$sel:subnetIds:EndpointDetails', endpointDetails_subnetIds - A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

$sel:vpcId:EndpointDetails', endpointDetails_vpcId - The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

$sel:addressAllocationIds:EndpointDetails', endpointDetails_addressAllocationIds - A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

$sel:vpcEndpointId:EndpointDetails', endpointDetails_vpcEndpointId - The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

ExecutionError

data ExecutionError Source #

Specifies the error message and type, for an error that occurs during the execution of the workflow.

See: newExecutionError smart constructor.

Constructors

ExecutionError' ExecutionErrorType Text

Instances

Instances details

Eq ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods (==) :: ExecutionError -> ExecutionError -> Bool # (/=) :: ExecutionError -> ExecutionError -> Bool #
Read ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods readsPrec :: Int -> ReadS ExecutionError # readList :: ReadS [ExecutionError] # readPrec :: ReadPrec ExecutionError # readListPrec :: ReadPrec [ExecutionError] #
Show ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods showsPrec :: Int -> ExecutionError -> ShowS # show :: ExecutionError -> String # showList :: [ExecutionError] -> ShowS #
Generic ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Associated Types type Rep ExecutionError :: Type -> Type # Methods from :: ExecutionError -> Rep ExecutionError x # to :: Rep ExecutionError x -> ExecutionError #
NFData ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods rnf :: ExecutionError -> () #
Hashable ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods hashWithSalt :: Int -> ExecutionError -> Int # hash :: ExecutionError -> Int #
FromJSON ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError Methods parseJSON :: Value -> Parser ExecutionError # parseJSONList :: Value -> Parser [ExecutionError] #
type Rep ExecutionError Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionError type Rep ExecutionError = D1 ('MetaData "ExecutionError" "Amazonka.Transfer.Types.ExecutionError" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ExecutionError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutionErrorType) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newExecutionError Source #

Arguments

:: ExecutionErrorType	`$sel:type':ExecutionError'`
-> Text	`$sel:message:ExecutionError'`
-> ExecutionError

Create a value of ExecutionError 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:type':ExecutionError', executionError_type - Specifies the error type: currently, the only valid value is PERMISSION_DENIED, which occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

$sel:message:ExecutionError', executionError_message - Specifies the descriptive message that corresponds to the ErrorType.

ExecutionResults

data ExecutionResults Source #

Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.

See: newExecutionResults smart constructor.

Constructors

ExecutionResults' (Maybe (NonEmpty ExecutionStepResult)) (Maybe (NonEmpty ExecutionStepResult))

Instances

Instances details

Eq ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults Methods (==) :: ExecutionResults -> ExecutionResults -> Bool # (/=) :: ExecutionResults -> ExecutionResults -> Bool #
Read ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults Methods readsPrec :: Int -> ReadS ExecutionResults # readList :: ReadS [ExecutionResults] # readPrec :: ReadPrec ExecutionResults # readListPrec :: ReadPrec [ExecutionResults] #
Show ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults Methods showsPrec :: Int -> ExecutionResults -> ShowS # show :: ExecutionResults -> String # showList :: [ExecutionResults] -> ShowS #
Generic ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults Associated Types type Rep ExecutionResults :: Type -> Type # Methods from :: ExecutionResults -> Rep ExecutionResults x # to :: Rep ExecutionResults x -> ExecutionResults #
NFData ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults Methods rnf :: ExecutionResults -> () #
Hashable ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults Methods hashWithSalt :: Int -> ExecutionResults -> Int # hash :: ExecutionResults -> Int #
FromJSON ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults Methods parseJSON :: Value -> Parser ExecutionResults # parseJSONList :: Value -> Parser [ExecutionResults] #
type Rep ExecutionResults Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionResults type Rep ExecutionResults = D1 ('MetaData "ExecutionResults" "Amazonka.Transfer.Types.ExecutionResults" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ExecutionResults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExecutionStepResult))) :*: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExecutionStepResult)))))

newExecutionResults :: ExecutionResults Source #

Create a value of ExecutionResults 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:onExceptionSteps:ExecutionResults', executionResults_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

$sel:steps:ExecutionResults', executionResults_steps - Specifies the details for the steps that are in the specified workflow.

ExecutionStepResult

data ExecutionStepResult Source #

Specifies the following details for the step: error (if any), outputs (if any), and the step type.

See: newExecutionStepResult smart constructor.

Constructors

ExecutionStepResult' (Maybe WorkflowStepType) (Maybe ExecutionError) (Maybe Text)

Instances

Instances details

Eq ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult Methods (==) :: ExecutionStepResult -> ExecutionStepResult -> Bool # (/=) :: ExecutionStepResult -> ExecutionStepResult -> Bool #
Read ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult Methods readsPrec :: Int -> ReadS ExecutionStepResult # readList :: ReadS [ExecutionStepResult] # readPrec :: ReadPrec ExecutionStepResult # readListPrec :: ReadPrec [ExecutionStepResult] #
Show ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult Methods showsPrec :: Int -> ExecutionStepResult -> ShowS # show :: ExecutionStepResult -> String # showList :: [ExecutionStepResult] -> ShowS #
Generic ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult Associated Types type Rep ExecutionStepResult :: Type -> Type # Methods from :: ExecutionStepResult -> Rep ExecutionStepResult x # to :: Rep ExecutionStepResult x -> ExecutionStepResult #
NFData ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult Methods rnf :: ExecutionStepResult -> () #
Hashable ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult Methods hashWithSalt :: Int -> ExecutionStepResult -> Int # hash :: ExecutionStepResult -> Int #
FromJSON ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult Methods parseJSON :: Value -> Parser ExecutionStepResult # parseJSONList :: Value -> Parser [ExecutionStepResult] #
type Rep ExecutionStepResult Source #
Instance details Defined in Amazonka.Transfer.Types.ExecutionStepResult type Rep ExecutionStepResult = D1 ('MetaData "ExecutionStepResult" "Amazonka.Transfer.Types.ExecutionStepResult" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ExecutionStepResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stepType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowStepType)) :: (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionError)) :: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newExecutionStepResult :: ExecutionStepResult Source #

Create a value of ExecutionStepResult 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:stepType:ExecutionStepResult', executionStepResult_stepType - One of the available step types.

Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file

$sel:error:ExecutionStepResult', executionStepResult_error - Specifies the details for an error, if it occurred during execution of the specified workfow step.

$sel:outputs:ExecutionStepResult', executionStepResult_outputs - The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

FileLocation

data FileLocation Source #

Specifies the Amazon S3 or EFS file details to be used in the step.

See: newFileLocation smart constructor.

Constructors

FileLocation' (Maybe EfsFileLocation) (Maybe S3FileLocation)

Instances

Instances details

Eq FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation Methods (==) :: FileLocation -> FileLocation -> Bool # (/=) :: FileLocation -> FileLocation -> Bool #
Read FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation Methods readsPrec :: Int -> ReadS FileLocation # readList :: ReadS [FileLocation] # readPrec :: ReadPrec FileLocation # readListPrec :: ReadPrec [FileLocation] #
Show FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation Methods showsPrec :: Int -> FileLocation -> ShowS # show :: FileLocation -> String # showList :: [FileLocation] -> ShowS #
Generic FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation Associated Types type Rep FileLocation :: Type -> Type # Methods from :: FileLocation -> Rep FileLocation x # to :: Rep FileLocation x -> FileLocation #
NFData FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation Methods rnf :: FileLocation -> () #
Hashable FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation Methods hashWithSalt :: Int -> FileLocation -> Int # hash :: FileLocation -> Int #
FromJSON FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation Methods parseJSON :: Value -> Parser FileLocation # parseJSONList :: Value -> Parser [FileLocation] #
type Rep FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.FileLocation type Rep FileLocation = D1 ('MetaData "FileLocation" "Amazonka.Transfer.Types.FileLocation" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "FileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "efsFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EfsFileLocation)) :*: S1 ('MetaSel ('Just "s3FileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3FileLocation))))

newFileLocation :: FileLocation Source #

Create a value of FileLocation 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:efsFileLocation:FileLocation', fileLocation_efsFileLocation - Specifies the Amazon EFS ID and the path for the file being used.

$sel:s3FileLocation:FileLocation', fileLocation_s3FileLocation - Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.

HomeDirectoryMapEntry

data HomeDirectoryMapEntry Source #

Represents an object that contains entries and targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

See: newHomeDirectoryMapEntry smart constructor.

Constructors

HomeDirectoryMapEntry' Text Text

Instances

Instances details

Eq HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Methods (==) :: HomeDirectoryMapEntry -> HomeDirectoryMapEntry -> Bool # (/=) :: HomeDirectoryMapEntry -> HomeDirectoryMapEntry -> Bool #
Read HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Methods readsPrec :: Int -> ReadS HomeDirectoryMapEntry # readList :: ReadS [HomeDirectoryMapEntry] # readPrec :: ReadPrec HomeDirectoryMapEntry # readListPrec :: ReadPrec [HomeDirectoryMapEntry] #
Show HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Methods showsPrec :: Int -> HomeDirectoryMapEntry -> ShowS # show :: HomeDirectoryMapEntry -> String # showList :: [HomeDirectoryMapEntry] -> ShowS #
Generic HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Associated Types type Rep HomeDirectoryMapEntry :: Type -> Type # Methods from :: HomeDirectoryMapEntry -> Rep HomeDirectoryMapEntry x # to :: Rep HomeDirectoryMapEntry x -> HomeDirectoryMapEntry #
NFData HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Methods rnf :: HomeDirectoryMapEntry -> () #
Hashable HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Methods hashWithSalt :: Int -> HomeDirectoryMapEntry -> Int # hash :: HomeDirectoryMapEntry -> Int #
ToJSON HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Methods toJSON :: HomeDirectoryMapEntry -> Value # toEncoding :: HomeDirectoryMapEntry -> Encoding # toJSONList :: [HomeDirectoryMapEntry] -> Value # toEncodingList :: [HomeDirectoryMapEntry] -> Encoding #
FromJSON HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry Methods parseJSON :: Value -> Parser HomeDirectoryMapEntry # parseJSONList :: Value -> Parser [HomeDirectoryMapEntry] #
type Rep HomeDirectoryMapEntry Source #
Instance details Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry type Rep HomeDirectoryMapEntry = D1 ('MetaData "HomeDirectoryMapEntry" "Amazonka.Transfer.Types.HomeDirectoryMapEntry" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "HomeDirectoryMapEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newHomeDirectoryMapEntry Source #

Arguments

:: Text	`$sel:entry:HomeDirectoryMapEntry'`
-> Text	`$sel:target:HomeDirectoryMapEntry'`
-> HomeDirectoryMapEntry

Create a value of HomeDirectoryMapEntry 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:entry:HomeDirectoryMapEntry', homeDirectoryMapEntry_entry - Represents an entry for HomeDirectoryMappings.

$sel:target:HomeDirectoryMapEntry', homeDirectoryMapEntry_target - Represents the map target that is used in a HomeDirectorymapEntry.

IdentityProviderDetails

data IdentityProviderDetails Source #

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.

See: newIdentityProviderDetails smart constructor.

Constructors

IdentityProviderDetails' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Methods (==) :: IdentityProviderDetails -> IdentityProviderDetails -> Bool # (/=) :: IdentityProviderDetails -> IdentityProviderDetails -> Bool #
Read IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Methods readsPrec :: Int -> ReadS IdentityProviderDetails # readList :: ReadS [IdentityProviderDetails] # readPrec :: ReadPrec IdentityProviderDetails # readListPrec :: ReadPrec [IdentityProviderDetails] #
Show IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Methods showsPrec :: Int -> IdentityProviderDetails -> ShowS # show :: IdentityProviderDetails -> String # showList :: [IdentityProviderDetails] -> ShowS #
Generic IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Associated Types type Rep IdentityProviderDetails :: Type -> Type # Methods from :: IdentityProviderDetails -> Rep IdentityProviderDetails x # to :: Rep IdentityProviderDetails x -> IdentityProviderDetails #
NFData IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Methods rnf :: IdentityProviderDetails -> () #
Hashable IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Methods hashWithSalt :: Int -> IdentityProviderDetails -> Int # hash :: IdentityProviderDetails -> Int #
ToJSON IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Methods toJSON :: IdentityProviderDetails -> Value # toEncoding :: IdentityProviderDetails -> Encoding # toJSONList :: [IdentityProviderDetails] -> Value # toEncodingList :: [IdentityProviderDetails] -> Encoding #
FromJSON IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails Methods parseJSON :: Value -> Parser IdentityProviderDetails # parseJSONList :: Value -> Parser [IdentityProviderDetails] #
type Rep IdentityProviderDetails Source #
Instance details Defined in Amazonka.Transfer.Types.IdentityProviderDetails type Rep IdentityProviderDetails = D1 ('MetaData "IdentityProviderDetails" "Amazonka.Transfer.Types.IdentityProviderDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "IdentityProviderDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "invocationRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newIdentityProviderDetails :: IdentityProviderDetails Source #

Create a value of IdentityProviderDetails 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:invocationRole:IdentityProviderDetails', identityProviderDetails_invocationRole - Provides the type of InvocationRole used to authenticate the user account.

$sel:directoryId:IdentityProviderDetails', identityProviderDetails_directoryId - The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

$sel:url:IdentityProviderDetails', identityProviderDetails_url - Provides the location of the service endpoint used to authenticate users.

InputFileLocation

data InputFileLocation Source #

Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.

See: newInputFileLocation smart constructor.

Constructors

InputFileLocation' (Maybe EfsFileLocation) (Maybe S3InputFileLocation)

Instances

Instances details

Eq InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Methods (==) :: InputFileLocation -> InputFileLocation -> Bool # (/=) :: InputFileLocation -> InputFileLocation -> Bool #
Read InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Methods readsPrec :: Int -> ReadS InputFileLocation # readList :: ReadS [InputFileLocation] # readPrec :: ReadPrec InputFileLocation # readListPrec :: ReadPrec [InputFileLocation] #
Show InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Methods showsPrec :: Int -> InputFileLocation -> ShowS # show :: InputFileLocation -> String # showList :: [InputFileLocation] -> ShowS #
Generic InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Associated Types type Rep InputFileLocation :: Type -> Type # Methods from :: InputFileLocation -> Rep InputFileLocation x # to :: Rep InputFileLocation x -> InputFileLocation #
NFData InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Methods rnf :: InputFileLocation -> () #
Hashable InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Methods hashWithSalt :: Int -> InputFileLocation -> Int # hash :: InputFileLocation -> Int #
ToJSON InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Methods toJSON :: InputFileLocation -> Value # toEncoding :: InputFileLocation -> Encoding # toJSONList :: [InputFileLocation] -> Value # toEncodingList :: [InputFileLocation] -> Encoding #
FromJSON InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation Methods parseJSON :: Value -> Parser InputFileLocation # parseJSONList :: Value -> Parser [InputFileLocation] #
type Rep InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.InputFileLocation type Rep InputFileLocation = D1 ('MetaData "InputFileLocation" "Amazonka.Transfer.Types.InputFileLocation" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "InputFileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "efsFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EfsFileLocation)) :*: S1 ('MetaSel ('Just "s3FileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3InputFileLocation))))

newInputFileLocation :: InputFileLocation Source #

Create a value of InputFileLocation 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:efsFileLocation:InputFileLocation', inputFileLocation_efsFileLocation - Reserved for future use.

$sel:s3FileLocation:InputFileLocation', inputFileLocation_s3FileLocation - Specifies the details for the S3 file being copied.

ListedAccess

data ListedAccess Source #

Lists the properties for one or more specified associated accesses.

See: newListedAccess smart constructor.

Constructors

ListedAccess' (Maybe HomeDirectoryType) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess Methods (==) :: ListedAccess -> ListedAccess -> Bool # (/=) :: ListedAccess -> ListedAccess -> Bool #
Read ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess Methods readsPrec :: Int -> ReadS ListedAccess # readList :: ReadS [ListedAccess] # readPrec :: ReadPrec ListedAccess # readListPrec :: ReadPrec [ListedAccess] #
Show ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess Methods showsPrec :: Int -> ListedAccess -> ShowS # show :: ListedAccess -> String # showList :: [ListedAccess] -> ShowS #
Generic ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess Associated Types type Rep ListedAccess :: Type -> Type # Methods from :: ListedAccess -> Rep ListedAccess x # to :: Rep ListedAccess x -> ListedAccess #
NFData ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess Methods rnf :: ListedAccess -> () #
Hashable ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess Methods hashWithSalt :: Int -> ListedAccess -> Int # hash :: ListedAccess -> Int #
FromJSON ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess Methods parseJSON :: Value -> Parser ListedAccess # parseJSONList :: Value -> Parser [ListedAccess] #
type Rep ListedAccess Source #
Instance details Defined in Amazonka.Transfer.Types.ListedAccess type Rep ListedAccess = D1 ('MetaData "ListedAccess" "Amazonka.Transfer.Types.ListedAccess" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListedAccess'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListedAccess :: ListedAccess Source #

Create a value of ListedAccess 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:homeDirectoryType:ListedAccess', listedAccess_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:role':ListedAccess', listedAccess_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

$sel:externalId:ListedAccess', listedAccess_externalId - A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

$sel:homeDirectory:ListedAccess', listedAccess_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

ListedExecution

data ListedExecution Source #

Returns properties of the execution that is specified.

See: newListedExecution smart constructor.

Constructors

ListedExecution' (Maybe ExecutionStatus) (Maybe Text) (Maybe FileLocation) (Maybe ServiceMetadata)

Instances

Instances details

Eq ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution Methods (==) :: ListedExecution -> ListedExecution -> Bool # (/=) :: ListedExecution -> ListedExecution -> Bool #
Read ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution Methods readsPrec :: Int -> ReadS ListedExecution # readList :: ReadS [ListedExecution] # readPrec :: ReadPrec ListedExecution # readListPrec :: ReadPrec [ListedExecution] #
Show ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution Methods showsPrec :: Int -> ListedExecution -> ShowS # show :: ListedExecution -> String # showList :: [ListedExecution] -> ShowS #
Generic ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution Associated Types type Rep ListedExecution :: Type -> Type # Methods from :: ListedExecution -> Rep ListedExecution x # to :: Rep ListedExecution x -> ListedExecution #
NFData ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution Methods rnf :: ListedExecution -> () #
Hashable ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution Methods hashWithSalt :: Int -> ListedExecution -> Int # hash :: ListedExecution -> Int #
FromJSON ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution Methods parseJSON :: Value -> Parser ListedExecution # parseJSONList :: Value -> Parser [ListedExecution] #
type Rep ListedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.ListedExecution type Rep ListedExecution = D1 ('MetaData "ListedExecution" "Amazonka.Transfer.Types.ListedExecution" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListedExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus)) :: S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "initialFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileLocation)) :*: S1 ('MetaSel ('Just "serviceMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceMetadata)))))

newListedExecution :: ListedExecution Source #

Create a value of ListedExecution 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:status:ListedExecution', listedExecution_status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

$sel:executionId:ListedExecution', listedExecution_executionId - A unique identifier for the execution of a workflow.

$sel:initialFileLocation:ListedExecution', listedExecution_initialFileLocation - A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

$sel:serviceMetadata:ListedExecution', listedExecution_serviceMetadata - A container object for the session details associated with a workflow.

ListedServer

data ListedServer Source #

Returns properties of a file transfer protocol-enabled server that was specified.

See: newListedServer smart constructor.

Constructors

ListedServer' (Maybe Text) (Maybe State) (Maybe IdentityProviderType) (Maybe Text) (Maybe Domain) (Maybe EndpointType) (Maybe Int) Text

Instances

Instances details

Eq ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer Methods (==) :: ListedServer -> ListedServer -> Bool # (/=) :: ListedServer -> ListedServer -> Bool #
Read ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer Methods readsPrec :: Int -> ReadS ListedServer # readList :: ReadS [ListedServer] # readPrec :: ReadPrec ListedServer # readListPrec :: ReadPrec [ListedServer] #
Show ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer Methods showsPrec :: Int -> ListedServer -> ShowS # show :: ListedServer -> String # showList :: [ListedServer] -> ShowS #
Generic ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer Associated Types type Rep ListedServer :: Type -> Type # Methods from :: ListedServer -> Rep ListedServer x # to :: Rep ListedServer x -> ListedServer #
NFData ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer Methods rnf :: ListedServer -> () #
Hashable ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer Methods hashWithSalt :: Int -> ListedServer -> Int # hash :: ListedServer -> Int #
FromJSON ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer Methods parseJSON :: Value -> Parser ListedServer # parseJSONList :: Value -> Parser [ListedServer] #
type Rep ListedServer Source #
Instance details Defined in Amazonka.Transfer.Types.ListedServer type Rep ListedServer = D1 ('MetaData "ListedServer" "Amazonka.Transfer.Types.ListedServer" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListedServer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State))) :: (S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderType)) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType))) :: (S1 ('MetaSel ('Just "userCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListedServer Source #

Arguments

:: Text	`$sel:arn:ListedServer'`
-> ListedServer

Create a value of ListedServer 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:loggingRole:ListedServer', listedServer_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

$sel:state:ListedServer', listedServer_state - Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

$sel:identityProviderType:ListedServer', listedServer_identityProviderType - Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

$sel:serverId:ListedServer', listedServer_serverId - Specifies the unique system assigned identifier for the servers that were listed.

$sel:domain:ListedServer', listedServer_domain - Specifies the domain of the storage system that is used for file transfers.

$sel:endpointType:ListedServer', listedServer_endpointType - Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

$sel:userCount:ListedServer', listedServer_userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.

$sel:arn:ListedServer', listedServer_arn - Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

ListedUser

data ListedUser Source #

Returns properties of the user that you specify.

See: newListedUser smart constructor.

Constructors

ListedUser' (Maybe HomeDirectoryType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) Text

Instances

Instances details

Eq ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser Methods (==) :: ListedUser -> ListedUser -> Bool # (/=) :: ListedUser -> ListedUser -> Bool #
Read ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser Methods readsPrec :: Int -> ReadS ListedUser # readList :: ReadS [ListedUser] # readPrec :: ReadPrec ListedUser # readListPrec :: ReadPrec [ListedUser] #
Show ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser Methods showsPrec :: Int -> ListedUser -> ShowS # show :: ListedUser -> String # showList :: [ListedUser] -> ShowS #
Generic ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser Associated Types type Rep ListedUser :: Type -> Type # Methods from :: ListedUser -> Rep ListedUser x # to :: Rep ListedUser x -> ListedUser #
NFData ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser Methods rnf :: ListedUser -> () #
Hashable ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser Methods hashWithSalt :: Int -> ListedUser -> Int # hash :: ListedUser -> Int #
FromJSON ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser Methods parseJSON :: Value -> Parser ListedUser # parseJSONList :: Value -> Parser [ListedUser] #
type Rep ListedUser Source #
Instance details Defined in Amazonka.Transfer.Types.ListedUser type Rep ListedUser = D1 ('MetaData "ListedUser" "Amazonka.Transfer.Types.ListedUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListedUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sshPublicKeyCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListedUser Source #

Arguments

:: Text	`$sel:arn:ListedUser'`
-> ListedUser

Create a value of ListedUser 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:homeDirectoryType:ListedUser', listedUser_homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

$sel:userName:ListedUser', listedUser_userName - Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

$sel:role':ListedUser', listedUser_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.

The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.

$sel:sshPublicKeyCount:ListedUser', listedUser_sshPublicKeyCount - Specifies the number of SSH public keys stored for the user you specified.

$sel:homeDirectory:ListedUser', listedUser_homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

$sel:arn:ListedUser', listedUser_arn - Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

ListedWorkflow

data ListedWorkflow Source #

Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.

See: newListedWorkflow smart constructor.

Constructors

ListedWorkflow' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow Methods (==) :: ListedWorkflow -> ListedWorkflow -> Bool # (/=) :: ListedWorkflow -> ListedWorkflow -> Bool #
Read ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow Methods readsPrec :: Int -> ReadS ListedWorkflow # readList :: ReadS [ListedWorkflow] # readPrec :: ReadPrec ListedWorkflow # readListPrec :: ReadPrec [ListedWorkflow] #
Show ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow Methods showsPrec :: Int -> ListedWorkflow -> ShowS # show :: ListedWorkflow -> String # showList :: [ListedWorkflow] -> ShowS #
Generic ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow Associated Types type Rep ListedWorkflow :: Type -> Type # Methods from :: ListedWorkflow -> Rep ListedWorkflow x # to :: Rep ListedWorkflow x -> ListedWorkflow #
NFData ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow Methods rnf :: ListedWorkflow -> () #
Hashable ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow Methods hashWithSalt :: Int -> ListedWorkflow -> Int # hash :: ListedWorkflow -> Int #
FromJSON ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow Methods parseJSON :: Value -> Parser ListedWorkflow # parseJSONList :: Value -> Parser [ListedWorkflow] #
type Rep ListedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.ListedWorkflow type Rep ListedWorkflow = D1 ('MetaData "ListedWorkflow" "Amazonka.Transfer.Types.ListedWorkflow" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListedWorkflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListedWorkflow :: ListedWorkflow Source #

Create a value of ListedWorkflow 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:arn:ListedWorkflow', listedWorkflow_arn - Specifies the unique Amazon Resource Name (ARN) for the workflow.

$sel:workflowId:ListedWorkflow', listedWorkflow_workflowId - A unique identifier for the workflow.

$sel:description:ListedWorkflow', listedWorkflow_description - Specifies the text description for the workflow.

LoggingConfiguration

data LoggingConfiguration Source #

Consists of the logging role and the log group name.

See: newLoggingConfiguration smart constructor.

Constructors

LoggingConfiguration' (Maybe Text) (Maybe Text)

Instances

Instances details

Eq LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration Methods (==) :: LoggingConfiguration -> LoggingConfiguration -> Bool # (/=) :: LoggingConfiguration -> LoggingConfiguration -> Bool #
Read LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration Methods readsPrec :: Int -> ReadS LoggingConfiguration # readList :: ReadS [LoggingConfiguration] # readPrec :: ReadPrec LoggingConfiguration # readListPrec :: ReadPrec [LoggingConfiguration] #
Show LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration Methods showsPrec :: Int -> LoggingConfiguration -> ShowS # show :: LoggingConfiguration -> String # showList :: [LoggingConfiguration] -> ShowS #
Generic LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration Associated Types type Rep LoggingConfiguration :: Type -> Type # Methods from :: LoggingConfiguration -> Rep LoggingConfiguration x # to :: Rep LoggingConfiguration x -> LoggingConfiguration #
NFData LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration Methods rnf :: LoggingConfiguration -> () #
Hashable LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration Methods hashWithSalt :: Int -> LoggingConfiguration -> Int # hash :: LoggingConfiguration -> Int #
FromJSON LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration Methods parseJSON :: Value -> Parser LoggingConfiguration # parseJSONList :: Value -> Parser [LoggingConfiguration] #
type Rep LoggingConfiguration Source #
Instance details Defined in Amazonka.Transfer.Types.LoggingConfiguration type Rep LoggingConfiguration = D1 ('MetaData "LoggingConfiguration" "Amazonka.Transfer.Types.LoggingConfiguration" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "LoggingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newLoggingConfiguration :: LoggingConfiguration Source #

Create a value of LoggingConfiguration 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:loggingRole:LoggingConfiguration', loggingConfiguration_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

$sel:logGroupName:LoggingConfiguration', loggingConfiguration_logGroupName - The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.

PosixProfile

data PosixProfile Source #

The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

See: newPosixProfile smart constructor.

Constructors

PosixProfile' (Maybe [Natural]) Natural Natural

Instances

Instances details

Eq PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Methods (==) :: PosixProfile -> PosixProfile -> Bool # (/=) :: PosixProfile -> PosixProfile -> Bool #
Read PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Methods readsPrec :: Int -> ReadS PosixProfile # readList :: ReadS [PosixProfile] # readPrec :: ReadPrec PosixProfile # readListPrec :: ReadPrec [PosixProfile] #
Show PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Methods showsPrec :: Int -> PosixProfile -> ShowS # show :: PosixProfile -> String # showList :: [PosixProfile] -> ShowS #
Generic PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Associated Types type Rep PosixProfile :: Type -> Type # Methods from :: PosixProfile -> Rep PosixProfile x # to :: Rep PosixProfile x -> PosixProfile #
NFData PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Methods rnf :: PosixProfile -> () #
Hashable PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Methods hashWithSalt :: Int -> PosixProfile -> Int # hash :: PosixProfile -> Int #
ToJSON PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Methods toJSON :: PosixProfile -> Value # toEncoding :: PosixProfile -> Encoding # toJSONList :: [PosixProfile] -> Value # toEncodingList :: [PosixProfile] -> Encoding #
FromJSON PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile Methods parseJSON :: Value -> Parser PosixProfile # parseJSONList :: Value -> Parser [PosixProfile] #
type Rep PosixProfile Source #
Instance details Defined in Amazonka.Transfer.Types.PosixProfile type Rep PosixProfile = D1 ('MetaData "PosixProfile" "Amazonka.Transfer.Types.PosixProfile" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "PosixProfile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secondaryGids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural])) :: (S1 ('MetaSel ('Just "uid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "gid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newPosixProfile Source #

Arguments

:: Natural	`$sel:uid:PosixProfile'`
-> Natural	`$sel:gid:PosixProfile'`
-> PosixProfile

Create a value of PosixProfile 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:secondaryGids:PosixProfile', posixProfile_secondaryGids - The secondary POSIX group IDs used for all EFS operations by this user.

$sel:uid:PosixProfile', posixProfile_uid - The POSIX user ID used for all EFS operations by this user.

$sel:gid:PosixProfile', posixProfile_gid - The POSIX group ID used for all EFS operations by this user.

ProtocolDetails

data ProtocolDetails Source #

The protocol settings that are configured for your server.

This type is only valid in the UpdateServer API.

See: newProtocolDetails smart constructor.

Constructors

ProtocolDetails' (Maybe Text)

Instances

Instances details

Eq ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Methods (==) :: ProtocolDetails -> ProtocolDetails -> Bool # (/=) :: ProtocolDetails -> ProtocolDetails -> Bool #
Read ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Methods readsPrec :: Int -> ReadS ProtocolDetails # readList :: ReadS [ProtocolDetails] # readPrec :: ReadPrec ProtocolDetails # readListPrec :: ReadPrec [ProtocolDetails] #
Show ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Methods showsPrec :: Int -> ProtocolDetails -> ShowS # show :: ProtocolDetails -> String # showList :: [ProtocolDetails] -> ShowS #
Generic ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Associated Types type Rep ProtocolDetails :: Type -> Type # Methods from :: ProtocolDetails -> Rep ProtocolDetails x # to :: Rep ProtocolDetails x -> ProtocolDetails #
NFData ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Methods rnf :: ProtocolDetails -> () #
Hashable ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Methods hashWithSalt :: Int -> ProtocolDetails -> Int # hash :: ProtocolDetails -> Int #
ToJSON ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Methods toJSON :: ProtocolDetails -> Value # toEncoding :: ProtocolDetails -> Encoding # toJSONList :: [ProtocolDetails] -> Value # toEncodingList :: [ProtocolDetails] -> Encoding #
FromJSON ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails Methods parseJSON :: Value -> Parser ProtocolDetails # parseJSONList :: Value -> Parser [ProtocolDetails] #
type Rep ProtocolDetails Source #
Instance details Defined in Amazonka.Transfer.Types.ProtocolDetails type Rep ProtocolDetails = D1 ('MetaData "ProtocolDetails" "Amazonka.Transfer.Types.ProtocolDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ProtocolDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "passiveIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newProtocolDetails :: ProtocolDetails Source #

Create a value of ProtocolDetails 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:passiveIp:ProtocolDetails', protocolDetails_passiveIp - Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. For example:

 aws transfer update-server --protocol-details PassiveIp=0.0.0.0

Replace 0.0.0.0 in the example above with the actual IP address you want to use.

If you change the PassiveIp value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.

S3FileLocation

data S3FileLocation Source #

Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using S3 storage.

See: newS3FileLocation smart constructor.

Constructors

S3FileLocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

Eq S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation Methods (==) :: S3FileLocation -> S3FileLocation -> Bool # (/=) :: S3FileLocation -> S3FileLocation -> Bool #
Read S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation Methods readsPrec :: Int -> ReadS S3FileLocation # readList :: ReadS [S3FileLocation] # readPrec :: ReadPrec S3FileLocation # readListPrec :: ReadPrec [S3FileLocation] #
Show S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation Methods showsPrec :: Int -> S3FileLocation -> ShowS # show :: S3FileLocation -> String # showList :: [S3FileLocation] -> ShowS #
Generic S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation Associated Types type Rep S3FileLocation :: Type -> Type # Methods from :: S3FileLocation -> Rep S3FileLocation x # to :: Rep S3FileLocation x -> S3FileLocation #
NFData S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation Methods rnf :: S3FileLocation -> () #
Hashable S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation Methods hashWithSalt :: Int -> S3FileLocation -> Int # hash :: S3FileLocation -> Int #
FromJSON S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation Methods parseJSON :: Value -> Parser S3FileLocation # parseJSONList :: Value -> Parser [S3FileLocation] #
type Rep S3FileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3FileLocation type Rep S3FileLocation = D1 ('MetaData "S3FileLocation" "Amazonka.Transfer.Types.S3FileLocation" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "S3FileLocation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "etag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newS3FileLocation :: S3FileLocation Source #

Create a value of S3FileLocation 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:versionId:S3FileLocation', s3FileLocation_versionId - Specifies the file version.

$sel:etag:S3FileLocation', s3FileLocation_etag - The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.

$sel:bucket:S3FileLocation', s3FileLocation_bucket - Specifies the S3 bucket that contains the file being used.

$sel:key:S3FileLocation', s3FileLocation_key - The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

S3InputFileLocation

data S3InputFileLocation Source #

Specifies the customer input S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

See: newS3InputFileLocation smart constructor.

Constructors

S3InputFileLocation' (Maybe Text) (Maybe Text)

Instances

Instances details

Eq S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Methods (==) :: S3InputFileLocation -> S3InputFileLocation -> Bool # (/=) :: S3InputFileLocation -> S3InputFileLocation -> Bool #
Read S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Methods readsPrec :: Int -> ReadS S3InputFileLocation # readList :: ReadS [S3InputFileLocation] # readPrec :: ReadPrec S3InputFileLocation # readListPrec :: ReadPrec [S3InputFileLocation] #
Show S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Methods showsPrec :: Int -> S3InputFileLocation -> ShowS # show :: S3InputFileLocation -> String # showList :: [S3InputFileLocation] -> ShowS #
Generic S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Associated Types type Rep S3InputFileLocation :: Type -> Type # Methods from :: S3InputFileLocation -> Rep S3InputFileLocation x # to :: Rep S3InputFileLocation x -> S3InputFileLocation #
NFData S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Methods rnf :: S3InputFileLocation -> () #
Hashable S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Methods hashWithSalt :: Int -> S3InputFileLocation -> Int # hash :: S3InputFileLocation -> Int #
ToJSON S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Methods toJSON :: S3InputFileLocation -> Value # toEncoding :: S3InputFileLocation -> Encoding # toJSONList :: [S3InputFileLocation] -> Value # toEncodingList :: [S3InputFileLocation] -> Encoding #
FromJSON S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation Methods parseJSON :: Value -> Parser S3InputFileLocation # parseJSONList :: Value -> Parser [S3InputFileLocation] #
type Rep S3InputFileLocation Source #
Instance details Defined in Amazonka.Transfer.Types.S3InputFileLocation type Rep S3InputFileLocation = D1 ('MetaData "S3InputFileLocation" "Amazonka.Transfer.Types.S3InputFileLocation" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "S3InputFileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newS3InputFileLocation :: S3InputFileLocation Source #

Create a value of S3InputFileLocation 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:bucket:S3InputFileLocation', s3InputFileLocation_bucket - Specifies the S3 bucket for the customer input file.

$sel:key:S3InputFileLocation', s3InputFileLocation_key - The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

S3Tag

data S3Tag Source #

Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.

See: newS3Tag smart constructor.

Constructors

S3Tag' Text Text

Instances

Instances details

Eq S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Methods (==) :: S3Tag -> S3Tag -> Bool # (/=) :: S3Tag -> S3Tag -> Bool #
Read S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Methods readsPrec :: Int -> ReadS S3Tag # readList :: ReadS [S3Tag] # readPrec :: ReadPrec S3Tag # readListPrec :: ReadPrec [S3Tag] #
Show S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Methods showsPrec :: Int -> S3Tag -> ShowS # show :: S3Tag -> String # showList :: [S3Tag] -> ShowS #
Generic S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Associated Types type Rep S3Tag :: Type -> Type # Methods from :: S3Tag -> Rep S3Tag x # to :: Rep S3Tag x -> S3Tag #
NFData S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Methods rnf :: S3Tag -> () #
Hashable S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Methods hashWithSalt :: Int -> S3Tag -> Int # hash :: S3Tag -> Int #
ToJSON S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Methods toJSON :: S3Tag -> Value # toEncoding :: S3Tag -> Encoding # toJSONList :: [S3Tag] -> Value # toEncodingList :: [S3Tag] -> Encoding #
FromJSON S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag Methods parseJSON :: Value -> Parser S3Tag # parseJSONList :: Value -> Parser [S3Tag] #
type Rep S3Tag Source #
Instance details Defined in Amazonka.Transfer.Types.S3Tag type Rep S3Tag = D1 ('MetaData "S3Tag" "Amazonka.Transfer.Types.S3Tag" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "S3Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newS3Tag Source #

Arguments

:: Text	`$sel:key:S3Tag'`
-> Text	`$sel:value:S3Tag'`
-> S3Tag

Create a value of S3Tag 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:key:S3Tag', s3Tag_key - The name assigned to the tag that you create.

$sel:value:S3Tag', s3Tag_value - The value that corresponds to the key.

ServiceMetadata

data ServiceMetadata Source #

A container object for the session details associated with a workflow.

See: newServiceMetadata smart constructor.

Constructors

ServiceMetadata' UserDetails

Instances

Instances details

Eq ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata Methods (==) :: ServiceMetadata -> ServiceMetadata -> Bool # (/=) :: ServiceMetadata -> ServiceMetadata -> Bool #
Read ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata Methods readsPrec :: Int -> ReadS ServiceMetadata # readList :: ReadS [ServiceMetadata] # readPrec :: ReadPrec ServiceMetadata # readListPrec :: ReadPrec [ServiceMetadata] #
Show ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata Methods showsPrec :: Int -> ServiceMetadata -> ShowS # show :: ServiceMetadata -> String # showList :: [ServiceMetadata] -> ShowS #
Generic ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata Associated Types type Rep ServiceMetadata :: Type -> Type # Methods from :: ServiceMetadata -> Rep ServiceMetadata x # to :: Rep ServiceMetadata x -> ServiceMetadata #
NFData ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata Methods rnf :: ServiceMetadata -> () #
Hashable ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata Methods hashWithSalt :: Int -> ServiceMetadata -> Int # hash :: ServiceMetadata -> Int #
FromJSON ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata Methods parseJSON :: Value -> Parser ServiceMetadata # parseJSONList :: Value -> Parser [ServiceMetadata] #
type Rep ServiceMetadata Source #
Instance details Defined in Amazonka.Transfer.Types.ServiceMetadata type Rep ServiceMetadata = D1 ('MetaData "ServiceMetadata" "Amazonka.Transfer.Types.ServiceMetadata" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ServiceMetadata'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserDetails)))

newServiceMetadata Source #

Arguments

:: UserDetails	`$sel:userDetails:ServiceMetadata'`
-> ServiceMetadata

Create a value of ServiceMetadata 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:userDetails:ServiceMetadata', serviceMetadata_userDetails - The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the UserDetails.

SshPublicKey

data SshPublicKey Source #

Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

See: newSshPublicKey smart constructor.

Constructors

SshPublicKey' POSIX Text Text

Instances

Instances details

Eq SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey Methods (==) :: SshPublicKey -> SshPublicKey -> Bool # (/=) :: SshPublicKey -> SshPublicKey -> Bool #
Read SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey Methods readsPrec :: Int -> ReadS SshPublicKey # readList :: ReadS [SshPublicKey] # readPrec :: ReadPrec SshPublicKey # readListPrec :: ReadPrec [SshPublicKey] #
Show SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey Methods showsPrec :: Int -> SshPublicKey -> ShowS # show :: SshPublicKey -> String # showList :: [SshPublicKey] -> ShowS #
Generic SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey Associated Types type Rep SshPublicKey :: Type -> Type # Methods from :: SshPublicKey -> Rep SshPublicKey x # to :: Rep SshPublicKey x -> SshPublicKey #
NFData SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey Methods rnf :: SshPublicKey -> () #
Hashable SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey Methods hashWithSalt :: Int -> SshPublicKey -> Int # hash :: SshPublicKey -> Int #
FromJSON SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey Methods parseJSON :: Value -> Parser SshPublicKey # parseJSONList :: Value -> Parser [SshPublicKey] #
type Rep SshPublicKey Source #
Instance details Defined in Amazonka.Transfer.Types.SshPublicKey type Rep SshPublicKey = D1 ('MetaData "SshPublicKey" "Amazonka.Transfer.Types.SshPublicKey" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "SshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dateImported") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "sshPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSshPublicKey Source #

Arguments

:: UTCTime	`$sel:dateImported:SshPublicKey'`
-> Text	`$sel:sshPublicKeyBody:SshPublicKey'`
-> Text	`$sel:sshPublicKeyId:SshPublicKey'`
-> SshPublicKey

Create a value of SshPublicKey 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:dateImported:SshPublicKey', sshPublicKey_dateImported - Specifies the date that the public key was added to the user account.

$sel:sshPublicKeyBody:SshPublicKey', sshPublicKey_sshPublicKeyBody - Specifies the content of the SSH public key as specified by the PublicKeyId.

$sel:sshPublicKeyId:SshPublicKey', sshPublicKey_sshPublicKeyId - Specifies the SshPublicKeyId parameter contains the identifier of the public key.

Tag

data Tag Source #

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

See: newTag smart constructor.

Constructors

Tag' Text Text

Instances

Instances details

Eq Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Read Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
Generic Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
NFData Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Methods rnf :: Tag -> () #
Hashable Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Methods hashWithSalt :: Int -> Tag -> Int # hash :: Tag -> Int #
ToJSON Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
FromJSON Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #
type Rep Tag Source #
Instance details Defined in Amazonka.Transfer.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Transfer.Types.Tag" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Arguments

:: Text	`$sel:key:Tag'`
-> Text	`$sel:value:Tag'`
-> Tag

Create a value of Tag 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:key:Tag', tag_key - The name assigned to the tag that you create.

$sel:value:Tag', tag_value - Contains one or more values that you assigned to the key name you create.

TagStepDetails

data TagStepDetails Source #

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

See: newTagStepDetails smart constructor.

Constructors

TagStepDetails' (Maybe Text) (Maybe (NonEmpty S3Tag))

Instances

Instances details

Eq TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods (==) :: TagStepDetails -> TagStepDetails -> Bool # (/=) :: TagStepDetails -> TagStepDetails -> Bool #
Read TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods readsPrec :: Int -> ReadS TagStepDetails # readList :: ReadS [TagStepDetails] # readPrec :: ReadPrec TagStepDetails # readListPrec :: ReadPrec [TagStepDetails] #
Show TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods showsPrec :: Int -> TagStepDetails -> ShowS # show :: TagStepDetails -> String # showList :: [TagStepDetails] -> ShowS #
Generic TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Associated Types type Rep TagStepDetails :: Type -> Type # Methods from :: TagStepDetails -> Rep TagStepDetails x # to :: Rep TagStepDetails x -> TagStepDetails #
NFData TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods rnf :: TagStepDetails -> () #
Hashable TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods hashWithSalt :: Int -> TagStepDetails -> Int # hash :: TagStepDetails -> Int #
ToJSON TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods toJSON :: TagStepDetails -> Value # toEncoding :: TagStepDetails -> Encoding # toJSONList :: [TagStepDetails] -> Value # toEncodingList :: [TagStepDetails] -> Encoding #
FromJSON TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods parseJSON :: Value -> Parser TagStepDetails # parseJSONList :: Value -> Parser [TagStepDetails] #
type Rep TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails type Rep TagStepDetails = D1 ('MetaData "TagStepDetails" "Amazonka.Transfer.Types.TagStepDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "TagStepDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty S3Tag)))))

newTagStepDetails :: TagStepDetails Source #

Create a value of TagStepDetails 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:name:TagStepDetails', tagStepDetails_name - The name of the step, used as an identifier.

$sel:tags:TagStepDetails', tagStepDetails_tags - Array that contains from 1 to 10 key/value pairs.

UserDetails

data UserDetails Source #

Specifies the user name, server ID, and session ID for a workflow.

See: newUserDetails smart constructor.

Constructors

UserDetails' (Maybe Text) Text Text

Instances

Instances details

Eq UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails Methods (==) :: UserDetails -> UserDetails -> Bool # (/=) :: UserDetails -> UserDetails -> Bool #
Read UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails Methods readsPrec :: Int -> ReadS UserDetails # readList :: ReadS [UserDetails] # readPrec :: ReadPrec UserDetails # readListPrec :: ReadPrec [UserDetails] #
Show UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails Methods showsPrec :: Int -> UserDetails -> ShowS # show :: UserDetails -> String # showList :: [UserDetails] -> ShowS #
Generic UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails Associated Types type Rep UserDetails :: Type -> Type # Methods from :: UserDetails -> Rep UserDetails x # to :: Rep UserDetails x -> UserDetails #
NFData UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails Methods rnf :: UserDetails -> () #
Hashable UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails Methods hashWithSalt :: Int -> UserDetails -> Int # hash :: UserDetails -> Int #
FromJSON UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails Methods parseJSON :: Value -> Parser UserDetails # parseJSONList :: Value -> Parser [UserDetails] #
type Rep UserDetails Source #
Instance details Defined in Amazonka.Transfer.Types.UserDetails type Rep UserDetails = D1 ('MetaData "UserDetails" "Amazonka.Transfer.Types.UserDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "UserDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUserDetails Source #

Arguments

:: Text	`$sel:userName:UserDetails'`
-> Text	`$sel:serverId:UserDetails'`
-> UserDetails

Create a value of UserDetails 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:sessionId:UserDetails', userDetails_sessionId - The system-assigned unique identifier for a session that corresponds to the workflow.

$sel:userName:UserDetails', userDetails_userName - A unique string that identifies a user account associated with a server.

$sel:serverId:UserDetails', userDetails_serverId - The system-assigned unique identifier for a Transfer server instance.

WorkflowDetail

data WorkflowDetail Source #

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

See: newWorkflowDetail smart constructor.

Constructors

WorkflowDetail' Text Text

Instances

Instances details

Eq WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Methods (==) :: WorkflowDetail -> WorkflowDetail -> Bool # (/=) :: WorkflowDetail -> WorkflowDetail -> Bool #
Read WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Methods readsPrec :: Int -> ReadS WorkflowDetail # readList :: ReadS [WorkflowDetail] # readPrec :: ReadPrec WorkflowDetail # readListPrec :: ReadPrec [WorkflowDetail] #
Show WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Methods showsPrec :: Int -> WorkflowDetail -> ShowS # show :: WorkflowDetail -> String # showList :: [WorkflowDetail] -> ShowS #
Generic WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Associated Types type Rep WorkflowDetail :: Type -> Type # Methods from :: WorkflowDetail -> Rep WorkflowDetail x # to :: Rep WorkflowDetail x -> WorkflowDetail #
NFData WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Methods rnf :: WorkflowDetail -> () #
Hashable WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Methods hashWithSalt :: Int -> WorkflowDetail -> Int # hash :: WorkflowDetail -> Int #
ToJSON WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Methods toJSON :: WorkflowDetail -> Value # toEncoding :: WorkflowDetail -> Encoding # toJSONList :: [WorkflowDetail] -> Value # toEncodingList :: [WorkflowDetail] -> Encoding #
FromJSON WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail Methods parseJSON :: Value -> Parser WorkflowDetail # parseJSONList :: Value -> Parser [WorkflowDetail] #
type Rep WorkflowDetail Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetail type Rep WorkflowDetail = D1 ('MetaData "WorkflowDetail" "Amazonka.Transfer.Types.WorkflowDetail" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "WorkflowDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newWorkflowDetail Source #

Arguments

:: Text	`$sel:workflowId:WorkflowDetail'`
-> Text	`$sel:executionRole:WorkflowDetail'`
-> WorkflowDetail

Create a value of WorkflowDetail 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:workflowId:WorkflowDetail', workflowDetail_workflowId - A unique identifier for the workflow.

$sel:executionRole:WorkflowDetail', workflowDetail_executionRole - Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

WorkflowDetails

data WorkflowDetails Source #

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

See: newWorkflowDetails smart constructor.

Constructors

WorkflowDetails' [WorkflowDetail]

Instances

Instances details

Eq WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods (==) :: WorkflowDetails -> WorkflowDetails -> Bool # (/=) :: WorkflowDetails -> WorkflowDetails -> Bool #
Read WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods readsPrec :: Int -> ReadS WorkflowDetails # readList :: ReadS [WorkflowDetails] # readPrec :: ReadPrec WorkflowDetails # readListPrec :: ReadPrec [WorkflowDetails] #
Show WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods showsPrec :: Int -> WorkflowDetails -> ShowS # show :: WorkflowDetails -> String # showList :: [WorkflowDetails] -> ShowS #
Generic WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Associated Types type Rep WorkflowDetails :: Type -> Type # Methods from :: WorkflowDetails -> Rep WorkflowDetails x # to :: Rep WorkflowDetails x -> WorkflowDetails #
NFData WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods rnf :: WorkflowDetails -> () #
Hashable WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods hashWithSalt :: Int -> WorkflowDetails -> Int # hash :: WorkflowDetails -> Int #
ToJSON WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods toJSON :: WorkflowDetails -> Value # toEncoding :: WorkflowDetails -> Encoding # toJSONList :: [WorkflowDetails] -> Value # toEncodingList :: [WorkflowDetails] -> Encoding #
FromJSON WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods parseJSON :: Value -> Parser WorkflowDetails # parseJSONList :: Value -> Parser [WorkflowDetails] #
type Rep WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails type Rep WorkflowDetails = D1 ('MetaData "WorkflowDetails" "Amazonka.Transfer.Types.WorkflowDetails" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "WorkflowDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "onUpload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WorkflowDetail])))

newWorkflowDetails :: WorkflowDetails Source #

Create a value of WorkflowDetails 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:onUpload:WorkflowDetails', workflowDetails_onUpload - A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

WorkflowStep

data WorkflowStep Source #

The basic building block of a workflow.

See: newWorkflowStep smart constructor.

Constructors

WorkflowStep' (Maybe TagStepDetails) (Maybe DeleteStepDetails) (Maybe CopyStepDetails) (Maybe WorkflowStepType) (Maybe CustomStepDetails)

Instances

Instances details

Eq WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Methods (==) :: WorkflowStep -> WorkflowStep -> Bool # (/=) :: WorkflowStep -> WorkflowStep -> Bool #
Read WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Methods readsPrec :: Int -> ReadS WorkflowStep # readList :: ReadS [WorkflowStep] # readPrec :: ReadPrec WorkflowStep # readListPrec :: ReadPrec [WorkflowStep] #
Show WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Methods showsPrec :: Int -> WorkflowStep -> ShowS # show :: WorkflowStep -> String # showList :: [WorkflowStep] -> ShowS #
Generic WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Associated Types type Rep WorkflowStep :: Type -> Type # Methods from :: WorkflowStep -> Rep WorkflowStep x # to :: Rep WorkflowStep x -> WorkflowStep #
NFData WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Methods rnf :: WorkflowStep -> () #
Hashable WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Methods hashWithSalt :: Int -> WorkflowStep -> Int # hash :: WorkflowStep -> Int #
ToJSON WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Methods toJSON :: WorkflowStep -> Value # toEncoding :: WorkflowStep -> Encoding # toJSONList :: [WorkflowStep] -> Value # toEncodingList :: [WorkflowStep] -> Encoding #
FromJSON WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep Methods parseJSON :: Value -> Parser WorkflowStep # parseJSONList :: Value -> Parser [WorkflowStep] #
type Rep WorkflowStep Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowStep type Rep WorkflowStep = D1 ('MetaData "WorkflowStep" "Amazonka.Transfer.Types.WorkflowStep" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "WorkflowStep'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tagStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TagStepDetails)) :: S1 ('MetaSel ('Just "deleteStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteStepDetails))) :: (S1 ('MetaSel ('Just "copyStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CopyStepDetails)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowStepType)) :: S1 ('MetaSel ('Just "customStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomStepDetails))))))

newWorkflowStep :: WorkflowStep Source #

Create a value of WorkflowStep 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:tagStepDetails:WorkflowStep', workflowStep_tagStepDetails - Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

$sel:deleteStepDetails:WorkflowStep', workflowStep_deleteStepDetails - Details for a step that deletes the file.

$sel:copyStepDetails:WorkflowStep', workflowStep_copyStepDetails - Details for a step that performs a file copy.

Consists of the following values:

A description
An S3 location for the destination of the file copy.
A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

$sel:type':WorkflowStep', workflowStep_type - Currently, the following step types are supported.

Copy: copy the file to another location
Custom: custom step with a lambda target
Delete: delete the file
Tag: add a tag to the file

$sel:customStepDetails:WorkflowStep', workflowStep_customStepDetails - Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).