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 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateAccess
- CreateAgreement
- CreateConnector
- CreateProfile
- CreateServer
- CreateUser
- CreateWorkflow
- DeleteAccess
- DeleteAgreement
- DeleteCertificate
- DeleteConnector
- DeleteHostKey
- DeleteProfile
- DeleteServer
- DeleteSshPublicKey
- DeleteUser
- DeleteWorkflow
- DescribeAccess
- DescribeAgreement
- DescribeCertificate
- DescribeConnector
- DescribeExecution
- DescribeHostKey
- DescribeProfile
- DescribeSecurityPolicy
- DescribeServer
- DescribeUser
- DescribeWorkflow
- ImportCertificate
- ImportHostKey
- ImportSshPublicKey
- ListAccesses (Paginated)
- ListAgreements (Paginated)
- ListCertificates (Paginated)
- ListConnectors (Paginated)
- ListExecutions (Paginated)
- ListHostKeys
- ListProfiles (Paginated)
- ListSecurityPolicies (Paginated)
- ListServers (Paginated)
- ListTagsForResource (Paginated)
- ListUsers (Paginated)
- ListWorkflows (Paginated)
- SendWorkflowStepState
- StartFileTransfer
- StartServer
- StopServer
- TagResource
- TestIdentityProvider
- UntagResource
- UpdateAccess
- UpdateAgreement
- UpdateCertificate
- UpdateConnector
- UpdateHostKey
- UpdateProfile
- UpdateServer
- UpdateUser
- Types
- 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
Derived from API version 2018-11-05
of the AWS service descriptions, licensed under Apache 2.0.
Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.
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
- newServerOffline :: Wait DescribeServer
- newServerOnline :: Wait DescribeServer
- data CreateAccess = CreateAccess' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) Text Text Text
- newCreateAccess :: Text -> Text -> Text -> CreateAccess
- data CreateAccessResponse = CreateAccessResponse' Int Text Text
- newCreateAccessResponse :: Int -> Text -> Text -> CreateAccessResponse
- data CreateAgreement = CreateAgreement' (Maybe Text) (Maybe AgreementStatusType) (Maybe (NonEmpty Tag)) Text Text Text Text Text
- newCreateAgreement :: Text -> Text -> Text -> Text -> Text -> CreateAgreement
- data CreateAgreementResponse = CreateAgreementResponse' Int Text
- newCreateAgreementResponse :: Int -> Text -> CreateAgreementResponse
- data CreateConnector = CreateConnector' (Maybe Text) (Maybe (NonEmpty Tag)) Text As2ConnectorConfig Text
- newCreateConnector :: Text -> As2ConnectorConfig -> Text -> CreateConnector
- data CreateConnectorResponse = CreateConnectorResponse' Int Text
- newCreateConnectorResponse :: Int -> Text -> CreateConnectorResponse
- data CreateProfile = CreateProfile' (Maybe [Text]) (Maybe (NonEmpty Tag)) Text ProfileType
- newCreateProfile :: Text -> ProfileType -> CreateProfile
- data CreateProfileResponse = CreateProfileResponse' Int Text
- newCreateProfileResponse :: Int -> Text -> CreateProfileResponse
- data CreateServer = CreateServer' (Maybe Text) (Maybe Domain) (Maybe EndpointDetails) (Maybe EndpointType) (Maybe (Sensitive Text)) (Maybe IdentityProviderDetails) (Maybe IdentityProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProtocolDetails) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe WorkflowDetails)
- newCreateServer :: CreateServer
- data CreateServerResponse = CreateServerResponse' Int Text
- newCreateServerResponse :: Int -> Text -> CreateServerResponse
- data CreateUser = CreateUser' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) (Maybe (NonEmpty Tag)) Text Text Text
- newCreateUser :: Text -> Text -> Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' Int Text Text
- newCreateUserResponse :: Int -> Text -> Text -> CreateUserResponse
- data CreateWorkflow = CreateWorkflow' (Maybe Text) (Maybe [WorkflowStep]) (Maybe (NonEmpty Tag)) [WorkflowStep]
- newCreateWorkflow :: CreateWorkflow
- data CreateWorkflowResponse = CreateWorkflowResponse' Int Text
- newCreateWorkflowResponse :: Int -> Text -> CreateWorkflowResponse
- data DeleteAccess = DeleteAccess' Text Text
- newDeleteAccess :: Text -> Text -> DeleteAccess
- data DeleteAccessResponse = DeleteAccessResponse' {
- newDeleteAccessResponse :: DeleteAccessResponse
- data DeleteAgreement = DeleteAgreement' Text Text
- newDeleteAgreement :: Text -> Text -> DeleteAgreement
- data DeleteAgreementResponse = DeleteAgreementResponse' {
- newDeleteAgreementResponse :: DeleteAgreementResponse
- data DeleteCertificate = DeleteCertificate' Text
- newDeleteCertificate :: Text -> DeleteCertificate
- data DeleteCertificateResponse = DeleteCertificateResponse' {
- newDeleteCertificateResponse :: DeleteCertificateResponse
- data DeleteConnector = DeleteConnector' Text
- newDeleteConnector :: Text -> DeleteConnector
- data DeleteConnectorResponse = DeleteConnectorResponse' {
- newDeleteConnectorResponse :: DeleteConnectorResponse
- data DeleteHostKey = DeleteHostKey' Text Text
- newDeleteHostKey :: Text -> Text -> DeleteHostKey
- data DeleteHostKeyResponse = DeleteHostKeyResponse' {
- newDeleteHostKeyResponse :: DeleteHostKeyResponse
- data DeleteProfile = DeleteProfile' Text
- newDeleteProfile :: Text -> DeleteProfile
- data DeleteProfileResponse = DeleteProfileResponse' {
- newDeleteProfileResponse :: DeleteProfileResponse
- data DeleteServer = DeleteServer' Text
- newDeleteServer :: Text -> DeleteServer
- data DeleteServerResponse = DeleteServerResponse' {
- newDeleteServerResponse :: DeleteServerResponse
- data DeleteSshPublicKey = DeleteSshPublicKey' Text Text Text
- newDeleteSshPublicKey :: Text -> Text -> Text -> DeleteSshPublicKey
- data DeleteSshPublicKeyResponse = DeleteSshPublicKeyResponse' {
- newDeleteSshPublicKeyResponse :: DeleteSshPublicKeyResponse
- data DeleteUser = DeleteUser' Text Text
- newDeleteUser :: Text -> Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' {
- newDeleteUserResponse :: DeleteUserResponse
- data DeleteWorkflow = DeleteWorkflow' Text
- newDeleteWorkflow :: Text -> DeleteWorkflow
- data DeleteWorkflowResponse = DeleteWorkflowResponse' {
- newDeleteWorkflowResponse :: DeleteWorkflowResponse
- data DescribeAccess = DescribeAccess' Text Text
- newDescribeAccess :: Text -> Text -> DescribeAccess
- data DescribeAccessResponse = DescribeAccessResponse' Int Text DescribedAccess
- newDescribeAccessResponse :: Int -> Text -> DescribedAccess -> DescribeAccessResponse
- data DescribeAgreement = DescribeAgreement' Text Text
- newDescribeAgreement :: Text -> Text -> DescribeAgreement
- data DescribeAgreementResponse = DescribeAgreementResponse' Int DescribedAgreement
- newDescribeAgreementResponse :: Int -> DescribedAgreement -> DescribeAgreementResponse
- data DescribeCertificate = DescribeCertificate' Text
- newDescribeCertificate :: Text -> DescribeCertificate
- data DescribeCertificateResponse = DescribeCertificateResponse' Int DescribedCertificate
- newDescribeCertificateResponse :: Int -> DescribedCertificate -> DescribeCertificateResponse
- data DescribeConnector = DescribeConnector' Text
- newDescribeConnector :: Text -> DescribeConnector
- data DescribeConnectorResponse = DescribeConnectorResponse' Int DescribedConnector
- newDescribeConnectorResponse :: Int -> DescribedConnector -> DescribeConnectorResponse
- data DescribeExecution = DescribeExecution' Text Text
- newDescribeExecution :: Text -> Text -> DescribeExecution
- data DescribeExecutionResponse = DescribeExecutionResponse' Int Text DescribedExecution
- newDescribeExecutionResponse :: Int -> Text -> DescribedExecution -> DescribeExecutionResponse
- data DescribeHostKey = DescribeHostKey' Text Text
- newDescribeHostKey :: Text -> Text -> DescribeHostKey
- data DescribeHostKeyResponse = DescribeHostKeyResponse' Int DescribedHostKey
- newDescribeHostKeyResponse :: Int -> DescribedHostKey -> DescribeHostKeyResponse
- data DescribeProfile = DescribeProfile' Text
- newDescribeProfile :: Text -> DescribeProfile
- data DescribeProfileResponse = DescribeProfileResponse' Int DescribedProfile
- newDescribeProfileResponse :: Int -> DescribedProfile -> DescribeProfileResponse
- data DescribeSecurityPolicy = DescribeSecurityPolicy' Text
- newDescribeSecurityPolicy :: Text -> DescribeSecurityPolicy
- data DescribeSecurityPolicyResponse = DescribeSecurityPolicyResponse' Int DescribedSecurityPolicy
- newDescribeSecurityPolicyResponse :: Int -> DescribedSecurityPolicy -> DescribeSecurityPolicyResponse
- data DescribeServer = DescribeServer' Text
- newDescribeServer :: Text -> DescribeServer
- data DescribeServerResponse = DescribeServerResponse' Int DescribedServer
- newDescribeServerResponse :: Int -> DescribedServer -> DescribeServerResponse
- data DescribeUser = DescribeUser' Text Text
- newDescribeUser :: Text -> Text -> DescribeUser
- data DescribeUserResponse = DescribeUserResponse' Int Text DescribedUser
- newDescribeUserResponse :: Int -> Text -> DescribedUser -> DescribeUserResponse
- data DescribeWorkflow = DescribeWorkflow' Text
- newDescribeWorkflow :: Text -> DescribeWorkflow
- data DescribeWorkflowResponse = DescribeWorkflowResponse' Int DescribedWorkflow
- newDescribeWorkflowResponse :: Int -> DescribedWorkflow -> DescribeWorkflowResponse
- data ImportCertificate = ImportCertificate' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) CertificateUsageType (Sensitive Text)
- newImportCertificate :: CertificateUsageType -> Text -> ImportCertificate
- data ImportCertificateResponse = ImportCertificateResponse' Int Text
- newImportCertificateResponse :: Int -> Text -> ImportCertificateResponse
- data ImportHostKey = ImportHostKey' (Maybe Text) (Maybe (NonEmpty Tag)) Text (Sensitive Text)
- newImportHostKey :: Text -> Text -> ImportHostKey
- data ImportHostKeyResponse = ImportHostKeyResponse' Int Text Text
- newImportHostKeyResponse :: Int -> Text -> Text -> ImportHostKeyResponse
- data ImportSshPublicKey = ImportSshPublicKey' Text Text Text
- newImportSshPublicKey :: Text -> Text -> Text -> ImportSshPublicKey
- data ImportSshPublicKeyResponse = ImportSshPublicKeyResponse' Int Text Text Text
- newImportSshPublicKeyResponse :: Int -> Text -> Text -> Text -> ImportSshPublicKeyResponse
- data ListAccesses = ListAccesses' (Maybe Natural) (Maybe Text) Text
- newListAccesses :: Text -> ListAccesses
- data ListAccessesResponse = ListAccessesResponse' (Maybe Text) Int Text [ListedAccess]
- newListAccessesResponse :: Int -> Text -> ListAccessesResponse
- data ListAgreements = ListAgreements' (Maybe Natural) (Maybe Text) Text
- newListAgreements :: Text -> ListAgreements
- data ListAgreementsResponse = ListAgreementsResponse' (Maybe Text) Int [ListedAgreement]
- newListAgreementsResponse :: Int -> ListAgreementsResponse
- data ListCertificates = ListCertificates' (Maybe Natural) (Maybe Text)
- newListCertificates :: ListCertificates
- data ListCertificatesResponse = ListCertificatesResponse' (Maybe Text) Int [ListedCertificate]
- newListCertificatesResponse :: Int -> ListCertificatesResponse
- data ListConnectors = ListConnectors' (Maybe Natural) (Maybe Text)
- newListConnectors :: ListConnectors
- data ListConnectorsResponse = ListConnectorsResponse' (Maybe Text) Int [ListedConnector]
- newListConnectorsResponse :: Int -> ListConnectorsResponse
- data ListExecutions = ListExecutions' (Maybe Natural) (Maybe Text) Text
- newListExecutions :: Text -> ListExecutions
- data ListExecutionsResponse = ListExecutionsResponse' (Maybe Text) Int Text [ListedExecution]
- newListExecutionsResponse :: Int -> Text -> ListExecutionsResponse
- data ListHostKeys = ListHostKeys' (Maybe Natural) (Maybe Text) Text
- newListHostKeys :: Text -> ListHostKeys
- data ListHostKeysResponse = ListHostKeysResponse' (Maybe Text) Int Text [ListedHostKey]
- newListHostKeysResponse :: Int -> Text -> ListHostKeysResponse
- data ListProfiles = ListProfiles' (Maybe Natural) (Maybe Text) (Maybe ProfileType)
- newListProfiles :: ListProfiles
- data ListProfilesResponse = ListProfilesResponse' (Maybe Text) Int [ListedProfile]
- newListProfilesResponse :: Int -> ListProfilesResponse
- data ListSecurityPolicies = ListSecurityPolicies' (Maybe Natural) (Maybe Text)
- newListSecurityPolicies :: ListSecurityPolicies
- data ListSecurityPoliciesResponse = ListSecurityPoliciesResponse' (Maybe Text) Int [Text]
- newListSecurityPoliciesResponse :: Int -> ListSecurityPoliciesResponse
- data ListServers = ListServers' (Maybe Natural) (Maybe Text)
- newListServers :: ListServers
- data ListServersResponse = ListServersResponse' (Maybe Text) Int [ListedServer]
- newListServersResponse :: Int -> ListServersResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListUsers = ListUsers' (Maybe Natural) (Maybe Text) Text
- newListUsers :: Text -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe Text) Int Text [ListedUser]
- newListUsersResponse :: Int -> Text -> ListUsersResponse
- data ListWorkflows = ListWorkflows' (Maybe Natural) (Maybe Text)
- newListWorkflows :: ListWorkflows
- data ListWorkflowsResponse = ListWorkflowsResponse' (Maybe Text) Int [ListedWorkflow]
- newListWorkflowsResponse :: Int -> ListWorkflowsResponse
- data SendWorkflowStepState = SendWorkflowStepState' Text Text Text CustomStepStatus
- newSendWorkflowStepState :: Text -> Text -> Text -> CustomStepStatus -> SendWorkflowStepState
- data SendWorkflowStepStateResponse = SendWorkflowStepStateResponse' Int
- newSendWorkflowStepStateResponse :: Int -> SendWorkflowStepStateResponse
- data StartFileTransfer = StartFileTransfer' Text (NonEmpty Text)
- newStartFileTransfer :: Text -> NonEmpty Text -> StartFileTransfer
- data StartFileTransferResponse = StartFileTransferResponse' Int Text
- newStartFileTransferResponse :: Int -> Text -> StartFileTransferResponse
- data StartServer = StartServer' Text
- newStartServer :: Text -> StartServer
- data StartServerResponse = StartServerResponse' {
- newStartServerResponse :: StartServerResponse
- data StopServer = StopServer' Text
- newStopServer :: Text -> StopServer
- data StopServerResponse = StopServerResponse' {
- newStopServerResponse :: StopServerResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data TestIdentityProvider = TestIdentityProvider' (Maybe Protocol) (Maybe Text) (Maybe (Sensitive Text)) Text Text
- newTestIdentityProvider :: Text -> Text -> TestIdentityProvider
- data TestIdentityProviderResponse = TestIdentityProviderResponse' (Maybe Text) (Maybe Text) Int Int Text
- newTestIdentityProviderResponse :: Int -> Int -> Text -> TestIdentityProviderResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateAccess = UpdateAccess' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) Text Text
- newUpdateAccess :: Text -> Text -> UpdateAccess
- data UpdateAccessResponse = UpdateAccessResponse' Int Text Text
- newUpdateAccessResponse :: Int -> Text -> Text -> UpdateAccessResponse
- data UpdateAgreement = UpdateAgreement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AgreementStatusType) Text Text
- newUpdateAgreement :: Text -> Text -> UpdateAgreement
- data UpdateAgreementResponse = UpdateAgreementResponse' Int Text
- newUpdateAgreementResponse :: Int -> Text -> UpdateAgreementResponse
- data UpdateCertificate = UpdateCertificate' (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text
- newUpdateCertificate :: Text -> UpdateCertificate
- data UpdateCertificateResponse = UpdateCertificateResponse' Int Text
- newUpdateCertificateResponse :: Int -> Text -> UpdateCertificateResponse
- data UpdateConnector = UpdateConnector' (Maybe Text) (Maybe As2ConnectorConfig) (Maybe Text) (Maybe Text) Text
- newUpdateConnector :: Text -> UpdateConnector
- data UpdateConnectorResponse = UpdateConnectorResponse' Int Text
- newUpdateConnectorResponse :: Int -> Text -> UpdateConnectorResponse
- data UpdateHostKey = UpdateHostKey' Text Text Text
- newUpdateHostKey :: Text -> Text -> Text -> UpdateHostKey
- data UpdateHostKeyResponse = UpdateHostKeyResponse' Int Text Text
- newUpdateHostKeyResponse :: Int -> Text -> Text -> UpdateHostKeyResponse
- data UpdateProfile = UpdateProfile' (Maybe [Text]) Text
- newUpdateProfile :: Text -> UpdateProfile
- data UpdateProfileResponse = UpdateProfileResponse' Int Text
- newUpdateProfileResponse :: Int -> Text -> UpdateProfileResponse
- data UpdateServer = UpdateServer' (Maybe Text) (Maybe EndpointDetails) (Maybe EndpointType) (Maybe (Sensitive Text)) (Maybe IdentityProviderDetails) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProtocolDetails) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe WorkflowDetails) Text
- newUpdateServer :: Text -> UpdateServer
- data UpdateServerResponse = UpdateServerResponse' Int Text
- newUpdateServerResponse :: Int -> Text -> UpdateServerResponse
- data UpdateUser = UpdateUser' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) Text Text
- newUpdateUser :: Text -> Text -> UpdateUser
- data UpdateUserResponse = UpdateUserResponse' Int Text Text
- newUpdateUserResponse :: Int -> Text -> Text -> UpdateUserResponse
- 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' (Maybe CompressionEnum) (Maybe EncryptionAlg) (Maybe Text) (Maybe MdnResponse) (Maybe MdnSigningAlg) (Maybe Text) (Maybe Text) (Maybe SigningAlg)
- newAs2ConnectorConfig :: As2ConnectorConfig
- data CopyStepDetails = CopyStepDetails' (Maybe InputFileLocation) (Maybe Text) (Maybe OverwriteExisting) (Maybe Text)
- newCopyStepDetails :: CopyStepDetails
- data CustomStepDetails = CustomStepDetails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newCustomStepDetails :: CustomStepDetails
- data DecryptStepDetails = DecryptStepDetails' (Maybe Text) (Maybe OverwriteExisting) (Maybe Text) EncryptionType InputFileLocation
- newDecryptStepDetails :: EncryptionType -> InputFileLocation -> DecryptStepDetails
- data DeleteStepDetails = DeleteStepDetails' (Maybe Text) (Maybe Text)
- newDeleteStepDetails :: DeleteStepDetails
- data DescribedAccess = DescribedAccess' (Maybe Text) (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text)
- newDescribedAccess :: DescribedAccess
- data DescribedAgreement = DescribedAgreement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AgreementStatusType) (Maybe (NonEmpty Tag)) Text
- newDescribedAgreement :: Text -> DescribedAgreement
- data DescribedCertificate = DescribedCertificate' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe CertificateStatusType) (Maybe (NonEmpty Tag)) (Maybe CertificateType) (Maybe CertificateUsageType) Text
- newDescribedCertificate :: Text -> DescribedCertificate
- data DescribedConnector = DescribedConnector' (Maybe Text) (Maybe As2ConnectorConfig) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text) Text
- newDescribedConnector :: Text -> DescribedConnector
- data DescribedExecution = DescribedExecution' (Maybe Text) (Maybe Text) (Maybe FileLocation) (Maybe LoggingConfiguration) (Maybe PosixProfile) (Maybe ExecutionResults) (Maybe ServiceMetadata) (Maybe ExecutionStatus)
- newDescribedExecution :: DescribedExecution
- data DescribedHostKey = DescribedHostKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text) Text
- newDescribedHostKey :: Text -> DescribedHostKey
- data DescribedProfile = DescribedProfile' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe ProfileType) (Maybe (NonEmpty Tag)) Text
- newDescribedProfile :: Text -> DescribedProfile
- data DescribedSecurityPolicy = DescribedSecurityPolicy' (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text
- newDescribedSecurityPolicy :: Text -> DescribedSecurityPolicy
- data DescribedServer = DescribedServer' (Maybe Text) (Maybe Domain) (Maybe EndpointDetails) (Maybe EndpointType) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe IdentityProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProtocolDetails) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe Text) (Maybe State) (Maybe (NonEmpty Tag)) (Maybe Int) (Maybe WorkflowDetails) Text
- newDescribedServer :: Text -> DescribedServer
- data DescribedUser = DescribedUser' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) (Maybe [SshPublicKey]) (Maybe (NonEmpty Tag)) (Maybe Text) Text
- newDescribedUser :: Text -> DescribedUser
- data DescribedWorkflow = DescribedWorkflow' (Maybe Text) (Maybe [WorkflowStep]) (Maybe [WorkflowStep]) (Maybe (NonEmpty Tag)) (Maybe Text) Text
- newDescribedWorkflow :: Text -> DescribedWorkflow
- data EfsFileLocation = EfsFileLocation' (Maybe Text) (Maybe Text)
- newEfsFileLocation :: EfsFileLocation
- data EndpointDetails = EndpointDetails' (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Text)
- newEndpointDetails :: EndpointDetails
- data ExecutionError = ExecutionError' ExecutionErrorType Text
- newExecutionError :: ExecutionErrorType -> Text -> ExecutionError
- data ExecutionResults = ExecutionResults' (Maybe (NonEmpty ExecutionStepResult)) (Maybe (NonEmpty ExecutionStepResult))
- newExecutionResults :: ExecutionResults
- data ExecutionStepResult = ExecutionStepResult' (Maybe ExecutionError) (Maybe Text) (Maybe WorkflowStepType)
- newExecutionStepResult :: ExecutionStepResult
- data FileLocation = FileLocation' (Maybe EfsFileLocation) (Maybe S3FileLocation)
- newFileLocation :: FileLocation
- data HomeDirectoryMapEntry = HomeDirectoryMapEntry' Text Text
- newHomeDirectoryMapEntry :: Text -> Text -> HomeDirectoryMapEntry
- data IdentityProviderDetails = IdentityProviderDetails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newIdentityProviderDetails :: IdentityProviderDetails
- data InputFileLocation = InputFileLocation' (Maybe EfsFileLocation) (Maybe S3InputFileLocation)
- newInputFileLocation :: InputFileLocation
- data ListedAccess = ListedAccess' (Maybe Text) (Maybe Text) (Maybe HomeDirectoryType) (Maybe Text)
- newListedAccess :: ListedAccess
- data ListedAgreement = ListedAgreement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AgreementStatusType)
- newListedAgreement :: ListedAgreement
- data ListedCertificate = ListedCertificate' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe CertificateStatusType) (Maybe CertificateType) (Maybe CertificateUsageType)
- newListedCertificate :: ListedCertificate
- data ListedConnector = ListedConnector' (Maybe Text) (Maybe Text) (Maybe Text)
- newListedConnector :: ListedConnector
- data ListedExecution = ListedExecution' (Maybe Text) (Maybe FileLocation) (Maybe ServiceMetadata) (Maybe ExecutionStatus)
- newListedExecution :: ListedExecution
- data ListedHostKey = ListedHostKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newListedHostKey :: Text -> ListedHostKey
- data ListedProfile = ListedProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProfileType)
- newListedProfile :: ListedProfile
- data ListedServer = ListedServer' (Maybe Domain) (Maybe EndpointType) (Maybe IdentityProviderType) (Maybe Text) (Maybe Text) (Maybe State) (Maybe Int) Text
- newListedServer :: Text -> ListedServer
- data ListedUser = ListedUser' (Maybe Text) (Maybe HomeDirectoryType) (Maybe Text) (Maybe Int) (Maybe Text) Text
- newListedUser :: Text -> ListedUser
- data ListedWorkflow = ListedWorkflow' (Maybe Text) (Maybe Text) (Maybe Text)
- newListedWorkflow :: ListedWorkflow
- data LoggingConfiguration = LoggingConfiguration' (Maybe Text) (Maybe Text)
- newLoggingConfiguration :: LoggingConfiguration
- data PosixProfile = PosixProfile' (Maybe [Natural]) Natural Natural
- newPosixProfile :: Natural -> Natural -> PosixProfile
- data ProtocolDetails = ProtocolDetails' (Maybe (NonEmpty As2Transport)) (Maybe Text) (Maybe SetStatOption) (Maybe TlsSessionResumptionMode)
- newProtocolDetails :: ProtocolDetails
- data S3FileLocation = S3FileLocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newS3FileLocation :: S3FileLocation
- data S3InputFileLocation = S3InputFileLocation' (Maybe Text) (Maybe Text)
- newS3InputFileLocation :: S3InputFileLocation
- data S3Tag = S3Tag' Text Text
- newS3Tag :: Text -> Text -> S3Tag
- data ServiceMetadata = ServiceMetadata' UserDetails
- newServiceMetadata :: UserDetails -> ServiceMetadata
- data SshPublicKey = SshPublicKey' POSIX Text Text
- newSshPublicKey :: UTCTime -> Text -> Text -> SshPublicKey
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TagStepDetails = TagStepDetails' (Maybe Text) (Maybe Text) (Maybe (NonEmpty S3Tag))
- newTagStepDetails :: TagStepDetails
- data UserDetails = UserDetails' (Maybe Text) Text Text
- newUserDetails :: Text -> Text -> UserDetails
- data WorkflowDetail = WorkflowDetail' Text Text
- newWorkflowDetail :: Text -> Text -> WorkflowDetail
- data WorkflowDetails = WorkflowDetails' (Maybe [WorkflowDetail]) (Maybe [WorkflowDetail])
- newWorkflowDetails :: WorkflowDetails
- data WorkflowStep = WorkflowStep' (Maybe CopyStepDetails) (Maybe CustomStepDetails) (Maybe DecryptStepDetails) (Maybe DeleteStepDetails) (Maybe TagStepDetails) (Maybe WorkflowStepType)
- newWorkflowStep :: WorkflowStep
Service Configuration
defaultService :: Service Source #
API version 2018-11-05
of the Amazon Transfer Family SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Transfer
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_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
_InternalServiceError :: AsError a => Fold a ServiceError Source #
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The NextToken
parameter that was passed is invalid.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the client submits a malformed request.
ResourceExistsException
_ResourceExistsException :: AsError a => Fold a ServiceError Source #
The requested resource does not exist.
ResourceNotFoundException
_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
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
ServerOffline
newServerOffline :: Wait DescribeServer Source #
Polls DescribeServer
every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
ServerOnline
newServerOnline :: Wait DescribeServer Source #
Polls DescribeServer
every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateAccess
data CreateAccess Source #
See: newCreateAccess
smart constructor.
CreateAccess' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) Text Text Text |
Instances
Create a value of CreateAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAccess
, createAccess_homeDirectory
- The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
CreateAccess
, createAccess_homeDirectoryMappings
- Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
The following is an Entry
and Target
pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to
lock down your user to the designated home directory ("chroot
"). To
do this, you can set Entry
to /
and set Target
to the
HomeDirectory
parameter value.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
CreateAccess
, createAccess_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.
CreateAccess
, createAccess_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}
.
This policy applies only when the domain of ServerId
is Amazon S3.
Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the
policy as a JSON blob and pass it in the Policy
argument.
For an example of a session policy, see Example session policy.
For more information, see AssumeRole in the Security Token Service API Reference.
CreateAccess
, createAccess_posixProfile
- Undocumented member.
CreateAccess
, createAccess_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.
CreateAccess
, createAccess_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
CreateAccess
, createAccess_externalId
- A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to
your Amazon S3 or Amazon EFS resources over the enabled protocols using
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: =,.@:/-
data CreateAccessResponse Source #
See: newCreateAccessResponse
smart constructor.
Instances
newCreateAccessResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateAccessResponse |
Create a value of CreateAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAccessResponse'
, createAccessResponse_httpStatus
- The response's http status code.
CreateAccess
, createAccessResponse_serverId
- The identifier of the server that the user is attached to.
CreateAccess
, createAccessResponse_externalId
- The external identifier of the group whose users have access to your
Amazon S3 or Amazon EFS resources over the enabled protocols using
Transfer Family.
CreateAgreement
data CreateAgreement Source #
See: newCreateAgreement
smart constructor.
CreateAgreement' (Maybe Text) (Maybe AgreementStatusType) (Maybe (NonEmpty Tag)) Text Text Text Text Text |
Instances
Create a value of CreateAgreement
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:
CreateAgreement
, createAgreement_description
- A name or short description to identify the agreement.
CreateAgreement
, createAgreement_status
- The status of the agreement. The agreement can be either ACTIVE
or
INACTIVE
.
CreateAgreement
, createAgreement_tags
- Key-value pairs that can be used to group and search for agreements.
CreateAgreement
, createAgreement_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
CreateAgreement
, createAgreement_localProfileId
- A unique identifier for the AS2 local profile.
CreateAgreement
, createAgreement_partnerProfileId
- A unique identifier for the partner profile used in the agreement.
CreateAgreement
, createAgreement_baseDirectory
- The landing directory (folder) for files transferred by using the AS2
protocol.
A BaseDirectory
example is
DOC-EXAMPLE-BUCKET/home/mydirectory.
CreateAgreement
, createAgreement_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
.
data CreateAgreementResponse Source #
See: newCreateAgreementResponse
smart constructor.
Instances
newCreateAgreementResponse Source #
:: Int | |
-> Text | |
-> CreateAgreementResponse |
Create a value of CreateAgreementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAgreementResponse'
, createAgreementResponse_httpStatus
- The response's http status code.
CreateAgreementResponse
, createAgreementResponse_agreementId
- The unique identifier for the agreement. Use this ID for deleting, or
updating an agreement, as well as in any other API calls that require
that you specify the agreement ID.
CreateConnector
data CreateConnector Source #
See: newCreateConnector
smart constructor.
Instances
Create a value of CreateConnector
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:
CreateConnector
, createConnector_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.
CreateConnector
, createConnector_tags
- Key-value pairs that can be used to group and search for connectors.
Tags are metadata attached to connectors for any purpose.
CreateConnector
, createConnector_url
- The URL of the partner's AS2 endpoint.
CreateConnector
, createConnector_as2Config
- A structure that contains the parameters for a connector object.
CreateConnector
, createConnector_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
.
data CreateConnectorResponse Source #
See: newCreateConnectorResponse
smart constructor.
Instances
newCreateConnectorResponse Source #
:: Int | |
-> Text | |
-> CreateConnectorResponse |
Create a value of CreateConnectorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateConnectorResponse'
, createConnectorResponse_httpStatus
- The response's http status code.
CreateConnectorResponse
, createConnectorResponse_connectorId
- The unique identifier for the connector, returned after the API call
succeeds.
CreateProfile
data CreateProfile Source #
See: newCreateProfile
smart constructor.
CreateProfile' (Maybe [Text]) (Maybe (NonEmpty Tag)) Text ProfileType |
Instances
Create a value of CreateProfile
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:
CreateProfile
, createProfile_certificateIds
- An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
CreateProfile
, createProfile_tags
- Key-value pairs that can be used to group and search for AS2 profiles.
CreateProfile
, createProfile_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.
CreateProfile
, createProfile_profileType
- Determines the type of profile to create:
- Specify
LOCAL
to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party. - Specify
PARTNER
to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.
data CreateProfileResponse Source #
See: newCreateProfileResponse
smart constructor.
Instances
newCreateProfileResponse Source #
Create a value of CreateProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateProfileResponse'
, createProfileResponse_httpStatus
- The response's http status code.
CreateProfileResponse
, createProfileResponse_profileId
- The unique identifier for the AS2 profile, returned after the API call
succeeds.
CreateServer
data CreateServer Source #
See: newCreateServer
smart constructor.
CreateServer' (Maybe Text) (Maybe Domain) (Maybe EndpointDetails) (Maybe EndpointType) (Maybe (Sensitive Text)) (Maybe IdentityProviderDetails) (Maybe IdentityProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProtocolDetails) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe WorkflowDetails) |
Instances
newCreateServer :: CreateServer Source #
Create a value of CreateServer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateServer
, createServer_certificate
- The Amazon Resource Name (ARN) of the Certificate Manager (ACM)
certificate. Required when Protocols
is set to FTPS
.
To request a new public certificate, see Request a public certificate in the Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
- 2048-bit RSA (RSA_2048)
- 4096-bit RSA (RSA_4096)
- Elliptic Prime Curve 256 bit (EC_prime256v1)
- Elliptic Prime Curve 384 bit (EC_secp384r1)
- Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
CreateServer
, createServer_domain
- The domain of the storage system that is used for file transfers. There
are two domains available: Amazon Simple Storage Service (Amazon S3) and
Amazon Elastic File System (Amazon EFS). The default value is S3.
After the server is created, the domain cannot be changed.
CreateServer
, createServer_endpointDetails
- The virtual private cloud (VPC) endpoint settings that are configured
for your server. When you host your endpoint within your VPC, you can
make 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.
CreateServer
, createServer_endpointType
- The type of endpoint that you want your server to use. You can choose to
make your server's endpoint publicly accessible (PUBLIC) or host it
inside your VPC. With an endpoint that is hosted in a VPC, you can
restrict access to your server and resources only within your VPC or
choose to make it internet facing by attaching Elastic IP addresses
directly to it.
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your Amazon Web Services account if your
account hasn't already done so before May 19, 2021. If you have already
created servers with EndpointType=VPC_ENDPOINT
in your Amazon Web
Services account on or before May 19, 2021, you will not be affected.
After this date, use EndpointType
=VPC
.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC
as the EndpointType
. With this
endpoint type, you have the option to directly associate up to three
Elastic IPv4 addresses (BYO IP included) with your server's endpoint
and use VPC security groups to restrict traffic by the client's public
IP address. This is not possible with EndpointType
set to
VPC_ENDPOINT
.
$sel:hostKey:CreateServer'
, createServer_hostKey
- The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled
server. You can add multiple host keys, in case you want to rotate keys,
or have a set of active keys that use different algorithms.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.
Use a minimum value of 2048 for the -b
option. You can create a
stronger key by using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.
Valid values for the -b
option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.
For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Update host keys for your SFTP-enabled server in the Transfer Family User Guide.
CreateServer
, createServer_identityProviderDetails
- Required when IdentityProviderType
is set to AWS_DIRECTORY_SERVICE
or API_GATEWAY
. Accepts an array containing all of the information
required to use a directory in AWS_DIRECTORY_SERVICE
or invoke a
customer-supplied authentication API, including the API Gateway URL. Not
required when IdentityProviderType
is set to SERVICE_MANAGED
.
CreateServer
, createServer_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.
CreateServer
, createServer_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.
CreateServer
, createServer_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.
CreateServer
, createServer_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.
CreateServer
, createServer_protocolDetails
- The protocol settings that are configured for your server.
- To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIp
parameter. 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
SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. - To determine whether your Transfer Family server resumes recent,
negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
CreateServer
, createServer_protocols
- Specifies the file transfer protocol or protocols over which your file
transfer protocol client can connect to your server's endpoint. The
available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over 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
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must beAWS_DIRECTORY_SERVICE
orAPI_GATEWAY
. - If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. - If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set toSERVICE_MANAGED
. - If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
CreateServer
, createServer_securityPolicyName
- Specifies the name of the security policy that is attached to the
server.
CreateServer
, createServer_tags
- Key-value pairs that can be used to group and search for servers.
CreateServer
, createServer_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.
data CreateServerResponse Source #
See: newCreateServerResponse
smart constructor.
Instances
newCreateServerResponse Source #
Create a value of CreateServerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateServerResponse'
, createServerResponse_httpStatus
- The response's http status code.
CreateServerResponse
, createServerResponse_serverId
- The service-assigned identifier of the server that is created.
CreateUser
data CreateUser Source #
See: newCreateUser
smart constructor.
CreateUser' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) (Maybe (NonEmpty Tag)) Text Text Text |
Instances
Create a value of CreateUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUser
, createUser_homeDirectory
- The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
CreateUser
, createUser_homeDirectoryMappings
- Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
The following is an Entry
and Target
pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to
lock your user down to the designated home directory ("chroot
"). To
do this, you can set Entry
to /
and set Target
to the
HomeDirectory parameter value.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
CreateUser
, createUser_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.
CreateUser
, createUser_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}
.
This policy applies only when the domain of ServerId
is Amazon S3.
Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the
policy as a JSON blob and pass it in the Policy
argument.
For an example of a session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
CreateUser
, createUser_posixProfile
- Specifies the full POSIX identity, including user ID (Uid
), group ID
(Gid
), and any secondary groups IDs (SecondaryGids
), that controls
your users' access to your Amazon EFS file systems. The POSIX
permissions that are set on files and directories in Amazon EFS
determine the level of access your users get when transferring files
into and out of your Amazon EFS file systems.
CreateUser
, createUser_sshPublicKeyBody
- The public portion of the Secure Shell (SSH) key used to authenticate
the user to the server.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
CreateUser
, createUser_tags
- Key-value pairs that can be used to group and search for users. Tags are
metadata attached to users for any purpose.
CreateUser
, createUser_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.
CreateUser
, createUser_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
CreateUser
, createUser_userName
- A unique string that identifies a user and is associated with a
ServerId
. This user name must be a minimum of 3 and a maximum of 100
characters long. The following are valid characters: a-z, A-Z, 0-9,
underscore '_', hyphen '-', period '.', and at sign '@'. The
user name can't start with a hyphen, period, or at sign.
data CreateUserResponse Source #
See: newCreateUserResponse
smart constructor.
Instances
newCreateUserResponse Source #
Create a value of CreateUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateUserResponse'
, createUserResponse_httpStatus
- The response's http status code.
CreateUser
, createUserResponse_serverId
- The identifier of the server that the user is attached to.
CreateUser
, createUserResponse_userName
- A unique string that identifies a user account associated with a server.
CreateWorkflow
data CreateWorkflow Source #
See: newCreateWorkflow
smart constructor.
CreateWorkflow' (Maybe Text) (Maybe [WorkflowStep]) (Maybe (NonEmpty Tag)) [WorkflowStep] |
Instances
newCreateWorkflow :: CreateWorkflow Source #
Create a value of CreateWorkflow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorkflow
, createWorkflow_description
- A textual description for the workflow.
CreateWorkflow
, createWorkflow_onExceptionSteps
- Specifies the steps (actions) to take if errors are encountered during
execution of the workflow.
For custom steps, the lambda function needs to send FAILURE
to the
call back API to kick off the exception steps. Additionally, if the
lambda does not send SUCCESS
before it times out, the exception steps
are executed.
CreateWorkflow
, createWorkflow_tags
- Key-value pairs that can be used to group and search for workflows. Tags
are metadata attached to workflows for any purpose.
CreateWorkflow
, createWorkflow_steps
- Specifies the details for the steps that are in the specified workflow.
The TYPE
specifies which of the following actions is being taken for
this step.
- COPY: Copy the file to another location.
- CUSTOM: Perform a custom step with an Lambda function target.
- DELETE: Delete the file.
- TAG: Add a tag to the file.
Currently, copying and tagging are supported only on S3.
For file location, you specify either the S3 bucket and key, or the EFS file system ID and path.
data CreateWorkflowResponse Source #
See: newCreateWorkflowResponse
smart constructor.
Instances
newCreateWorkflowResponse Source #
Create a value of CreateWorkflowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateWorkflowResponse'
, createWorkflowResponse_httpStatus
- The response's http status code.
CreateWorkflowResponse
, createWorkflowResponse_workflowId
- A unique identifier for the workflow.
DeleteAccess
data DeleteAccess Source #
See: newDeleteAccess
smart constructor.
Instances
Create a value of DeleteAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAccess
, deleteAccess_serverId
- A system-assigned unique identifier for a server that has this user
assigned.
DeleteAccess
, deleteAccess_externalId
- A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to
your Amazon S3 or Amazon EFS resources over the enabled protocols using
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: =,.@:/-
data DeleteAccessResponse Source #
See: newDeleteAccessResponse
smart constructor.
Instances
Generic DeleteAccessResponse Source # | |
Defined in Amazonka.Transfer.DeleteAccess type Rep DeleteAccessResponse :: Type -> Type # from :: DeleteAccessResponse -> Rep DeleteAccessResponse x # to :: Rep DeleteAccessResponse x -> DeleteAccessResponse # | |
Read DeleteAccessResponse Source # | |
Show DeleteAccessResponse Source # | |
Defined in Amazonka.Transfer.DeleteAccess showsPrec :: Int -> DeleteAccessResponse -> ShowS # show :: DeleteAccessResponse -> String # showList :: [DeleteAccessResponse] -> ShowS # | |
NFData DeleteAccessResponse Source # | |
Defined in Amazonka.Transfer.DeleteAccess rnf :: DeleteAccessResponse -> () # | |
Eq DeleteAccessResponse Source # | |
Defined in Amazonka.Transfer.DeleteAccess (==) :: DeleteAccessResponse -> DeleteAccessResponse -> Bool # (/=) :: DeleteAccessResponse -> DeleteAccessResponse -> Bool # | |
type Rep DeleteAccessResponse Source # | |
newDeleteAccessResponse :: DeleteAccessResponse Source #
Create a value of DeleteAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteAgreement
data DeleteAgreement Source #
See: newDeleteAgreement
smart constructor.
Instances
Create a value of DeleteAgreement
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:
DeleteAgreement
, deleteAgreement_agreementId
- A unique identifier for the agreement. This identifier is returned when
you create an agreement.
DeleteAgreement
, deleteAgreement_serverId
- The server identifier associated with the agreement that you are
deleting.
data DeleteAgreementResponse Source #
See: newDeleteAgreementResponse
smart constructor.
Instances
Generic DeleteAgreementResponse Source # | |
Defined in Amazonka.Transfer.DeleteAgreement type Rep DeleteAgreementResponse :: Type -> Type # | |
Read DeleteAgreementResponse Source # | |
Show DeleteAgreementResponse Source # | |
Defined in Amazonka.Transfer.DeleteAgreement showsPrec :: Int -> DeleteAgreementResponse -> ShowS # show :: DeleteAgreementResponse -> String # showList :: [DeleteAgreementResponse] -> ShowS # | |
NFData DeleteAgreementResponse Source # | |
Defined in Amazonka.Transfer.DeleteAgreement rnf :: DeleteAgreementResponse -> () # | |
Eq DeleteAgreementResponse Source # | |
Defined in Amazonka.Transfer.DeleteAgreement | |
type Rep DeleteAgreementResponse Source # | |
newDeleteAgreementResponse :: DeleteAgreementResponse Source #
Create a value of DeleteAgreementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCertificate
data DeleteCertificate Source #
See: newDeleteCertificate
smart constructor.
Instances
Create a value of DeleteCertificate
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:
DeleteCertificate
, deleteCertificate_certificateId
- The identifier of the certificate object that you are deleting.
data DeleteCertificateResponse Source #
See: newDeleteCertificateResponse
smart constructor.
Instances
Generic DeleteCertificateResponse Source # | |
Defined in Amazonka.Transfer.DeleteCertificate type Rep DeleteCertificateResponse :: Type -> Type # | |
Read DeleteCertificateResponse Source # | |
Show DeleteCertificateResponse Source # | |
Defined in Amazonka.Transfer.DeleteCertificate showsPrec :: Int -> DeleteCertificateResponse -> ShowS # show :: DeleteCertificateResponse -> String # showList :: [DeleteCertificateResponse] -> ShowS # | |
NFData DeleteCertificateResponse Source # | |
Defined in Amazonka.Transfer.DeleteCertificate rnf :: DeleteCertificateResponse -> () # | |
Eq DeleteCertificateResponse Source # | |
type Rep DeleteCertificateResponse Source # | |
Defined in Amazonka.Transfer.DeleteCertificate |
newDeleteCertificateResponse :: DeleteCertificateResponse Source #
Create a value of DeleteCertificateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteConnector
data DeleteConnector Source #
See: newDeleteConnector
smart constructor.
Instances
Create a value of DeleteConnector
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:
DeleteConnector
, deleteConnector_connectorId
- The unique identifier for the connector.
data DeleteConnectorResponse Source #
See: newDeleteConnectorResponse
smart constructor.
Instances
Generic DeleteConnectorResponse Source # | |
Defined in Amazonka.Transfer.DeleteConnector type Rep DeleteConnectorResponse :: Type -> Type # | |
Read DeleteConnectorResponse Source # | |
Show DeleteConnectorResponse Source # | |
Defined in Amazonka.Transfer.DeleteConnector showsPrec :: Int -> DeleteConnectorResponse -> ShowS # show :: DeleteConnectorResponse -> String # showList :: [DeleteConnectorResponse] -> ShowS # | |
NFData DeleteConnectorResponse Source # | |
Defined in Amazonka.Transfer.DeleteConnector rnf :: DeleteConnectorResponse -> () # | |
Eq DeleteConnectorResponse Source # | |
Defined in Amazonka.Transfer.DeleteConnector | |
type Rep DeleteConnectorResponse Source # | |
newDeleteConnectorResponse :: DeleteConnectorResponse Source #
Create a value of DeleteConnectorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteHostKey
data DeleteHostKey Source #
See: newDeleteHostKey
smart constructor.
Instances
Create a value of DeleteHostKey
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:
DeleteHostKey
, deleteHostKey_serverId
- The identifier of the server that contains the host key that you are
deleting.
DeleteHostKey
, deleteHostKey_hostKeyId
- The identifier of the host key that you are deleting.
data DeleteHostKeyResponse Source #
See: newDeleteHostKeyResponse
smart constructor.
Instances
Generic DeleteHostKeyResponse Source # | |
Defined in Amazonka.Transfer.DeleteHostKey type Rep DeleteHostKeyResponse :: Type -> Type # | |
Read DeleteHostKeyResponse Source # | |
Show DeleteHostKeyResponse Source # | |
Defined in Amazonka.Transfer.DeleteHostKey showsPrec :: Int -> DeleteHostKeyResponse -> ShowS # show :: DeleteHostKeyResponse -> String # showList :: [DeleteHostKeyResponse] -> ShowS # | |
NFData DeleteHostKeyResponse Source # | |
Defined in Amazonka.Transfer.DeleteHostKey rnf :: DeleteHostKeyResponse -> () # | |
Eq DeleteHostKeyResponse Source # | |
Defined in Amazonka.Transfer.DeleteHostKey (==) :: DeleteHostKeyResponse -> DeleteHostKeyResponse -> Bool # (/=) :: DeleteHostKeyResponse -> DeleteHostKeyResponse -> Bool # | |
type Rep DeleteHostKeyResponse Source # | |
newDeleteHostKeyResponse :: DeleteHostKeyResponse Source #
Create a value of DeleteHostKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteProfile
data DeleteProfile Source #
See: newDeleteProfile
smart constructor.
Instances
Create a value of DeleteProfile
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:
DeleteProfile
, deleteProfile_profileId
- The identifier of the profile that you are deleting.
data DeleteProfileResponse Source #
See: newDeleteProfileResponse
smart constructor.
Instances
Generic DeleteProfileResponse Source # | |
Defined in Amazonka.Transfer.DeleteProfile type Rep DeleteProfileResponse :: Type -> Type # | |
Read DeleteProfileResponse Source # | |
Show DeleteProfileResponse Source # | |
Defined in Amazonka.Transfer.DeleteProfile showsPrec :: Int -> DeleteProfileResponse -> ShowS # show :: DeleteProfileResponse -> String # showList :: [DeleteProfileResponse] -> ShowS # | |
NFData DeleteProfileResponse Source # | |
Defined in Amazonka.Transfer.DeleteProfile rnf :: DeleteProfileResponse -> () # | |
Eq DeleteProfileResponse Source # | |
Defined in Amazonka.Transfer.DeleteProfile (==) :: DeleteProfileResponse -> DeleteProfileResponse -> Bool # (/=) :: DeleteProfileResponse -> DeleteProfileResponse -> Bool # | |
type Rep DeleteProfileResponse Source # | |
newDeleteProfileResponse :: DeleteProfileResponse Source #
Create a value of DeleteProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteServer
data DeleteServer Source #
See: newDeleteServer
smart constructor.
Instances
Create a value of DeleteServer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteServer
, deleteServer_serverId
- A unique system-assigned identifier for a server instance.
data DeleteServerResponse Source #
See: newDeleteServerResponse
smart constructor.
Instances
Generic DeleteServerResponse Source # | |
Defined in Amazonka.Transfer.DeleteServer type Rep DeleteServerResponse :: Type -> Type # from :: DeleteServerResponse -> Rep DeleteServerResponse x # to :: Rep DeleteServerResponse x -> DeleteServerResponse # | |
Read DeleteServerResponse Source # | |
Show DeleteServerResponse Source # | |
Defined in Amazonka.Transfer.DeleteServer showsPrec :: Int -> DeleteServerResponse -> ShowS # show :: DeleteServerResponse -> String # showList :: [DeleteServerResponse] -> ShowS # | |
NFData DeleteServerResponse Source # | |
Defined in Amazonka.Transfer.DeleteServer rnf :: DeleteServerResponse -> () # | |
Eq DeleteServerResponse Source # | |
Defined in Amazonka.Transfer.DeleteServer (==) :: DeleteServerResponse -> DeleteServerResponse -> Bool # (/=) :: DeleteServerResponse -> DeleteServerResponse -> Bool # | |
type Rep DeleteServerResponse Source # | |
newDeleteServerResponse :: DeleteServerResponse Source #
Create a value of DeleteServerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteSshPublicKey
data DeleteSshPublicKey Source #
See: newDeleteSshPublicKey
smart constructor.
Instances
newDeleteSshPublicKey Source #
Create a value of DeleteSshPublicKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSshPublicKey
, deleteSshPublicKey_serverId
- A system-assigned unique identifier for a file transfer protocol-enabled
server instance that has the user assigned to it.
DeleteSshPublicKey
, deleteSshPublicKey_sshPublicKeyId
- A unique identifier used to reference your user's specific SSH key.
DeleteSshPublicKey
, deleteSshPublicKey_userName
- A unique string that identifies a user whose public key is being
deleted.
data DeleteSshPublicKeyResponse Source #
See: newDeleteSshPublicKeyResponse
smart constructor.
Instances
newDeleteSshPublicKeyResponse :: DeleteSshPublicKeyResponse Source #
Create a value of DeleteSshPublicKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteUser
data DeleteUser Source #
See: newDeleteUser
smart constructor.
Instances
Create a value of DeleteUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteUser
, deleteUser_serverId
- A system-assigned unique identifier for a server instance that has the
user assigned to it.
DeleteUser
, deleteUser_userName
- A unique string that identifies a user that is being deleted from a
server.
data DeleteUserResponse Source #
See: newDeleteUserResponse
smart constructor.
Instances
Generic DeleteUserResponse Source # | |
Defined in Amazonka.Transfer.DeleteUser type Rep DeleteUserResponse :: Type -> Type # from :: DeleteUserResponse -> Rep DeleteUserResponse x # to :: Rep DeleteUserResponse x -> DeleteUserResponse # | |
Read DeleteUserResponse Source # | |
Defined in Amazonka.Transfer.DeleteUser | |
Show DeleteUserResponse Source # | |
Defined in Amazonka.Transfer.DeleteUser showsPrec :: Int -> DeleteUserResponse -> ShowS # show :: DeleteUserResponse -> String # showList :: [DeleteUserResponse] -> ShowS # | |
NFData DeleteUserResponse Source # | |
Defined in Amazonka.Transfer.DeleteUser rnf :: DeleteUserResponse -> () # | |
Eq DeleteUserResponse Source # | |
Defined in Amazonka.Transfer.DeleteUser (==) :: DeleteUserResponse -> DeleteUserResponse -> Bool # (/=) :: DeleteUserResponse -> DeleteUserResponse -> Bool # | |
type Rep DeleteUserResponse Source # | |
newDeleteUserResponse :: DeleteUserResponse Source #
Create a value of DeleteUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteWorkflow
data DeleteWorkflow Source #
See: newDeleteWorkflow
smart constructor.
Instances
Create a value of DeleteWorkflow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWorkflow
, deleteWorkflow_workflowId
- A unique identifier for the workflow.
data DeleteWorkflowResponse Source #
See: newDeleteWorkflowResponse
smart constructor.
Instances
Generic DeleteWorkflowResponse Source # | |
Defined in Amazonka.Transfer.DeleteWorkflow type Rep DeleteWorkflowResponse :: Type -> Type # | |
Read DeleteWorkflowResponse Source # | |
Show DeleteWorkflowResponse Source # | |
Defined in Amazonka.Transfer.DeleteWorkflow showsPrec :: Int -> DeleteWorkflowResponse -> ShowS # show :: DeleteWorkflowResponse -> String # showList :: [DeleteWorkflowResponse] -> ShowS # | |
NFData DeleteWorkflowResponse Source # | |
Defined in Amazonka.Transfer.DeleteWorkflow rnf :: DeleteWorkflowResponse -> () # | |
Eq DeleteWorkflowResponse Source # | |
Defined in Amazonka.Transfer.DeleteWorkflow | |
type Rep DeleteWorkflowResponse Source # | |
newDeleteWorkflowResponse :: DeleteWorkflowResponse Source #
Create a value of DeleteWorkflowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeAccess
data DescribeAccess Source #
See: newDescribeAccess
smart constructor.
Instances
Create a value of DescribeAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAccess
, describeAccess_serverId
- A system-assigned unique identifier for a server that has this access
assigned.
DescribeAccess
, describeAccess_externalId
- A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to
your Amazon S3 or Amazon EFS resources over the enabled protocols using
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: =,.@:/-
data DescribeAccessResponse Source #
See: newDescribeAccessResponse
smart constructor.
Instances
newDescribeAccessResponse Source #
:: Int | |
-> Text | |
-> DescribedAccess | |
-> DescribeAccessResponse |
Create a value of DescribeAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeAccessResponse'
, describeAccessResponse_httpStatus
- The response's http status code.
DescribeAccess
, describeAccessResponse_serverId
- A system-assigned unique identifier for a server that has this access
assigned.
$sel:access:DescribeAccessResponse'
, describeAccessResponse_access
- The external identifier of the server that the access is attached to.
DescribeAgreement
data DescribeAgreement Source #
See: newDescribeAgreement
smart constructor.
Instances
Create a value of DescribeAgreement
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:
DescribeAgreement
, describeAgreement_agreementId
- A unique identifier for the agreement. This identifier is returned when
you create an agreement.
DescribeAgreement
, describeAgreement_serverId
- The server identifier that's associated with the agreement.
data DescribeAgreementResponse Source #
See: newDescribeAgreementResponse
smart constructor.
Instances
newDescribeAgreementResponse Source #
Create a value of DescribeAgreementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeAgreementResponse'
, describeAgreementResponse_httpStatus
- The response's http status code.
$sel:agreement:DescribeAgreementResponse'
, describeAgreementResponse_agreement
- The details for the specified agreement, returned as a
DescribedAgreement
object.
DescribeCertificate
data DescribeCertificate Source #
See: newDescribeCertificate
smart constructor.
Instances
newDescribeCertificate Source #
Create a value of DescribeCertificate
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:
DescribeCertificate
, describeCertificate_certificateId
- An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
data DescribeCertificateResponse Source #
See: newDescribeCertificateResponse
smart constructor.
Instances
newDescribeCertificateResponse Source #
Create a value of DescribeCertificateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeCertificateResponse'
, describeCertificateResponse_httpStatus
- The response's http status code.
DescribeCertificateResponse
, describeCertificateResponse_certificate
- The details for the specified certificate, returned as an object.
DescribeConnector
data DescribeConnector Source #
See: newDescribeConnector
smart constructor.
Instances
Create a value of DescribeConnector
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:
DescribeConnector
, describeConnector_connectorId
- The unique identifier for the connector.
data DescribeConnectorResponse Source #
See: newDescribeConnectorResponse
smart constructor.
Instances
newDescribeConnectorResponse Source #
Create a value of DescribeConnectorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeConnectorResponse'
, describeConnectorResponse_httpStatus
- The response's http status code.
$sel:connector:DescribeConnectorResponse'
, describeConnectorResponse_connector
- The structure that contains the details of the connector.
DescribeExecution
data DescribeExecution Source #
See: newDescribeExecution
smart constructor.
Instances
Create a value of DescribeExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeExecution
, describeExecution_executionId
- A unique identifier for the execution of a workflow.
DescribeExecution
, describeExecution_workflowId
- A unique identifier for the workflow.
data DescribeExecutionResponse Source #
See: newDescribeExecutionResponse
smart constructor.
Instances
newDescribeExecutionResponse Source #
Create a value of DescribeExecutionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeExecutionResponse'
, describeExecutionResponse_httpStatus
- The response's http status code.
DescribeExecution
, describeExecutionResponse_workflowId
- A unique identifier for the workflow.
$sel:execution:DescribeExecutionResponse'
, describeExecutionResponse_execution
- The structure that contains the details of the workflow' execution.
DescribeHostKey
data DescribeHostKey Source #
See: newDescribeHostKey
smart constructor.
Instances
Create a value of DescribeHostKey
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:
DescribeHostKey
, describeHostKey_serverId
- The identifier of the server that contains the host key that you want
described.
DescribeHostKey
, describeHostKey_hostKeyId
- The identifier of the host key that you want described.
data DescribeHostKeyResponse Source #
See: newDescribeHostKeyResponse
smart constructor.
Instances
newDescribeHostKeyResponse Source #
Create a value of DescribeHostKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeHostKeyResponse'
, describeHostKeyResponse_httpStatus
- The response's http status code.
$sel:hostKey:DescribeHostKeyResponse'
, describeHostKeyResponse_hostKey
- Returns the details for the specified host key.
DescribeProfile
data DescribeProfile Source #
See: newDescribeProfile
smart constructor.
Instances
Create a value of DescribeProfile
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:
DescribeProfile
, describeProfile_profileId
- The identifier of the profile that you want described.
data DescribeProfileResponse Source #
See: newDescribeProfileResponse
smart constructor.
Instances
newDescribeProfileResponse Source #
Create a value of DescribeProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeProfileResponse'
, describeProfileResponse_httpStatus
- The response's http status code.
$sel:profile:DescribeProfileResponse'
, describeProfileResponse_profile
- The details of the specified profile, returned as an object.
DescribeSecurityPolicy
data DescribeSecurityPolicy Source #
See: newDescribeSecurityPolicy
smart constructor.
Instances
newDescribeSecurityPolicy Source #
Create a value of DescribeSecurityPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSecurityPolicy
, describeSecurityPolicy_securityPolicyName
- Specifies the name of the security policy that is attached to the
server.
data DescribeSecurityPolicyResponse Source #
See: newDescribeSecurityPolicyResponse
smart constructor.
Instances
Generic DescribeSecurityPolicyResponse Source # | |
Read DescribeSecurityPolicyResponse Source # | |
Show DescribeSecurityPolicyResponse Source # | |
Defined in Amazonka.Transfer.DescribeSecurityPolicy | |
NFData DescribeSecurityPolicyResponse Source # | |
Defined in Amazonka.Transfer.DescribeSecurityPolicy rnf :: DescribeSecurityPolicyResponse -> () # | |
Eq DescribeSecurityPolicyResponse Source # | |
type Rep DescribeSecurityPolicyResponse Source # | |
Defined in Amazonka.Transfer.DescribeSecurityPolicy type Rep DescribeSecurityPolicyResponse = D1 ('MetaData "DescribeSecurityPolicyResponse" "Amazonka.Transfer.DescribeSecurityPolicy" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeSecurityPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedSecurityPolicy))) |
newDescribeSecurityPolicyResponse Source #
Create a value of DescribeSecurityPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeSecurityPolicyResponse'
, describeSecurityPolicyResponse_httpStatus
- The response's http status code.
$sel:securityPolicy:DescribeSecurityPolicyResponse'
, describeSecurityPolicyResponse_securityPolicy
- An array containing the properties of the security policy.
DescribeServer
data DescribeServer Source #
See: newDescribeServer
smart constructor.
Instances
Create a value of DescribeServer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeServer
, describeServer_serverId
- A system-assigned unique identifier for a server.
data DescribeServerResponse Source #
See: newDescribeServerResponse
smart constructor.
Instances
newDescribeServerResponse Source #
Create a value of DescribeServerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeServerResponse'
, describeServerResponse_httpStatus
- The response's http status code.
$sel:server:DescribeServerResponse'
, describeServerResponse_server
- An array containing the properties of a server with the ServerID
you
specified.
DescribeUser
data DescribeUser Source #
See: newDescribeUser
smart constructor.
Instances
Create a value of DescribeUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUser
, describeUser_serverId
- A system-assigned unique identifier for a server that has this user
assigned.
DescribeUser
, describeUser_userName
- The name of the user assigned to one or more servers. User names are
part of the sign-in credentials to use the Transfer Family service and
perform file transfer tasks.
data DescribeUserResponse Source #
See: newDescribeUserResponse
smart constructor.
Instances
newDescribeUserResponse Source #
:: Int | |
-> Text | |
-> DescribedUser | |
-> DescribeUserResponse |
Create a value of DescribeUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeUserResponse'
, describeUserResponse_httpStatus
- The response's http status code.
DescribeUser
, describeUserResponse_serverId
- A system-assigned unique identifier for a server that has this user
assigned.
$sel:user:DescribeUserResponse'
, describeUserResponse_user
- An array containing the properties of the user account for the
ServerID
value that you specified.
DescribeWorkflow
data DescribeWorkflow Source #
See: newDescribeWorkflow
smart constructor.
Instances
Create a value of DescribeWorkflow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWorkflow
, describeWorkflow_workflowId
- A unique identifier for the workflow.
data DescribeWorkflowResponse Source #
See: newDescribeWorkflowResponse
smart constructor.
Instances
newDescribeWorkflowResponse Source #
Create a value of DescribeWorkflowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeWorkflowResponse'
, describeWorkflowResponse_httpStatus
- The response's http status code.
$sel:workflow:DescribeWorkflowResponse'
, describeWorkflowResponse_workflow
- The structure that contains the details of the workflow.
ImportCertificate
data ImportCertificate Source #
See: newImportCertificate
smart constructor.
ImportCertificate' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) CertificateUsageType (Sensitive Text) |
Instances
Create a value of ImportCertificate
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:
ImportCertificate
, importCertificate_activeDate
- An optional date that specifies when the certificate becomes active.
ImportCertificate
, importCertificate_certificateChain
- An optional list of certificates that make up the chain for the
certificate that's being imported.
ImportCertificate
, importCertificate_description
- A short description that helps identify the certificate.
ImportCertificate
, importCertificate_inactiveDate
- An optional date that specifies when the certificate becomes inactive.
$sel:privateKey:ImportCertificate'
, importCertificate_privateKey
- The file that contains the private key for the certificate that's being
imported.
ImportCertificate
, importCertificate_tags
- Key-value pairs that can be used to group and search for certificates.
ImportCertificate
, importCertificate_usage
- Specifies whether this certificate is used for signing or encryption.
ImportCertificate
, importCertificate_certificate
- The file that contains the certificate to import.
data ImportCertificateResponse Source #
See: newImportCertificateResponse
smart constructor.
Instances
newImportCertificateResponse Source #
:: Int | |
-> Text | |
-> ImportCertificateResponse |
Create a value of ImportCertificateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ImportCertificateResponse'
, importCertificateResponse_httpStatus
- The response's http status code.
ImportCertificateResponse
, importCertificateResponse_certificateId
- An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
ImportHostKey
data ImportHostKey Source #
See: newImportHostKey
smart constructor.
Instances
Create a value of ImportHostKey
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:
ImportHostKey
, importHostKey_description
- The text description that identifies this host key.
ImportHostKey
, importHostKey_tags
- Key-value pairs that can be used to group and search for host keys.
ImportHostKey
, importHostKey_serverId
- The identifier of the server that contains the host key that you are
importing.
$sel:hostKeyBody:ImportHostKey'
, importHostKey_hostKeyBody
- The public key portion of an SSH key pair.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
data ImportHostKeyResponse Source #
See: newImportHostKeyResponse
smart constructor.
Instances
newImportHostKeyResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> ImportHostKeyResponse |
Create a value of ImportHostKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ImportHostKeyResponse'
, importHostKeyResponse_httpStatus
- The response's http status code.
ImportHostKey
, importHostKeyResponse_serverId
- Returns the server identifier that contains the imported key.
ImportHostKeyResponse
, importHostKeyResponse_hostKeyId
- Returns the host key identifier for the imported key.
ImportSshPublicKey
data ImportSshPublicKey Source #
See: newImportSshPublicKey
smart constructor.
Instances
newImportSshPublicKey Source #
Create a value of ImportSshPublicKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ImportSshPublicKey
, importSshPublicKey_serverId
- A system-assigned unique identifier for a server.
ImportSshPublicKey
, importSshPublicKey_sshPublicKeyBody
- The public key portion of an SSH key pair.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
ImportSshPublicKey
, importSshPublicKey_userName
- The name of the user account that is assigned to one or more servers.
data ImportSshPublicKeyResponse Source #
Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.
See: newImportSshPublicKeyResponse
smart constructor.
Instances
newImportSshPublicKeyResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> ImportSshPublicKeyResponse |
Create a value of ImportSshPublicKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ImportSshPublicKeyResponse'
, importSshPublicKeyResponse_httpStatus
- The response's http status code.
ImportSshPublicKey
, importSshPublicKeyResponse_serverId
- A system-assigned unique identifier for a server.
ImportSshPublicKeyResponse
, importSshPublicKeyResponse_sshPublicKeyId
- The name given to a public key by the system that was imported.
ImportSshPublicKey
, importSshPublicKeyResponse_userName
- A user name assigned to the ServerID
value that you specified.
ListAccesses (Paginated)
data ListAccesses Source #
See: newListAccesses
smart constructor.
Instances
Create a value of ListAccesses
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAccesses'
, listAccesses_maxResults
- Specifies the maximum number of access SIDs to return.
ListAccesses
, listAccesses_nextToken
- When you can get additional results from the ListAccesses
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional accesses.
ListAccesses
, listAccesses_serverId
- A system-assigned unique identifier for a server that has users assigned
to it.
data ListAccessesResponse Source #
See: newListAccessesResponse
smart constructor.
Instances
newListAccessesResponse Source #
Create a value of ListAccessesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAccesses
, listAccessesResponse_nextToken
- When you can get additional results from the ListAccesses
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional accesses.
$sel:httpStatus:ListAccessesResponse'
, listAccessesResponse_httpStatus
- The response's http status code.
ListAccesses
, listAccessesResponse_serverId
- A system-assigned unique identifier for a server that has users assigned
to it.
$sel:accesses:ListAccessesResponse'
, listAccessesResponse_accesses
- Returns the accesses and their properties for the ServerId
value that
you specify.
ListAgreements (Paginated)
data ListAgreements Source #
See: newListAgreements
smart constructor.
Instances
Create a value of ListAgreements
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:maxResults:ListAgreements'
, listAgreements_maxResults
- The maximum number of agreements to return.
ListAgreements
, listAgreements_nextToken
- When you can get additional results from the ListAgreements
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional agreements.
ListAgreements
, listAgreements_serverId
- The identifier of the server for which you want a list of agreements.
data ListAgreementsResponse Source #
See: newListAgreementsResponse
smart constructor.
Instances
newListAgreementsResponse Source #
Create a value of ListAgreementsResponse
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:
ListAgreements
, listAgreementsResponse_nextToken
- Returns a token that you can use to call ListAgreements
again and
receive additional results, if there are any.
$sel:httpStatus:ListAgreementsResponse'
, listAgreementsResponse_httpStatus
- The response's http status code.
$sel:agreements:ListAgreementsResponse'
, listAgreementsResponse_agreements
- Returns an array, where each item contains the details of an agreement.
ListCertificates (Paginated)
data ListCertificates Source #
See: newListCertificates
smart constructor.
Instances
newListCertificates :: ListCertificates Source #
Create a value of ListCertificates
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:maxResults:ListCertificates'
, listCertificates_maxResults
- The maximum number of certificates to return.
ListCertificates
, listCertificates_nextToken
- When you can get additional results from the ListCertificates
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional certificates.
data ListCertificatesResponse Source #
See: newListCertificatesResponse
smart constructor.
Instances
newListCertificatesResponse Source #
Create a value of ListCertificatesResponse
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:
ListCertificates
, listCertificatesResponse_nextToken
- Returns the next token, which you can use to list the next certificate.
$sel:httpStatus:ListCertificatesResponse'
, listCertificatesResponse_httpStatus
- The response's http status code.
$sel:certificates:ListCertificatesResponse'
, listCertificatesResponse_certificates
- Returns an array of the certificates that are specified in the
ListCertificates
call.
ListConnectors (Paginated)
data ListConnectors Source #
See: newListConnectors
smart constructor.
Instances
newListConnectors :: ListConnectors Source #
Create a value of ListConnectors
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:maxResults:ListConnectors'
, listConnectors_maxResults
- The maximum number of connectors to return.
ListConnectors
, listConnectors_nextToken
- When you can get additional results from the ListConnectors
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional connectors.
data ListConnectorsResponse Source #
See: newListConnectorsResponse
smart constructor.
Instances
newListConnectorsResponse Source #
Create a value of ListConnectorsResponse
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:
ListConnectors
, listConnectorsResponse_nextToken
- Returns a token that you can use to call ListConnectors
again and
receive additional results, if there are any.
$sel:httpStatus:ListConnectorsResponse'
, listConnectorsResponse_httpStatus
- The response's http status code.
$sel:connectors:ListConnectorsResponse'
, listConnectorsResponse_connectors
- Returns an array, where each item contains the details of a connector.
ListExecutions (Paginated)
data ListExecutions Source #
See: newListExecutions
smart constructor.
Instances
Create a value of ListExecutions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListExecutions'
, listExecutions_maxResults
- Specifies the maximum number of executions to return.
ListExecutions
, listExecutions_nextToken
- ListExecutions
returns the NextToken
parameter in the output. You
can then pass the NextToken
parameter in a subsequent command to
continue listing additional executions.
This is useful for pagination, for instance. If you have 100 executions
for a workflow, you might only want to list first 10. If so, call the
API by specifying the max-results
:
aws transfer list-executions --max-results 10
This returns details for the first 10 executions, as well as the pointer
(NextToken
) to the eleventh execution. You can now call the API again,
supplying the NextToken
value you received:
aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult
This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.
ListExecutions
, listExecutions_workflowId
- A unique identifier for the workflow.
data ListExecutionsResponse Source #
See: newListExecutionsResponse
smart constructor.
Instances
newListExecutionsResponse Source #
Create a value of ListExecutionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListExecutions
, listExecutionsResponse_nextToken
- ListExecutions
returns the NextToken
parameter in the output. You
can then pass the NextToken
parameter in a subsequent command to
continue listing additional executions.
$sel:httpStatus:ListExecutionsResponse'
, listExecutionsResponse_httpStatus
- The response's http status code.
ListExecutions
, listExecutionsResponse_workflowId
- A unique identifier for the workflow.
$sel:executions:ListExecutionsResponse'
, listExecutionsResponse_executions
- Returns the details for each execution.
- NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
- StartTime: timestamp indicating when the execution began.
- Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
- Status: one of the following values:
IN_PROGRESS
,COMPLETED
,EXCEPTION
,HANDLING_EXEPTION
.
ListHostKeys
data ListHostKeys Source #
See: newListHostKeys
smart constructor.
Instances
Create a value of ListHostKeys
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:maxResults:ListHostKeys'
, listHostKeys_maxResults
- The maximum number of host keys to return.
ListHostKeys
, listHostKeys_nextToken
- When there are additional results that were not returned, a NextToken
parameter is returned. You can use that value for a subsequent call to
ListHostKeys
to continue listing results.
ListHostKeys
, listHostKeys_serverId
- The identifier of the server that contains the host keys that you want
to view.
data ListHostKeysResponse Source #
See: newListHostKeysResponse
smart constructor.
Instances
newListHostKeysResponse Source #
Create a value of ListHostKeysResponse
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:
ListHostKeys
, listHostKeysResponse_nextToken
- Returns a token that you can use to call ListHostKeys
again and
receive additional results, if there are any.
$sel:httpStatus:ListHostKeysResponse'
, listHostKeysResponse_httpStatus
- The response's http status code.
ListHostKeys
, listHostKeysResponse_serverId
- Returns the server identifier that contains the listed host keys.
$sel:hostKeys:ListHostKeysResponse'
, listHostKeysResponse_hostKeys
- Returns an array, where each item contains the details of a host key.
ListProfiles (Paginated)
data ListProfiles Source #
See: newListProfiles
smart constructor.
Instances
newListProfiles :: ListProfiles Source #
Create a value of ListProfiles
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:maxResults:ListProfiles'
, listProfiles_maxResults
- The maximum number of profiles to return.
ListProfiles
, listProfiles_nextToken
- When there are additional results that were not returned, a NextToken
parameter is returned. You can use that value for a subsequent call to
ListProfiles
to continue listing results.
ListProfiles
, listProfiles_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.
data ListProfilesResponse Source #
See: newListProfilesResponse
smart constructor.
Instances
newListProfilesResponse Source #
Create a value of ListProfilesResponse
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:
ListProfiles
, listProfilesResponse_nextToken
- Returns a token that you can use to call ListProfiles
again and
receive additional results, if there are any.
$sel:httpStatus:ListProfilesResponse'
, listProfilesResponse_httpStatus
- The response's http status code.
$sel:profiles:ListProfilesResponse'
, listProfilesResponse_profiles
- Returns an array, where each item contains the details of a profile.
ListSecurityPolicies (Paginated)
data ListSecurityPolicies Source #
See: newListSecurityPolicies
smart constructor.
Instances
newListSecurityPolicies :: ListSecurityPolicies Source #
Create a value of ListSecurityPolicies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSecurityPolicies'
, listSecurityPolicies_maxResults
- Specifies the number of security policies to return as a response to the
ListSecurityPolicies
query.
ListSecurityPolicies
, listSecurityPolicies_nextToken
- When additional results are obtained from the ListSecurityPolicies
command, a NextToken
parameter is returned in the output. You can then
pass the NextToken
parameter in a subsequent command to continue
listing additional security policies.
data ListSecurityPoliciesResponse Source #
See: newListSecurityPoliciesResponse
smart constructor.
Instances
newListSecurityPoliciesResponse Source #
Create a value of ListSecurityPoliciesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSecurityPolicies
, listSecurityPoliciesResponse_nextToken
- When you can get additional results from the ListSecurityPolicies
operation, a NextToken
parameter is returned in the output. In a
following command, you can pass in the NextToken
parameter to continue
listing security policies.
$sel:httpStatus:ListSecurityPoliciesResponse'
, listSecurityPoliciesResponse_httpStatus
- The response's http status code.
$sel:securityPolicyNames:ListSecurityPoliciesResponse'
, listSecurityPoliciesResponse_securityPolicyNames
- An array of security policies that were listed.
ListServers (Paginated)
data ListServers Source #
See: newListServers
smart constructor.
Instances
newListServers :: ListServers Source #
Create a value of ListServers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListServers'
, listServers_maxResults
- Specifies the number of servers to return as a response to the
ListServers
query.
ListServers
, listServers_nextToken
- When additional results are obtained from the ListServers
command, a
NextToken
parameter is returned in the output. You can then pass the
NextToken
parameter in a subsequent command to continue listing
additional servers.
data ListServersResponse Source #
See: newListServersResponse
smart constructor.
Instances
newListServersResponse Source #
Create a value of ListServersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListServers
, listServersResponse_nextToken
- When you can get additional results from the ListServers
operation, a
NextToken
parameter is returned in the output. In a following command,
you can pass in the NextToken
parameter to continue listing additional
servers.
$sel:httpStatus:ListServersResponse'
, listServersResponse_httpStatus
- The response's http status code.
$sel:servers:ListServersResponse'
, listServersResponse_servers
- An array of servers that were listed.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTagsForResource'
, listTagsForResource_maxResults
- Specifies the number of tags to return as a response to the
ListTagsForResource
request.
ListTagsForResource
, listTagsForResource_nextToken
- When you request additional results from the ListTagsForResource
operation, a NextToken
parameter is returned in the input. You can
then pass in a subsequent command to the NextToken
parameter to
continue listing additional tags.
ListTagsForResource
, listTagsForResource_arn
- Requests the tags associated with a particular Amazon Resource Name
(ARN). An ARN is an identifier for a specific Amazon Web Services
resource, such as a server, user, or role.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource
, listTagsForResourceResponse_arn
- The ARN you specified to list the tags of.
ListTagsForResource
, listTagsForResourceResponse_nextToken
- When you can get additional results from the ListTagsForResource
call,
a NextToken
parameter is returned in the output. You can then pass in
a subsequent command to the NextToken
parameter to continue listing
additional tags.
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- Key-value pairs that are assigned to a resource, usually for the purpose
of grouping and searching for items. Tags are metadata that you define.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListUsers (Paginated)
See: newListUsers
smart constructor.
Instances
Create a value of ListUsers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListUsers'
, listUsers_maxResults
- Specifies the number of users to return as a response to the ListUsers
request.
ListUsers
, listUsers_nextToken
- When you can get additional results from the ListUsers
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional users.
ListUsers
, listUsers_serverId
- A system-assigned unique identifier for a server that has users assigned
to it.
data ListUsersResponse Source #
See: newListUsersResponse
smart constructor.
Instances
Create a value of ListUsersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUsers
, listUsersResponse_nextToken
- When you can get additional results from the ListUsers
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional users.
$sel:httpStatus:ListUsersResponse'
, listUsersResponse_httpStatus
- The response's http status code.
ListUsers
, listUsersResponse_serverId
- A system-assigned unique identifier for a server that the users are
assigned to.
$sel:users:ListUsersResponse'
, listUsersResponse_users
- Returns the user accounts and their properties for the ServerId
value
that you specify.
ListWorkflows (Paginated)
data ListWorkflows Source #
See: newListWorkflows
smart constructor.
Instances
newListWorkflows :: ListWorkflows Source #
Create a value of ListWorkflows
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListWorkflows'
, listWorkflows_maxResults
- Specifies the maximum number of workflows to return.
ListWorkflows
, listWorkflows_nextToken
- ListWorkflows
returns the NextToken
parameter in the output. You can
then pass the NextToken
parameter in a subsequent command to continue
listing additional workflows.
data ListWorkflowsResponse Source #
See: newListWorkflowsResponse
smart constructor.
Instances
newListWorkflowsResponse Source #
Create a value of ListWorkflowsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorkflows
, listWorkflowsResponse_nextToken
- ListWorkflows
returns the NextToken
parameter in the output. You can
then pass the NextToken
parameter in a subsequent command to continue
listing additional workflows.
$sel:httpStatus:ListWorkflowsResponse'
, listWorkflowsResponse_httpStatus
- The response's http status code.
$sel:workflows:ListWorkflowsResponse'
, listWorkflowsResponse_workflows
- Returns the Arn
, WorkflowId
, and Description
for each workflow.
SendWorkflowStepState
data SendWorkflowStepState Source #
See: newSendWorkflowStepState
smart constructor.
Instances
newSendWorkflowStepState Source #
:: Text | |
-> Text | |
-> Text | |
-> CustomStepStatus | |
-> SendWorkflowStepState |
Create a value of SendWorkflowStepState
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SendWorkflowStepState
, sendWorkflowStepState_workflowId
- A unique identifier for the workflow.
SendWorkflowStepState
, sendWorkflowStepState_executionId
- A unique identifier for the execution of a workflow.
$sel:token:SendWorkflowStepState'
, sendWorkflowStepState_token
- Used to distinguish between multiple callbacks for multiple Lambda steps
within the same execution.
SendWorkflowStepState
, sendWorkflowStepState_status
- Indicates whether the specified step succeeded or failed.
data SendWorkflowStepStateResponse Source #
See: newSendWorkflowStepStateResponse
smart constructor.
Instances
Generic SendWorkflowStepStateResponse Source # | |
Read SendWorkflowStepStateResponse Source # | |
Show SendWorkflowStepStateResponse Source # | |
Defined in Amazonka.Transfer.SendWorkflowStepState showsPrec :: Int -> SendWorkflowStepStateResponse -> ShowS # show :: SendWorkflowStepStateResponse -> String # showList :: [SendWorkflowStepStateResponse] -> ShowS # | |
NFData SendWorkflowStepStateResponse Source # | |
Defined in Amazonka.Transfer.SendWorkflowStepState rnf :: SendWorkflowStepStateResponse -> () # | |
Eq SendWorkflowStepStateResponse Source # | |
type Rep SendWorkflowStepStateResponse Source # | |
Defined in Amazonka.Transfer.SendWorkflowStepState type Rep SendWorkflowStepStateResponse = D1 ('MetaData "SendWorkflowStepStateResponse" "Amazonka.Transfer.SendWorkflowStepState" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "SendWorkflowStepStateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newSendWorkflowStepStateResponse Source #
Create a value of SendWorkflowStepStateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SendWorkflowStepStateResponse'
, sendWorkflowStepStateResponse_httpStatus
- The response's http status code.
StartFileTransfer
data StartFileTransfer Source #
See: newStartFileTransfer
smart constructor.
Instances
Create a value of StartFileTransfer
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:
StartFileTransfer
, startFileTransfer_connectorId
- The unique identifier for the connector.
$sel:sendFilePaths:StartFileTransfer'
, startFileTransfer_sendFilePaths
- An array of strings. Each string represents the absolute path for one
outbound file transfer. For example,
DOC-EXAMPLE-BUCKET
/
myfile.txt
.
data StartFileTransferResponse Source #
See: newStartFileTransferResponse
smart constructor.
Instances
newStartFileTransferResponse Source #
:: Int | |
-> Text | |
-> StartFileTransferResponse |
Create a value of StartFileTransferResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartFileTransferResponse'
, startFileTransferResponse_httpStatus
- The response's http status code.
$sel:transferId:StartFileTransferResponse'
, startFileTransferResponse_transferId
- Returns the unique identifier for this file transfer.
StartServer
data StartServer Source #
See: newStartServer
smart constructor.
Instances
Create a value of StartServer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartServer
, startServer_serverId
- A system-assigned unique identifier for a server that you start.
data StartServerResponse Source #
See: newStartServerResponse
smart constructor.
Instances
Generic StartServerResponse Source # | |
Defined in Amazonka.Transfer.StartServer type Rep StartServerResponse :: Type -> Type # from :: StartServerResponse -> Rep StartServerResponse x # to :: Rep StartServerResponse x -> StartServerResponse # | |
Read StartServerResponse Source # | |
Defined in Amazonka.Transfer.StartServer | |
Show StartServerResponse Source # | |
Defined in Amazonka.Transfer.StartServer showsPrec :: Int -> StartServerResponse -> ShowS # show :: StartServerResponse -> String # showList :: [StartServerResponse] -> ShowS # | |
NFData StartServerResponse Source # | |
Defined in Amazonka.Transfer.StartServer rnf :: StartServerResponse -> () # | |
Eq StartServerResponse Source # | |
Defined in Amazonka.Transfer.StartServer (==) :: StartServerResponse -> StartServerResponse -> Bool # (/=) :: StartServerResponse -> StartServerResponse -> Bool # | |
type Rep StartServerResponse Source # | |
newStartServerResponse :: StartServerResponse Source #
Create a value of StartServerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopServer
data StopServer Source #
See: newStopServer
smart constructor.
Instances
:: Text | |
-> StopServer |
Create a value of StopServer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopServer
, stopServer_serverId
- A system-assigned unique identifier for a server that you stopped.
data StopServerResponse Source #
See: newStopServerResponse
smart constructor.
Instances
Generic StopServerResponse Source # | |
Defined in Amazonka.Transfer.StopServer type Rep StopServerResponse :: Type -> Type # from :: StopServerResponse -> Rep StopServerResponse x # to :: Rep StopServerResponse x -> StopServerResponse # | |
Read StopServerResponse Source # | |
Defined in Amazonka.Transfer.StopServer | |
Show StopServerResponse Source # | |
Defined in Amazonka.Transfer.StopServer showsPrec :: Int -> StopServerResponse -> ShowS # show :: StopServerResponse -> String # showList :: [StopServerResponse] -> ShowS # | |
NFData StopServerResponse Source # | |
Defined in Amazonka.Transfer.StopServer rnf :: StopServerResponse -> () # | |
Eq StopServerResponse Source # | |
Defined in Amazonka.Transfer.StopServer (==) :: StopServerResponse -> StopServerResponse -> Bool # (/=) :: StopServerResponse -> StopServerResponse -> Bool # | |
type Rep StopServerResponse Source # | |
newStopServerResponse :: StopServerResponse Source #
Create a value of StopServerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource
, tagResource_arn
- An Amazon Resource Name (ARN) for a specific Amazon Web Services
resource, such as a server, user, or role.
TagResource
, tagResource_tags
- Key-value pairs assigned to ARNs that you can use to group and search
for resources by type. You can attach this metadata to user accounts for
any purpose.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Generic TagResourceResponse Source # | |
Defined in Amazonka.Transfer.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
Read TagResourceResponse Source # | |
Defined in Amazonka.Transfer.TagResource | |
Show TagResourceResponse Source # | |
Defined in Amazonka.Transfer.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.Transfer.TagResource rnf :: TagResourceResponse -> () # | |
Eq TagResourceResponse Source # | |
Defined in Amazonka.Transfer.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TestIdentityProvider
data TestIdentityProvider Source #
See: newTestIdentityProvider
smart constructor.
Instances
newTestIdentityProvider Source #
Create a value of TestIdentityProvider
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serverProtocol:TestIdentityProvider'
, testIdentityProvider_serverProtocol
- The type of file transfer protocol to be tested.
The available protocols are:
- Secure Shell (SSH) File Transfer Protocol (SFTP)
- File Transfer Protocol Secure (FTPS)
- File Transfer Protocol (FTP)
$sel:sourceIp:TestIdentityProvider'
, testIdentityProvider_sourceIp
- The source IP address of the user account to be tested.
$sel:userPassword:TestIdentityProvider'
, testIdentityProvider_userPassword
- The password of the user account to be tested.
TestIdentityProvider
, testIdentityProvider_serverId
- A system-assigned identifier for a specific server. That server's user
authentication method is tested with a user name and password.
TestIdentityProvider
, testIdentityProvider_userName
- The name of the user account to be tested.
data TestIdentityProviderResponse Source #
See: newTestIdentityProviderResponse
smart constructor.
Instances
newTestIdentityProviderResponse Source #
:: Int | |
-> Int | |
-> Text | |
-> TestIdentityProviderResponse |
Create a value of TestIdentityProviderResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TestIdentityProviderResponse
, testIdentityProviderResponse_message
- A message that indicates whether the test was successful or not.
If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.
$sel:response:TestIdentityProviderResponse'
, testIdentityProviderResponse_response
- The response that is returned from your API Gateway.
$sel:httpStatus:TestIdentityProviderResponse'
, testIdentityProviderResponse_httpStatus
- The response's http status code.
$sel:statusCode:TestIdentityProviderResponse'
, testIdentityProviderResponse_statusCode
- The HTTP status code that is the response from your API Gateway.
TestIdentityProviderResponse
, testIdentityProviderResponse_url
- The endpoint of the service used to authenticate a user.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource
, untagResource_arn
- The value of the resource that will have the tag removed. An Amazon
Resource Name (ARN) is an identifier for a specific Amazon Web Services
resource, such as a server, user, or role.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- TagKeys are key-value pairs assigned to ARNs that can be used to group
and search for resources by type. This metadata can be attached to
resources for any purpose.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Generic UntagResourceResponse Source # | |
Defined in Amazonka.Transfer.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.Transfer.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.Transfer.UntagResource rnf :: UntagResourceResponse -> () # | |
Eq UntagResourceResponse Source # | |
Defined in Amazonka.Transfer.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
type Rep UntagResourceResponse Source # | |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateAccess
data UpdateAccess Source #
See: newUpdateAccess
smart constructor.
UpdateAccess' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) Text Text |
Instances
Create a value of UpdateAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAccess
, updateAccess_homeDirectory
- The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
UpdateAccess
, updateAccess_homeDirectoryMappings
- Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
The following is an Entry
and Target
pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to
lock down your user to the designated home directory ("chroot
"). To
do this, you can set Entry
to /
and set Target
to the
HomeDirectory
parameter value.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
UpdateAccess
, updateAccess_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.
UpdateAccess
, updateAccess_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}
.
This policy applies only when the domain of ServerId
is Amazon S3.
Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the
policy as a JSON blob and pass it in the Policy
argument.
For an example of a session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.
UpdateAccess
, updateAccess_posixProfile
- Undocumented member.
UpdateAccess
, updateAccess_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.
UpdateAccess
, updateAccess_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
UpdateAccess
, updateAccess_externalId
- A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to
your Amazon S3 or Amazon EFS resources over the enabled protocols using
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: =,.@:/-
data UpdateAccessResponse Source #
See: newUpdateAccessResponse
smart constructor.
Instances
newUpdateAccessResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UpdateAccessResponse |
Create a value of UpdateAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAccessResponse'
, updateAccessResponse_httpStatus
- The response's http status code.
UpdateAccess
, updateAccessResponse_serverId
- The identifier of the server that the user is attached to.
UpdateAccess
, updateAccessResponse_externalId
- The external identifier of the group whose users have access to your
Amazon S3 or Amazon EFS resources over the enabled protocols using
Amazon Web ServicesTransfer Family.
UpdateAgreement
data UpdateAgreement Source #
See: newUpdateAgreement
smart constructor.
UpdateAgreement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AgreementStatusType) Text Text |
Instances
Create a value of UpdateAgreement
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:
UpdateAgreement
, updateAgreement_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
.
UpdateAgreement
, updateAgreement_baseDirectory
- To change the landing directory (folder) for files that are transferred,
provide the bucket folder that you want to use; for example,
/
DOC-EXAMPLE-BUCKET
/
home
/
mydirectory
.
UpdateAgreement
, updateAgreement_description
- To replace the existing description, provide a short description for the
agreement.
UpdateAgreement
, updateAgreement_localProfileId
- A unique identifier for the AS2 local profile.
To change the local profile identifier, provide a new value here.
UpdateAgreement
, updateAgreement_partnerProfileId
- A unique identifier for the partner profile. To change the partner
profile identifier, provide a new value here.
UpdateAgreement
, updateAgreement_status
- You can update the status for the agreement, either activating an
inactive agreement or the reverse.
UpdateAgreement
, updateAgreement_agreementId
- A unique identifier for the agreement. This identifier is returned when
you create an agreement.
UpdateAgreement
, updateAgreement_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
data UpdateAgreementResponse Source #
See: newUpdateAgreementResponse
smart constructor.
Instances
newUpdateAgreementResponse Source #
Create a value of UpdateAgreementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAgreementResponse'
, updateAgreementResponse_httpStatus
- The response's http status code.
UpdateAgreement
, updateAgreementResponse_agreementId
- A unique identifier for the agreement. This identifier is returned when
you create an agreement.
UpdateCertificate
data UpdateCertificate Source #
See: newUpdateCertificate
smart constructor.
Instances
Create a value of UpdateCertificate
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:
UpdateCertificate
, updateCertificate_activeDate
- An optional date that specifies when the certificate becomes active.
UpdateCertificate
, updateCertificate_description
- A short description to help identify the certificate.
UpdateCertificate
, updateCertificate_inactiveDate
- An optional date that specifies when the certificate becomes inactive.
UpdateCertificate
, updateCertificate_certificateId
- The identifier of the certificate object that you are updating.
data UpdateCertificateResponse Source #
See: newUpdateCertificateResponse
smart constructor.
Instances
newUpdateCertificateResponse Source #
:: Int | |
-> Text | |
-> UpdateCertificateResponse |
Create a value of UpdateCertificateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateCertificateResponse'
, updateCertificateResponse_httpStatus
- The response's http status code.
UpdateCertificate
, updateCertificateResponse_certificateId
- Returns the identifier of the certificate object that you are updating.
UpdateConnector
data UpdateConnector Source #
See: newUpdateConnector
smart constructor.
Instances
Create a value of UpdateConnector
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:
UpdateConnector
, updateConnector_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
.
UpdateConnector
, updateConnector_as2Config
- A structure that contains the parameters for a connector object.
UpdateConnector
, updateConnector_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.
UpdateConnector
, updateConnector_url
- The URL of the partner's AS2 endpoint.
UpdateConnector
, updateConnector_connectorId
- The unique identifier for the connector.
data UpdateConnectorResponse Source #
See: newUpdateConnectorResponse
smart constructor.
Instances
newUpdateConnectorResponse Source #
Create a value of UpdateConnectorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateConnectorResponse'
, updateConnectorResponse_httpStatus
- The response's http status code.
UpdateConnector
, updateConnectorResponse_connectorId
- Returns the identifier of the connector object that you are updating.
UpdateHostKey
data UpdateHostKey Source #
See: newUpdateHostKey
smart constructor.
Instances
Create a value of UpdateHostKey
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:
UpdateHostKey
, updateHostKey_serverId
- The identifier of the server that contains the host key that you are
updating.
UpdateHostKey
, updateHostKey_hostKeyId
- The identifier of the host key that you are updating.
UpdateHostKey
, updateHostKey_description
- An updated description for the host key.
data UpdateHostKeyResponse Source #
See: newUpdateHostKeyResponse
smart constructor.
Instances
newUpdateHostKeyResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UpdateHostKeyResponse |
Create a value of UpdateHostKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateHostKeyResponse'
, updateHostKeyResponse_httpStatus
- The response's http status code.
UpdateHostKey
, updateHostKeyResponse_serverId
- Returns the server identifier for the server that contains the updated
host key.
UpdateHostKey
, updateHostKeyResponse_hostKeyId
- Returns the host key identifier for the updated host key.
UpdateProfile
data UpdateProfile Source #
See: newUpdateProfile
smart constructor.
UpdateProfile' (Maybe [Text]) Text |
Instances
Create a value of UpdateProfile
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:
UpdateProfile
, updateProfile_certificateIds
- An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
UpdateProfile
, updateProfile_profileId
- The identifier of the profile object that you are updating.
data UpdateProfileResponse Source #
See: newUpdateProfileResponse
smart constructor.
Instances
newUpdateProfileResponse Source #
Create a value of UpdateProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateProfileResponse'
, updateProfileResponse_httpStatus
- The response's http status code.
UpdateProfile
, updateProfileResponse_profileId
- Returns the identifier for the profile that's being updated.
UpdateServer
data UpdateServer Source #
See: newUpdateServer
smart constructor.
UpdateServer' (Maybe Text) (Maybe EndpointDetails) (Maybe EndpointType) (Maybe (Sensitive Text)) (Maybe IdentityProviderDetails) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProtocolDetails) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe WorkflowDetails) Text |
Instances
Create a value of UpdateServer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateServer
, updateServer_certificate
- The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate
Manager (ACM) certificate. Required when Protocols
is set to FTPS
.
To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
- 2048-bit RSA (RSA_2048)
- 4096-bit RSA (RSA_4096)
- Elliptic Prime Curve 256 bit (EC_prime256v1)
- Elliptic Prime Curve 384 bit (EC_secp384r1)
- Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
UpdateServer
, updateServer_endpointDetails
- The virtual private cloud (VPC) endpoint settings that are configured
for your server. When you host your endpoint within your VPC, you can
make 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.
UpdateServer
, updateServer_endpointType
- The type of endpoint that you want your server to use. You can choose to
make your server's endpoint publicly accessible (PUBLIC) or host it
inside your VPC. With an endpoint that is hosted in a VPC, you can
restrict access to your server and resources only within your VPC or
choose to make it internet facing by attaching Elastic IP addresses
directly to it.
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your Amazon Web Servicesaccount if your
account hasn't already done so before May 19, 2021. If you have already
created servers with EndpointType=VPC_ENDPOINT
in your Amazon Web
Servicesaccount on or before May 19, 2021, you will not be affected.
After this date, use EndpointType
=VPC
.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC
as the EndpointType
. With this
endpoint type, you have the option to directly associate up to three
Elastic IPv4 addresses (BYO IP included) with your server's endpoint
and use VPC security groups to restrict traffic by the client's public
IP address. This is not possible with EndpointType
set to
VPC_ENDPOINT
.
$sel:hostKey:UpdateServer'
, updateServer_hostKey
- The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled
server. You can add multiple host keys, in case you want to rotate keys,
or have a set of active keys that use different algorithms.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.
Use a minimum value of 2048 for the -b
option. You can create a
stronger key by using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.
Valid values for the -b
option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.
For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Update host keys for your SFTP-enabled server in the Transfer Family User Guide.
UpdateServer
, updateServer_identityProviderDetails
- An array containing all of the information required to call a
customer's authentication API method.
UpdateServer
, updateServer_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.
UpdateServer
, updateServer_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.
UpdateServer
, updateServer_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.
UpdateServer
, updateServer_protocolDetails
- The protocol settings that are configured for your server.
- To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIp
parameter. 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
SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. - To determine whether your Transfer Family server resumes recent,
negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
UpdateServer
, updateServer_protocols
- Specifies the file transfer protocol or protocols over which your file
transfer protocol client can connect to your server's endpoint. The
available protocols are:
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
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must beAWS_DIRECTORY_SERVICE
orAPI_GATEWAY
. - If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. - If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set toSERVICE_MANAGED
. - If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
UpdateServer
, updateServer_securityPolicyName
- Specifies the name of the security policy that is attached to the
server.
UpdateServer
, updateServer_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.
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":[]}'
UpdateServer
, updateServer_serverId
- A system-assigned unique identifier for a server instance that the user
account is assigned to.
data UpdateServerResponse Source #
See: newUpdateServerResponse
smart constructor.
Instances
newUpdateServerResponse Source #
Create a value of UpdateServerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateServerResponse'
, updateServerResponse_httpStatus
- The response's http status code.
UpdateServer
, updateServerResponse_serverId
- A system-assigned unique identifier for a server that the user account
is assigned to.
UpdateUser
data UpdateUser Source #
See: newUpdateUser
smart constructor.
UpdateUser' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) Text Text |
Instances
Create a value of UpdateUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUser
, updateUser_homeDirectory
- The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
UpdateUser
, updateUser_homeDirectoryMappings
- Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
The following is an Entry
and Target
pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to
lock down your user to the designated home directory ("chroot
"). To
do this, you can set Entry
to '/' and set Target
to the
HomeDirectory parameter value.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
UpdateUser
, updateUser_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.
UpdateUser
, updateUser_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}
.
This policy applies only when the domain of ServerId
is Amazon S3.
Amazon EFS does not use session policies.
For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the
policy as a JSON blob and pass it in the Policy
argument.
For an example of a session policy, see Creating a session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
UpdateUser
, updateUser_posixProfile
- Specifies the full POSIX identity, including user ID (Uid
), group ID
(Gid
), and any secondary groups IDs (SecondaryGids
), that controls
your users' access to your Amazon Elastic File Systems (Amazon EFS).
The POSIX permissions that are set on files and directories in your file
system determines the level of access your users get when transferring
files into and out of your Amazon EFS file systems.
UpdateUser
, updateUser_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.
UpdateUser
, updateUser_serverId
- A system-assigned unique identifier for a server instance that the user
account is assigned to.
UpdateUser
, updateUser_userName
- A unique string that identifies a user and is associated with a server
as specified by the ServerId
. This user name must be a minimum of 3
and a maximum of 100 characters long. The following are valid
characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.',
and at sign '@'. The user name can't start with a hyphen, period, or
at sign.
data UpdateUserResponse Source #
UpdateUserResponse
returns the user name and identifier for the
request to update a user's properties.
See: newUpdateUserResponse
smart constructor.
Instances
newUpdateUserResponse Source #
Create a value of UpdateUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateUserResponse'
, updateUserResponse_httpStatus
- The response's http status code.
UpdateUser
, updateUserResponse_serverId
- A system-assigned unique identifier for a server instance that the user
account is assigned to.
UpdateUser
, updateUserResponse_userName
- The unique identifier for a user that is assigned to a server instance
that was specified in the request.
Types
AgreementStatusType
newtype AgreementStatusType Source #
pattern AgreementStatusType_ACTIVE :: AgreementStatusType | |
pattern AgreementStatusType_INACTIVE :: AgreementStatusType |
Instances
As2Transport
newtype As2Transport Source #
pattern As2Transport_HTTP :: As2Transport |
Instances
CertificateStatusType
newtype CertificateStatusType Source #
pattern CertificateStatusType_ACTIVE :: CertificateStatusType | |
pattern CertificateStatusType_INACTIVE :: CertificateStatusType | |
pattern CertificateStatusType_PENDING_ROTATION :: CertificateStatusType |
Instances
CertificateType
newtype CertificateType Source #
pattern CertificateType_CERTIFICATE :: CertificateType | |
pattern CertificateType_CERTIFICATE_WITH_PRIVATE_KEY :: CertificateType |
Instances
CertificateUsageType
newtype CertificateUsageType Source #
pattern CertificateUsageType_ENCRYPTION :: CertificateUsageType | |
pattern CertificateUsageType_SIGNING :: CertificateUsageType |
Instances
CompressionEnum
newtype CompressionEnum Source #
pattern CompressionEnum_DISABLED :: CompressionEnum | |
pattern CompressionEnum_ZLIB :: CompressionEnum |
Instances
CustomStepStatus
newtype CustomStepStatus Source #
pattern CustomStepStatus_FAILURE :: CustomStepStatus | |
pattern CustomStepStatus_SUCCESS :: CustomStepStatus |
Instances
Domain
pattern Domain_EFS :: Domain | |
pattern Domain_S3 :: Domain |
Instances
EncryptionAlg
newtype EncryptionAlg Source #
pattern EncryptionAlg_AES128_CBC :: EncryptionAlg | |
pattern EncryptionAlg_AES192_CBC :: EncryptionAlg | |
pattern EncryptionAlg_AES256_CBC :: EncryptionAlg | |
pattern EncryptionAlg_NONE :: EncryptionAlg |
Instances
EncryptionType
newtype EncryptionType Source #
pattern EncryptionType_PGP :: EncryptionType |
Instances
EndpointType
newtype EndpointType Source #
pattern EndpointType_PUBLIC :: EndpointType | |
pattern EndpointType_VPC :: EndpointType | |
pattern EndpointType_VPC_ENDPOINT :: EndpointType |
Instances
ExecutionErrorType
newtype ExecutionErrorType Source #
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 #
pattern ExecutionStatus_COMPLETED :: ExecutionStatus | |
pattern ExecutionStatus_EXCEPTION :: ExecutionStatus | |
pattern ExecutionStatus_HANDLING_EXCEPTION :: ExecutionStatus | |
pattern ExecutionStatus_IN_PROGRESS :: ExecutionStatus |
Instances
HomeDirectoryType
newtype HomeDirectoryType Source #
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.
Instances
MdnResponse
newtype MdnResponse Source #
pattern MdnResponse_NONE :: MdnResponse | |
pattern MdnResponse_SYNC :: MdnResponse |
Instances
MdnSigningAlg
newtype MdnSigningAlg Source #
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 #
pattern OverwriteExisting_FALSE :: OverwriteExisting | |
pattern OverwriteExisting_TRUE :: OverwriteExisting |
Instances
ProfileType
newtype ProfileType Source #
pattern ProfileType_LOCAL :: ProfileType | |
pattern ProfileType_PARTNER :: ProfileType |
Instances
Protocol
pattern Protocol_AS2 :: Protocol | |
pattern Protocol_FTP :: Protocol | |
pattern Protocol_FTPS :: Protocol | |
pattern Protocol_SFTP :: Protocol |
Instances
SetStatOption
newtype SetStatOption Source #
pattern SetStatOption_DEFAULT :: SetStatOption | |
pattern SetStatOption_ENABLE_NO_OP :: SetStatOption |
Instances
SigningAlg
newtype SigningAlg Source #
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.
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 #
Instances
WorkflowStepType
newtype WorkflowStepType Source #
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.
As2ConnectorConfig' (Maybe CompressionEnum) (Maybe EncryptionAlg) (Maybe Text) (Maybe MdnResponse) (Maybe MdnSigningAlg) (Maybe Text) (Maybe Text) (Maybe SigningAlg) |
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.
CopyStepDetails
data CopyStepDetails Source #
Each step type has its own StepDetails
structure.
See: newCopyStepDetails
smart constructor.
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.
CustomStepDetails
data CustomStepDetails Source #
Each step type has its own StepDetails
structure.
See: newCustomStepDetails
smart constructor.
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.
DecryptStepDetails
data DecryptStepDetails Source #
See: newDecryptStepDetails
smart constructor.
DecryptStepDetails' (Maybe Text) (Maybe OverwriteExisting) (Maybe Text) EncryptionType InputFileLocation |
Instances
newDecryptStepDetails Source #
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.
DeleteStepDetails
data DeleteStepDetails Source #
The name of the step, used to identify the delete step.
See: newDeleteStepDetails
smart constructor.
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.
DescribedAccess
data DescribedAccess Source #
Describes the properties of the access that was specified.
See: newDescribedAccess
smart constructor.
DescribedAccess' (Maybe Text) (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) |
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.
DescribedAgreement
data DescribedAgreement Source #
Describes the properties of an agreement.
See: newDescribedAgreement
smart constructor.
DescribedAgreement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AgreementStatusType) (Maybe (NonEmpty Tag)) Text |
Instances
newDescribedAgreement Source #
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.
DescribedCertificate
data DescribedCertificate Source #
Describes the properties of a certificate.
See: newDescribedCertificate
smart constructor.
DescribedCertificate' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe CertificateStatusType) (Maybe (NonEmpty Tag)) (Maybe CertificateType) (Maybe CertificateUsageType) Text |
Instances
newDescribedCertificate Source #
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.
DescribedConnector
data DescribedConnector Source #
Describes the parameters for the connector, as identified by the
ConnectorId
.
See: newDescribedConnector
smart constructor.
DescribedConnector' (Maybe Text) (Maybe As2ConnectorConfig) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text) Text |
Instances
newDescribedConnector Source #
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.
DescribedExecution
data DescribedExecution Source #
The details for an execution object.
See: newDescribedExecution
smart constructor.
DescribedExecution' (Maybe Text) (Maybe Text) (Maybe FileLocation) (Maybe LoggingConfiguration) (Maybe PosixProfile) (Maybe ExecutionResults) (Maybe ServiceMetadata) (Maybe ExecutionStatus) |
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.
DescribedHostKey
data DescribedHostKey Source #
The details for a server host key.
See: newDescribedHostKey
smart constructor.
DescribedHostKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text) Text |
Instances
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.
DescribedProfile
data DescribedProfile Source #
The details for a local or partner AS2 profile.
See: newDescribedProfile
smart constructor.
DescribedProfile' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe ProfileType) (Maybe (NonEmpty Tag)) Text |
Instances
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.
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.
DescribedSecurityPolicy' (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text |
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.
DescribedServer
data DescribedServer Source #
Describes the properties of a file transfer protocol-enabled server that was specified.
See: newDescribedServer
smart constructor.
DescribedServer' (Maybe Text) (Maybe Domain) (Maybe EndpointDetails) (Maybe EndpointType) (Maybe Text) (Maybe IdentityProviderDetails) (Maybe IdentityProviderType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProtocolDetails) (Maybe (NonEmpty Protocol)) (Maybe Text) (Maybe Text) (Maybe State) (Maybe (NonEmpty Tag)) (Maybe Int) (Maybe WorkflowDetails) Text |
Instances
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
PassiveIp
parameter. 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
SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. - To determine whether your Transfer Family server resumes recent,
negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. As2Transports
indicates 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
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must beAWS_DIRECTORY_SERVICE
orAPI_GATEWAY
. - If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. - If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set toSERVICE_MANAGED
. - If
Protocol
includesAS2
, then theEndpointType
must 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.
DescribedUser
data DescribedUser Source #
Describes the properties of a user that was specified.
See: newDescribedUser
smart constructor.
DescribedUser' (Maybe Text) (Maybe (NonEmpty HomeDirectoryMapEntry)) (Maybe HomeDirectoryType) (Maybe Text) (Maybe PosixProfile) (Maybe Text) (Maybe [SshPublicKey]) (Maybe (NonEmpty Tag)) (Maybe Text) Text |
Instances
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.
DescribedWorkflow
data DescribedWorkflow Source #
Describes the properties of the specified workflow
See: newDescribedWorkflow
smart constructor.
DescribedWorkflow' (Maybe Text) (Maybe [WorkflowStep]) (Maybe [WorkflowStep]) (Maybe (NonEmpty Tag)) (Maybe Text) Text |
Instances
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.
EfsFileLocation
data EfsFileLocation Source #
Reserved for future use.
See: newEfsFileLocation
smart constructor.
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.
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.
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
.
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.
Instances
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
TimeoutSeconds
for 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
.
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.
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.
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.
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.
FileLocation
data FileLocation Source #
Specifies the Amazon S3 or EFS file details to be used in the step.
See: newFileLocation
smart constructor.
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.
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.
Instances
newHomeDirectoryMapEntry Source #
:: 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
.
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.
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.
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.
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.
ListedAccess
data ListedAccess Source #
Lists the properties for one or more specified associated accesses.
See: newListedAccess
smart constructor.
ListedAccess' (Maybe Text) (Maybe Text) (Maybe HomeDirectoryType) (Maybe Text) |
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.
ListedAgreement
data ListedAgreement Source #
Describes the properties of an agreement.
See: newListedAgreement
smart constructor.
ListedAgreement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AgreementStatusType) |
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
.
ListedCertificate
data ListedCertificate Source #
Describes the properties of a certificate.
See: newListedCertificate
smart constructor.
ListedCertificate' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe CertificateStatusType) (Maybe CertificateType) (Maybe CertificateUsageType) |
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.
ListedConnector
data ListedConnector Source #
Returns details of the connector that is specified.
See: newListedConnector
smart constructor.
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.
ListedExecution
data ListedExecution Source #
Returns properties of the execution that is specified.
See: newListedExecution
smart constructor.
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.
ListedHostKey
data ListedHostKey Source #
Returns properties of the host key that's specified.
See: newListedHostKey
smart constructor.
Instances
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.
ListedProfile
data ListedProfile Source #
Returns the properties of the profile that was specified.
See: newListedProfile
smart constructor.
ListedProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ProfileType) |
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.
ListedServer
data ListedServer Source #
Returns properties of a file transfer protocol-enabled server that was specified.
See: newListedServer
smart constructor.
ListedServer' (Maybe Domain) (Maybe EndpointType) (Maybe IdentityProviderType) (Maybe Text) (Maybe Text) (Maybe State) (Maybe Int) Text |
Instances
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.
ListedUser
data ListedUser Source #
Returns properties of the user that you specify.
See: newListedUser
smart constructor.
Instances
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.
ListedWorkflow
data ListedWorkflow Source #
Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.
See: newListedWorkflow
smart constructor.
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.
LoggingConfiguration
data LoggingConfiguration Source #
Consists of the logging role and the log group name.
See: newLoggingConfiguration
smart constructor.
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.
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.
Instances
Create a value of PosixProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secondaryGids:PosixProfile'
, posixProfile_secondaryGids
- The secondary POSIX group IDs used for all EFS operations by this user.
$sel:uid:PosixProfile'
, posixProfile_uid
- The POSIX user ID used for all EFS operations by this user.
$sel:gid:PosixProfile'
, posixProfile_gid
- The POSIX group ID used for all EFS operations by this user.
ProtocolDetails
data ProtocolDetails Source #
The protocol settings that are configured for your server.
See: newProtocolDetails
smart constructor.
ProtocolDetails' (Maybe (NonEmpty As2Transport)) (Maybe Text) (Maybe SetStatOption) (Maybe TlsSessionResumptionMode) |
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
ENFORCED
value, 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.
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.
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.
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.
S3Tag
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
See: newS3Tag
smart constructor.
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.
Instances
Create a value of ServiceMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userDetails:ServiceMetadata'
, serviceMetadata_userDetails
- The Server ID (ServerId
), Session ID (SessionId
) and user
(UserName
) make up the UserDetails
.
SshPublicKey
data SshPublicKey Source #
Provides information about the public Secure Shell (SSH) key that is
associated with a user account for the specific file transfer
protocol-enabled server (as identified by ServerId
). The information
returned includes the date the key was imported, the public key
contents, and the public key ID. A user can store more than one SSH
public key associated with their user name on a specific server.
See: newSshPublicKey
smart constructor.
Instances
:: 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.
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.
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.
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.
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.
UserDetails
data UserDetails Source #
Specifies the user name, server ID, and session ID for a workflow.
See: newUserDetails
smart constructor.
Instances
Create a value of UserDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sessionId:UserDetails'
, userDetails_sessionId
- The system-assigned unique identifier for a session that corresponds to
the workflow.
$sel:userName:UserDetails'
, userDetails_userName
- A unique string that identifies a user account associated with a server.
$sel:serverId:UserDetails'
, userDetails_serverId
- The system-assigned unique identifier for a Transfer server instance.
WorkflowDetail
data WorkflowDetail Source #
Specifies the workflow ID for the workflow to assign and the execution role 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.
Instances
Create a value of WorkflowDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workflowId:WorkflowDetail'
, workflowDetail_workflowId
- A unique identifier for the workflow.
$sel:executionRole:WorkflowDetail'
, workflowDetail_executionRole
- Includes the necessary permissions for S3, EFS, and Lambda operations
that Transfer can assume, so that all workflow steps can operate on the
required resources
WorkflowDetails
data WorkflowDetails Source #
Container for the WorkflowDetail
data type. It is used by actions that
trigger a workflow to begin execution.
See: newWorkflowDetails
smart constructor.
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":[]}'
WorkflowStep
data WorkflowStep Source #
The basic building block of a workflow.
See: newWorkflowStep
smart constructor.
WorkflowStep' (Maybe CopyStepDetails) (Maybe CustomStepDetails) (Maybe DecryptStepDetails) (Maybe DeleteStepDetails) (Maybe TagStepDetails) (Maybe WorkflowStepType) |
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.