| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Transfer.Types
Contents
- Service Configuration
- Errors
- AgreementStatusType
- As2Transport
- CertificateStatusType
- CertificateType
- CertificateUsageType
- CompressionEnum
- CustomStepStatus
- Domain
- EncryptionAlg
- EncryptionType
- EndpointType
- ExecutionErrorType
- ExecutionStatus
- HomeDirectoryType
- IdentityProviderType
- MdnResponse
- MdnSigningAlg
- OverwriteExisting
- ProfileType
- Protocol
- SetStatOption
- SigningAlg
- State
- TlsSessionResumptionMode
- WorkflowStepType
- As2ConnectorConfig
- CopyStepDetails
- CustomStepDetails
- DecryptStepDetails
- DeleteStepDetails
- DescribedAccess
- DescribedAgreement
- DescribedCertificate
- DescribedConnector
- DescribedExecution
- DescribedHostKey
- DescribedProfile
- DescribedSecurityPolicy
- DescribedServer
- DescribedUser
- DescribedWorkflow
- EfsFileLocation
- EndpointDetails
- ExecutionError
- ExecutionResults
- ExecutionStepResult
- FileLocation
- HomeDirectoryMapEntry
- IdentityProviderDetails
- InputFileLocation
- ListedAccess
- ListedAgreement
- ListedCertificate
- ListedConnector
- ListedExecution
- ListedHostKey
- ListedProfile
- ListedServer
- ListedUser
- ListedWorkflow
- LoggingConfiguration
- PosixProfile
- ProtocolDetails
- S3FileLocation
- S3InputFileLocation
- S3Tag
- ServiceMetadata
- SshPublicKey
- Tag
- TagStepDetails
- UserDetails
- WorkflowDetail
- WorkflowDetails
- WorkflowStep
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServiceError :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _ResourceExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- newtype AgreementStatusType where
- newtype As2Transport where
- As2Transport' { }
- pattern As2Transport_HTTP :: As2Transport
- newtype CertificateStatusType where
- newtype CertificateType where
- newtype CertificateUsageType where
- newtype CompressionEnum where
- CompressionEnum' { }
- pattern CompressionEnum_DISABLED :: CompressionEnum
- pattern CompressionEnum_ZLIB :: CompressionEnum
- newtype CustomStepStatus where
- CustomStepStatus' { }
- pattern CustomStepStatus_FAILURE :: CustomStepStatus
- pattern CustomStepStatus_SUCCESS :: CustomStepStatus
- newtype Domain where
- Domain' {
- fromDomain :: Text
- pattern Domain_EFS :: Domain
- pattern Domain_S3 :: Domain
- Domain' {
- newtype EncryptionAlg where
- EncryptionAlg' { }
- pattern EncryptionAlg_AES128_CBC :: EncryptionAlg
- pattern EncryptionAlg_AES192_CBC :: EncryptionAlg
- pattern EncryptionAlg_AES256_CBC :: EncryptionAlg
- pattern EncryptionAlg_NONE :: EncryptionAlg
- newtype EncryptionType where
- EncryptionType' { }
- pattern EncryptionType_PGP :: EncryptionType
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_PUBLIC :: EndpointType
- pattern EndpointType_VPC :: EndpointType
- pattern EndpointType_VPC_ENDPOINT :: EndpointType
- newtype ExecutionErrorType where
- ExecutionErrorType' { }
- pattern ExecutionErrorType_ALREADY_EXISTS :: ExecutionErrorType
- pattern ExecutionErrorType_BAD_REQUEST :: ExecutionErrorType
- pattern ExecutionErrorType_CUSTOM_STEP_FAILED :: ExecutionErrorType
- pattern ExecutionErrorType_INTERNAL_SERVER_ERROR :: ExecutionErrorType
- pattern ExecutionErrorType_NOT_FOUND :: ExecutionErrorType
- pattern ExecutionErrorType_PERMISSION_DENIED :: ExecutionErrorType
- pattern ExecutionErrorType_THROTTLED :: ExecutionErrorType
- pattern ExecutionErrorType_TIMEOUT :: ExecutionErrorType
- newtype ExecutionStatus where
- ExecutionStatus' { }
- pattern ExecutionStatus_COMPLETED :: ExecutionStatus
- pattern ExecutionStatus_EXCEPTION :: ExecutionStatus
- pattern ExecutionStatus_HANDLING_EXCEPTION :: ExecutionStatus
- pattern ExecutionStatus_IN_PROGRESS :: ExecutionStatus
- newtype HomeDirectoryType where
- HomeDirectoryType' { }
- pattern HomeDirectoryType_LOGICAL :: HomeDirectoryType
- pattern HomeDirectoryType_PATH :: HomeDirectoryType
- newtype IdentityProviderType where
- newtype MdnResponse where
- MdnResponse' { }
- pattern MdnResponse_NONE :: MdnResponse
- pattern MdnResponse_SYNC :: MdnResponse
- newtype MdnSigningAlg where
- MdnSigningAlg' { }
- pattern MdnSigningAlg_DEFAULT :: MdnSigningAlg
- pattern MdnSigningAlg_NONE :: MdnSigningAlg
- pattern MdnSigningAlg_SHA1 :: MdnSigningAlg
- pattern MdnSigningAlg_SHA256 :: MdnSigningAlg
- pattern MdnSigningAlg_SHA384 :: MdnSigningAlg
- pattern MdnSigningAlg_SHA512 :: MdnSigningAlg
- newtype OverwriteExisting where
- OverwriteExisting' { }
- pattern OverwriteExisting_FALSE :: OverwriteExisting
- pattern OverwriteExisting_TRUE :: OverwriteExisting
- newtype ProfileType where
- ProfileType' { }
- pattern ProfileType_LOCAL :: ProfileType
- pattern ProfileType_PARTNER :: ProfileType
- newtype Protocol where
- Protocol' {
- fromProtocol :: Text
- pattern Protocol_AS2 :: Protocol
- pattern Protocol_FTP :: Protocol
- pattern Protocol_FTPS :: Protocol
- pattern Protocol_SFTP :: Protocol
- Protocol' {
- newtype SetStatOption where
- SetStatOption' { }
- pattern SetStatOption_DEFAULT :: SetStatOption
- pattern SetStatOption_ENABLE_NO_OP :: SetStatOption
- newtype SigningAlg where
- SigningAlg' { }
- pattern SigningAlg_NONE :: SigningAlg
- pattern SigningAlg_SHA1 :: SigningAlg
- pattern SigningAlg_SHA256 :: SigningAlg
- pattern SigningAlg_SHA384 :: SigningAlg
- pattern SigningAlg_SHA512 :: SigningAlg
- newtype State where
- State' { }
- 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 TlsSessionResumptionMode where
- newtype WorkflowStepType where
- WorkflowStepType' { }
- pattern WorkflowStepType_COPY :: WorkflowStepType
- pattern WorkflowStepType_CUSTOM :: WorkflowStepType
- pattern WorkflowStepType_DECRYPT :: WorkflowStepType
- pattern WorkflowStepType_DELETE :: WorkflowStepType
- pattern WorkflowStepType_TAG :: WorkflowStepType
- data As2ConnectorConfig = As2ConnectorConfig' {}
- newAs2ConnectorConfig :: As2ConnectorConfig
- as2ConnectorConfig_compression :: Lens' As2ConnectorConfig (Maybe CompressionEnum)
- as2ConnectorConfig_encryptionAlgorithm :: Lens' As2ConnectorConfig (Maybe EncryptionAlg)
- as2ConnectorConfig_localProfileId :: Lens' As2ConnectorConfig (Maybe Text)
- as2ConnectorConfig_mdnResponse :: Lens' As2ConnectorConfig (Maybe MdnResponse)
- as2ConnectorConfig_mdnSigningAlgorithm :: Lens' As2ConnectorConfig (Maybe MdnSigningAlg)
- as2ConnectorConfig_messageSubject :: Lens' As2ConnectorConfig (Maybe Text)
- as2ConnectorConfig_partnerProfileId :: Lens' As2ConnectorConfig (Maybe Text)
- as2ConnectorConfig_signingAlgorithm :: Lens' As2ConnectorConfig (Maybe SigningAlg)
- data CopyStepDetails = CopyStepDetails' {}
- newCopyStepDetails :: CopyStepDetails
- copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation)
- copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text)
- copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting)
- copyStepDetails_sourceFileLocation :: Lens' CopyStepDetails (Maybe Text)
- data CustomStepDetails = CustomStepDetails' {}
- newCustomStepDetails :: CustomStepDetails
- customStepDetails_name :: Lens' CustomStepDetails (Maybe Text)
- customStepDetails_sourceFileLocation :: Lens' CustomStepDetails (Maybe Text)
- customStepDetails_target :: Lens' CustomStepDetails (Maybe Text)
- customStepDetails_timeoutSeconds :: Lens' CustomStepDetails (Maybe Natural)
- data DecryptStepDetails = DecryptStepDetails' {}
- newDecryptStepDetails :: EncryptionType -> InputFileLocation -> DecryptStepDetails
- decryptStepDetails_name :: Lens' DecryptStepDetails (Maybe Text)
- decryptStepDetails_overwriteExisting :: Lens' DecryptStepDetails (Maybe OverwriteExisting)
- decryptStepDetails_sourceFileLocation :: Lens' DecryptStepDetails (Maybe Text)
- decryptStepDetails_type :: Lens' DecryptStepDetails EncryptionType
- decryptStepDetails_destinationFileLocation :: Lens' DecryptStepDetails InputFileLocation
- data DeleteStepDetails = DeleteStepDetails' {}
- newDeleteStepDetails :: DeleteStepDetails
- deleteStepDetails_name :: Lens' DeleteStepDetails (Maybe Text)
- deleteStepDetails_sourceFileLocation :: Lens' DeleteStepDetails (Maybe Text)
- data DescribedAccess = DescribedAccess' {}
- newDescribedAccess :: DescribedAccess
- describedAccess_externalId :: Lens' DescribedAccess (Maybe Text)
- describedAccess_homeDirectory :: Lens' DescribedAccess (Maybe Text)
- describedAccess_homeDirectoryMappings :: Lens' DescribedAccess (Maybe (NonEmpty HomeDirectoryMapEntry))
- describedAccess_homeDirectoryType :: Lens' DescribedAccess (Maybe HomeDirectoryType)
- describedAccess_policy :: Lens' DescribedAccess (Maybe Text)
- describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile)
- describedAccess_role :: Lens' DescribedAccess (Maybe Text)
- data DescribedAgreement = DescribedAgreement' {
- accessRole :: Maybe Text
- agreementId :: Maybe Text
- baseDirectory :: Maybe Text
- description :: Maybe Text
- localProfileId :: Maybe Text
- partnerProfileId :: Maybe Text
- serverId :: Maybe Text
- status :: Maybe AgreementStatusType
- tags :: Maybe (NonEmpty Tag)
- arn :: Text
- newDescribedAgreement :: Text -> DescribedAgreement
- describedAgreement_accessRole :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_agreementId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_baseDirectory :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_description :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_localProfileId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_partnerProfileId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_serverId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_status :: Lens' DescribedAgreement (Maybe AgreementStatusType)
- describedAgreement_tags :: Lens' DescribedAgreement (Maybe (NonEmpty Tag))
- describedAgreement_arn :: Lens' DescribedAgreement Text
- data DescribedCertificate = DescribedCertificate' {
- activeDate :: Maybe POSIX
- certificate :: Maybe (Sensitive Text)
- certificateChain :: Maybe (Sensitive Text)
- certificateId :: Maybe Text
- description :: Maybe Text
- inactiveDate :: Maybe POSIX
- notAfterDate :: Maybe POSIX
- notBeforeDate :: Maybe POSIX
- serial :: Maybe Text
- status :: Maybe CertificateStatusType
- tags :: Maybe (NonEmpty Tag)
- type' :: Maybe CertificateType
- usage :: Maybe CertificateUsageType
- arn :: Text
- newDescribedCertificate :: Text -> DescribedCertificate
- describedCertificate_activeDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_certificate :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_certificateChain :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_certificateId :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_description :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_inactiveDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_notAfterDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_notBeforeDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_serial :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_status :: Lens' DescribedCertificate (Maybe CertificateStatusType)
- describedCertificate_tags :: Lens' DescribedCertificate (Maybe (NonEmpty Tag))
- describedCertificate_type :: Lens' DescribedCertificate (Maybe CertificateType)
- describedCertificate_usage :: Lens' DescribedCertificate (Maybe CertificateUsageType)
- describedCertificate_arn :: Lens' DescribedCertificate Text
- data DescribedConnector = DescribedConnector' {}
- newDescribedConnector :: Text -> DescribedConnector
- describedConnector_accessRole :: Lens' DescribedConnector (Maybe Text)
- describedConnector_as2Config :: Lens' DescribedConnector (Maybe As2ConnectorConfig)
- describedConnector_connectorId :: Lens' DescribedConnector (Maybe Text)
- describedConnector_loggingRole :: Lens' DescribedConnector (Maybe Text)
- describedConnector_tags :: Lens' DescribedConnector (Maybe (NonEmpty Tag))
- describedConnector_url :: Lens' DescribedConnector (Maybe Text)
- describedConnector_arn :: Lens' DescribedConnector Text
- data DescribedExecution = DescribedExecution' {}
- newDescribedExecution :: DescribedExecution
- describedExecution_executionId :: Lens' DescribedExecution (Maybe Text)
- describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text)
- describedExecution_initialFileLocation :: Lens' DescribedExecution (Maybe FileLocation)
- describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration)
- describedExecution_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile)
- describedExecution_results :: Lens' DescribedExecution (Maybe ExecutionResults)
- describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata)
- describedExecution_status :: Lens' DescribedExecution (Maybe ExecutionStatus)
- data DescribedHostKey = DescribedHostKey' {}
- newDescribedHostKey :: Text -> DescribedHostKey
- describedHostKey_dateImported :: Lens' DescribedHostKey (Maybe UTCTime)
- describedHostKey_description :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_hostKeyFingerprint :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_hostKeyId :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_tags :: Lens' DescribedHostKey (Maybe (NonEmpty Tag))
- describedHostKey_type :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_arn :: Lens' DescribedHostKey Text
- data DescribedProfile = DescribedProfile' {}
- newDescribedProfile :: Text -> DescribedProfile
- describedProfile_as2Id :: Lens' DescribedProfile (Maybe Text)
- describedProfile_certificateIds :: Lens' DescribedProfile (Maybe [Text])
- describedProfile_profileId :: Lens' DescribedProfile (Maybe Text)
- describedProfile_profileType :: Lens' DescribedProfile (Maybe ProfileType)
- describedProfile_tags :: Lens' DescribedProfile (Maybe (NonEmpty Tag))
- describedProfile_arn :: Lens' DescribedProfile Text
- data DescribedSecurityPolicy = DescribedSecurityPolicy' {}
- newDescribedSecurityPolicy :: Text -> DescribedSecurityPolicy
- describedSecurityPolicy_fips :: Lens' DescribedSecurityPolicy (Maybe Bool)
- describedSecurityPolicy_sshCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_sshKexs :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_sshMacs :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_tlsCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_securityPolicyName :: Lens' DescribedSecurityPolicy Text
- data DescribedServer = DescribedServer' {
- certificate :: Maybe Text
- domain :: Maybe Domain
- endpointDetails :: Maybe EndpointDetails
- endpointType :: Maybe EndpointType
- hostKeyFingerprint :: Maybe Text
- identityProviderDetails :: Maybe IdentityProviderDetails
- identityProviderType :: Maybe IdentityProviderType
- loggingRole :: Maybe Text
- postAuthenticationLoginBanner :: Maybe Text
- preAuthenticationLoginBanner :: Maybe Text
- protocolDetails :: Maybe ProtocolDetails
- protocols :: Maybe (NonEmpty Protocol)
- securityPolicyName :: Maybe Text
- serverId :: Maybe Text
- state :: Maybe State
- tags :: Maybe (NonEmpty Tag)
- userCount :: Maybe Int
- workflowDetails :: Maybe WorkflowDetails
- arn :: Text
- newDescribedServer :: Text -> DescribedServer
- describedServer_certificate :: Lens' DescribedServer (Maybe Text)
- describedServer_domain :: Lens' DescribedServer (Maybe Domain)
- describedServer_endpointDetails :: Lens' DescribedServer (Maybe EndpointDetails)
- describedServer_endpointType :: Lens' DescribedServer (Maybe EndpointType)
- describedServer_hostKeyFingerprint :: Lens' DescribedServer (Maybe Text)
- describedServer_identityProviderDetails :: Lens' DescribedServer (Maybe IdentityProviderDetails)
- describedServer_identityProviderType :: Lens' DescribedServer (Maybe IdentityProviderType)
- describedServer_loggingRole :: Lens' DescribedServer (Maybe Text)
- describedServer_postAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text)
- describedServer_preAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text)
- describedServer_protocolDetails :: Lens' DescribedServer (Maybe ProtocolDetails)
- describedServer_protocols :: Lens' DescribedServer (Maybe (NonEmpty Protocol))
- describedServer_securityPolicyName :: Lens' DescribedServer (Maybe Text)
- describedServer_serverId :: Lens' DescribedServer (Maybe Text)
- describedServer_state :: Lens' DescribedServer (Maybe State)
- describedServer_tags :: Lens' DescribedServer (Maybe (NonEmpty Tag))
- describedServer_userCount :: Lens' DescribedServer (Maybe Int)
- describedServer_workflowDetails :: Lens' DescribedServer (Maybe WorkflowDetails)
- describedServer_arn :: Lens' DescribedServer Text
- data DescribedUser = DescribedUser' {
- homeDirectory :: Maybe Text
- homeDirectoryMappings :: Maybe (NonEmpty HomeDirectoryMapEntry)
- homeDirectoryType :: Maybe HomeDirectoryType
- policy :: Maybe Text
- posixProfile :: Maybe PosixProfile
- role' :: Maybe Text
- sshPublicKeys :: Maybe [SshPublicKey]
- tags :: Maybe (NonEmpty Tag)
- userName :: Maybe Text
- arn :: Text
- newDescribedUser :: Text -> DescribedUser
- describedUser_homeDirectory :: Lens' DescribedUser (Maybe Text)
- describedUser_homeDirectoryMappings :: Lens' DescribedUser (Maybe (NonEmpty HomeDirectoryMapEntry))
- describedUser_homeDirectoryType :: Lens' DescribedUser (Maybe HomeDirectoryType)
- describedUser_policy :: Lens' DescribedUser (Maybe Text)
- describedUser_posixProfile :: Lens' DescribedUser (Maybe PosixProfile)
- describedUser_role :: Lens' DescribedUser (Maybe Text)
- describedUser_sshPublicKeys :: Lens' DescribedUser (Maybe [SshPublicKey])
- describedUser_tags :: Lens' DescribedUser (Maybe (NonEmpty Tag))
- describedUser_userName :: Lens' DescribedUser (Maybe Text)
- describedUser_arn :: Lens' DescribedUser Text
- data DescribedWorkflow = DescribedWorkflow' {
- description :: Maybe Text
- onExceptionSteps :: Maybe [WorkflowStep]
- steps :: Maybe [WorkflowStep]
- tags :: Maybe (NonEmpty Tag)
- workflowId :: Maybe Text
- arn :: Text
- newDescribedWorkflow :: Text -> DescribedWorkflow
- describedWorkflow_description :: Lens' DescribedWorkflow (Maybe Text)
- describedWorkflow_onExceptionSteps :: Lens' DescribedWorkflow (Maybe [WorkflowStep])
- describedWorkflow_steps :: Lens' DescribedWorkflow (Maybe [WorkflowStep])
- describedWorkflow_tags :: Lens' DescribedWorkflow (Maybe (NonEmpty Tag))
- describedWorkflow_workflowId :: Lens' DescribedWorkflow (Maybe Text)
- describedWorkflow_arn :: Lens' DescribedWorkflow Text
- data EfsFileLocation = EfsFileLocation' {}
- newEfsFileLocation :: EfsFileLocation
- efsFileLocation_fileSystemId :: Lens' EfsFileLocation (Maybe Text)
- efsFileLocation_path :: Lens' EfsFileLocation (Maybe Text)
- data EndpointDetails = EndpointDetails' {
- addressAllocationIds :: Maybe [Text]
- securityGroupIds :: Maybe [Text]
- subnetIds :: Maybe [Text]
- vpcEndpointId :: Maybe Text
- vpcId :: Maybe Text
- newEndpointDetails :: EndpointDetails
- endpointDetails_addressAllocationIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_securityGroupIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_subnetIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_vpcEndpointId :: Lens' EndpointDetails (Maybe Text)
- endpointDetails_vpcId :: Lens' EndpointDetails (Maybe Text)
- data ExecutionError = ExecutionError' {}
- newExecutionError :: ExecutionErrorType -> Text -> ExecutionError
- executionError_type :: Lens' ExecutionError ExecutionErrorType
- executionError_message :: Lens' ExecutionError Text
- data ExecutionResults = ExecutionResults' {}
- newExecutionResults :: ExecutionResults
- executionResults_onExceptionSteps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult))
- executionResults_steps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult))
- data ExecutionStepResult = ExecutionStepResult' {}
- newExecutionStepResult :: ExecutionStepResult
- executionStepResult_error :: Lens' ExecutionStepResult (Maybe ExecutionError)
- executionStepResult_outputs :: Lens' ExecutionStepResult (Maybe Text)
- executionStepResult_stepType :: Lens' ExecutionStepResult (Maybe WorkflowStepType)
- data FileLocation = FileLocation' {}
- newFileLocation :: FileLocation
- fileLocation_efsFileLocation :: Lens' FileLocation (Maybe EfsFileLocation)
- fileLocation_s3FileLocation :: Lens' FileLocation (Maybe S3FileLocation)
- data HomeDirectoryMapEntry = HomeDirectoryMapEntry' {}
- newHomeDirectoryMapEntry :: Text -> Text -> HomeDirectoryMapEntry
- homeDirectoryMapEntry_entry :: Lens' HomeDirectoryMapEntry Text
- homeDirectoryMapEntry_target :: Lens' HomeDirectoryMapEntry Text
- data IdentityProviderDetails = IdentityProviderDetails' {}
- newIdentityProviderDetails :: IdentityProviderDetails
- identityProviderDetails_directoryId :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_function :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_invocationRole :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_url :: Lens' IdentityProviderDetails (Maybe Text)
- data InputFileLocation = InputFileLocation' {}
- newInputFileLocation :: InputFileLocation
- inputFileLocation_efsFileLocation :: Lens' InputFileLocation (Maybe EfsFileLocation)
- inputFileLocation_s3FileLocation :: Lens' InputFileLocation (Maybe S3InputFileLocation)
- data ListedAccess = ListedAccess' {}
- newListedAccess :: ListedAccess
- listedAccess_externalId :: Lens' ListedAccess (Maybe Text)
- listedAccess_homeDirectory :: Lens' ListedAccess (Maybe Text)
- listedAccess_homeDirectoryType :: Lens' ListedAccess (Maybe HomeDirectoryType)
- listedAccess_role :: Lens' ListedAccess (Maybe Text)
- data ListedAgreement = ListedAgreement' {}
- newListedAgreement :: ListedAgreement
- listedAgreement_agreementId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_arn :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_description :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_localProfileId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_partnerProfileId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_serverId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_status :: Lens' ListedAgreement (Maybe AgreementStatusType)
- data ListedCertificate = ListedCertificate' {}
- newListedCertificate :: ListedCertificate
- listedCertificate_activeDate :: Lens' ListedCertificate (Maybe UTCTime)
- listedCertificate_arn :: Lens' ListedCertificate (Maybe Text)
- listedCertificate_certificateId :: Lens' ListedCertificate (Maybe Text)
- listedCertificate_description :: Lens' ListedCertificate (Maybe Text)
- listedCertificate_inactiveDate :: Lens' ListedCertificate (Maybe UTCTime)
- listedCertificate_status :: Lens' ListedCertificate (Maybe CertificateStatusType)
- listedCertificate_type :: Lens' ListedCertificate (Maybe CertificateType)
- listedCertificate_usage :: Lens' ListedCertificate (Maybe CertificateUsageType)
- data ListedConnector = ListedConnector' {}
- newListedConnector :: ListedConnector
- listedConnector_arn :: Lens' ListedConnector (Maybe Text)
- listedConnector_connectorId :: Lens' ListedConnector (Maybe Text)
- listedConnector_url :: Lens' ListedConnector (Maybe Text)
- data ListedExecution = ListedExecution' {}
- newListedExecution :: ListedExecution
- listedExecution_executionId :: Lens' ListedExecution (Maybe Text)
- listedExecution_initialFileLocation :: Lens' ListedExecution (Maybe FileLocation)
- listedExecution_serviceMetadata :: Lens' ListedExecution (Maybe ServiceMetadata)
- listedExecution_status :: Lens' ListedExecution (Maybe ExecutionStatus)
- data ListedHostKey = ListedHostKey' {}
- newListedHostKey :: Text -> ListedHostKey
- listedHostKey_dateImported :: Lens' ListedHostKey (Maybe UTCTime)
- listedHostKey_description :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_fingerprint :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_hostKeyId :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_type :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_arn :: Lens' ListedHostKey Text
- data ListedProfile = ListedProfile' {}
- newListedProfile :: ListedProfile
- listedProfile_arn :: Lens' ListedProfile (Maybe Text)
- listedProfile_as2Id :: Lens' ListedProfile (Maybe Text)
- listedProfile_profileId :: Lens' ListedProfile (Maybe Text)
- listedProfile_profileType :: Lens' ListedProfile (Maybe ProfileType)
- data ListedServer = ListedServer' {}
- newListedServer :: Text -> ListedServer
- listedServer_domain :: Lens' ListedServer (Maybe Domain)
- listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType)
- listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType)
- listedServer_loggingRole :: Lens' ListedServer (Maybe Text)
- listedServer_serverId :: Lens' ListedServer (Maybe Text)
- listedServer_state :: Lens' ListedServer (Maybe State)
- listedServer_userCount :: Lens' ListedServer (Maybe Int)
- listedServer_arn :: Lens' ListedServer Text
- data ListedUser = ListedUser' {}
- newListedUser :: Text -> ListedUser
- listedUser_homeDirectory :: Lens' ListedUser (Maybe Text)
- listedUser_homeDirectoryType :: Lens' ListedUser (Maybe HomeDirectoryType)
- listedUser_role :: Lens' ListedUser (Maybe Text)
- listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int)
- listedUser_userName :: Lens' ListedUser (Maybe Text)
- listedUser_arn :: Lens' ListedUser Text
- data ListedWorkflow = ListedWorkflow' {
- arn :: Maybe Text
- description :: Maybe Text
- workflowId :: Maybe Text
- newListedWorkflow :: ListedWorkflow
- listedWorkflow_arn :: Lens' ListedWorkflow (Maybe Text)
- listedWorkflow_description :: Lens' ListedWorkflow (Maybe Text)
- listedWorkflow_workflowId :: Lens' ListedWorkflow (Maybe Text)
- data LoggingConfiguration = LoggingConfiguration' {}
- newLoggingConfiguration :: LoggingConfiguration
- loggingConfiguration_logGroupName :: Lens' LoggingConfiguration (Maybe Text)
- loggingConfiguration_loggingRole :: Lens' LoggingConfiguration (Maybe Text)
- data PosixProfile = PosixProfile' {}
- newPosixProfile :: Natural -> Natural -> PosixProfile
- posixProfile_secondaryGids :: Lens' PosixProfile (Maybe [Natural])
- posixProfile_uid :: Lens' PosixProfile Natural
- posixProfile_gid :: Lens' PosixProfile Natural
- data ProtocolDetails = ProtocolDetails' {}
- newProtocolDetails :: ProtocolDetails
- protocolDetails_as2Transports :: Lens' ProtocolDetails (Maybe (NonEmpty As2Transport))
- protocolDetails_passiveIp :: Lens' ProtocolDetails (Maybe Text)
- protocolDetails_setStatOption :: Lens' ProtocolDetails (Maybe SetStatOption)
- protocolDetails_tlsSessionResumptionMode :: Lens' ProtocolDetails (Maybe TlsSessionResumptionMode)
- data S3FileLocation = S3FileLocation' {}
- newS3FileLocation :: S3FileLocation
- s3FileLocation_bucket :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_etag :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_key :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_versionId :: Lens' S3FileLocation (Maybe Text)
- data S3InputFileLocation = S3InputFileLocation' {}
- newS3InputFileLocation :: S3InputFileLocation
- s3InputFileLocation_bucket :: Lens' S3InputFileLocation (Maybe Text)
- s3InputFileLocation_key :: Lens' S3InputFileLocation (Maybe Text)
- data S3Tag = S3Tag' {}
- newS3Tag :: Text -> Text -> S3Tag
- s3Tag_key :: Lens' S3Tag Text
- s3Tag_value :: Lens' S3Tag Text
- data ServiceMetadata = ServiceMetadata' {}
- newServiceMetadata :: UserDetails -> ServiceMetadata
- serviceMetadata_userDetails :: Lens' ServiceMetadata UserDetails
- data SshPublicKey = SshPublicKey' {}
- newSshPublicKey :: UTCTime -> Text -> Text -> SshPublicKey
- sshPublicKey_dateImported :: Lens' SshPublicKey UTCTime
- sshPublicKey_sshPublicKeyBody :: Lens' SshPublicKey Text
- sshPublicKey_sshPublicKeyId :: Lens' SshPublicKey Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TagStepDetails = TagStepDetails' {}
- newTagStepDetails :: TagStepDetails
- tagStepDetails_name :: Lens' TagStepDetails (Maybe Text)
- tagStepDetails_sourceFileLocation :: Lens' TagStepDetails (Maybe Text)
- tagStepDetails_tags :: Lens' TagStepDetails (Maybe (NonEmpty S3Tag))
- data UserDetails = UserDetails' {}
- newUserDetails :: Text -> Text -> UserDetails
- userDetails_sessionId :: Lens' UserDetails (Maybe Text)
- userDetails_userName :: Lens' UserDetails Text
- userDetails_serverId :: Lens' UserDetails Text
- data WorkflowDetail = WorkflowDetail' {
- workflowId :: Text
- executionRole :: Text
- newWorkflowDetail :: Text -> Text -> WorkflowDetail
- workflowDetail_workflowId :: Lens' WorkflowDetail Text
- workflowDetail_executionRole :: Lens' WorkflowDetail Text
- data WorkflowDetails = WorkflowDetails' {}
- newWorkflowDetails :: WorkflowDetails
- workflowDetails_onPartialUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail])
- workflowDetails_onUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail])
- data WorkflowStep = WorkflowStep' {}
- newWorkflowStep :: WorkflowStep
- workflowStep_copyStepDetails :: Lens' WorkflowStep (Maybe CopyStepDetails)
- workflowStep_customStepDetails :: Lens' WorkflowStep (Maybe CustomStepDetails)
- workflowStep_decryptStepDetails :: Lens' WorkflowStep (Maybe DecryptStepDetails)
- workflowStep_deleteStepDetails :: Lens' WorkflowStep (Maybe DeleteStepDetails)
- workflowStep_tagStepDetails :: Lens' WorkflowStep (Maybe TagStepDetails)
- workflowStep_type :: Lens' WorkflowStep (Maybe WorkflowStepType)
Service Configuration
defaultService :: Service Source #
API version 2018-11-05 of the Amazon Transfer Family SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold 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.
_InternalServiceError :: AsError a => Fold a ServiceError Source #
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The NextToken parameter that was passed is invalid.
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the client submits a malformed request.
_ResourceExistsException :: AsError a => Fold a ServiceError Source #
The requested resource does not exist.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
AgreementStatusType
newtype AgreementStatusType Source #
Constructors
| AgreementStatusType' | |
Fields | |
Bundled Patterns
| pattern AgreementStatusType_ACTIVE :: AgreementStatusType | |
| pattern AgreementStatusType_INACTIVE :: AgreementStatusType |
Instances
As2Transport
newtype As2Transport Source #
Constructors
| As2Transport' | |
Fields | |
Bundled Patterns
| pattern As2Transport_HTTP :: As2Transport |
Instances
CertificateStatusType
newtype CertificateStatusType Source #
Constructors
| CertificateStatusType' | |
Fields | |
Bundled Patterns
| pattern CertificateStatusType_ACTIVE :: CertificateStatusType | |
| pattern CertificateStatusType_INACTIVE :: CertificateStatusType | |
| pattern CertificateStatusType_PENDING_ROTATION :: CertificateStatusType |
Instances
CertificateType
newtype CertificateType Source #
Constructors
| CertificateType' | |
Fields | |
Bundled Patterns
| pattern CertificateType_CERTIFICATE :: CertificateType | |
| pattern CertificateType_CERTIFICATE_WITH_PRIVATE_KEY :: CertificateType |
Instances
CertificateUsageType
newtype CertificateUsageType Source #
Constructors
| CertificateUsageType' | |
Fields | |
Bundled Patterns
| pattern CertificateUsageType_ENCRYPTION :: CertificateUsageType | |
| pattern CertificateUsageType_SIGNING :: CertificateUsageType |
Instances
CompressionEnum
newtype CompressionEnum Source #
Constructors
| CompressionEnum' | |
Fields | |
Bundled Patterns
| pattern CompressionEnum_DISABLED :: CompressionEnum | |
| pattern CompressionEnum_ZLIB :: CompressionEnum |
Instances
CustomStepStatus
newtype CustomStepStatus Source #
Constructors
| CustomStepStatus' | |
Fields | |
Bundled Patterns
| pattern CustomStepStatus_FAILURE :: CustomStepStatus | |
| pattern CustomStepStatus_SUCCESS :: CustomStepStatus |
Instances
Domain
Constructors
| Domain' | |
Fields
| |
Bundled Patterns
| pattern Domain_EFS :: Domain | |
| pattern Domain_S3 :: Domain |
Instances
EncryptionAlg
newtype EncryptionAlg Source #
Constructors
| EncryptionAlg' | |
Fields | |
Bundled Patterns
| pattern EncryptionAlg_AES128_CBC :: EncryptionAlg | |
| pattern EncryptionAlg_AES192_CBC :: EncryptionAlg | |
| pattern EncryptionAlg_AES256_CBC :: EncryptionAlg | |
| pattern EncryptionAlg_NONE :: EncryptionAlg |
Instances
EncryptionType
newtype EncryptionType Source #
Constructors
| EncryptionType' | |
Fields | |
Bundled Patterns
| pattern EncryptionType_PGP :: EncryptionType |
Instances
EndpointType
newtype EndpointType Source #
Constructors
| EndpointType' | |
Fields | |
Bundled Patterns
| pattern EndpointType_PUBLIC :: EndpointType | |
| pattern EndpointType_VPC :: EndpointType | |
| pattern EndpointType_VPC_ENDPOINT :: EndpointType |
Instances
ExecutionErrorType
newtype ExecutionErrorType Source #
Constructors
| ExecutionErrorType' | |
Fields | |
Bundled Patterns
| pattern ExecutionErrorType_ALREADY_EXISTS :: ExecutionErrorType | |
| pattern ExecutionErrorType_BAD_REQUEST :: ExecutionErrorType | |
| pattern ExecutionErrorType_CUSTOM_STEP_FAILED :: ExecutionErrorType | |
| pattern ExecutionErrorType_INTERNAL_SERVER_ERROR :: ExecutionErrorType | |
| pattern ExecutionErrorType_NOT_FOUND :: ExecutionErrorType | |
| pattern ExecutionErrorType_PERMISSION_DENIED :: ExecutionErrorType | |
| pattern ExecutionErrorType_THROTTLED :: ExecutionErrorType | |
| pattern ExecutionErrorType_TIMEOUT :: ExecutionErrorType |
Instances
ExecutionStatus
newtype ExecutionStatus Source #
Constructors
| ExecutionStatus' | |
Fields | |
Bundled Patterns
| pattern ExecutionStatus_COMPLETED :: ExecutionStatus | |
| pattern ExecutionStatus_EXCEPTION :: ExecutionStatus | |
| pattern ExecutionStatus_HANDLING_EXCEPTION :: ExecutionStatus | |
| pattern ExecutionStatus_IN_PROGRESS :: ExecutionStatus |
Instances
HomeDirectoryType
newtype HomeDirectoryType Source #
Constructors
| HomeDirectoryType' | |
Fields | |
Bundled Patterns
| pattern HomeDirectoryType_LOGICAL :: HomeDirectoryType | |
| pattern HomeDirectoryType_PATH :: HomeDirectoryType |
Instances
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 | |
Bundled Patterns
Instances
MdnResponse
newtype MdnResponse Source #
Constructors
| MdnResponse' | |
Fields | |
Bundled Patterns
| pattern MdnResponse_NONE :: MdnResponse | |
| pattern MdnResponse_SYNC :: MdnResponse |
Instances
MdnSigningAlg
newtype MdnSigningAlg Source #
Constructors
| MdnSigningAlg' | |
Fields | |
Bundled Patterns
| pattern MdnSigningAlg_DEFAULT :: MdnSigningAlg | |
| pattern MdnSigningAlg_NONE :: MdnSigningAlg | |
| pattern MdnSigningAlg_SHA1 :: MdnSigningAlg | |
| pattern MdnSigningAlg_SHA256 :: MdnSigningAlg | |
| pattern MdnSigningAlg_SHA384 :: MdnSigningAlg | |
| pattern MdnSigningAlg_SHA512 :: MdnSigningAlg |
Instances
OverwriteExisting
newtype OverwriteExisting Source #
Constructors
| OverwriteExisting' | |
Fields | |
Bundled Patterns
| pattern OverwriteExisting_FALSE :: OverwriteExisting | |
| pattern OverwriteExisting_TRUE :: OverwriteExisting |
Instances
ProfileType
newtype ProfileType Source #
Constructors
| ProfileType' | |
Fields | |
Bundled Patterns
| pattern ProfileType_LOCAL :: ProfileType | |
| pattern ProfileType_PARTNER :: ProfileType |
Instances
Protocol
Constructors
| Protocol' | |
Fields
| |
Bundled Patterns
| pattern Protocol_AS2 :: Protocol | |
| pattern Protocol_FTP :: Protocol | |
| pattern Protocol_FTPS :: Protocol | |
| pattern Protocol_SFTP :: Protocol |
Instances
SetStatOption
newtype SetStatOption Source #
Constructors
| SetStatOption' | |
Fields | |
Bundled Patterns
| pattern SetStatOption_DEFAULT :: SetStatOption | |
| pattern SetStatOption_ENABLE_NO_OP :: SetStatOption |
Instances
SigningAlg
newtype SigningAlg Source #
Constructors
| SigningAlg' | |
Fields | |
Bundled Patterns
| pattern SigningAlg_NONE :: SigningAlg | |
| pattern SigningAlg_SHA1 :: SigningAlg | |
| pattern SigningAlg_SHA256 :: SigningAlg | |
| pattern SigningAlg_SHA384 :: SigningAlg | |
| pattern SigningAlg_SHA512 :: SigningAlg |
Instances
State
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.
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
TlsSessionResumptionMode
newtype TlsSessionResumptionMode Source #
Constructors
| TlsSessionResumptionMode' | |
Fields | |
Bundled Patterns
Instances
WorkflowStepType
newtype WorkflowStepType Source #
Constructors
| WorkflowStepType' | |
Fields | |
Bundled Patterns
| pattern WorkflowStepType_COPY :: WorkflowStepType | |
| pattern WorkflowStepType_CUSTOM :: WorkflowStepType | |
| pattern WorkflowStepType_DECRYPT :: WorkflowStepType | |
| pattern WorkflowStepType_DELETE :: WorkflowStepType | |
| pattern WorkflowStepType_TAG :: WorkflowStepType |
Instances
As2ConnectorConfig
data As2ConnectorConfig Source #
Contains the details for a connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.
See: newAs2ConnectorConfig smart constructor.
Constructors
| As2ConnectorConfig' | |
Fields
| |
Instances
newAs2ConnectorConfig :: As2ConnectorConfig Source #
Create a value of As2ConnectorConfig 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:compression:As2ConnectorConfig', as2ConnectorConfig_compression - Specifies whether the AS2 file is compressed.
$sel:encryptionAlgorithm:As2ConnectorConfig', as2ConnectorConfig_encryptionAlgorithm - The algorithm that is used to encrypt the file.
$sel:localProfileId:As2ConnectorConfig', as2ConnectorConfig_localProfileId - A unique identifier for the AS2 local profile.
$sel:mdnResponse:As2ConnectorConfig', as2ConnectorConfig_mdnResponse - Used for outbound requests (from an Transfer Family server to a partner
AS2 server) to determine whether the partner response for transfers is
synchronous or asynchronous. Specify either of the following values:
SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).NONE: Specifies that no MDN response is required.
$sel:mdnSigningAlgorithm:As2ConnectorConfig', as2ConnectorConfig_mdnSigningAlgorithm - The signing algorithm for the MDN response.
If set to DEFAULT (or not set at all), the value for SigningAlogorithm
is used.
$sel:messageSubject:As2ConnectorConfig', as2ConnectorConfig_messageSubject - Used as the Subject HTTP header attribute in AS2 messages that are
being sent with the connector.
$sel:partnerProfileId:As2ConnectorConfig', as2ConnectorConfig_partnerProfileId - A unique identifier for the partner profile for the connector.
$sel:signingAlgorithm:As2ConnectorConfig', as2ConnectorConfig_signingAlgorithm - The algorithm that is used to sign the AS2 messages sent with the
connector.
as2ConnectorConfig_compression :: Lens' As2ConnectorConfig (Maybe CompressionEnum) Source #
Specifies whether the AS2 file is compressed.
as2ConnectorConfig_encryptionAlgorithm :: Lens' As2ConnectorConfig (Maybe EncryptionAlg) Source #
The algorithm that is used to encrypt the file.
as2ConnectorConfig_localProfileId :: Lens' As2ConnectorConfig (Maybe Text) Source #
A unique identifier for the AS2 local profile.
as2ConnectorConfig_mdnResponse :: Lens' As2ConnectorConfig (Maybe MdnResponse) Source #
Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:
SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).NONE: Specifies that no MDN response is required.
as2ConnectorConfig_mdnSigningAlgorithm :: Lens' As2ConnectorConfig (Maybe MdnSigningAlg) Source #
The signing algorithm for the MDN response.
If set to DEFAULT (or not set at all), the value for SigningAlogorithm
is used.
as2ConnectorConfig_messageSubject :: Lens' As2ConnectorConfig (Maybe Text) Source #
Used as the Subject HTTP header attribute in AS2 messages that are
being sent with the connector.
as2ConnectorConfig_partnerProfileId :: Lens' As2ConnectorConfig (Maybe Text) Source #
A unique identifier for the partner profile for the connector.
as2ConnectorConfig_signingAlgorithm :: Lens' As2ConnectorConfig (Maybe SigningAlg) Source #
The algorithm that is used to sign the AS2 messages sent with the connector.
CopyStepDetails
data CopyStepDetails Source #
Each step type has its own StepDetails structure.
See: newCopyStepDetails smart constructor.
Constructors
| CopyStepDetails' | |
Fields
| |
Instances
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 - Specifies the location for the file being copied. Only applicable for
Copy type workflow steps. Use ${Transfer:username} in this field to
parametrize the destination prefix by username.
$sel:name:CopyStepDetails', copyStepDetails_name - The name of the step, used as an identifier.
$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:sourceFileLocation:CopyStepDetails', copyStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the
output from the previous step, or the originally uploaded file for the
workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation) Source #
Specifies the location for the file being copied. Only applicable for
Copy type workflow steps. Use ${Transfer:username} in this field to
parametrize the destination prefix by username.
copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting) Source #
A flag that indicates whether or not to overwrite an existing file of
the same name. The default is FALSE.
copyStepDetails_sourceFileLocation :: Lens' CopyStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
CustomStepDetails
data CustomStepDetails Source #
Each step type has its own StepDetails structure.
See: newCustomStepDetails smart constructor.
Constructors
| CustomStepDetails' | |
Fields
| |
Instances
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:sourceFileLocation:CustomStepDetails', customStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the
output from the previous step, or the originally uploaded file for the
workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
$sel:target:CustomStepDetails', customStepDetails_target - The ARN for the lambda function that is being called.
$sel:timeoutSeconds:CustomStepDetails', customStepDetails_timeoutSeconds - Timeout, in seconds, for the step.
customStepDetails_name :: Lens' CustomStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
customStepDetails_sourceFileLocation :: Lens' CustomStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
customStepDetails_target :: Lens' CustomStepDetails (Maybe Text) Source #
The ARN for the lambda function that is being called.
customStepDetails_timeoutSeconds :: Lens' CustomStepDetails (Maybe Natural) Source #
Timeout, in seconds, for the step.
DecryptStepDetails
data DecryptStepDetails Source #
See: newDecryptStepDetails smart constructor.
Constructors
| DecryptStepDetails' | |
Instances
newDecryptStepDetails Source #
Arguments
| :: EncryptionType | |
| -> InputFileLocation | |
| -> DecryptStepDetails |
Create a value of DecryptStepDetails 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:DecryptStepDetails', decryptStepDetails_name - Undocumented member.
$sel:overwriteExisting:DecryptStepDetails', decryptStepDetails_overwriteExisting - Undocumented member.
$sel:sourceFileLocation:DecryptStepDetails', decryptStepDetails_sourceFileLocation - Undocumented member.
$sel:type':DecryptStepDetails', decryptStepDetails_type - Undocumented member.
$sel:destinationFileLocation:DecryptStepDetails', decryptStepDetails_destinationFileLocation - Undocumented member.
decryptStepDetails_name :: Lens' DecryptStepDetails (Maybe Text) Source #
Undocumented member.
decryptStepDetails_overwriteExisting :: Lens' DecryptStepDetails (Maybe OverwriteExisting) Source #
Undocumented member.
decryptStepDetails_sourceFileLocation :: Lens' DecryptStepDetails (Maybe Text) Source #
Undocumented member.
decryptStepDetails_type :: Lens' DecryptStepDetails EncryptionType Source #
Undocumented member.
decryptStepDetails_destinationFileLocation :: Lens' DecryptStepDetails InputFileLocation Source #
Undocumented member.
DeleteStepDetails
data DeleteStepDetails Source #
The name of the step, used to identify the delete step.
See: newDeleteStepDetails smart constructor.
Constructors
| DeleteStepDetails' | |
Fields
| |
Instances
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.
$sel:sourceFileLocation:DeleteStepDetails', deleteStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the
output from the previous step, or the originally uploaded file for the
workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
deleteStepDetails_name :: Lens' DeleteStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
deleteStepDetails_sourceFileLocation :: Lens' DeleteStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
DescribedAccess
data DescribedAccess Source #
Describes the properties of the access that was specified.
See: newDescribedAccess smart constructor.
Constructors
| DescribedAccess' | |
Fields
| |
Instances
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: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
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 regular expression 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.
$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 Identity and Access
Management (IAM) role provides access to paths in Target. This value
can be set only 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:homeDirectoryType:DescribedAccess', describedAccess_homeDirectoryType - The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
$sel:policy:DescribedAccess', describedAccess_policy - A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's 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:posixProfile:DescribedAccess', describedAccess_posixProfile - Undocumented member.
$sel:role':DescribedAccess', describedAccess_role - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that controls your users' access to your Amazon S3 bucket or
Amazon 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 Amazon 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.
describedAccess_externalId :: Lens' DescribedAccess (Maybe Text) Source #
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 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 regular expression 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: =,.@:/-
describedAccess_homeDirectory :: Lens' DescribedAccess (Maybe Text) Source #
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.
describedAccess_homeDirectoryMappings :: Lens' DescribedAccess (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
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 Identity and Access
Management (IAM) role provides access to paths in Target. This value
can be set only 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.
describedAccess_homeDirectoryType :: Lens' DescribedAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
describedAccess_policy :: Lens' DescribedAccess (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName},
${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile) Source #
Undocumented member.
describedAccess_role :: Lens' DescribedAccess (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.
DescribedAgreement
data DescribedAgreement Source #
Describes the properties of an agreement.
See: newDescribedAgreement smart constructor.
Constructors
| DescribedAgreement' | |
Fields
| |
Instances
newDescribedAgreement Source #
Arguments
| :: Text | |
| -> DescribedAgreement |
Create a value of DescribedAgreement 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:accessRole:DescribedAgreement', describedAgreement_accessRole - With AS2, you can send files by calling StartFileTransfer and
specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt, parent directory is
/bucket/dir/) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer.
$sel:agreementId:DescribedAgreement', describedAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when
you create an agreement.
$sel:baseDirectory:DescribedAgreement', describedAgreement_baseDirectory - The landing directory (folder) for files that are transferred by using
the AS2 protocol.
$sel:description:DescribedAgreement', describedAgreement_description - The name or short description that's used to identify the agreement.
$sel:localProfileId:DescribedAgreement', describedAgreement_localProfileId - A unique identifier for the AS2 local profile.
$sel:partnerProfileId:DescribedAgreement', describedAgreement_partnerProfileId - A unique identifier for the partner profile used in the agreement.
$sel:serverId:DescribedAgreement', describedAgreement_serverId - A system-assigned unique identifier for a server instance. This
identifier indicates the specific server that the agreement uses.
$sel:status:DescribedAgreement', describedAgreement_status - The current status of the agreement, either ACTIVE or INACTIVE.
$sel:tags:DescribedAgreement', describedAgreement_tags - Key-value pairs that can be used to group and search for agreements.
$sel:arn:DescribedAgreement', describedAgreement_arn - The unique Amazon Resource Name (ARN) for the agreement.
describedAgreement_accessRole :: Lens' DescribedAgreement (Maybe Text) Source #
With AS2, you can send files by calling StartFileTransfer and
specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt, parent directory is
/bucket/dir/) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer.
describedAgreement_agreementId :: Lens' DescribedAgreement (Maybe Text) Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
describedAgreement_baseDirectory :: Lens' DescribedAgreement (Maybe Text) Source #
The landing directory (folder) for files that are transferred by using the AS2 protocol.
describedAgreement_description :: Lens' DescribedAgreement (Maybe Text) Source #
The name or short description that's used to identify the agreement.
describedAgreement_localProfileId :: Lens' DescribedAgreement (Maybe Text) Source #
A unique identifier for the AS2 local profile.
describedAgreement_partnerProfileId :: Lens' DescribedAgreement (Maybe Text) Source #
A unique identifier for the partner profile used in the agreement.
describedAgreement_serverId :: Lens' DescribedAgreement (Maybe Text) Source #
A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.
describedAgreement_status :: Lens' DescribedAgreement (Maybe AgreementStatusType) Source #
The current status of the agreement, either ACTIVE or INACTIVE.
describedAgreement_tags :: Lens' DescribedAgreement (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for agreements.
describedAgreement_arn :: Lens' DescribedAgreement Text Source #
The unique Amazon Resource Name (ARN) for the agreement.
DescribedCertificate
data DescribedCertificate Source #
Describes the properties of a certificate.
See: newDescribedCertificate smart constructor.
Constructors
| DescribedCertificate' | |
Fields
| |
Instances
newDescribedCertificate Source #
Arguments
| :: Text | |
| -> DescribedCertificate |
Create a value of DescribedCertificate 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:activeDate:DescribedCertificate', describedCertificate_activeDate - An optional date that specifies when the certificate becomes active.
$sel:certificate:DescribedCertificate', describedCertificate_certificate - The file name for the certificate.
$sel:certificateChain:DescribedCertificate', describedCertificate_certificateChain - The list of certificates that make up the chain for the certificate.
$sel:certificateId:DescribedCertificate', describedCertificate_certificateId - An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
$sel:description:DescribedCertificate', describedCertificate_description - The name or description that's used to identity the certificate.
$sel:inactiveDate:DescribedCertificate', describedCertificate_inactiveDate - An optional date that specifies when the certificate becomes inactive.
$sel:notAfterDate:DescribedCertificate', describedCertificate_notAfterDate - The final date that the certificate is valid.
$sel:notBeforeDate:DescribedCertificate', describedCertificate_notBeforeDate - The earliest date that the certificate is valid.
$sel:serial:DescribedCertificate', describedCertificate_serial - The serial number for the certificate.
$sel:status:DescribedCertificate', describedCertificate_status - The certificate can be either ACTIVE, PENDING_ROTATION, or
INACTIVE. PENDING_ROTATION means that this certificate will replace
the current certificate when it expires.
$sel:tags:DescribedCertificate', describedCertificate_tags - Key-value pairs that can be used to group and search for certificates.
$sel:type':DescribedCertificate', describedCertificate_type - If a private key has been specified for the certificate, its type is
CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is
CERTIFICATE.
$sel:usage:DescribedCertificate', describedCertificate_usage - Specifies whether this certificate is used for signing or encryption.
$sel:arn:DescribedCertificate', describedCertificate_arn - The unique Amazon Resource Name (ARN) for the certificate.
describedCertificate_activeDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes active.
describedCertificate_certificate :: Lens' DescribedCertificate (Maybe Text) Source #
The file name for the certificate.
describedCertificate_certificateChain :: Lens' DescribedCertificate (Maybe Text) Source #
The list of certificates that make up the chain for the certificate.
describedCertificate_certificateId :: Lens' DescribedCertificate (Maybe Text) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
describedCertificate_description :: Lens' DescribedCertificate (Maybe Text) Source #
The name or description that's used to identity the certificate.
describedCertificate_inactiveDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes inactive.
describedCertificate_notAfterDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
The final date that the certificate is valid.
describedCertificate_notBeforeDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
The earliest date that the certificate is valid.
describedCertificate_serial :: Lens' DescribedCertificate (Maybe Text) Source #
The serial number for the certificate.
describedCertificate_status :: Lens' DescribedCertificate (Maybe CertificateStatusType) Source #
The certificate can be either ACTIVE, PENDING_ROTATION, or
INACTIVE. PENDING_ROTATION means that this certificate will replace
the current certificate when it expires.
describedCertificate_tags :: Lens' DescribedCertificate (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for certificates.
describedCertificate_type :: Lens' DescribedCertificate (Maybe CertificateType) Source #
If a private key has been specified for the certificate, its type is
CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is
CERTIFICATE.
describedCertificate_usage :: Lens' DescribedCertificate (Maybe CertificateUsageType) Source #
Specifies whether this certificate is used for signing or encryption.
describedCertificate_arn :: Lens' DescribedCertificate Text Source #
The unique Amazon Resource Name (ARN) for the certificate.
DescribedConnector
data DescribedConnector Source #
Describes the parameters for the connector, as identified by the
ConnectorId.
See: newDescribedConnector smart constructor.
Constructors
| DescribedConnector' | |
Fields
| |
Instances
newDescribedConnector Source #
Arguments
| :: Text | |
| -> DescribedConnector |
Create a value of DescribedConnector 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:accessRole:DescribedConnector', describedConnector_accessRole - With AS2, you can send files by calling StartFileTransfer and
specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt, parent directory is
/bucket/dir/) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer.
$sel:as2Config:DescribedConnector', describedConnector_as2Config - A structure that contains the parameters for a connector object.
$sel:connectorId:DescribedConnector', describedConnector_connectorId - The unique identifier for the connector.
$sel:loggingRole:DescribedConnector', describedConnector_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a connector to turn on CloudWatch logging for
Amazon S3 events. When set, you can view connector activity in your
CloudWatch logs.
$sel:tags:DescribedConnector', describedConnector_tags - Key-value pairs that can be used to group and search for connectors.
$sel:url:DescribedConnector', describedConnector_url - The URL of the partner's AS2 endpoint.
$sel:arn:DescribedConnector', describedConnector_arn - The unique Amazon Resource Name (ARN) for the connector.
describedConnector_accessRole :: Lens' DescribedConnector (Maybe Text) Source #
With AS2, you can send files by calling StartFileTransfer and
specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt, parent directory is
/bucket/dir/) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer.
describedConnector_as2Config :: Lens' DescribedConnector (Maybe As2ConnectorConfig) Source #
A structure that contains the parameters for a connector object.
describedConnector_connectorId :: Lens' DescribedConnector (Maybe Text) Source #
The unique identifier for the connector.
describedConnector_loggingRole :: Lens' DescribedConnector (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
describedConnector_tags :: Lens' DescribedConnector (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for connectors.
describedConnector_url :: Lens' DescribedConnector (Maybe Text) Source #
The URL of the partner's AS2 endpoint.
describedConnector_arn :: Lens' DescribedConnector Text Source #
The unique Amazon Resource Name (ARN) for the connector.
DescribedExecution
data DescribedExecution Source #
The details for an execution object.
See: newDescribedExecution smart constructor.
Constructors
| DescribedExecution' | |
Fields
| |
Instances
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:executionId:DescribedExecution', describedExecution_executionId - A unique identifier for the execution of a workflow.
$sel:executionRole:DescribedExecution', describedExecution_executionRole - The IAM role associated with the execution.
$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:loggingConfiguration:DescribedExecution', describedExecution_loggingConfiguration - The IAM logging role associated with the execution.
$sel:posixProfile:DescribedExecution', describedExecution_posixProfile - Undocumented member.
$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:serviceMetadata:DescribedExecution', describedExecution_serviceMetadata - A container object for the session details that are associated with a
workflow.
$sel:status:DescribedExecution', describedExecution_status - The status is one of the execution. Can be in progress, completed,
exception encountered, or handling the exception.
describedExecution_executionId :: Lens' DescribedExecution (Maybe Text) Source #
A unique identifier for the execution of a workflow.
describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text) Source #
The IAM role associated with the execution.
describedExecution_initialFileLocation :: Lens' DescribedExecution (Maybe FileLocation) Source #
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.
describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration) Source #
The IAM logging role associated with the execution.
describedExecution_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile) Source #
Undocumented member.
describedExecution_results :: Lens' DescribedExecution (Maybe ExecutionResults) Source #
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.
describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata) Source #
A container object for the session details that are associated with a workflow.
describedExecution_status :: Lens' DescribedExecution (Maybe ExecutionStatus) Source #
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
DescribedHostKey
data DescribedHostKey Source #
The details for a server host key.
See: newDescribedHostKey smart constructor.
Constructors
| DescribedHostKey' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribedHostKey |
Create a value of DescribedHostKey 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:DescribedHostKey', describedHostKey_dateImported - The date on which the host key was added to the server.
$sel:description:DescribedHostKey', describedHostKey_description - The text description for this host key.
$sel:hostKeyFingerprint:DescribedHostKey', describedHostKey_hostKeyFingerprint - The public key fingerprint, which is a short sequence of bytes used to
identify the longer public key.
$sel:hostKeyId:DescribedHostKey', describedHostKey_hostKeyId - A unique identifier for the host key.
$sel:tags:DescribedHostKey', describedHostKey_tags - Key-value pairs that can be used to group and search for host keys.
$sel:type':DescribedHostKey', describedHostKey_type - The encryption algorithm that is used for the host key. The Type
parameter is specified by using one of the following values:
ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
$sel:arn:DescribedHostKey', describedHostKey_arn - The unique Amazon Resource Name (ARN) for the host key.
describedHostKey_dateImported :: Lens' DescribedHostKey (Maybe UTCTime) Source #
The date on which the host key was added to the server.
describedHostKey_description :: Lens' DescribedHostKey (Maybe Text) Source #
The text description for this host key.
describedHostKey_hostKeyFingerprint :: Lens' DescribedHostKey (Maybe Text) Source #
The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
describedHostKey_hostKeyId :: Lens' DescribedHostKey (Maybe Text) Source #
A unique identifier for the host key.
describedHostKey_tags :: Lens' DescribedHostKey (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for host keys.
describedHostKey_type :: Lens' DescribedHostKey (Maybe Text) Source #
The encryption algorithm that is used for the host key. The Type
parameter is specified by using one of the following values:
ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
describedHostKey_arn :: Lens' DescribedHostKey Text Source #
The unique Amazon Resource Name (ARN) for the host key.
DescribedProfile
data DescribedProfile Source #
The details for a local or partner AS2 profile.
See: newDescribedProfile smart constructor.
Constructors
| DescribedProfile' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribedProfile |
Create a value of DescribedProfile 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:as2Id:DescribedProfile', describedProfile_as2Id - The As2Id is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To header for
the AS2 messages sent to the partner using the StartFileTransfer API
operation. This ID cannot include spaces.
$sel:certificateIds:DescribedProfile', describedProfile_certificateIds - An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
$sel:profileId:DescribedProfile', describedProfile_profileId - A unique identifier for the local or partner AS2 profile.
$sel:profileType:DescribedProfile', describedProfile_profileType - Indicates whether to list only LOCAL type profiles or only PARTNER
type profiles. If not supplied in the request, the command lists all
types of profiles.
$sel:tags:DescribedProfile', describedProfile_tags - Key-value pairs that can be used to group and search for profiles.
$sel:arn:DescribedProfile', describedProfile_arn - The unique Amazon Resource Name (ARN) for the profile.
describedProfile_as2Id :: Lens' DescribedProfile (Maybe Text) Source #
The As2Id is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To header for
the AS2 messages sent to the partner using the StartFileTransfer API
operation. This ID cannot include spaces.
describedProfile_certificateIds :: Lens' DescribedProfile (Maybe [Text]) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
describedProfile_profileId :: Lens' DescribedProfile (Maybe Text) Source #
A unique identifier for the local or partner AS2 profile.
describedProfile_profileType :: Lens' DescribedProfile (Maybe ProfileType) Source #
Indicates whether to list only LOCAL type profiles or only PARTNER
type profiles. If not supplied in the request, the command lists all
types of profiles.
describedProfile_tags :: Lens' DescribedProfile (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for profiles.
describedProfile_arn :: Lens' DescribedProfile Text Source #
The unique Amazon Resource Name (ARN) for the profile.
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' | |
Fields
| |
Instances
newDescribedSecurityPolicy Source #
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:sshCiphers:DescribedSecurityPolicy', describedSecurityPolicy_sshCiphers - Specifies the enabled Secure Shell (SSH) cipher 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: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: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:securityPolicyName:DescribedSecurityPolicy', describedSecurityPolicy_securityPolicyName - Specifies the name of the security policy that is attached to the
server.
describedSecurityPolicy_fips :: Lens' DescribedSecurityPolicy (Maybe Bool) Source #
Specifies whether this policy enables Federal Information Processing Standards (FIPS).
describedSecurityPolicy_sshCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_sshKexs :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_sshMacs :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_tlsCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_securityPolicyName :: Lens' DescribedSecurityPolicy Text Source #
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' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:certificate:DescribedServer', describedServer_certificate - Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM)
certificate. Required when Protocols is set to FTPS.
$sel:domain:DescribedServer', describedServer_domain - Specifies the domain of the storage system that is used for file
transfers.
$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 your endpoint accessible only to resources within your VPC, or you
can attach Elastic IP addresses and make your endpoint accessible to
clients over the internet. Your VPC's default security groups are
automatically assigned to your endpoint.
$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: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: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:identityProviderType:DescribedServer', describedServer_identityProviderType - The mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Directory Service for Microsoft Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connector. This option also requires you to provide a Directory
ID by 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
Amazon API Gateway endpoint URL to call for authentication by using the
IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use an Lambda function as your
identity provider. If you choose this value, you must specify the ARN
for the Lambda function in the Function parameter or the
IdentityProviderDetails data type.
$sel:loggingRole:DescribedServer', describedServer_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a server to turn on Amazon CloudWatch logging for
Amazon S3 or Amazon EFSevents. When set, you can view user activity in
your CloudWatch logs.
$sel:postAuthenticationLoginBanner:DescribedServer', describedServer_postAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This
string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
$sel:preAuthenticationLoginBanner:DescribedServer', describedServer_preAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This
string is displayed before the user authenticates. For example, the
following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
$sel:protocolDetails:DescribedServer', describedServer_protocolDetails - The protocol settings that are configured for your server.
- To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIpparameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - To ignore the error that is generated when the client attempts to
use the
SETSTATcommand on a file that you are uploading to an Amazon S3 bucket, use theSetStatOptionparameter. To have the Transfer Family server ignore theSETSTATcommand and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP. If you set theSetStatOptionparameter toENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTATcall. - To determine whether your Transfer Family server resumes recent,
negotiated sessions through a unique session ID, use the
TlsSessionResumptionModeparameter. As2Transportsindicates the transport method for the AS2 messages. Currently, only HTTP is supported.
$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 SSHFTPS(File Transfer Protocol Secure): File transfer with TLS encryptionFTP(File Transfer Protocol): Unencrypted file transferAS2(Applicability Statement 2): used for transporting structured business-to-business data- If you select
FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust beAWS_DIRECTORY_SERVICEorAPI_GATEWAY. - If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated. - If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set toSERVICE_MANAGED. - If
ProtocolincludesAS2, then theEndpointTypemust beVPC, and domain must be Amazon S3.
$sel:securityPolicyName:DescribedServer', describedServer_securityPolicyName - Specifies the name of the security policy that is attached to the
server.
$sel:serverId:DescribedServer', describedServer_serverId - Specifies the unique system-assigned identifier for a server that you
instantiate.
$sel:state:DescribedServer', describedServer_state - The condition of 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: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:userCount:DescribedServer', describedServer_userCount - Specifies the number of users that are assigned to a server you
specified with the ServerId.
$sel:workflowDetails:DescribedServer', describedServer_workflowDetails - Specifies the workflow ID for the workflow to assign and the execution
role that's used for executing the workflow.
In additon to a workflow to execute when a file is uploaded completely,
WorkflowDeatails can also contain a workflow ID (and execution role)
for a workflow to execute on partial upload. A partial upload occurs
when a file is open when the session disconnects.
$sel:arn:DescribedServer', describedServer_arn - Specifies the unique Amazon Resource Name (ARN) of the server.
describedServer_certificate :: Lens' DescribedServer (Maybe Text) Source #
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM)
certificate. Required when Protocols is set to FTPS.
describedServer_domain :: Lens' DescribedServer (Maybe Domain) Source #
Specifies the domain of the storage system that is used for file transfers.
describedServer_endpointDetails :: Lens' DescribedServer (Maybe EndpointDetails) Source #
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
describedServer_endpointType :: Lens' DescribedServer (Maybe EndpointType) Source #
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.
describedServer_hostKeyFingerprint :: Lens' DescribedServer (Maybe Text) Source #
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.
describedServer_identityProviderDetails :: Lens' DescribedServer (Maybe IdentityProviderDetails) Source #
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.
describedServer_identityProviderType :: Lens' DescribedServer (Maybe IdentityProviderType) Source #
The mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Directory Service for Microsoft Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connector. This option also requires you to provide a Directory
ID by 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
Amazon API Gateway endpoint URL to call for authentication by using the
IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use an Lambda function as your
identity provider. If you choose this value, you must specify the ARN
for the Lambda function in the Function parameter or the
IdentityProviderDetails data type.
describedServer_loggingRole :: Lens' DescribedServer (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
describedServer_postAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
describedServer_preAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
describedServer_protocolDetails :: Lens' DescribedServer (Maybe ProtocolDetails) Source #
The protocol settings that are configured for your server.
- To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIpparameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. - To ignore the error that is generated when the client attempts to
use the
SETSTATcommand on a file that you are uploading to an Amazon S3 bucket, use theSetStatOptionparameter. To have the Transfer Family server ignore theSETSTATcommand and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP. If you set theSetStatOptionparameter toENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTATcall. - To determine whether your Transfer Family server resumes recent,
negotiated sessions through a unique session ID, use the
TlsSessionResumptionModeparameter. As2Transportsindicates the transport method for the AS2 messages. Currently, only HTTP is supported.
describedServer_protocols :: Lens' DescribedServer (Maybe (NonEmpty Protocol)) Source #
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 SSHFTPS(File Transfer Protocol Secure): File transfer with TLS encryptionFTP(File Transfer Protocol): Unencrypted file transferAS2(Applicability Statement 2): used for transporting structured business-to-business data- If you select
FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust beAWS_DIRECTORY_SERVICEorAPI_GATEWAY. - If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated. - If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set toSERVICE_MANAGED. - If
ProtocolincludesAS2, then theEndpointTypemust beVPC, and domain must be Amazon S3.
describedServer_securityPolicyName :: Lens' DescribedServer (Maybe Text) Source #
Specifies the name of the security policy that is attached to the server.
describedServer_serverId :: Lens' DescribedServer (Maybe Text) Source #
Specifies the unique system-assigned identifier for a server that you instantiate.
describedServer_state :: Lens' DescribedServer (Maybe State) Source #
The condition of 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.
describedServer_tags :: Lens' DescribedServer (Maybe (NonEmpty Tag)) Source #
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
describedServer_userCount :: Lens' DescribedServer (Maybe Int) Source #
Specifies the number of users that are assigned to a server you
specified with the ServerId.
describedServer_workflowDetails :: Lens' DescribedServer (Maybe WorkflowDetails) Source #
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In additon to a workflow to execute when a file is uploaded completely,
WorkflowDeatails can also contain a workflow ID (and execution role)
for a workflow to execute on partial upload. A partial upload occurs
when a file is open when the session disconnects.
describedServer_arn :: Lens' DescribedServer Text Source #
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' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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: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: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 Identity and Access
Management (IAM) role provides access to paths in Target. This value
can be set only 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:homeDirectoryType:DescribedUser', describedUser_homeDirectoryType - The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
$sel:policy:DescribedUser', describedUser_policy - A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's 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: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:role':DescribedUser', describedUser_role - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that controls your users' access to your Amazon S3 bucket or
Amazon 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 Amazon 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:sshPublicKeys:DescribedUser', describedUser_sshPublicKeys - Specifies the public key portion of the Secure Shell (SSH) keys stored
for the described user.
$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: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:arn:DescribedUser', describedUser_arn - Specifies the unique Amazon Resource Name (ARN) for the user that was
requested to be described.
describedUser_homeDirectory :: Lens' DescribedUser (Maybe Text) Source #
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.
describedUser_homeDirectoryMappings :: Lens' DescribedUser (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
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 Identity and Access
Management (IAM) role provides access to paths in Target. This value
can be set only 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.
describedUser_homeDirectoryType :: Lens' DescribedUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
describedUser_policy :: Lens' DescribedUser (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName},
${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
describedUser_posixProfile :: Lens' DescribedUser (Maybe PosixProfile) Source #
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.
describedUser_role :: Lens' DescribedUser (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.
describedUser_sshPublicKeys :: Lens' DescribedUser (Maybe [SshPublicKey]) Source #
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
describedUser_tags :: Lens' DescribedUser (Maybe (NonEmpty Tag)) Source #
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
describedUser_userName :: Lens' DescribedUser (Maybe Text) Source #
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.
describedUser_arn :: Lens' DescribedUser Text Source #
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' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:description:DescribedWorkflow', describedWorkflow_description - Specifies the text description for the workflow.
$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: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:workflowId:DescribedWorkflow', describedWorkflow_workflowId - A unique identifier for the workflow.
$sel:arn:DescribedWorkflow', describedWorkflow_arn - Specifies the unique Amazon Resource Name (ARN) for the workflow.
describedWorkflow_description :: Lens' DescribedWorkflow (Maybe Text) Source #
Specifies the text description for the workflow.
describedWorkflow_onExceptionSteps :: Lens' DescribedWorkflow (Maybe [WorkflowStep]) Source #
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
describedWorkflow_steps :: Lens' DescribedWorkflow (Maybe [WorkflowStep]) Source #
Specifies the details for the steps that are in the specified workflow.
describedWorkflow_tags :: Lens' DescribedWorkflow (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
describedWorkflow_workflowId :: Lens' DescribedWorkflow (Maybe Text) Source #
A unique identifier for the workflow.
describedWorkflow_arn :: Lens' DescribedWorkflow Text Source #
Specifies the unique Amazon Resource Name (ARN) for the workflow.
EfsFileLocation
data EfsFileLocation Source #
Reserved for future use.
See: newEfsFileLocation smart constructor.
Constructors
| EfsFileLocation' | |
Instances
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:fileSystemId:EfsFileLocation', efsFileLocation_fileSystemId - The identifier of the file system, assigned by Amazon EFS.
$sel:path:EfsFileLocation', efsFileLocation_path - The pathname for the folder being used by a workflow.
efsFileLocation_fileSystemId :: Lens' EfsFileLocation (Maybe Text) Source #
The identifier of the file system, assigned by Amazon EFS.
efsFileLocation_path :: Lens' EfsFileLocation (Maybe Text) Source #
The pathname for the folder being used by a workflow.
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' | |
Fields
| |
Instances
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: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: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:vpcEndpointId:EndpointDetails', endpointDetails_vpcEndpointId - The identifier 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.
$sel:vpcId:EndpointDetails', endpointDetails_vpcId - The VPC identifier of the VPC in which a server's endpoint will be
hosted.
This property can only be set when EndpointType is set to VPC.
endpointDetails_addressAllocationIds :: Lens' EndpointDetails (Maybe [Text]) Source #
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.
endpointDetails_securityGroupIds :: Lens' EndpointDetails (Maybe [Text]) Source #
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.
endpointDetails_subnetIds :: Lens' EndpointDetails (Maybe [Text]) Source #
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.
endpointDetails_vpcEndpointId :: Lens' EndpointDetails (Maybe Text) Source #
The identifier 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.
endpointDetails_vpcId :: Lens' EndpointDetails (Maybe Text) Source #
The VPC identifier of the VPC in which a server's endpoint will be hosted.
This property can only be set when EndpointType is set to VPC.
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' | |
Fields
| |
Instances
Arguments
| :: ExecutionErrorType | |
| -> Text | |
| -> 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.
ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returnsBAD_REQUEST, as only S3 files can be tagged.CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.TIMEOUT: occurs when the execution times out.You can set the
TimeoutSecondsfor a custom step, anywhere from 1 second to 1800 seconds (30 minutes).THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.
$sel:message:ExecutionError', executionError_message - Specifies the descriptive message that corresponds to the ErrorType.
executionError_type :: Lens' ExecutionError ExecutionErrorType Source #
Specifies the error type.
ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returnsBAD_REQUEST, as only S3 files can be tagged.CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.TIMEOUT: occurs when the execution times out.You can set the
TimeoutSecondsfor a custom step, anywhere from 1 second to 1800 seconds (30 minutes).THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.
executionError_message :: Lens' ExecutionError Text Source #
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' | |
Fields
| |
Instances
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.
executionResults_onExceptionSteps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult)) Source #
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
executionResults_steps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult)) Source #
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' | |
Fields
| |
Instances
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:error:ExecutionStepResult', executionStepResult_error - Specifies the details for an error, if it occurred during execution of
the specified workflow 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.
$sel:stepType:ExecutionStepResult', executionStepResult_stepType - One of the available step types.
- COPY: Copy the file to another location.
- CUSTOM: Perform a custom step with an Lambda function target.
- DELETE: Delete the file.
- TAG: Add a tag to the file.
executionStepResult_error :: Lens' ExecutionStepResult (Maybe ExecutionError) Source #
Specifies the details for an error, if it occurred during execution of the specified workflow step.
executionStepResult_outputs :: Lens' ExecutionStepResult (Maybe Text) Source #
The values for the key/value pair applied as a tag to the file. Only
applicable if the step type is TAG.
executionStepResult_stepType :: Lens' ExecutionStepResult (Maybe WorkflowStepType) Source #
One of the available step types.
- COPY: Copy the file to another location.
- CUSTOM: Perform a custom step with an Lambda function target.
- DELETE: Delete the file.
- TAG: Add a tag to the file.
FileLocation
data FileLocation Source #
Specifies the Amazon S3 or EFS file details to be used in the step.
See: newFileLocation smart constructor.
Constructors
| FileLocation' | |
Fields
| |
Instances
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 identifier 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.
fileLocation_efsFileLocation :: Lens' FileLocation (Maybe EfsFileLocation) Source #
Specifies the Amazon EFS identifier and the path for the file being used.
fileLocation_s3FileLocation :: Lens' FileLocation (Maybe S3FileLocation) Source #
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" } ]See: newHomeDirectoryMapEntry smart constructor.
Constructors
| HomeDirectoryMapEntry' | |
Instances
newHomeDirectoryMapEntry Source #
Arguments
| :: Text | |
| -> Text | |
| -> 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.
homeDirectoryMapEntry_entry :: Lens' HomeDirectoryMapEntry Text Source #
Represents an entry for HomeDirectoryMappings.
homeDirectoryMapEntry_target :: Lens' HomeDirectoryMapEntry Text Source #
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' | |
Fields
| |
Instances
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:directoryId:IdentityProviderDetails', identityProviderDetails_directoryId - The identifier of the Directory Service directory that you want to stop
sharing.
$sel:function:IdentityProviderDetails', identityProviderDetails_function - The ARN for a lambda function to use for the Identity provider.
$sel:invocationRole:IdentityProviderDetails', identityProviderDetails_invocationRole - Provides the type of InvocationRole used to authenticate the user
account.
$sel:url:IdentityProviderDetails', identityProviderDetails_url - Provides the location of the service endpoint used to authenticate
users.
identityProviderDetails_directoryId :: Lens' IdentityProviderDetails (Maybe Text) Source #
The identifier of the Directory Service directory that you want to stop sharing.
identityProviderDetails_function :: Lens' IdentityProviderDetails (Maybe Text) Source #
The ARN for a lambda function to use for the Identity provider.
identityProviderDetails_invocationRole :: Lens' IdentityProviderDetails (Maybe Text) Source #
Provides the type of InvocationRole used to authenticate the user
account.
identityProviderDetails_url :: Lens' IdentityProviderDetails (Maybe Text) Source #
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' | |
Fields
| |
Instances
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.
inputFileLocation_efsFileLocation :: Lens' InputFileLocation (Maybe EfsFileLocation) Source #
Reserved for future use.
inputFileLocation_s3FileLocation :: Lens' InputFileLocation (Maybe S3InputFileLocation) Source #
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' | |
Fields
| |
Instances
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: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
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 regular expression 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.
$sel:homeDirectoryType:ListedAccess', listedAccess_homeDirectoryType - The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
$sel:role':ListedAccess', listedAccess_role - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that controls your users' access to your Amazon S3 bucket or
Amazon 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 Amazon 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.
listedAccess_externalId :: Lens' ListedAccess (Maybe Text) Source #
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 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 regular expression 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: =,.@:/-
listedAccess_homeDirectory :: Lens' ListedAccess (Maybe Text) Source #
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.
listedAccess_homeDirectoryType :: Lens' ListedAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
listedAccess_role :: Lens' ListedAccess (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.
ListedAgreement
data ListedAgreement Source #
Describes the properties of an agreement.
See: newListedAgreement smart constructor.
Constructors
| ListedAgreement' | |
Fields
| |
Instances
newListedAgreement :: ListedAgreement Source #
Create a value of ListedAgreement 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:agreementId:ListedAgreement', listedAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when
you create an agreement.
$sel:arn:ListedAgreement', listedAgreement_arn - The Amazon Resource Name (ARN) of the specified agreement.
$sel:description:ListedAgreement', listedAgreement_description - The current description for the agreement. You can change it by calling
the UpdateAgreement operation and providing a new description.
$sel:localProfileId:ListedAgreement', listedAgreement_localProfileId - A unique identifier for the AS2 local profile.
$sel:partnerProfileId:ListedAgreement', listedAgreement_partnerProfileId - A unique identifier for the partner profile.
$sel:serverId:ListedAgreement', listedAgreement_serverId - The unique identifier for the agreement.
$sel:status:ListedAgreement', listedAgreement_status - The agreement can be either ACTIVE or INACTIVE.
listedAgreement_agreementId :: Lens' ListedAgreement (Maybe Text) Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
listedAgreement_arn :: Lens' ListedAgreement (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified agreement.
listedAgreement_description :: Lens' ListedAgreement (Maybe Text) Source #
The current description for the agreement. You can change it by calling
the UpdateAgreement operation and providing a new description.
listedAgreement_localProfileId :: Lens' ListedAgreement (Maybe Text) Source #
A unique identifier for the AS2 local profile.
listedAgreement_partnerProfileId :: Lens' ListedAgreement (Maybe Text) Source #
A unique identifier for the partner profile.
listedAgreement_serverId :: Lens' ListedAgreement (Maybe Text) Source #
The unique identifier for the agreement.
listedAgreement_status :: Lens' ListedAgreement (Maybe AgreementStatusType) Source #
The agreement can be either ACTIVE or INACTIVE.
ListedCertificate
data ListedCertificate Source #
Describes the properties of a certificate.
See: newListedCertificate smart constructor.
Constructors
| ListedCertificate' | |
Fields
| |
Instances
newListedCertificate :: ListedCertificate Source #
Create a value of ListedCertificate 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:activeDate:ListedCertificate', listedCertificate_activeDate - An optional date that specifies when the certificate becomes active.
$sel:arn:ListedCertificate', listedCertificate_arn - The Amazon Resource Name (ARN) of the specified certificate.
$sel:certificateId:ListedCertificate', listedCertificate_certificateId - An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
$sel:description:ListedCertificate', listedCertificate_description - The name or short description that's used to identify the certificate.
$sel:inactiveDate:ListedCertificate', listedCertificate_inactiveDate - An optional date that specifies when the certificate becomes inactive.
$sel:status:ListedCertificate', listedCertificate_status - The certificate can be either ACTIVE, PENDING_ROTATION, or
INACTIVE. PENDING_ROTATION means that this certificate will replace
the current certificate when it expires.
$sel:type':ListedCertificate', listedCertificate_type - The type for the certificate. If a private key has been specified for
the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is
no private key, the type is CERTIFICATE.
$sel:usage:ListedCertificate', listedCertificate_usage - Specifies whether this certificate is used for signing or encryption.
listedCertificate_activeDate :: Lens' ListedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes active.
listedCertificate_arn :: Lens' ListedCertificate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified certificate.
listedCertificate_certificateId :: Lens' ListedCertificate (Maybe Text) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
listedCertificate_description :: Lens' ListedCertificate (Maybe Text) Source #
The name or short description that's used to identify the certificate.
listedCertificate_inactiveDate :: Lens' ListedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes inactive.
listedCertificate_status :: Lens' ListedCertificate (Maybe CertificateStatusType) Source #
The certificate can be either ACTIVE, PENDING_ROTATION, or
INACTIVE. PENDING_ROTATION means that this certificate will replace
the current certificate when it expires.
listedCertificate_type :: Lens' ListedCertificate (Maybe CertificateType) Source #
The type for the certificate. If a private key has been specified for
the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is
no private key, the type is CERTIFICATE.
listedCertificate_usage :: Lens' ListedCertificate (Maybe CertificateUsageType) Source #
Specifies whether this certificate is used for signing or encryption.
ListedConnector
data ListedConnector Source #
Returns details of the connector that is specified.
See: newListedConnector smart constructor.
Constructors
| ListedConnector' | |
Instances
newListedConnector :: ListedConnector Source #
Create a value of ListedConnector 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:ListedConnector', listedConnector_arn - The Amazon Resource Name (ARN) of the specified connector.
$sel:connectorId:ListedConnector', listedConnector_connectorId - The unique identifier for the connector.
$sel:url:ListedConnector', listedConnector_url - The URL of the partner's AS2 endpoint.
listedConnector_arn :: Lens' ListedConnector (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified connector.
listedConnector_connectorId :: Lens' ListedConnector (Maybe Text) Source #
The unique identifier for the connector.
listedConnector_url :: Lens' ListedConnector (Maybe Text) Source #
The URL of the partner's AS2 endpoint.
ListedExecution
data ListedExecution Source #
Returns properties of the execution that is specified.
See: newListedExecution smart constructor.
Constructors
| ListedExecution' | |
Fields
| |
Instances
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: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 that are associated with a
workflow.
$sel:status:ListedExecution', listedExecution_status - The status is one of the execution. Can be in progress, completed,
exception encountered, or handling the exception.
listedExecution_executionId :: Lens' ListedExecution (Maybe Text) Source #
A unique identifier for the execution of a workflow.
listedExecution_initialFileLocation :: Lens' ListedExecution (Maybe FileLocation) Source #
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.
listedExecution_serviceMetadata :: Lens' ListedExecution (Maybe ServiceMetadata) Source #
A container object for the session details that are associated with a workflow.
listedExecution_status :: Lens' ListedExecution (Maybe ExecutionStatus) Source #
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
ListedHostKey
data ListedHostKey Source #
Returns properties of the host key that's specified.
See: newListedHostKey smart constructor.
Constructors
| ListedHostKey' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListedHostKey |
Create a value of ListedHostKey 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:ListedHostKey', listedHostKey_dateImported - The date on which the host key was added to the server.
$sel:description:ListedHostKey', listedHostKey_description - The current description for the host key. You can change it by calling
the UpdateHostKey operation and providing a new description.
$sel:fingerprint:ListedHostKey', listedHostKey_fingerprint - The public key fingerprint, which is a short sequence of bytes used to
identify the longer public key.
$sel:hostKeyId:ListedHostKey', listedHostKey_hostKeyId - A unique identifier for the host key.
$sel:type':ListedHostKey', listedHostKey_type - The encryption algorithm that is used for the host key. The Type
parameter is specified by using one of the following values:
ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
$sel:arn:ListedHostKey', listedHostKey_arn - The unique Amazon Resource Name (ARN) of the host key.
listedHostKey_dateImported :: Lens' ListedHostKey (Maybe UTCTime) Source #
The date on which the host key was added to the server.
listedHostKey_description :: Lens' ListedHostKey (Maybe Text) Source #
The current description for the host key. You can change it by calling
the UpdateHostKey operation and providing a new description.
listedHostKey_fingerprint :: Lens' ListedHostKey (Maybe Text) Source #
The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
listedHostKey_hostKeyId :: Lens' ListedHostKey (Maybe Text) Source #
A unique identifier for the host key.
listedHostKey_type :: Lens' ListedHostKey (Maybe Text) Source #
The encryption algorithm that is used for the host key. The Type
parameter is specified by using one of the following values:
ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
listedHostKey_arn :: Lens' ListedHostKey Text Source #
The unique Amazon Resource Name (ARN) of the host key.
ListedProfile
data ListedProfile Source #
Returns the properties of the profile that was specified.
See: newListedProfile smart constructor.
Constructors
| ListedProfile' | |
Fields
| |
Instances
newListedProfile :: ListedProfile Source #
Create a value of ListedProfile 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:ListedProfile', listedProfile_arn - The Amazon Resource Name (ARN) of the specified profile.
$sel:as2Id:ListedProfile', listedProfile_as2Id - The As2Id is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To header for
the AS2 messages sent to the partner using the StartFileTransfer API
operation. This ID cannot include spaces.
$sel:profileId:ListedProfile', listedProfile_profileId - A unique identifier for the local or partner AS2 profile.
$sel:profileType:ListedProfile', listedProfile_profileType - Indicates whether to list only LOCAL type profiles or only PARTNER
type profiles. If not supplied in the request, the command lists all
types of profiles.
listedProfile_arn :: Lens' ListedProfile (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified profile.
listedProfile_as2Id :: Lens' ListedProfile (Maybe Text) Source #
The As2Id is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To header for
the AS2 messages sent to the partner using the StartFileTransfer API
operation. This ID cannot include spaces.
listedProfile_profileId :: Lens' ListedProfile (Maybe Text) Source #
A unique identifier for the local or partner AS2 profile.
listedProfile_profileType :: Lens' ListedProfile (Maybe ProfileType) Source #
Indicates whether to list only LOCAL type profiles or only PARTNER
type profiles. If not supplied in the request, the command lists all
types of profiles.
ListedServer
data ListedServer Source #
Returns properties of a file transfer protocol-enabled server that was specified.
See: newListedServer smart constructor.
Constructors
| ListedServer' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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: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:identityProviderType:ListedServer', listedServer_identityProviderType - The mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Directory Service for Microsoft Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connector. This option also requires you to provide a Directory
ID by 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
Amazon API Gateway endpoint URL to call for authentication by using the
IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use an Lambda function as your
identity provider. If you choose this value, you must specify the ARN
for the Lambda function in the Function parameter or the
IdentityProviderDetails data type.
$sel:loggingRole:ListedServer', listedServer_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a server to turn on Amazon CloudWatch logging for
Amazon S3 or Amazon EFSevents. When set, you can view user activity in
your CloudWatch logs.
$sel:serverId:ListedServer', listedServer_serverId - Specifies the unique system assigned identifier for the servers that
were listed.
$sel:state:ListedServer', listedServer_state - The condition of 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: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.
listedServer_domain :: Lens' ListedServer (Maybe Domain) Source #
Specifies the domain of the storage system that is used for file transfers.
listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType) Source #
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.
listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType) Source #
The mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Directory Service for Microsoft Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connector. This option also requires you to provide a Directory
ID by 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
Amazon API Gateway endpoint URL to call for authentication by using the
IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use an Lambda function as your
identity provider. If you choose this value, you must specify the ARN
for the Lambda function in the Function parameter or the
IdentityProviderDetails data type.
listedServer_loggingRole :: Lens' ListedServer (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
listedServer_serverId :: Lens' ListedServer (Maybe Text) Source #
Specifies the unique system assigned identifier for the servers that were listed.
listedServer_state :: Lens' ListedServer (Maybe State) Source #
The condition of 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.
listedServer_userCount :: Lens' ListedServer (Maybe Int) Source #
Specifies the number of users that are assigned to a server you
specified with the ServerId.
listedServer_arn :: Lens' ListedServer Text Source #
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' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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: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:homeDirectoryType:ListedUser', listedUser_homeDirectoryType - The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
$sel:role':ListedUser', listedUser_role - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that controls your users' access to your Amazon S3 bucket or
Amazon 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 Amazon 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:userName:ListedUser', listedUser_userName - Specifies the name of the user whose ARN was specified. User names are
used for authentication purposes.
$sel:arn:ListedUser', listedUser_arn - Provides the unique Amazon Resource Name (ARN) for the user that you
want to learn about.
listedUser_homeDirectory :: Lens' ListedUser (Maybe Text) Source #
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.
listedUser_homeDirectoryType :: Lens' ListedUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to 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 Amazon EFS paths visible to your users.
listedUser_role :: Lens' ListedUser (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.
listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int) Source #
Specifies the number of SSH public keys stored for the user you specified.
listedUser_userName :: Lens' ListedUser (Maybe Text) Source #
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
listedUser_arn :: Lens' ListedUser Text Source #
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
ListedWorkflow
data ListedWorkflow Source #
Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.
See: newListedWorkflow smart constructor.
Constructors
| ListedWorkflow' | |
Fields
| |
Instances
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:description:ListedWorkflow', listedWorkflow_description - Specifies the text description for the workflow.
$sel:workflowId:ListedWorkflow', listedWorkflow_workflowId - A unique identifier for the workflow.
listedWorkflow_arn :: Lens' ListedWorkflow (Maybe Text) Source #
Specifies the unique Amazon Resource Name (ARN) for the workflow.
listedWorkflow_description :: Lens' ListedWorkflow (Maybe Text) Source #
Specifies the text description for the workflow.
listedWorkflow_workflowId :: Lens' ListedWorkflow (Maybe Text) Source #
A unique identifier for the workflow.
LoggingConfiguration
data LoggingConfiguration Source #
Consists of the logging role and the log group name.
See: newLoggingConfiguration smart constructor.
Constructors
| LoggingConfiguration' | |
Fields
| |
Instances
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:logGroupName:LoggingConfiguration', loggingConfiguration_logGroupName - The name of the CloudWatch logging group for the Transfer Family server
to which this workflow belongs.
$sel:loggingRole:LoggingConfiguration', loggingConfiguration_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a server to turn on Amazon CloudWatch logging for
Amazon S3 or Amazon EFSevents. When set, you can view user activity in
your CloudWatch logs.
loggingConfiguration_logGroupName :: Lens' LoggingConfiguration (Maybe Text) Source #
The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.
loggingConfiguration_loggingRole :: Lens' LoggingConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
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' | |
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> 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.
posixProfile_secondaryGids :: Lens' PosixProfile (Maybe [Natural]) Source #
The secondary POSIX group IDs used for all EFS operations by this user.
posixProfile_uid :: Lens' PosixProfile Natural Source #
The POSIX user ID used for all EFS operations by this user.
posixProfile_gid :: Lens' PosixProfile Natural Source #
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.
See: newProtocolDetails smart constructor.
Constructors
| ProtocolDetails' | |
Fields
| |
Instances
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:as2Transports:ProtocolDetails', protocolDetails_as2Transports - Indicates the transport method for the AS2 messages. Currently, only
HTTP is supported.
$sel:passiveIp:ProtocolDetails', protocolDetails_passiveIp - Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4
address, such as the public 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 Family server for the change to take effect. For details on
using passive mode (PASV) in a NAT environment, see
Configuring your FTPS server behind a firewall or NAT with Transfer Family.
Special values
The AUTO and 0.0.0.0 are special values for the PassiveIp
parameter. The value PassiveIp=AUTO is assigned by default to FTP and
FTPS type servers. In this case, the server automatically responds with
one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0
has a more unique application for its usage. For example, if you have a
High Availability (HA) Network Load Balancer (NLB) environment, where
you have 3 subnets, you can only specify a single IP address using the
PassiveIp parameter. This reduces the effectiveness of having High
Availability. In this case, you can specify PassiveIp=0.0.0.0. This
tells the client to use the same IP address as the Control connection
and utilize all AZs for their connections. Note, however, that not all
FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and
WinSCP do support it. If you are using other clients, check to see if
your client supports the PassiveIp=0.0.0.0 response.
$sel:setStatOption:ProtocolDetails', protocolDetails_setStatOption - Use the SetStatOption to ignore the error that is generated when the
client attempts to use SETSTAT on a file you are uploading to an S3
bucket.
Some SFTP file transfer clients can attempt to change the attributes of
remote files, including timestamp and permissions, using commands, such
as SETSTAT when uploading the file. However, these commands are not
compatible with object storage systems, such as Amazon S3. Due to this
incompatibility, file uploads from these clients can result in errors
even when the file is otherwise successfully uploaded.
Set the value to ENABLE_NO_OP to have the Transfer Family server
ignore the SETSTAT command, and upload files without needing to make
any changes to your SFTP client. While the SetStatOption
ENABLE_NO_OP setting ignores the error, it does generate a log entry
in Amazon CloudWatch Logs, so you can determine when the client is
making a SETSTAT call.
If you want to preserve the original timestamp for your file, and modify
other file attributes using SETSTAT, you can use Amazon EFS as backend
storage with Transfer Family.
$sel:tlsSessionResumptionMode:ProtocolDetails', protocolDetails_tlsSessionResumptionMode - A property used with Transfer Family servers that use the FTPS protocol.
TLS Session Resumption provides a mechanism to resume or share a
negotiated secret key between the control and data connection for an
FTPS session. TlsSessionResumptionMode determines whether or not the
server resumes recent, negotiated sessions through a unique session ID.
This property is available during CreateServer and UpdateServer
calls. If a TlsSessionResumptionMode value is not specified during
CreateServer, it is set to ENFORCED by default.
DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value toENFORCED, test your clients.Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the
ENFORCEDvalue, you need to test your clients.
protocolDetails_as2Transports :: Lens' ProtocolDetails (Maybe (NonEmpty As2Transport)) Source #
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
protocolDetails_passiveIp :: Lens' ProtocolDetails (Maybe Text) Source #
Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public 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 Family server for the change to take effect. For details on
using passive mode (PASV) in a NAT environment, see
Configuring your FTPS server behind a firewall or NAT with Transfer Family.
Special values
The AUTO and 0.0.0.0 are special values for the PassiveIp
parameter. The value PassiveIp=AUTO is assigned by default to FTP and
FTPS type servers. In this case, the server automatically responds with
one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0
has a more unique application for its usage. For example, if you have a
High Availability (HA) Network Load Balancer (NLB) environment, where
you have 3 subnets, you can only specify a single IP address using the
PassiveIp parameter. This reduces the effectiveness of having High
Availability. In this case, you can specify PassiveIp=0.0.0.0. This
tells the client to use the same IP address as the Control connection
and utilize all AZs for their connections. Note, however, that not all
FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and
WinSCP do support it. If you are using other clients, check to see if
your client supports the PassiveIp=0.0.0.0 response.
protocolDetails_setStatOption :: Lens' ProtocolDetails (Maybe SetStatOption) Source #
Use the SetStatOption to ignore the error that is generated when the
client attempts to use SETSTAT on a file you are uploading to an S3
bucket.
Some SFTP file transfer clients can attempt to change the attributes of
remote files, including timestamp and permissions, using commands, such
as SETSTAT when uploading the file. However, these commands are not
compatible with object storage systems, such as Amazon S3. Due to this
incompatibility, file uploads from these clients can result in errors
even when the file is otherwise successfully uploaded.
Set the value to ENABLE_NO_OP to have the Transfer Family server
ignore the SETSTAT command, and upload files without needing to make
any changes to your SFTP client. While the SetStatOption
ENABLE_NO_OP setting ignores the error, it does generate a log entry
in Amazon CloudWatch Logs, so you can determine when the client is
making a SETSTAT call.
If you want to preserve the original timestamp for your file, and modify
other file attributes using SETSTAT, you can use Amazon EFS as backend
storage with Transfer Family.
protocolDetails_tlsSessionResumptionMode :: Lens' ProtocolDetails (Maybe TlsSessionResumptionMode) Source #
A property used with Transfer Family servers that use the FTPS protocol.
TLS Session Resumption provides a mechanism to resume or share a
negotiated secret key between the control and data connection for an
FTPS session. TlsSessionResumptionMode determines whether or not the
server resumes recent, negotiated sessions through a unique session ID.
This property is available during CreateServer and UpdateServer
calls. If a TlsSessionResumptionMode value is not specified during
CreateServer, it is set to ENFORCED by default.
DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value toENFORCED, test your clients.Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the
ENFORCEDvalue, you need to test your clients.
S3FileLocation
data S3FileLocation Source #
Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using S3 storage.
See: newS3FileLocation smart constructor.
Constructors
| S3FileLocation' | |
Fields
| |
Instances
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:bucket:S3FileLocation', s3FileLocation_bucket - Specifies the S3 bucket that contains the file being used.
$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:key:S3FileLocation', s3FileLocation_key - The name assigned to the file when it was created in Amazon S3. You use
the object key to retrieve the object.
$sel:versionId:S3FileLocation', s3FileLocation_versionId - Specifies the file version.
s3FileLocation_bucket :: Lens' S3FileLocation (Maybe Text) Source #
Specifies the S3 bucket that contains the file being used.
s3FileLocation_etag :: Lens' S3FileLocation (Maybe Text) Source #
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.
s3FileLocation_key :: Lens' S3FileLocation (Maybe Text) Source #
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
s3FileLocation_versionId :: Lens' S3FileLocation (Maybe Text) Source #
Specifies the file version.
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' | |
Instances
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 Amazon S3. You use
the object key to retrieve the object.
s3InputFileLocation_bucket :: Lens' S3InputFileLocation (Maybe Text) Source #
Specifies the S3 bucket for the customer input file.
s3InputFileLocation_key :: Lens' S3InputFileLocation (Maybe Text) Source #
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
S3Tag
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
See: newS3Tag smart constructor.
Constructors
| S3Tag' | |
Instances
| FromJSON S3Tag Source # | |
| ToJSON S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag | |
| Generic S3Tag Source # | |
| Read S3Tag Source # | |
| Show S3Tag Source # | |
| NFData S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag | |
| Eq S3Tag Source # | |
| Hashable S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag | |
| type Rep S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag type Rep S3Tag = D1 ('MetaData "S3Tag" "Amazonka.Transfer.Types.S3Tag" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "S3Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
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 that are associated with a workflow.
See: newServiceMetadata smart constructor.
Constructors
| ServiceMetadata' | |
Fields
| |
Instances
Arguments
| :: UserDetails | |
| -> 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.
serviceMetadata_userDetails :: Lens' ServiceMetadata UserDetails Source #
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' | |
Fields
| |
Instances
Arguments
| :: UTCTime | |
| -> Text | |
| -> Text | |
| -> 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.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
$sel:sshPublicKeyId:SshPublicKey', sshPublicKey_sshPublicKeyId - Specifies the SshPublicKeyId parameter contains the identifier of the
public key.
sshPublicKey_dateImported :: Lens' SshPublicKey UTCTime Source #
Specifies the date that the public key was added to the user account.
sshPublicKey_sshPublicKeyBody :: Lens' SshPublicKey Text Source #
Specifies the content of the SSH public key as specified by the
PublicKeyId.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
sshPublicKey_sshPublicKeyId :: Lens' SshPublicKey Text Source #
Specifies the SshPublicKeyId parameter contains the identifier of the
public key.
Tag
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' | |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Transfer.Types.Tag" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
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.
tag_value :: Lens' Tag Text Source #
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' | |
Fields
| |
Instances
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:sourceFileLocation:TagStepDetails', tagStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the
output from the previous step, or the originally uploaded file for the
workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
$sel:tags:TagStepDetails', tagStepDetails_tags - Array that contains from 1 to 10 key/value pairs.
tagStepDetails_name :: Lens' TagStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
tagStepDetails_sourceFileLocation :: Lens' TagStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}to use the originally-uploaded file location as input for this step.
tagStepDetails_tags :: Lens' TagStepDetails (Maybe (NonEmpty S3Tag)) Source #
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' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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.
userDetails_sessionId :: Lens' UserDetails (Maybe Text) Source #
The system-assigned unique identifier for a session that corresponds to the workflow.
userDetails_userName :: Lens' UserDetails Text Source #
A unique string that identifies a user account associated with a server.
userDetails_serverId :: Lens' UserDetails Text Source #
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 that's used for executing the workflow.
In additon to a workflow to execute when a file is uploaded completely,
WorkflowDeatails can also contain a workflow ID (and execution role)
for a workflow to execute on partial upload. A partial upload occurs
when a file is open when the session disconnects.
See: newWorkflowDetail smart constructor.
Constructors
| WorkflowDetail' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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
workflowDetail_workflowId :: Lens' WorkflowDetail Text Source #
A unique identifier for the workflow.
workflowDetail_executionRole :: Lens' WorkflowDetail Text Source #
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' | |
Fields
| |
Instances
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:onPartialUpload:WorkflowDetails', workflowDetails_onPartialUpload - A trigger that starts a workflow if a file is only partially uploaded.
You can attach a workflow to a server that executes whenever there is a
partial upload.
A partial upload occurs when a file is open when the session disconnects.
$sel:onUpload:WorkflowDetails', workflowDetails_onUpload - A trigger that starts a workflow: the workflow begins to execute after a
file is uploaded.
To remove an associated workflow from a server, you can provide an empty
OnUpload object, as in the following example.
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'workflowDetails_onPartialUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail]) Source #
A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.
A partial upload occurs when a file is open when the session disconnects.
workflowDetails_onUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail]) Source #
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
To remove an associated workflow from a server, you can provide an empty
OnUpload object, as in the following example.
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'WorkflowStep
data WorkflowStep Source #
The basic building block of a workflow.
See: newWorkflowStep smart constructor.
Constructors
| WorkflowStep' | |
Fields
| |
Instances
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: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:customStepDetails:WorkflowStep', workflowStep_customStepDetails - Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
$sel:decryptStepDetails:WorkflowStep', workflowStep_decryptStepDetails - Undocumented member.
$sel:deleteStepDetails:WorkflowStep', workflowStep_deleteStepDetails - Details for a step that deletes the file.
$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.
WorkflowStep, workflowStep_type - Currently, the following step types are supported.
- COPY: Copy the file to another location.
- CUSTOM: Perform a custom step with an Lambda function target.
- DELETE: Delete the file.
- TAG: Add a tag to the file.
workflowStep_copyStepDetails :: Lens' WorkflowStep (Maybe CopyStepDetails) Source #
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.
workflowStep_customStepDetails :: Lens' WorkflowStep (Maybe CustomStepDetails) Source #
Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
workflowStep_decryptStepDetails :: Lens' WorkflowStep (Maybe DecryptStepDetails) Source #
Undocumented member.
workflowStep_deleteStepDetails :: Lens' WorkflowStep (Maybe DeleteStepDetails) Source #
Details for a step that deletes the file.
workflowStep_tagStepDetails :: Lens' WorkflowStep (Maybe TagStepDetails) Source #
Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
workflowStep_type :: Lens' WorkflowStep (Maybe WorkflowStepType) Source #
Currently, the following step types are supported.
- COPY: Copy the file to another location.
- CUSTOM: Perform a custom step with an Lambda function target.
- DELETE: Delete the file.
- TAG: Add a tag to the file.