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 |
- 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
- ListAgreements
- ListCertificates
- ListConnectors
- ListExecutions
- ListHostKeys
- ListProfiles
- ListSecurityPolicies
- ListServers
- ListTagsForResource
- ListUsers
- ListWorkflows
- SendWorkflowStepState
- StartFileTransfer
- StartServer
- StopServer
- TagResource
- TestIdentityProvider
- UntagResource
- UpdateAccess
- UpdateAgreement
- UpdateCertificate
- UpdateConnector
- UpdateHostKey
- UpdateProfile
- UpdateServer
- UpdateUser
- Types
- 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
Synopsis
- createAccess_homeDirectory :: Lens' CreateAccess (Maybe Text)
- createAccess_homeDirectoryMappings :: Lens' CreateAccess (Maybe (NonEmpty HomeDirectoryMapEntry))
- createAccess_homeDirectoryType :: Lens' CreateAccess (Maybe HomeDirectoryType)
- createAccess_policy :: Lens' CreateAccess (Maybe Text)
- createAccess_posixProfile :: Lens' CreateAccess (Maybe PosixProfile)
- createAccess_role :: Lens' CreateAccess Text
- createAccess_serverId :: Lens' CreateAccess Text
- createAccess_externalId :: Lens' CreateAccess Text
- createAccessResponse_httpStatus :: Lens' CreateAccessResponse Int
- createAccessResponse_serverId :: Lens' CreateAccessResponse Text
- createAccessResponse_externalId :: Lens' CreateAccessResponse Text
- createAgreement_description :: Lens' CreateAgreement (Maybe Text)
- createAgreement_status :: Lens' CreateAgreement (Maybe AgreementStatusType)
- createAgreement_tags :: Lens' CreateAgreement (Maybe (NonEmpty Tag))
- createAgreement_serverId :: Lens' CreateAgreement Text
- createAgreement_localProfileId :: Lens' CreateAgreement Text
- createAgreement_partnerProfileId :: Lens' CreateAgreement Text
- createAgreement_baseDirectory :: Lens' CreateAgreement Text
- createAgreement_accessRole :: Lens' CreateAgreement Text
- createAgreementResponse_httpStatus :: Lens' CreateAgreementResponse Int
- createAgreementResponse_agreementId :: Lens' CreateAgreementResponse Text
- createConnector_loggingRole :: Lens' CreateConnector (Maybe Text)
- createConnector_tags :: Lens' CreateConnector (Maybe (NonEmpty Tag))
- createConnector_url :: Lens' CreateConnector Text
- createConnector_as2Config :: Lens' CreateConnector As2ConnectorConfig
- createConnector_accessRole :: Lens' CreateConnector Text
- createConnectorResponse_httpStatus :: Lens' CreateConnectorResponse Int
- createConnectorResponse_connectorId :: Lens' CreateConnectorResponse Text
- createProfile_certificateIds :: Lens' CreateProfile (Maybe [Text])
- createProfile_tags :: Lens' CreateProfile (Maybe (NonEmpty Tag))
- createProfile_as2Id :: Lens' CreateProfile Text
- createProfile_profileType :: Lens' CreateProfile ProfileType
- createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int
- createProfileResponse_profileId :: Lens' CreateProfileResponse Text
- createServer_certificate :: Lens' CreateServer (Maybe Text)
- createServer_domain :: Lens' CreateServer (Maybe Domain)
- createServer_endpointDetails :: Lens' CreateServer (Maybe EndpointDetails)
- createServer_endpointType :: Lens' CreateServer (Maybe EndpointType)
- createServer_hostKey :: Lens' CreateServer (Maybe Text)
- createServer_identityProviderDetails :: Lens' CreateServer (Maybe IdentityProviderDetails)
- createServer_identityProviderType :: Lens' CreateServer (Maybe IdentityProviderType)
- createServer_loggingRole :: Lens' CreateServer (Maybe Text)
- createServer_postAuthenticationLoginBanner :: Lens' CreateServer (Maybe Text)
- createServer_preAuthenticationLoginBanner :: Lens' CreateServer (Maybe Text)
- createServer_protocolDetails :: Lens' CreateServer (Maybe ProtocolDetails)
- createServer_protocols :: Lens' CreateServer (Maybe (NonEmpty Protocol))
- createServer_securityPolicyName :: Lens' CreateServer (Maybe Text)
- createServer_tags :: Lens' CreateServer (Maybe (NonEmpty Tag))
- createServer_workflowDetails :: Lens' CreateServer (Maybe WorkflowDetails)
- createServerResponse_httpStatus :: Lens' CreateServerResponse Int
- createServerResponse_serverId :: Lens' CreateServerResponse Text
- createUser_homeDirectory :: Lens' CreateUser (Maybe Text)
- createUser_homeDirectoryMappings :: Lens' CreateUser (Maybe (NonEmpty HomeDirectoryMapEntry))
- createUser_homeDirectoryType :: Lens' CreateUser (Maybe HomeDirectoryType)
- createUser_policy :: Lens' CreateUser (Maybe Text)
- createUser_posixProfile :: Lens' CreateUser (Maybe PosixProfile)
- createUser_sshPublicKeyBody :: Lens' CreateUser (Maybe Text)
- createUser_tags :: Lens' CreateUser (Maybe (NonEmpty Tag))
- createUser_role :: Lens' CreateUser Text
- createUser_serverId :: Lens' CreateUser Text
- createUser_userName :: Lens' CreateUser Text
- createUserResponse_httpStatus :: Lens' CreateUserResponse Int
- createUserResponse_serverId :: Lens' CreateUserResponse Text
- createUserResponse_userName :: Lens' CreateUserResponse Text
- createWorkflow_description :: Lens' CreateWorkflow (Maybe Text)
- createWorkflow_onExceptionSteps :: Lens' CreateWorkflow (Maybe [WorkflowStep])
- createWorkflow_tags :: Lens' CreateWorkflow (Maybe (NonEmpty Tag))
- createWorkflow_steps :: Lens' CreateWorkflow [WorkflowStep]
- createWorkflowResponse_httpStatus :: Lens' CreateWorkflowResponse Int
- createWorkflowResponse_workflowId :: Lens' CreateWorkflowResponse Text
- deleteAccess_serverId :: Lens' DeleteAccess Text
- deleteAccess_externalId :: Lens' DeleteAccess Text
- deleteAgreement_agreementId :: Lens' DeleteAgreement Text
- deleteAgreement_serverId :: Lens' DeleteAgreement Text
- deleteCertificate_certificateId :: Lens' DeleteCertificate Text
- deleteConnector_connectorId :: Lens' DeleteConnector Text
- deleteHostKey_serverId :: Lens' DeleteHostKey Text
- deleteHostKey_hostKeyId :: Lens' DeleteHostKey Text
- deleteProfile_profileId :: Lens' DeleteProfile Text
- deleteServer_serverId :: Lens' DeleteServer Text
- deleteSshPublicKey_serverId :: Lens' DeleteSshPublicKey Text
- deleteSshPublicKey_sshPublicKeyId :: Lens' DeleteSshPublicKey Text
- deleteSshPublicKey_userName :: Lens' DeleteSshPublicKey Text
- deleteUser_serverId :: Lens' DeleteUser Text
- deleteUser_userName :: Lens' DeleteUser Text
- deleteWorkflow_workflowId :: Lens' DeleteWorkflow Text
- describeAccess_serverId :: Lens' DescribeAccess Text
- describeAccess_externalId :: Lens' DescribeAccess Text
- describeAccessResponse_httpStatus :: Lens' DescribeAccessResponse Int
- describeAccessResponse_serverId :: Lens' DescribeAccessResponse Text
- describeAccessResponse_access :: Lens' DescribeAccessResponse DescribedAccess
- describeAgreement_agreementId :: Lens' DescribeAgreement Text
- describeAgreement_serverId :: Lens' DescribeAgreement Text
- describeAgreementResponse_httpStatus :: Lens' DescribeAgreementResponse Int
- describeAgreementResponse_agreement :: Lens' DescribeAgreementResponse DescribedAgreement
- describeCertificate_certificateId :: Lens' DescribeCertificate Text
- describeCertificateResponse_httpStatus :: Lens' DescribeCertificateResponse Int
- describeCertificateResponse_certificate :: Lens' DescribeCertificateResponse DescribedCertificate
- describeConnector_connectorId :: Lens' DescribeConnector Text
- describeConnectorResponse_httpStatus :: Lens' DescribeConnectorResponse Int
- describeConnectorResponse_connector :: Lens' DescribeConnectorResponse DescribedConnector
- describeExecution_executionId :: Lens' DescribeExecution Text
- describeExecution_workflowId :: Lens' DescribeExecution Text
- describeExecutionResponse_httpStatus :: Lens' DescribeExecutionResponse Int
- describeExecutionResponse_workflowId :: Lens' DescribeExecutionResponse Text
- describeExecutionResponse_execution :: Lens' DescribeExecutionResponse DescribedExecution
- describeHostKey_serverId :: Lens' DescribeHostKey Text
- describeHostKey_hostKeyId :: Lens' DescribeHostKey Text
- describeHostKeyResponse_httpStatus :: Lens' DescribeHostKeyResponse Int
- describeHostKeyResponse_hostKey :: Lens' DescribeHostKeyResponse DescribedHostKey
- describeProfile_profileId :: Lens' DescribeProfile Text
- describeProfileResponse_httpStatus :: Lens' DescribeProfileResponse Int
- describeProfileResponse_profile :: Lens' DescribeProfileResponse DescribedProfile
- describeSecurityPolicy_securityPolicyName :: Lens' DescribeSecurityPolicy Text
- describeSecurityPolicyResponse_httpStatus :: Lens' DescribeSecurityPolicyResponse Int
- describeSecurityPolicyResponse_securityPolicy :: Lens' DescribeSecurityPolicyResponse DescribedSecurityPolicy
- describeServer_serverId :: Lens' DescribeServer Text
- describeServerResponse_httpStatus :: Lens' DescribeServerResponse Int
- describeServerResponse_server :: Lens' DescribeServerResponse DescribedServer
- describeUser_serverId :: Lens' DescribeUser Text
- describeUser_userName :: Lens' DescribeUser Text
- describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int
- describeUserResponse_serverId :: Lens' DescribeUserResponse Text
- describeUserResponse_user :: Lens' DescribeUserResponse DescribedUser
- describeWorkflow_workflowId :: Lens' DescribeWorkflow Text
- describeWorkflowResponse_httpStatus :: Lens' DescribeWorkflowResponse Int
- describeWorkflowResponse_workflow :: Lens' DescribeWorkflowResponse DescribedWorkflow
- importCertificate_activeDate :: Lens' ImportCertificate (Maybe UTCTime)
- importCertificate_certificateChain :: Lens' ImportCertificate (Maybe Text)
- importCertificate_description :: Lens' ImportCertificate (Maybe Text)
- importCertificate_inactiveDate :: Lens' ImportCertificate (Maybe UTCTime)
- importCertificate_privateKey :: Lens' ImportCertificate (Maybe Text)
- importCertificate_tags :: Lens' ImportCertificate (Maybe (NonEmpty Tag))
- importCertificate_usage :: Lens' ImportCertificate CertificateUsageType
- importCertificate_certificate :: Lens' ImportCertificate Text
- importCertificateResponse_httpStatus :: Lens' ImportCertificateResponse Int
- importCertificateResponse_certificateId :: Lens' ImportCertificateResponse Text
- importHostKey_description :: Lens' ImportHostKey (Maybe Text)
- importHostKey_tags :: Lens' ImportHostKey (Maybe (NonEmpty Tag))
- importHostKey_serverId :: Lens' ImportHostKey Text
- importHostKey_hostKeyBody :: Lens' ImportHostKey Text
- importHostKeyResponse_httpStatus :: Lens' ImportHostKeyResponse Int
- importHostKeyResponse_serverId :: Lens' ImportHostKeyResponse Text
- importHostKeyResponse_hostKeyId :: Lens' ImportHostKeyResponse Text
- importSshPublicKey_serverId :: Lens' ImportSshPublicKey Text
- importSshPublicKey_sshPublicKeyBody :: Lens' ImportSshPublicKey Text
- importSshPublicKey_userName :: Lens' ImportSshPublicKey Text
- importSshPublicKeyResponse_httpStatus :: Lens' ImportSshPublicKeyResponse Int
- importSshPublicKeyResponse_serverId :: Lens' ImportSshPublicKeyResponse Text
- importSshPublicKeyResponse_sshPublicKeyId :: Lens' ImportSshPublicKeyResponse Text
- importSshPublicKeyResponse_userName :: Lens' ImportSshPublicKeyResponse Text
- listAccesses_maxResults :: Lens' ListAccesses (Maybe Natural)
- listAccesses_nextToken :: Lens' ListAccesses (Maybe Text)
- listAccesses_serverId :: Lens' ListAccesses Text
- listAccessesResponse_nextToken :: Lens' ListAccessesResponse (Maybe Text)
- listAccessesResponse_httpStatus :: Lens' ListAccessesResponse Int
- listAccessesResponse_serverId :: Lens' ListAccessesResponse Text
- listAccessesResponse_accesses :: Lens' ListAccessesResponse [ListedAccess]
- listAgreements_maxResults :: Lens' ListAgreements (Maybe Natural)
- listAgreements_nextToken :: Lens' ListAgreements (Maybe Text)
- listAgreements_serverId :: Lens' ListAgreements Text
- listAgreementsResponse_nextToken :: Lens' ListAgreementsResponse (Maybe Text)
- listAgreementsResponse_httpStatus :: Lens' ListAgreementsResponse Int
- listAgreementsResponse_agreements :: Lens' ListAgreementsResponse [ListedAgreement]
- listCertificates_maxResults :: Lens' ListCertificates (Maybe Natural)
- listCertificates_nextToken :: Lens' ListCertificates (Maybe Text)
- listCertificatesResponse_nextToken :: Lens' ListCertificatesResponse (Maybe Text)
- listCertificatesResponse_httpStatus :: Lens' ListCertificatesResponse Int
- listCertificatesResponse_certificates :: Lens' ListCertificatesResponse [ListedCertificate]
- listConnectors_maxResults :: Lens' ListConnectors (Maybe Natural)
- listConnectors_nextToken :: Lens' ListConnectors (Maybe Text)
- listConnectorsResponse_nextToken :: Lens' ListConnectorsResponse (Maybe Text)
- listConnectorsResponse_httpStatus :: Lens' ListConnectorsResponse Int
- listConnectorsResponse_connectors :: Lens' ListConnectorsResponse [ListedConnector]
- listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural)
- listExecutions_nextToken :: Lens' ListExecutions (Maybe Text)
- listExecutions_workflowId :: Lens' ListExecutions Text
- listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text)
- listExecutionsResponse_httpStatus :: Lens' ListExecutionsResponse Int
- listExecutionsResponse_workflowId :: Lens' ListExecutionsResponse Text
- listExecutionsResponse_executions :: Lens' ListExecutionsResponse [ListedExecution]
- listHostKeys_maxResults :: Lens' ListHostKeys (Maybe Natural)
- listHostKeys_nextToken :: Lens' ListHostKeys (Maybe Text)
- listHostKeys_serverId :: Lens' ListHostKeys Text
- listHostKeysResponse_nextToken :: Lens' ListHostKeysResponse (Maybe Text)
- listHostKeysResponse_httpStatus :: Lens' ListHostKeysResponse Int
- listHostKeysResponse_serverId :: Lens' ListHostKeysResponse Text
- listHostKeysResponse_hostKeys :: Lens' ListHostKeysResponse [ListedHostKey]
- listProfiles_maxResults :: Lens' ListProfiles (Maybe Natural)
- listProfiles_nextToken :: Lens' ListProfiles (Maybe Text)
- listProfiles_profileType :: Lens' ListProfiles (Maybe ProfileType)
- listProfilesResponse_nextToken :: Lens' ListProfilesResponse (Maybe Text)
- listProfilesResponse_httpStatus :: Lens' ListProfilesResponse Int
- listProfilesResponse_profiles :: Lens' ListProfilesResponse [ListedProfile]
- listSecurityPolicies_maxResults :: Lens' ListSecurityPolicies (Maybe Natural)
- listSecurityPolicies_nextToken :: Lens' ListSecurityPolicies (Maybe Text)
- listSecurityPoliciesResponse_nextToken :: Lens' ListSecurityPoliciesResponse (Maybe Text)
- listSecurityPoliciesResponse_httpStatus :: Lens' ListSecurityPoliciesResponse Int
- listSecurityPoliciesResponse_securityPolicyNames :: Lens' ListSecurityPoliciesResponse [Text]
- listServers_maxResults :: Lens' ListServers (Maybe Natural)
- listServers_nextToken :: Lens' ListServers (Maybe Text)
- listServersResponse_nextToken :: Lens' ListServersResponse (Maybe Text)
- listServersResponse_httpStatus :: Lens' ListServersResponse Int
- listServersResponse_servers :: Lens' ListServersResponse [ListedServer]
- listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)
- listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)
- listTagsForResource_arn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_arn :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
- listUsers_nextToken :: Lens' ListUsers (Maybe Text)
- listUsers_serverId :: Lens' ListUsers Text
- listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)
- listUsersResponse_httpStatus :: Lens' ListUsersResponse Int
- listUsersResponse_serverId :: Lens' ListUsersResponse Text
- listUsersResponse_users :: Lens' ListUsersResponse [ListedUser]
- listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural)
- listWorkflows_nextToken :: Lens' ListWorkflows (Maybe Text)
- listWorkflowsResponse_nextToken :: Lens' ListWorkflowsResponse (Maybe Text)
- listWorkflowsResponse_httpStatus :: Lens' ListWorkflowsResponse Int
- listWorkflowsResponse_workflows :: Lens' ListWorkflowsResponse [ListedWorkflow]
- sendWorkflowStepState_workflowId :: Lens' SendWorkflowStepState Text
- sendWorkflowStepState_executionId :: Lens' SendWorkflowStepState Text
- sendWorkflowStepState_token :: Lens' SendWorkflowStepState Text
- sendWorkflowStepState_status :: Lens' SendWorkflowStepState CustomStepStatus
- sendWorkflowStepStateResponse_httpStatus :: Lens' SendWorkflowStepStateResponse Int
- startFileTransfer_connectorId :: Lens' StartFileTransfer Text
- startFileTransfer_sendFilePaths :: Lens' StartFileTransfer (NonEmpty Text)
- startFileTransferResponse_httpStatus :: Lens' StartFileTransferResponse Int
- startFileTransferResponse_transferId :: Lens' StartFileTransferResponse Text
- startServer_serverId :: Lens' StartServer Text
- stopServer_serverId :: Lens' StopServer Text
- tagResource_arn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (NonEmpty Tag)
- testIdentityProvider_serverProtocol :: Lens' TestIdentityProvider (Maybe Protocol)
- testIdentityProvider_sourceIp :: Lens' TestIdentityProvider (Maybe Text)
- testIdentityProvider_userPassword :: Lens' TestIdentityProvider (Maybe Text)
- testIdentityProvider_serverId :: Lens' TestIdentityProvider Text
- testIdentityProvider_userName :: Lens' TestIdentityProvider Text
- testIdentityProviderResponse_message :: Lens' TestIdentityProviderResponse (Maybe Text)
- testIdentityProviderResponse_response :: Lens' TestIdentityProviderResponse (Maybe Text)
- testIdentityProviderResponse_httpStatus :: Lens' TestIdentityProviderResponse Int
- testIdentityProviderResponse_statusCode :: Lens' TestIdentityProviderResponse Int
- testIdentityProviderResponse_url :: Lens' TestIdentityProviderResponse Text
- untagResource_arn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- updateAccess_homeDirectory :: Lens' UpdateAccess (Maybe Text)
- updateAccess_homeDirectoryMappings :: Lens' UpdateAccess (Maybe (NonEmpty HomeDirectoryMapEntry))
- updateAccess_homeDirectoryType :: Lens' UpdateAccess (Maybe HomeDirectoryType)
- updateAccess_policy :: Lens' UpdateAccess (Maybe Text)
- updateAccess_posixProfile :: Lens' UpdateAccess (Maybe PosixProfile)
- updateAccess_role :: Lens' UpdateAccess (Maybe Text)
- updateAccess_serverId :: Lens' UpdateAccess Text
- updateAccess_externalId :: Lens' UpdateAccess Text
- updateAccessResponse_httpStatus :: Lens' UpdateAccessResponse Int
- updateAccessResponse_serverId :: Lens' UpdateAccessResponse Text
- updateAccessResponse_externalId :: Lens' UpdateAccessResponse Text
- updateAgreement_accessRole :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_baseDirectory :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_description :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_localProfileId :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_partnerProfileId :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_status :: Lens' UpdateAgreement (Maybe AgreementStatusType)
- updateAgreement_agreementId :: Lens' UpdateAgreement Text
- updateAgreement_serverId :: Lens' UpdateAgreement Text
- updateAgreementResponse_httpStatus :: Lens' UpdateAgreementResponse Int
- updateAgreementResponse_agreementId :: Lens' UpdateAgreementResponse Text
- updateCertificate_activeDate :: Lens' UpdateCertificate (Maybe UTCTime)
- updateCertificate_description :: Lens' UpdateCertificate (Maybe Text)
- updateCertificate_inactiveDate :: Lens' UpdateCertificate (Maybe UTCTime)
- updateCertificate_certificateId :: Lens' UpdateCertificate Text
- updateCertificateResponse_httpStatus :: Lens' UpdateCertificateResponse Int
- updateCertificateResponse_certificateId :: Lens' UpdateCertificateResponse Text
- updateConnector_accessRole :: Lens' UpdateConnector (Maybe Text)
- updateConnector_as2Config :: Lens' UpdateConnector (Maybe As2ConnectorConfig)
- updateConnector_loggingRole :: Lens' UpdateConnector (Maybe Text)
- updateConnector_url :: Lens' UpdateConnector (Maybe Text)
- updateConnector_connectorId :: Lens' UpdateConnector Text
- updateConnectorResponse_httpStatus :: Lens' UpdateConnectorResponse Int
- updateConnectorResponse_connectorId :: Lens' UpdateConnectorResponse Text
- updateHostKey_serverId :: Lens' UpdateHostKey Text
- updateHostKey_hostKeyId :: Lens' UpdateHostKey Text
- updateHostKey_description :: Lens' UpdateHostKey Text
- updateHostKeyResponse_httpStatus :: Lens' UpdateHostKeyResponse Int
- updateHostKeyResponse_serverId :: Lens' UpdateHostKeyResponse Text
- updateHostKeyResponse_hostKeyId :: Lens' UpdateHostKeyResponse Text
- updateProfile_certificateIds :: Lens' UpdateProfile (Maybe [Text])
- updateProfile_profileId :: Lens' UpdateProfile Text
- updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int
- updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text
- updateServer_certificate :: Lens' UpdateServer (Maybe Text)
- updateServer_endpointDetails :: Lens' UpdateServer (Maybe EndpointDetails)
- updateServer_endpointType :: Lens' UpdateServer (Maybe EndpointType)
- updateServer_hostKey :: Lens' UpdateServer (Maybe Text)
- updateServer_identityProviderDetails :: Lens' UpdateServer (Maybe IdentityProviderDetails)
- updateServer_loggingRole :: Lens' UpdateServer (Maybe Text)
- updateServer_postAuthenticationLoginBanner :: Lens' UpdateServer (Maybe Text)
- updateServer_preAuthenticationLoginBanner :: Lens' UpdateServer (Maybe Text)
- updateServer_protocolDetails :: Lens' UpdateServer (Maybe ProtocolDetails)
- updateServer_protocols :: Lens' UpdateServer (Maybe (NonEmpty Protocol))
- updateServer_securityPolicyName :: Lens' UpdateServer (Maybe Text)
- updateServer_workflowDetails :: Lens' UpdateServer (Maybe WorkflowDetails)
- updateServer_serverId :: Lens' UpdateServer Text
- updateServerResponse_httpStatus :: Lens' UpdateServerResponse Int
- updateServerResponse_serverId :: Lens' UpdateServerResponse Text
- updateUser_homeDirectory :: Lens' UpdateUser (Maybe Text)
- updateUser_homeDirectoryMappings :: Lens' UpdateUser (Maybe (NonEmpty HomeDirectoryMapEntry))
- updateUser_homeDirectoryType :: Lens' UpdateUser (Maybe HomeDirectoryType)
- updateUser_policy :: Lens' UpdateUser (Maybe Text)
- updateUser_posixProfile :: Lens' UpdateUser (Maybe PosixProfile)
- updateUser_role :: Lens' UpdateUser (Maybe Text)
- updateUser_serverId :: Lens' UpdateUser Text
- updateUser_userName :: Lens' UpdateUser Text
- updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int
- updateUserResponse_serverId :: Lens' UpdateUserResponse Text
- updateUserResponse_userName :: Lens' UpdateUserResponse Text
- as2ConnectorConfig_compression :: Lens' As2ConnectorConfig (Maybe CompressionEnum)
- as2ConnectorConfig_encryptionAlgorithm :: Lens' As2ConnectorConfig (Maybe EncryptionAlg)
- as2ConnectorConfig_localProfileId :: Lens' As2ConnectorConfig (Maybe Text)
- as2ConnectorConfig_mdnResponse :: Lens' As2ConnectorConfig (Maybe MdnResponse)
- as2ConnectorConfig_mdnSigningAlgorithm :: Lens' As2ConnectorConfig (Maybe MdnSigningAlg)
- as2ConnectorConfig_messageSubject :: Lens' As2ConnectorConfig (Maybe Text)
- as2ConnectorConfig_partnerProfileId :: Lens' As2ConnectorConfig (Maybe Text)
- as2ConnectorConfig_signingAlgorithm :: Lens' As2ConnectorConfig (Maybe SigningAlg)
- copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation)
- copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text)
- copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting)
- copyStepDetails_sourceFileLocation :: Lens' CopyStepDetails (Maybe Text)
- customStepDetails_name :: Lens' CustomStepDetails (Maybe Text)
- customStepDetails_sourceFileLocation :: Lens' CustomStepDetails (Maybe Text)
- customStepDetails_target :: Lens' CustomStepDetails (Maybe Text)
- customStepDetails_timeoutSeconds :: Lens' CustomStepDetails (Maybe Natural)
- decryptStepDetails_name :: Lens' DecryptStepDetails (Maybe Text)
- decryptStepDetails_overwriteExisting :: Lens' DecryptStepDetails (Maybe OverwriteExisting)
- decryptStepDetails_sourceFileLocation :: Lens' DecryptStepDetails (Maybe Text)
- decryptStepDetails_type :: Lens' DecryptStepDetails EncryptionType
- decryptStepDetails_destinationFileLocation :: Lens' DecryptStepDetails InputFileLocation
- deleteStepDetails_name :: Lens' DeleteStepDetails (Maybe Text)
- deleteStepDetails_sourceFileLocation :: Lens' DeleteStepDetails (Maybe Text)
- describedAccess_externalId :: Lens' DescribedAccess (Maybe Text)
- describedAccess_homeDirectory :: Lens' DescribedAccess (Maybe Text)
- describedAccess_homeDirectoryMappings :: Lens' DescribedAccess (Maybe (NonEmpty HomeDirectoryMapEntry))
- describedAccess_homeDirectoryType :: Lens' DescribedAccess (Maybe HomeDirectoryType)
- describedAccess_policy :: Lens' DescribedAccess (Maybe Text)
- describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile)
- describedAccess_role :: Lens' DescribedAccess (Maybe Text)
- describedAgreement_accessRole :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_agreementId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_baseDirectory :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_description :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_localProfileId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_partnerProfileId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_serverId :: Lens' DescribedAgreement (Maybe Text)
- describedAgreement_status :: Lens' DescribedAgreement (Maybe AgreementStatusType)
- describedAgreement_tags :: Lens' DescribedAgreement (Maybe (NonEmpty Tag))
- describedAgreement_arn :: Lens' DescribedAgreement Text
- describedCertificate_activeDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_certificate :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_certificateChain :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_certificateId :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_description :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_inactiveDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_notAfterDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_notBeforeDate :: Lens' DescribedCertificate (Maybe UTCTime)
- describedCertificate_serial :: Lens' DescribedCertificate (Maybe Text)
- describedCertificate_status :: Lens' DescribedCertificate (Maybe CertificateStatusType)
- describedCertificate_tags :: Lens' DescribedCertificate (Maybe (NonEmpty Tag))
- describedCertificate_type :: Lens' DescribedCertificate (Maybe CertificateType)
- describedCertificate_usage :: Lens' DescribedCertificate (Maybe CertificateUsageType)
- describedCertificate_arn :: Lens' DescribedCertificate Text
- describedConnector_accessRole :: Lens' DescribedConnector (Maybe Text)
- describedConnector_as2Config :: Lens' DescribedConnector (Maybe As2ConnectorConfig)
- describedConnector_connectorId :: Lens' DescribedConnector (Maybe Text)
- describedConnector_loggingRole :: Lens' DescribedConnector (Maybe Text)
- describedConnector_tags :: Lens' DescribedConnector (Maybe (NonEmpty Tag))
- describedConnector_url :: Lens' DescribedConnector (Maybe Text)
- describedConnector_arn :: Lens' DescribedConnector Text
- describedExecution_executionId :: Lens' DescribedExecution (Maybe Text)
- describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text)
- describedExecution_initialFileLocation :: Lens' DescribedExecution (Maybe FileLocation)
- describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration)
- describedExecution_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile)
- describedExecution_results :: Lens' DescribedExecution (Maybe ExecutionResults)
- describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata)
- describedExecution_status :: Lens' DescribedExecution (Maybe ExecutionStatus)
- describedHostKey_dateImported :: Lens' DescribedHostKey (Maybe UTCTime)
- describedHostKey_description :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_hostKeyFingerprint :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_hostKeyId :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_tags :: Lens' DescribedHostKey (Maybe (NonEmpty Tag))
- describedHostKey_type :: Lens' DescribedHostKey (Maybe Text)
- describedHostKey_arn :: Lens' DescribedHostKey Text
- describedProfile_as2Id :: Lens' DescribedProfile (Maybe Text)
- describedProfile_certificateIds :: Lens' DescribedProfile (Maybe [Text])
- describedProfile_profileId :: Lens' DescribedProfile (Maybe Text)
- describedProfile_profileType :: Lens' DescribedProfile (Maybe ProfileType)
- describedProfile_tags :: Lens' DescribedProfile (Maybe (NonEmpty Tag))
- describedProfile_arn :: Lens' DescribedProfile Text
- describedSecurityPolicy_fips :: Lens' DescribedSecurityPolicy (Maybe Bool)
- describedSecurityPolicy_sshCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_sshKexs :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_sshMacs :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_tlsCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_securityPolicyName :: Lens' DescribedSecurityPolicy Text
- describedServer_certificate :: Lens' DescribedServer (Maybe Text)
- describedServer_domain :: Lens' DescribedServer (Maybe Domain)
- describedServer_endpointDetails :: Lens' DescribedServer (Maybe EndpointDetails)
- describedServer_endpointType :: Lens' DescribedServer (Maybe EndpointType)
- describedServer_hostKeyFingerprint :: Lens' DescribedServer (Maybe Text)
- describedServer_identityProviderDetails :: Lens' DescribedServer (Maybe IdentityProviderDetails)
- describedServer_identityProviderType :: Lens' DescribedServer (Maybe IdentityProviderType)
- describedServer_loggingRole :: Lens' DescribedServer (Maybe Text)
- describedServer_postAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text)
- describedServer_preAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text)
- describedServer_protocolDetails :: Lens' DescribedServer (Maybe ProtocolDetails)
- describedServer_protocols :: Lens' DescribedServer (Maybe (NonEmpty Protocol))
- describedServer_securityPolicyName :: Lens' DescribedServer (Maybe Text)
- describedServer_serverId :: Lens' DescribedServer (Maybe Text)
- describedServer_state :: Lens' DescribedServer (Maybe State)
- describedServer_tags :: Lens' DescribedServer (Maybe (NonEmpty Tag))
- describedServer_userCount :: Lens' DescribedServer (Maybe Int)
- describedServer_workflowDetails :: Lens' DescribedServer (Maybe WorkflowDetails)
- describedServer_arn :: Lens' DescribedServer Text
- describedUser_homeDirectory :: Lens' DescribedUser (Maybe Text)
- describedUser_homeDirectoryMappings :: Lens' DescribedUser (Maybe (NonEmpty HomeDirectoryMapEntry))
- describedUser_homeDirectoryType :: Lens' DescribedUser (Maybe HomeDirectoryType)
- describedUser_policy :: Lens' DescribedUser (Maybe Text)
- describedUser_posixProfile :: Lens' DescribedUser (Maybe PosixProfile)
- describedUser_role :: Lens' DescribedUser (Maybe Text)
- describedUser_sshPublicKeys :: Lens' DescribedUser (Maybe [SshPublicKey])
- describedUser_tags :: Lens' DescribedUser (Maybe (NonEmpty Tag))
- describedUser_userName :: Lens' DescribedUser (Maybe Text)
- describedUser_arn :: Lens' DescribedUser Text
- describedWorkflow_description :: Lens' DescribedWorkflow (Maybe Text)
- describedWorkflow_onExceptionSteps :: Lens' DescribedWorkflow (Maybe [WorkflowStep])
- describedWorkflow_steps :: Lens' DescribedWorkflow (Maybe [WorkflowStep])
- describedWorkflow_tags :: Lens' DescribedWorkflow (Maybe (NonEmpty Tag))
- describedWorkflow_workflowId :: Lens' DescribedWorkflow (Maybe Text)
- describedWorkflow_arn :: Lens' DescribedWorkflow Text
- efsFileLocation_fileSystemId :: Lens' EfsFileLocation (Maybe Text)
- efsFileLocation_path :: Lens' EfsFileLocation (Maybe Text)
- endpointDetails_addressAllocationIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_securityGroupIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_subnetIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_vpcEndpointId :: Lens' EndpointDetails (Maybe Text)
- endpointDetails_vpcId :: Lens' EndpointDetails (Maybe Text)
- executionError_type :: Lens' ExecutionError ExecutionErrorType
- executionError_message :: Lens' ExecutionError Text
- executionResults_onExceptionSteps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult))
- executionResults_steps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult))
- executionStepResult_error :: Lens' ExecutionStepResult (Maybe ExecutionError)
- executionStepResult_outputs :: Lens' ExecutionStepResult (Maybe Text)
- executionStepResult_stepType :: Lens' ExecutionStepResult (Maybe WorkflowStepType)
- fileLocation_efsFileLocation :: Lens' FileLocation (Maybe EfsFileLocation)
- fileLocation_s3FileLocation :: Lens' FileLocation (Maybe S3FileLocation)
- homeDirectoryMapEntry_entry :: Lens' HomeDirectoryMapEntry Text
- homeDirectoryMapEntry_target :: Lens' HomeDirectoryMapEntry Text
- identityProviderDetails_directoryId :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_function :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_invocationRole :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_url :: Lens' IdentityProviderDetails (Maybe Text)
- inputFileLocation_efsFileLocation :: Lens' InputFileLocation (Maybe EfsFileLocation)
- inputFileLocation_s3FileLocation :: Lens' InputFileLocation (Maybe S3InputFileLocation)
- listedAccess_externalId :: Lens' ListedAccess (Maybe Text)
- listedAccess_homeDirectory :: Lens' ListedAccess (Maybe Text)
- listedAccess_homeDirectoryType :: Lens' ListedAccess (Maybe HomeDirectoryType)
- listedAccess_role :: Lens' ListedAccess (Maybe Text)
- listedAgreement_agreementId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_arn :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_description :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_localProfileId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_partnerProfileId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_serverId :: Lens' ListedAgreement (Maybe Text)
- listedAgreement_status :: Lens' ListedAgreement (Maybe AgreementStatusType)
- listedCertificate_activeDate :: Lens' ListedCertificate (Maybe UTCTime)
- listedCertificate_arn :: Lens' ListedCertificate (Maybe Text)
- listedCertificate_certificateId :: Lens' ListedCertificate (Maybe Text)
- listedCertificate_description :: Lens' ListedCertificate (Maybe Text)
- listedCertificate_inactiveDate :: Lens' ListedCertificate (Maybe UTCTime)
- listedCertificate_status :: Lens' ListedCertificate (Maybe CertificateStatusType)
- listedCertificate_type :: Lens' ListedCertificate (Maybe CertificateType)
- listedCertificate_usage :: Lens' ListedCertificate (Maybe CertificateUsageType)
- listedConnector_arn :: Lens' ListedConnector (Maybe Text)
- listedConnector_connectorId :: Lens' ListedConnector (Maybe Text)
- listedConnector_url :: Lens' ListedConnector (Maybe Text)
- listedExecution_executionId :: Lens' ListedExecution (Maybe Text)
- listedExecution_initialFileLocation :: Lens' ListedExecution (Maybe FileLocation)
- listedExecution_serviceMetadata :: Lens' ListedExecution (Maybe ServiceMetadata)
- listedExecution_status :: Lens' ListedExecution (Maybe ExecutionStatus)
- listedHostKey_dateImported :: Lens' ListedHostKey (Maybe UTCTime)
- listedHostKey_description :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_fingerprint :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_hostKeyId :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_type :: Lens' ListedHostKey (Maybe Text)
- listedHostKey_arn :: Lens' ListedHostKey Text
- listedProfile_arn :: Lens' ListedProfile (Maybe Text)
- listedProfile_as2Id :: Lens' ListedProfile (Maybe Text)
- listedProfile_profileId :: Lens' ListedProfile (Maybe Text)
- listedProfile_profileType :: Lens' ListedProfile (Maybe ProfileType)
- listedServer_domain :: Lens' ListedServer (Maybe Domain)
- listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType)
- listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType)
- listedServer_loggingRole :: Lens' ListedServer (Maybe Text)
- listedServer_serverId :: Lens' ListedServer (Maybe Text)
- listedServer_state :: Lens' ListedServer (Maybe State)
- listedServer_userCount :: Lens' ListedServer (Maybe Int)
- listedServer_arn :: Lens' ListedServer Text
- listedUser_homeDirectory :: Lens' ListedUser (Maybe Text)
- listedUser_homeDirectoryType :: Lens' ListedUser (Maybe HomeDirectoryType)
- listedUser_role :: Lens' ListedUser (Maybe Text)
- listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int)
- listedUser_userName :: Lens' ListedUser (Maybe Text)
- listedUser_arn :: Lens' ListedUser Text
- listedWorkflow_arn :: Lens' ListedWorkflow (Maybe Text)
- listedWorkflow_description :: Lens' ListedWorkflow (Maybe Text)
- listedWorkflow_workflowId :: Lens' ListedWorkflow (Maybe Text)
- loggingConfiguration_logGroupName :: Lens' LoggingConfiguration (Maybe Text)
- loggingConfiguration_loggingRole :: Lens' LoggingConfiguration (Maybe Text)
- posixProfile_secondaryGids :: Lens' PosixProfile (Maybe [Natural])
- posixProfile_uid :: Lens' PosixProfile Natural
- posixProfile_gid :: Lens' PosixProfile Natural
- protocolDetails_as2Transports :: Lens' ProtocolDetails (Maybe (NonEmpty As2Transport))
- protocolDetails_passiveIp :: Lens' ProtocolDetails (Maybe Text)
- protocolDetails_setStatOption :: Lens' ProtocolDetails (Maybe SetStatOption)
- protocolDetails_tlsSessionResumptionMode :: Lens' ProtocolDetails (Maybe TlsSessionResumptionMode)
- s3FileLocation_bucket :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_etag :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_key :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_versionId :: Lens' S3FileLocation (Maybe Text)
- s3InputFileLocation_bucket :: Lens' S3InputFileLocation (Maybe Text)
- s3InputFileLocation_key :: Lens' S3InputFileLocation (Maybe Text)
- s3Tag_key :: Lens' S3Tag Text
- s3Tag_value :: Lens' S3Tag Text
- serviceMetadata_userDetails :: Lens' ServiceMetadata UserDetails
- sshPublicKey_dateImported :: Lens' SshPublicKey UTCTime
- sshPublicKey_sshPublicKeyBody :: Lens' SshPublicKey Text
- sshPublicKey_sshPublicKeyId :: Lens' SshPublicKey Text
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- tagStepDetails_name :: Lens' TagStepDetails (Maybe Text)
- tagStepDetails_sourceFileLocation :: Lens' TagStepDetails (Maybe Text)
- tagStepDetails_tags :: Lens' TagStepDetails (Maybe (NonEmpty S3Tag))
- userDetails_sessionId :: Lens' UserDetails (Maybe Text)
- userDetails_userName :: Lens' UserDetails Text
- userDetails_serverId :: Lens' UserDetails Text
- workflowDetail_workflowId :: Lens' WorkflowDetail Text
- workflowDetail_executionRole :: Lens' WorkflowDetail Text
- workflowDetails_onPartialUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail])
- workflowDetails_onUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail])
- workflowStep_copyStepDetails :: Lens' WorkflowStep (Maybe CopyStepDetails)
- workflowStep_customStepDetails :: Lens' WorkflowStep (Maybe CustomStepDetails)
- workflowStep_decryptStepDetails :: Lens' WorkflowStep (Maybe DecryptStepDetails)
- workflowStep_deleteStepDetails :: Lens' WorkflowStep (Maybe DeleteStepDetails)
- workflowStep_tagStepDetails :: Lens' WorkflowStep (Maybe TagStepDetails)
- workflowStep_type :: Lens' WorkflowStep (Maybe WorkflowStepType)
Operations
CreateAccess
createAccess_homeDirectory :: Lens' CreateAccess (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
createAccess_homeDirectoryMappings :: Lens' CreateAccess (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
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_homeDirectoryType :: Lens' CreateAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
createAccess_policy :: Lens' CreateAccess (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName}
,
${Transfer:HomeDirectory}
, and ${Transfer:HomeBucket}
.
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_posixProfile :: Lens' CreateAccess (Maybe PosixProfile) Source #
Undocumented member.
createAccess_role :: Lens' CreateAccess Text Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
createAccess_serverId :: Lens' CreateAccess Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
createAccess_externalId :: Lens' CreateAccess Text Source #
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
createAccessResponse_httpStatus :: Lens' CreateAccessResponse Int Source #
The response's http status code.
createAccessResponse_serverId :: Lens' CreateAccessResponse Text Source #
The identifier of the server that the user is attached to.
createAccessResponse_externalId :: Lens' CreateAccessResponse Text Source #
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
createAgreement_description :: Lens' CreateAgreement (Maybe Text) Source #
A name or short description to identify the agreement.
createAgreement_status :: Lens' CreateAgreement (Maybe AgreementStatusType) Source #
The status of the agreement. The agreement can be either ACTIVE
or
INACTIVE
.
createAgreement_tags :: Lens' CreateAgreement (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for agreements.
createAgreement_serverId :: Lens' CreateAgreement Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
createAgreement_localProfileId :: Lens' CreateAgreement Text Source #
A unique identifier for the AS2 local profile.
createAgreement_partnerProfileId :: Lens' CreateAgreement Text Source #
A unique identifier for the partner profile used in the agreement.
createAgreement_baseDirectory :: Lens' CreateAgreement Text Source #
The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory
example is
DOC-EXAMPLE-BUCKET/home/mydirectory.
createAgreement_accessRole :: Lens' CreateAgreement Text Source #
With AS2, you can send files by calling StartFileTransfer
and
specifying the file paths in the request parameter, SendFilePaths
. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt
, parent directory is
/bucket/dir/
) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole
needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer
request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer
.
createAgreementResponse_httpStatus :: Lens' CreateAgreementResponse Int Source #
The response's http status code.
createAgreementResponse_agreementId :: Lens' CreateAgreementResponse Text Source #
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
createConnector_loggingRole :: Lens' CreateConnector (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
createConnector_tags :: Lens' CreateConnector (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
createConnector_url :: Lens' CreateConnector Text Source #
The URL of the partner's AS2 endpoint.
createConnector_as2Config :: Lens' CreateConnector As2ConnectorConfig Source #
A structure that contains the parameters for a connector object.
createConnector_accessRole :: Lens' CreateConnector Text Source #
With AS2, you can send files by calling StartFileTransfer
and
specifying the file paths in the request parameter, SendFilePaths
. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt
, parent directory is
/bucket/dir/
) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole
needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer
request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer
.
createConnectorResponse_httpStatus :: Lens' CreateConnectorResponse Int Source #
The response's http status code.
createConnectorResponse_connectorId :: Lens' CreateConnectorResponse Text Source #
The unique identifier for the connector, returned after the API call succeeds.
CreateProfile
createProfile_certificateIds :: Lens' CreateProfile (Maybe [Text]) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
createProfile_tags :: Lens' CreateProfile (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for AS2 profiles.
createProfile_as2Id :: Lens' CreateProfile Text Source #
The As2Id
is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From
header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To
header for
the AS2 messages sent to the partner using the StartFileTransfer
API
operation. This ID cannot include spaces.
createProfile_profileType :: Lens' CreateProfile ProfileType Source #
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.
createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int Source #
The response's http status code.
createProfileResponse_profileId :: Lens' CreateProfileResponse Text Source #
The unique identifier for the AS2 profile, returned after the API call succeeds.
CreateServer
createServer_certificate :: Lens' CreateServer (Maybe Text) Source #
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_domain :: Lens' CreateServer (Maybe Domain) Source #
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_endpointDetails :: Lens' CreateServer (Maybe EndpointDetails) Source #
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
createServer_endpointType :: Lens' CreateServer (Maybe EndpointType) Source #
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
.
createServer_hostKey :: Lens' CreateServer (Maybe Text) Source #
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_identityProviderDetails :: Lens' CreateServer (Maybe IdentityProviderDetails) Source #
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_identityProviderType :: Lens' CreateServer (Maybe IdentityProviderType) Source #
The mode of authentication for a server. The default value is
SERVICE_MANAGED
, which allows you to store and access user credentials
within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups
in Directory Service for Microsoft Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connector. This option also requires you to provide a Directory
ID by using the IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of
your choosing. The API_GATEWAY
setting requires you to provide an
Amazon API Gateway endpoint URL to call for authentication by using the
IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your
identity provider. If you choose this value, you must specify the ARN
for the Lambda function in the Function
parameter or the
IdentityProviderDetails
data type.
createServer_loggingRole :: Lens' CreateServer (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
createServer_postAuthenticationLoginBanner :: Lens' CreateServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
createServer_preAuthenticationLoginBanner :: Lens' CreateServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
createServer_protocolDetails :: Lens' CreateServer (Maybe ProtocolDetails) Source #
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_protocols :: Lens' CreateServer (Maybe (NonEmpty Protocol)) Source #
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSHFTPS
(File Transfer Protocol Secure): File transfer with TLS encryptionFTP
(File Transfer Protocol): Unencrypted file transferAS2
(Applicability Statement 2): used for transporting structured business-to-business data- If you select
FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If
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_securityPolicyName :: Lens' CreateServer (Maybe Text) Source #
Specifies the name of the security policy that is attached to the server.
createServer_tags :: Lens' CreateServer (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for servers.
createServer_workflowDetails :: Lens' CreateServer (Maybe WorkflowDetails) Source #
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In additon to a workflow to execute when a file is uploaded completely,
WorkflowDeatails
can also contain a workflow ID (and execution role)
for a workflow to execute on partial upload. A partial upload occurs
when a file is open when the session disconnects.
createServerResponse_httpStatus :: Lens' CreateServerResponse Int Source #
The response's http status code.
createServerResponse_serverId :: Lens' CreateServerResponse Text Source #
The service-assigned identifier of the server that is created.
CreateUser
createUser_homeDirectory :: Lens' CreateUser (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
createUser_homeDirectoryMappings :: Lens' CreateUser (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
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_homeDirectoryType :: Lens' CreateUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
createUser_policy :: Lens' CreateUser (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName}
,
${Transfer:HomeDirectory}
, and ${Transfer:HomeBucket}
.
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_posixProfile :: Lens' CreateUser (Maybe PosixProfile) Source #
Specifies the full POSIX identity, including user ID (Uid
), group ID
(Gid
), and any secondary groups IDs (SecondaryGids
), that controls
your users' access to your Amazon 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_sshPublicKeyBody :: Lens' CreateUser (Maybe Text) Source #
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_tags :: Lens' CreateUser (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
createUser_role :: Lens' CreateUser Text Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
createUser_serverId :: Lens' CreateUser Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
createUser_userName :: Lens' CreateUser Text Source #
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.
createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #
The response's http status code.
createUserResponse_serverId :: Lens' CreateUserResponse Text Source #
The identifier of the server that the user is attached to.
createUserResponse_userName :: Lens' CreateUserResponse Text Source #
A unique string that identifies a user account associated with a server.
CreateWorkflow
createWorkflow_description :: Lens' CreateWorkflow (Maybe Text) Source #
A textual description for the workflow.
createWorkflow_onExceptionSteps :: Lens' CreateWorkflow (Maybe [WorkflowStep]) Source #
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_tags :: Lens' CreateWorkflow (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
createWorkflow_steps :: Lens' CreateWorkflow [WorkflowStep] Source #
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.
createWorkflowResponse_httpStatus :: Lens' CreateWorkflowResponse Int Source #
The response's http status code.
createWorkflowResponse_workflowId :: Lens' CreateWorkflowResponse Text Source #
A unique identifier for the workflow.
DeleteAccess
deleteAccess_serverId :: Lens' DeleteAccess Text Source #
A system-assigned unique identifier for a server that has this user assigned.
deleteAccess_externalId :: Lens' DeleteAccess Text Source #
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
DeleteAgreement
deleteAgreement_agreementId :: Lens' DeleteAgreement Text Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
deleteAgreement_serverId :: Lens' DeleteAgreement Text Source #
The server identifier associated with the agreement that you are deleting.
DeleteCertificate
deleteCertificate_certificateId :: Lens' DeleteCertificate Text Source #
The identifier of the certificate object that you are deleting.
DeleteConnector
deleteConnector_connectorId :: Lens' DeleteConnector Text Source #
The unique identifier for the connector.
DeleteHostKey
deleteHostKey_serverId :: Lens' DeleteHostKey Text Source #
The identifier of the server that contains the host key that you are deleting.
deleteHostKey_hostKeyId :: Lens' DeleteHostKey Text Source #
The identifier of the host key that you are deleting.
DeleteProfile
deleteProfile_profileId :: Lens' DeleteProfile Text Source #
The identifier of the profile that you are deleting.
DeleteServer
deleteServer_serverId :: Lens' DeleteServer Text Source #
A unique system-assigned identifier for a server instance.
DeleteSshPublicKey
deleteSshPublicKey_serverId :: Lens' DeleteSshPublicKey Text Source #
A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.
deleteSshPublicKey_sshPublicKeyId :: Lens' DeleteSshPublicKey Text Source #
A unique identifier used to reference your user's specific SSH key.
deleteSshPublicKey_userName :: Lens' DeleteSshPublicKey Text Source #
A unique string that identifies a user whose public key is being deleted.
DeleteUser
deleteUser_serverId :: Lens' DeleteUser Text Source #
A system-assigned unique identifier for a server instance that has the user assigned to it.
deleteUser_userName :: Lens' DeleteUser Text Source #
A unique string that identifies a user that is being deleted from a server.
DeleteWorkflow
deleteWorkflow_workflowId :: Lens' DeleteWorkflow Text Source #
A unique identifier for the workflow.
DescribeAccess
describeAccess_serverId :: Lens' DescribeAccess Text Source #
A system-assigned unique identifier for a server that has this access assigned.
describeAccess_externalId :: Lens' DescribeAccess Text Source #
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
describeAccessResponse_httpStatus :: Lens' DescribeAccessResponse Int Source #
The response's http status code.
describeAccessResponse_serverId :: Lens' DescribeAccessResponse Text Source #
A system-assigned unique identifier for a server that has this access assigned.
describeAccessResponse_access :: Lens' DescribeAccessResponse DescribedAccess Source #
The external identifier of the server that the access is attached to.
DescribeAgreement
describeAgreement_agreementId :: Lens' DescribeAgreement Text Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
describeAgreement_serverId :: Lens' DescribeAgreement Text Source #
The server identifier that's associated with the agreement.
describeAgreementResponse_httpStatus :: Lens' DescribeAgreementResponse Int Source #
The response's http status code.
describeAgreementResponse_agreement :: Lens' DescribeAgreementResponse DescribedAgreement Source #
The details for the specified agreement, returned as a
DescribedAgreement
object.
DescribeCertificate
describeCertificate_certificateId :: Lens' DescribeCertificate Text Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
describeCertificateResponse_httpStatus :: Lens' DescribeCertificateResponse Int Source #
The response's http status code.
describeCertificateResponse_certificate :: Lens' DescribeCertificateResponse DescribedCertificate Source #
The details for the specified certificate, returned as an object.
DescribeConnector
describeConnector_connectorId :: Lens' DescribeConnector Text Source #
The unique identifier for the connector.
describeConnectorResponse_httpStatus :: Lens' DescribeConnectorResponse Int Source #
The response's http status code.
describeConnectorResponse_connector :: Lens' DescribeConnectorResponse DescribedConnector Source #
The structure that contains the details of the connector.
DescribeExecution
describeExecution_executionId :: Lens' DescribeExecution Text Source #
A unique identifier for the execution of a workflow.
describeExecution_workflowId :: Lens' DescribeExecution Text Source #
A unique identifier for the workflow.
describeExecutionResponse_httpStatus :: Lens' DescribeExecutionResponse Int Source #
The response's http status code.
describeExecutionResponse_workflowId :: Lens' DescribeExecutionResponse Text Source #
A unique identifier for the workflow.
describeExecutionResponse_execution :: Lens' DescribeExecutionResponse DescribedExecution Source #
The structure that contains the details of the workflow' execution.
DescribeHostKey
describeHostKey_serverId :: Lens' DescribeHostKey Text Source #
The identifier of the server that contains the host key that you want described.
describeHostKey_hostKeyId :: Lens' DescribeHostKey Text Source #
The identifier of the host key that you want described.
describeHostKeyResponse_httpStatus :: Lens' DescribeHostKeyResponse Int Source #
The response's http status code.
describeHostKeyResponse_hostKey :: Lens' DescribeHostKeyResponse DescribedHostKey Source #
Returns the details for the specified host key.
DescribeProfile
describeProfile_profileId :: Lens' DescribeProfile Text Source #
The identifier of the profile that you want described.
describeProfileResponse_httpStatus :: Lens' DescribeProfileResponse Int Source #
The response's http status code.
describeProfileResponse_profile :: Lens' DescribeProfileResponse DescribedProfile Source #
The details of the specified profile, returned as an object.
DescribeSecurityPolicy
describeSecurityPolicy_securityPolicyName :: Lens' DescribeSecurityPolicy Text Source #
Specifies the name of the security policy that is attached to the server.
describeSecurityPolicyResponse_httpStatus :: Lens' DescribeSecurityPolicyResponse Int Source #
The response's http status code.
describeSecurityPolicyResponse_securityPolicy :: Lens' DescribeSecurityPolicyResponse DescribedSecurityPolicy Source #
An array containing the properties of the security policy.
DescribeServer
describeServer_serverId :: Lens' DescribeServer Text Source #
A system-assigned unique identifier for a server.
describeServerResponse_httpStatus :: Lens' DescribeServerResponse Int Source #
The response's http status code.
describeServerResponse_server :: Lens' DescribeServerResponse DescribedServer Source #
An array containing the properties of a server with the ServerID
you
specified.
DescribeUser
describeUser_serverId :: Lens' DescribeUser Text Source #
A system-assigned unique identifier for a server that has this user assigned.
describeUser_userName :: Lens' DescribeUser Text Source #
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.
describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #
The response's http status code.
describeUserResponse_serverId :: Lens' DescribeUserResponse Text Source #
A system-assigned unique identifier for a server that has this user assigned.
describeUserResponse_user :: Lens' DescribeUserResponse DescribedUser Source #
An array containing the properties of the user account for the
ServerID
value that you specified.
DescribeWorkflow
describeWorkflow_workflowId :: Lens' DescribeWorkflow Text Source #
A unique identifier for the workflow.
describeWorkflowResponse_httpStatus :: Lens' DescribeWorkflowResponse Int Source #
The response's http status code.
describeWorkflowResponse_workflow :: Lens' DescribeWorkflowResponse DescribedWorkflow Source #
The structure that contains the details of the workflow.
ImportCertificate
importCertificate_activeDate :: Lens' ImportCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes active.
importCertificate_certificateChain :: Lens' ImportCertificate (Maybe Text) Source #
An optional list of certificates that make up the chain for the certificate that's being imported.
importCertificate_description :: Lens' ImportCertificate (Maybe Text) Source #
A short description that helps identify the certificate.
importCertificate_inactiveDate :: Lens' ImportCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes inactive.
importCertificate_privateKey :: Lens' ImportCertificate (Maybe Text) Source #
The file that contains the private key for the certificate that's being imported.
importCertificate_tags :: Lens' ImportCertificate (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for certificates.
importCertificate_usage :: Lens' ImportCertificate CertificateUsageType Source #
Specifies whether this certificate is used for signing or encryption.
importCertificate_certificate :: Lens' ImportCertificate Text Source #
The file that contains the certificate to import.
importCertificateResponse_httpStatus :: Lens' ImportCertificateResponse Int Source #
The response's http status code.
importCertificateResponse_certificateId :: Lens' ImportCertificateResponse Text Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
ImportHostKey
importHostKey_description :: Lens' ImportHostKey (Maybe Text) Source #
The text description that identifies this host key.
importHostKey_tags :: Lens' ImportHostKey (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for host keys.
importHostKey_serverId :: Lens' ImportHostKey Text Source #
The identifier of the server that contains the host key that you are importing.
importHostKey_hostKeyBody :: Lens' ImportHostKey Text Source #
The public key portion of an SSH key pair.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
importHostKeyResponse_httpStatus :: Lens' ImportHostKeyResponse Int Source #
The response's http status code.
importHostKeyResponse_serverId :: Lens' ImportHostKeyResponse Text Source #
Returns the server identifier that contains the imported key.
importHostKeyResponse_hostKeyId :: Lens' ImportHostKeyResponse Text Source #
Returns the host key identifier for the imported key.
ImportSshPublicKey
importSshPublicKey_serverId :: Lens' ImportSshPublicKey Text Source #
A system-assigned unique identifier for a server.
importSshPublicKey_sshPublicKeyBody :: Lens' ImportSshPublicKey Text Source #
The public key portion of an SSH key pair.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
importSshPublicKey_userName :: Lens' ImportSshPublicKey Text Source #
The name of the user account that is assigned to one or more servers.
importSshPublicKeyResponse_httpStatus :: Lens' ImportSshPublicKeyResponse Int Source #
The response's http status code.
importSshPublicKeyResponse_serverId :: Lens' ImportSshPublicKeyResponse Text Source #
A system-assigned unique identifier for a server.
importSshPublicKeyResponse_sshPublicKeyId :: Lens' ImportSshPublicKeyResponse Text Source #
The name given to a public key by the system that was imported.
importSshPublicKeyResponse_userName :: Lens' ImportSshPublicKeyResponse Text Source #
A user name assigned to the ServerID
value that you specified.
ListAccesses
listAccesses_maxResults :: Lens' ListAccesses (Maybe Natural) Source #
Specifies the maximum number of access SIDs to return.
listAccesses_nextToken :: Lens' ListAccesses (Maybe Text) Source #
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_serverId :: Lens' ListAccesses Text Source #
A system-assigned unique identifier for a server that has users assigned to it.
listAccessesResponse_nextToken :: Lens' ListAccessesResponse (Maybe Text) Source #
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.
listAccessesResponse_httpStatus :: Lens' ListAccessesResponse Int Source #
The response's http status code.
listAccessesResponse_serverId :: Lens' ListAccessesResponse Text Source #
A system-assigned unique identifier for a server that has users assigned to it.
listAccessesResponse_accesses :: Lens' ListAccessesResponse [ListedAccess] Source #
Returns the accesses and their properties for the ServerId
value that
you specify.
ListAgreements
listAgreements_maxResults :: Lens' ListAgreements (Maybe Natural) Source #
The maximum number of agreements to return.
listAgreements_nextToken :: Lens' ListAgreements (Maybe Text) Source #
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_serverId :: Lens' ListAgreements Text Source #
The identifier of the server for which you want a list of agreements.
listAgreementsResponse_nextToken :: Lens' ListAgreementsResponse (Maybe Text) Source #
Returns a token that you can use to call ListAgreements
again and
receive additional results, if there are any.
listAgreementsResponse_httpStatus :: Lens' ListAgreementsResponse Int Source #
The response's http status code.
listAgreementsResponse_agreements :: Lens' ListAgreementsResponse [ListedAgreement] Source #
Returns an array, where each item contains the details of an agreement.
ListCertificates
listCertificates_maxResults :: Lens' ListCertificates (Maybe Natural) Source #
The maximum number of certificates to return.
listCertificates_nextToken :: Lens' ListCertificates (Maybe Text) Source #
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.
listCertificatesResponse_nextToken :: Lens' ListCertificatesResponse (Maybe Text) Source #
Returns the next token, which you can use to list the next certificate.
listCertificatesResponse_httpStatus :: Lens' ListCertificatesResponse Int Source #
The response's http status code.
listCertificatesResponse_certificates :: Lens' ListCertificatesResponse [ListedCertificate] Source #
Returns an array of the certificates that are specified in the
ListCertificates
call.
ListConnectors
listConnectors_maxResults :: Lens' ListConnectors (Maybe Natural) Source #
The maximum number of connectors to return.
listConnectors_nextToken :: Lens' ListConnectors (Maybe Text) Source #
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.
listConnectorsResponse_nextToken :: Lens' ListConnectorsResponse (Maybe Text) Source #
Returns a token that you can use to call ListConnectors
again and
receive additional results, if there are any.
listConnectorsResponse_httpStatus :: Lens' ListConnectorsResponse Int Source #
The response's http status code.
listConnectorsResponse_connectors :: Lens' ListConnectorsResponse [ListedConnector] Source #
Returns an array, where each item contains the details of a connector.
ListExecutions
listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural) Source #
Specifies the maximum number of executions to return.
listExecutions_nextToken :: Lens' ListExecutions (Maybe Text) Source #
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_workflowId :: Lens' ListExecutions Text Source #
A unique identifier for the workflow.
listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text) Source #
ListExecutions
returns the NextToken
parameter in the output. You
can then pass the NextToken
parameter in a subsequent command to
continue listing additional executions.
listExecutionsResponse_httpStatus :: Lens' ListExecutionsResponse Int Source #
The response's http status code.
listExecutionsResponse_workflowId :: Lens' ListExecutionsResponse Text Source #
A unique identifier for the workflow.
listExecutionsResponse_executions :: Lens' ListExecutionsResponse [ListedExecution] Source #
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
listHostKeys_maxResults :: Lens' ListHostKeys (Maybe Natural) Source #
The maximum number of host keys to return.
listHostKeys_nextToken :: Lens' ListHostKeys (Maybe Text) Source #
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_serverId :: Lens' ListHostKeys Text Source #
The identifier of the server that contains the host keys that you want to view.
listHostKeysResponse_nextToken :: Lens' ListHostKeysResponse (Maybe Text) Source #
Returns a token that you can use to call ListHostKeys
again and
receive additional results, if there are any.
listHostKeysResponse_httpStatus :: Lens' ListHostKeysResponse Int Source #
The response's http status code.
listHostKeysResponse_serverId :: Lens' ListHostKeysResponse Text Source #
Returns the server identifier that contains the listed host keys.
listHostKeysResponse_hostKeys :: Lens' ListHostKeysResponse [ListedHostKey] Source #
Returns an array, where each item contains the details of a host key.
ListProfiles
listProfiles_maxResults :: Lens' ListProfiles (Maybe Natural) Source #
The maximum number of profiles to return.
listProfiles_nextToken :: Lens' ListProfiles (Maybe Text) Source #
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_profileType :: Lens' ListProfiles (Maybe ProfileType) Source #
Indicates whether to list only LOCAL
type profiles or only PARTNER
type profiles. If not supplied in the request, the command lists all
types of profiles.
listProfilesResponse_nextToken :: Lens' ListProfilesResponse (Maybe Text) Source #
Returns a token that you can use to call ListProfiles
again and
receive additional results, if there are any.
listProfilesResponse_httpStatus :: Lens' ListProfilesResponse Int Source #
The response's http status code.
listProfilesResponse_profiles :: Lens' ListProfilesResponse [ListedProfile] Source #
Returns an array, where each item contains the details of a profile.
ListSecurityPolicies
listSecurityPolicies_maxResults :: Lens' ListSecurityPolicies (Maybe Natural) Source #
Specifies the number of security policies to return as a response to the
ListSecurityPolicies
query.
listSecurityPolicies_nextToken :: Lens' ListSecurityPolicies (Maybe Text) Source #
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.
listSecurityPoliciesResponse_nextToken :: Lens' ListSecurityPoliciesResponse (Maybe Text) Source #
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.
listSecurityPoliciesResponse_httpStatus :: Lens' ListSecurityPoliciesResponse Int Source #
The response's http status code.
listSecurityPoliciesResponse_securityPolicyNames :: Lens' ListSecurityPoliciesResponse [Text] Source #
An array of security policies that were listed.
ListServers
listServers_maxResults :: Lens' ListServers (Maybe Natural) Source #
Specifies the number of servers to return as a response to the
ListServers
query.
listServers_nextToken :: Lens' ListServers (Maybe Text) Source #
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.
listServersResponse_nextToken :: Lens' ListServersResponse (Maybe Text) Source #
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.
listServersResponse_httpStatus :: Lens' ListServersResponse Int Source #
The response's http status code.
listServersResponse_servers :: Lens' ListServersResponse [ListedServer] Source #
An array of servers that were listed.
ListTagsForResource
listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #
Specifies the number of tags to return as a response to the
ListTagsForResource
request.
listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #
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_arn :: Lens' ListTagsForResource Text Source #
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.
listTagsForResourceResponse_arn :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
The ARN you specified to list the tags of.
listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
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_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #
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.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListUsers
listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #
Specifies the number of users to return as a response to the ListUsers
request.
listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #
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_serverId :: Lens' ListUsers Text Source #
A system-assigned unique identifier for a server that has users assigned to it.
listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #
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.
listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #
The response's http status code.
listUsersResponse_serverId :: Lens' ListUsersResponse Text Source #
A system-assigned unique identifier for a server that the users are assigned to.
listUsersResponse_users :: Lens' ListUsersResponse [ListedUser] Source #
Returns the user accounts and their properties for the ServerId
value
that you specify.
ListWorkflows
listWorkflows_maxResults :: Lens' ListWorkflows (Maybe Natural) Source #
Specifies the maximum number of workflows to return.
listWorkflows_nextToken :: Lens' ListWorkflows (Maybe Text) Source #
ListWorkflows
returns the NextToken
parameter in the output. You can
then pass the NextToken
parameter in a subsequent command to continue
listing additional workflows.
listWorkflowsResponse_nextToken :: Lens' ListWorkflowsResponse (Maybe Text) Source #
ListWorkflows
returns the NextToken
parameter in the output. You can
then pass the NextToken
parameter in a subsequent command to continue
listing additional workflows.
listWorkflowsResponse_httpStatus :: Lens' ListWorkflowsResponse Int Source #
The response's http status code.
listWorkflowsResponse_workflows :: Lens' ListWorkflowsResponse [ListedWorkflow] Source #
Returns the Arn
, WorkflowId
, and Description
for each workflow.
SendWorkflowStepState
sendWorkflowStepState_workflowId :: Lens' SendWorkflowStepState Text Source #
A unique identifier for the workflow.
sendWorkflowStepState_executionId :: Lens' SendWorkflowStepState Text Source #
A unique identifier for the execution of a workflow.
sendWorkflowStepState_token :: Lens' SendWorkflowStepState Text Source #
Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
sendWorkflowStepState_status :: Lens' SendWorkflowStepState CustomStepStatus Source #
Indicates whether the specified step succeeded or failed.
sendWorkflowStepStateResponse_httpStatus :: Lens' SendWorkflowStepStateResponse Int Source #
The response's http status code.
StartFileTransfer
startFileTransfer_connectorId :: Lens' StartFileTransfer Text Source #
The unique identifier for the connector.
startFileTransfer_sendFilePaths :: Lens' StartFileTransfer (NonEmpty Text) Source #
An array of strings. Each string represents the absolute path for one
outbound file transfer. For example,
DOC-EXAMPLE-BUCKET
/
myfile.txt
.
startFileTransferResponse_httpStatus :: Lens' StartFileTransferResponse Int Source #
The response's http status code.
startFileTransferResponse_transferId :: Lens' StartFileTransferResponse Text Source #
Returns the unique identifier for this file transfer.
StartServer
startServer_serverId :: Lens' StartServer Text Source #
A system-assigned unique identifier for a server that you start.
StopServer
stopServer_serverId :: Lens' StopServer Text Source #
A system-assigned unique identifier for a server that you stopped.
TagResource
tagResource_arn :: Lens' TagResource Text Source #
An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.
tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #
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.
TestIdentityProvider
testIdentityProvider_serverProtocol :: Lens' TestIdentityProvider (Maybe Protocol) Source #
The type of file transfer protocol to be tested.
The available protocols are:
- Secure Shell (SSH) File Transfer Protocol (SFTP)
- File Transfer Protocol Secure (FTPS)
- File Transfer Protocol (FTP)
testIdentityProvider_sourceIp :: Lens' TestIdentityProvider (Maybe Text) Source #
The source IP address of the user account to be tested.
testIdentityProvider_userPassword :: Lens' TestIdentityProvider (Maybe Text) Source #
The password of the user account to be tested.
testIdentityProvider_serverId :: Lens' TestIdentityProvider Text Source #
A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
testIdentityProvider_userName :: Lens' TestIdentityProvider Text Source #
The name of the user account to be tested.
testIdentityProviderResponse_message :: Lens' TestIdentityProviderResponse (Maybe Text) Source #
A message that indicates whether the test was successful or not.
If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.
testIdentityProviderResponse_response :: Lens' TestIdentityProviderResponse (Maybe Text) Source #
The response that is returned from your API Gateway.
testIdentityProviderResponse_httpStatus :: Lens' TestIdentityProviderResponse Int Source #
The response's http status code.
testIdentityProviderResponse_statusCode :: Lens' TestIdentityProviderResponse Int Source #
The HTTP status code that is the response from your API Gateway.
testIdentityProviderResponse_url :: Lens' TestIdentityProviderResponse Text Source #
The endpoint of the service used to authenticate a user.
UntagResource
untagResource_arn :: Lens' UntagResource Text Source #
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.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
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.
UpdateAccess
updateAccess_homeDirectory :: Lens' UpdateAccess (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
updateAccess_homeDirectoryMappings :: Lens' UpdateAccess (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
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_homeDirectoryType :: Lens' UpdateAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
updateAccess_policy :: Lens' UpdateAccess (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName}
,
${Transfer:HomeDirectory}
, and ${Transfer:HomeBucket}
.
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_posixProfile :: Lens' UpdateAccess (Maybe PosixProfile) Source #
Undocumented member.
updateAccess_role :: Lens' UpdateAccess (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
updateAccess_serverId :: Lens' UpdateAccess Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
updateAccess_externalId :: Lens' UpdateAccess Text Source #
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
updateAccessResponse_httpStatus :: Lens' UpdateAccessResponse Int Source #
The response's http status code.
updateAccessResponse_serverId :: Lens' UpdateAccessResponse Text Source #
The identifier of the server that the user is attached to.
updateAccessResponse_externalId :: Lens' UpdateAccessResponse Text Source #
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
updateAgreement_accessRole :: Lens' UpdateAgreement (Maybe Text) Source #
With AS2, you can send files by calling StartFileTransfer
and
specifying the file paths in the request parameter, SendFilePaths
. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt
, parent directory is
/bucket/dir/
) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole
needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer
request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer
.
updateAgreement_baseDirectory :: Lens' UpdateAgreement (Maybe Text) Source #
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_description :: Lens' UpdateAgreement (Maybe Text) Source #
To replace the existing description, provide a short description for the agreement.
updateAgreement_localProfileId :: Lens' UpdateAgreement (Maybe Text) Source #
A unique identifier for the AS2 local profile.
To change the local profile identifier, provide a new value here.
updateAgreement_partnerProfileId :: Lens' UpdateAgreement (Maybe Text) Source #
A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.
updateAgreement_status :: Lens' UpdateAgreement (Maybe AgreementStatusType) Source #
You can update the status for the agreement, either activating an inactive agreement or the reverse.
updateAgreement_agreementId :: Lens' UpdateAgreement Text Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
updateAgreement_serverId :: Lens' UpdateAgreement Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
updateAgreementResponse_httpStatus :: Lens' UpdateAgreementResponse Int Source #
The response's http status code.
updateAgreementResponse_agreementId :: Lens' UpdateAgreementResponse Text Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
UpdateCertificate
updateCertificate_activeDate :: Lens' UpdateCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes active.
updateCertificate_description :: Lens' UpdateCertificate (Maybe Text) Source #
A short description to help identify the certificate.
updateCertificate_inactiveDate :: Lens' UpdateCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes inactive.
updateCertificate_certificateId :: Lens' UpdateCertificate Text Source #
The identifier of the certificate object that you are updating.
updateCertificateResponse_httpStatus :: Lens' UpdateCertificateResponse Int Source #
The response's http status code.
updateCertificateResponse_certificateId :: Lens' UpdateCertificateResponse Text Source #
Returns the identifier of the certificate object that you are updating.
UpdateConnector
updateConnector_accessRole :: Lens' UpdateConnector (Maybe Text) Source #
With AS2, you can send files by calling StartFileTransfer
and
specifying the file paths in the request parameter, SendFilePaths
. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt
, parent directory is
/bucket/dir/
) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole
needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer
request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer
.
updateConnector_as2Config :: Lens' UpdateConnector (Maybe As2ConnectorConfig) Source #
A structure that contains the parameters for a connector object.
updateConnector_loggingRole :: Lens' UpdateConnector (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
updateConnector_url :: Lens' UpdateConnector (Maybe Text) Source #
The URL of the partner's AS2 endpoint.
updateConnector_connectorId :: Lens' UpdateConnector Text Source #
The unique identifier for the connector.
updateConnectorResponse_httpStatus :: Lens' UpdateConnectorResponse Int Source #
The response's http status code.
updateConnectorResponse_connectorId :: Lens' UpdateConnectorResponse Text Source #
Returns the identifier of the connector object that you are updating.
UpdateHostKey
updateHostKey_serverId :: Lens' UpdateHostKey Text Source #
The identifier of the server that contains the host key that you are updating.
updateHostKey_hostKeyId :: Lens' UpdateHostKey Text Source #
The identifier of the host key that you are updating.
updateHostKey_description :: Lens' UpdateHostKey Text Source #
An updated description for the host key.
updateHostKeyResponse_httpStatus :: Lens' UpdateHostKeyResponse Int Source #
The response's http status code.
updateHostKeyResponse_serverId :: Lens' UpdateHostKeyResponse Text Source #
Returns the server identifier for the server that contains the updated host key.
updateHostKeyResponse_hostKeyId :: Lens' UpdateHostKeyResponse Text Source #
Returns the host key identifier for the updated host key.
UpdateProfile
updateProfile_certificateIds :: Lens' UpdateProfile (Maybe [Text]) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
updateProfile_profileId :: Lens' UpdateProfile Text Source #
The identifier of the profile object that you are updating.
updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int Source #
The response's http status code.
updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text Source #
Returns the identifier for the profile that's being updated.
UpdateServer
updateServer_certificate :: Lens' UpdateServer (Maybe Text) Source #
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_endpointDetails :: Lens' UpdateServer (Maybe EndpointDetails) Source #
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
updateServer_endpointType :: Lens' UpdateServer (Maybe EndpointType) Source #
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
.
updateServer_hostKey :: Lens' UpdateServer (Maybe Text) Source #
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_identityProviderDetails :: Lens' UpdateServer (Maybe IdentityProviderDetails) Source #
An array containing all of the information required to call a customer's authentication API method.
updateServer_loggingRole :: Lens' UpdateServer (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
updateServer_postAuthenticationLoginBanner :: Lens' UpdateServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
updateServer_preAuthenticationLoginBanner :: Lens' UpdateServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
updateServer_protocolDetails :: Lens' UpdateServer (Maybe ProtocolDetails) Source #
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_protocols :: Lens' UpdateServer (Maybe (NonEmpty Protocol)) Source #
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSHFTPS
(File Transfer Protocol Secure): File transfer with TLS encryptionFTP
(File Transfer Protocol): Unencrypted file transferAS2
(Applicability Statement 2): used for transporting structured business-to-business data- If you select
FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If
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_securityPolicyName :: Lens' UpdateServer (Maybe Text) Source #
Specifies the name of the security policy that is attached to the server.
updateServer_workflowDetails :: Lens' UpdateServer (Maybe WorkflowDetails) Source #
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In additon to a workflow to execute when a file is uploaded completely,
WorkflowDeatails
can also contain a workflow ID (and execution role)
for a workflow to execute on partial upload. A partial upload occurs
when a file is open when the session disconnects.
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_serverId :: Lens' UpdateServer Text Source #
A system-assigned unique identifier for a server instance that the user account is assigned to.
updateServerResponse_httpStatus :: Lens' UpdateServerResponse Int Source #
The response's http status code.
updateServerResponse_serverId :: Lens' UpdateServerResponse Text Source #
A system-assigned unique identifier for a server that the user account is assigned to.
UpdateUser
updateUser_homeDirectory :: Lens' UpdateUser (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
updateUser_homeDirectoryMappings :: Lens' UpdateUser (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
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_homeDirectoryType :: Lens' UpdateUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
updateUser_policy :: Lens' UpdateUser (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName}
,
${Transfer:HomeDirectory}
, and ${Transfer:HomeBucket}
.
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_posixProfile :: Lens' UpdateUser (Maybe PosixProfile) Source #
Specifies the full POSIX identity, including user ID (Uid
), group ID
(Gid
), and any secondary groups IDs (SecondaryGids
), that controls
your users' access to your Amazon Elastic File 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_role :: Lens' UpdateUser (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
updateUser_serverId :: Lens' UpdateUser Text Source #
A system-assigned unique identifier for a server instance that the user account is assigned to.
updateUser_userName :: Lens' UpdateUser Text Source #
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.
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #
The response's http status code.
updateUserResponse_serverId :: Lens' UpdateUserResponse Text Source #
A system-assigned unique identifier for a server instance that the user account is assigned to.
updateUserResponse_userName :: Lens' UpdateUserResponse Text Source #
The unique identifier for a user that is assigned to a server instance that was specified in the request.
Types
As2ConnectorConfig
as2ConnectorConfig_compression :: Lens' As2ConnectorConfig (Maybe CompressionEnum) Source #
Specifies whether the AS2 file is compressed.
as2ConnectorConfig_encryptionAlgorithm :: Lens' As2ConnectorConfig (Maybe EncryptionAlg) Source #
The algorithm that is used to encrypt the file.
as2ConnectorConfig_localProfileId :: Lens' As2ConnectorConfig (Maybe Text) Source #
A unique identifier for the AS2 local profile.
as2ConnectorConfig_mdnResponse :: Lens' As2ConnectorConfig (Maybe MdnResponse) Source #
Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:
SYNC
: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).NONE
: Specifies that no MDN response is required.
as2ConnectorConfig_mdnSigningAlgorithm :: Lens' As2ConnectorConfig (Maybe MdnSigningAlg) Source #
The signing algorithm for the MDN response.
If set to DEFAULT (or not set at all), the value for SigningAlogorithm
is used.
as2ConnectorConfig_messageSubject :: Lens' As2ConnectorConfig (Maybe Text) Source #
Used as the Subject
HTTP header attribute in AS2 messages that are
being sent with the connector.
as2ConnectorConfig_partnerProfileId :: Lens' As2ConnectorConfig (Maybe Text) Source #
A unique identifier for the partner profile for the connector.
as2ConnectorConfig_signingAlgorithm :: Lens' As2ConnectorConfig (Maybe SigningAlg) Source #
The algorithm that is used to sign the AS2 messages sent with the connector.
CopyStepDetails
copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation) Source #
Specifies the location for the file being copied. Only applicable for
Copy type workflow steps. Use ${Transfer:username}
in this field to
parametrize the destination prefix by username.
copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting) Source #
A flag that indicates whether or not to overwrite an existing file of
the same name. The default is FALSE
.
copyStepDetails_sourceFileLocation :: Lens' CopyStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}
to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}
to use the originally-uploaded file location as input for this step.
CustomStepDetails
customStepDetails_name :: Lens' CustomStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
customStepDetails_sourceFileLocation :: Lens' CustomStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}
to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}
to use the originally-uploaded file location as input for this step.
customStepDetails_target :: Lens' CustomStepDetails (Maybe Text) Source #
The ARN for the lambda function that is being called.
customStepDetails_timeoutSeconds :: Lens' CustomStepDetails (Maybe Natural) Source #
Timeout, in seconds, for the step.
DecryptStepDetails
decryptStepDetails_name :: Lens' DecryptStepDetails (Maybe Text) Source #
Undocumented member.
decryptStepDetails_overwriteExisting :: Lens' DecryptStepDetails (Maybe OverwriteExisting) Source #
Undocumented member.
decryptStepDetails_sourceFileLocation :: Lens' DecryptStepDetails (Maybe Text) Source #
Undocumented member.
decryptStepDetails_type :: Lens' DecryptStepDetails EncryptionType Source #
Undocumented member.
decryptStepDetails_destinationFileLocation :: Lens' DecryptStepDetails InputFileLocation Source #
Undocumented member.
DeleteStepDetails
deleteStepDetails_name :: Lens' DeleteStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
deleteStepDetails_sourceFileLocation :: Lens' DeleteStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}
to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}
to use the originally-uploaded file location as input for this step.
DescribedAccess
describedAccess_externalId :: Lens' DescribedAccess (Maybe Text) Source #
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
describedAccess_homeDirectory :: Lens' DescribedAccess (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
describedAccess_homeDirectoryMappings :: Lens' DescribedAccess (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
In most cases, you can use this value instead of the session policy to
lock down the associated access to the designated home directory
("chroot
"). To do this, you can set Entry
to '/' and set
Target
to the HomeDirectory
parameter value.
describedAccess_homeDirectoryType :: Lens' DescribedAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
describedAccess_policy :: Lens' DescribedAccess (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName}
,
${Transfer:HomeDirectory}
, and ${Transfer:HomeBucket}
.
describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile) Source #
Undocumented member.
describedAccess_role :: Lens' DescribedAccess (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
DescribedAgreement
describedAgreement_accessRole :: Lens' DescribedAgreement (Maybe Text) Source #
With AS2, you can send files by calling StartFileTransfer
and
specifying the file paths in the request parameter, SendFilePaths
. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt
, parent directory is
/bucket/dir/
) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole
needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer
request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer
.
describedAgreement_agreementId :: Lens' DescribedAgreement (Maybe Text) Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
describedAgreement_baseDirectory :: Lens' DescribedAgreement (Maybe Text) Source #
The landing directory (folder) for files that are transferred by using the AS2 protocol.
describedAgreement_description :: Lens' DescribedAgreement (Maybe Text) Source #
The name or short description that's used to identify the agreement.
describedAgreement_localProfileId :: Lens' DescribedAgreement (Maybe Text) Source #
A unique identifier for the AS2 local profile.
describedAgreement_partnerProfileId :: Lens' DescribedAgreement (Maybe Text) Source #
A unique identifier for the partner profile used in the agreement.
describedAgreement_serverId :: Lens' DescribedAgreement (Maybe Text) Source #
A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.
describedAgreement_status :: Lens' DescribedAgreement (Maybe AgreementStatusType) Source #
The current status of the agreement, either ACTIVE
or INACTIVE
.
describedAgreement_tags :: Lens' DescribedAgreement (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for agreements.
describedAgreement_arn :: Lens' DescribedAgreement Text Source #
The unique Amazon Resource Name (ARN) for the agreement.
DescribedCertificate
describedCertificate_activeDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes active.
describedCertificate_certificate :: Lens' DescribedCertificate (Maybe Text) Source #
The file name for the certificate.
describedCertificate_certificateChain :: Lens' DescribedCertificate (Maybe Text) Source #
The list of certificates that make up the chain for the certificate.
describedCertificate_certificateId :: Lens' DescribedCertificate (Maybe Text) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
describedCertificate_description :: Lens' DescribedCertificate (Maybe Text) Source #
The name or description that's used to identity the certificate.
describedCertificate_inactiveDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes inactive.
describedCertificate_notAfterDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
The final date that the certificate is valid.
describedCertificate_notBeforeDate :: Lens' DescribedCertificate (Maybe UTCTime) Source #
The earliest date that the certificate is valid.
describedCertificate_serial :: Lens' DescribedCertificate (Maybe Text) Source #
The serial number for the certificate.
describedCertificate_status :: Lens' DescribedCertificate (Maybe CertificateStatusType) Source #
The certificate can be either ACTIVE
, PENDING_ROTATION
, or
INACTIVE
. PENDING_ROTATION
means that this certificate will replace
the current certificate when it expires.
describedCertificate_tags :: Lens' DescribedCertificate (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for certificates.
describedCertificate_type :: Lens' DescribedCertificate (Maybe CertificateType) Source #
If a private key has been specified for the certificate, its type is
CERTIFICATE_WITH_PRIVATE_KEY
. If there is no private key, the type is
CERTIFICATE
.
describedCertificate_usage :: Lens' DescribedCertificate (Maybe CertificateUsageType) Source #
Specifies whether this certificate is used for signing or encryption.
describedCertificate_arn :: Lens' DescribedCertificate Text Source #
The unique Amazon Resource Name (ARN) for the certificate.
DescribedConnector
describedConnector_accessRole :: Lens' DescribedConnector (Maybe Text) Source #
With AS2, you can send files by calling StartFileTransfer
and
specifying the file paths in the request parameter, SendFilePaths
. We
use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt
, parent directory is
/bucket/dir/
) to temporarily store a processed AS2 message file,
store the MDN when we receive them from the partner, and write a final
JSON file containing relevant metadata of the transmission. So, the
AccessRole
needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer
request.
Additionally, you need to provide read and write access to the parent
directory of the files that you intend to send with StartFileTransfer
.
describedConnector_as2Config :: Lens' DescribedConnector (Maybe As2ConnectorConfig) Source #
A structure that contains the parameters for a connector object.
describedConnector_connectorId :: Lens' DescribedConnector (Maybe Text) Source #
The unique identifier for the connector.
describedConnector_loggingRole :: Lens' DescribedConnector (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
describedConnector_tags :: Lens' DescribedConnector (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for connectors.
describedConnector_url :: Lens' DescribedConnector (Maybe Text) Source #
The URL of the partner's AS2 endpoint.
describedConnector_arn :: Lens' DescribedConnector Text Source #
The unique Amazon Resource Name (ARN) for the connector.
DescribedExecution
describedExecution_executionId :: Lens' DescribedExecution (Maybe Text) Source #
A unique identifier for the execution of a workflow.
describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text) Source #
The IAM role associated with the execution.
describedExecution_initialFileLocation :: Lens' DescribedExecution (Maybe FileLocation) Source #
A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration) Source #
The IAM logging role associated with the execution.
describedExecution_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile) Source #
Undocumented member.
describedExecution_results :: Lens' DescribedExecution (Maybe ExecutionResults) Source #
A structure that describes the execution results. This includes a list
of the steps along with the details of each step, error type and message
(if any), and the OnExceptionSteps
structure.
describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata) Source #
A container object for the session details that are associated with a workflow.
describedExecution_status :: Lens' DescribedExecution (Maybe ExecutionStatus) Source #
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
DescribedHostKey
describedHostKey_dateImported :: Lens' DescribedHostKey (Maybe UTCTime) Source #
The date on which the host key was added to the server.
describedHostKey_description :: Lens' DescribedHostKey (Maybe Text) Source #
The text description for this host key.
describedHostKey_hostKeyFingerprint :: Lens' DescribedHostKey (Maybe Text) Source #
The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
describedHostKey_hostKeyId :: Lens' DescribedHostKey (Maybe Text) Source #
A unique identifier for the host key.
describedHostKey_tags :: Lens' DescribedHostKey (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for host keys.
describedHostKey_type :: Lens' DescribedHostKey (Maybe Text) Source #
The encryption algorithm that is used for the host key. The Type
parameter is specified by using one of the following values:
ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
describedHostKey_arn :: Lens' DescribedHostKey Text Source #
The unique Amazon Resource Name (ARN) for the host key.
DescribedProfile
describedProfile_as2Id :: Lens' DescribedProfile (Maybe Text) Source #
The As2Id
is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From
header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To
header for
the AS2 messages sent to the partner using the StartFileTransfer
API
operation. This ID cannot include spaces.
describedProfile_certificateIds :: Lens' DescribedProfile (Maybe [Text]) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
describedProfile_profileId :: Lens' DescribedProfile (Maybe Text) Source #
A unique identifier for the local or partner AS2 profile.
describedProfile_profileType :: Lens' DescribedProfile (Maybe ProfileType) Source #
Indicates whether to list only LOCAL
type profiles or only PARTNER
type profiles. If not supplied in the request, the command lists all
types of profiles.
describedProfile_tags :: Lens' DescribedProfile (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for profiles.
describedProfile_arn :: Lens' DescribedProfile Text Source #
The unique Amazon Resource Name (ARN) for the profile.
DescribedSecurityPolicy
describedSecurityPolicy_fips :: Lens' DescribedSecurityPolicy (Maybe Bool) Source #
Specifies whether this policy enables Federal Information Processing Standards (FIPS).
describedSecurityPolicy_sshCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_sshKexs :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_sshMacs :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_tlsCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text]) Source #
Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
describedSecurityPolicy_securityPolicyName :: Lens' DescribedSecurityPolicy Text Source #
Specifies the name of the security policy that is attached to the server.
DescribedServer
describedServer_certificate :: Lens' DescribedServer (Maybe Text) Source #
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM)
certificate. Required when Protocols
is set to FTPS
.
describedServer_domain :: Lens' DescribedServer (Maybe Domain) Source #
Specifies the domain of the storage system that is used for file transfers.
describedServer_endpointDetails :: Lens' DescribedServer (Maybe EndpointDetails) Source #
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
describedServer_endpointType :: Lens' DescribedServer (Maybe EndpointType) Source #
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
describedServer_hostKeyFingerprint :: Lens' DescribedServer (Maybe Text) Source #
Specifies the Base64-encoded SHA256 fingerprint of the server's host
key. This value is equivalent to the output of the
ssh-keygen -l -f my-new-server-key
command.
describedServer_identityProviderDetails :: Lens' DescribedServer (Maybe IdentityProviderDetails) Source #
Specifies information to call a customer-supplied authentication API.
This field is not populated when the IdentityProviderType
of a server
is AWS_DIRECTORY_SERVICE
or SERVICE_MANAGED
.
describedServer_identityProviderType :: Lens' DescribedServer (Maybe IdentityProviderType) Source #
The mode of authentication for a server. The default value is
SERVICE_MANAGED
, which allows you to store and access user credentials
within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups
in Directory Service for Microsoft Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connector. This option also requires you to provide a Directory
ID by using the IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of
your choosing. The API_GATEWAY
setting requires you to provide an
Amazon API Gateway endpoint URL to call for authentication by using the
IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your
identity provider. If you choose this value, you must specify the ARN
for the Lambda function in the Function
parameter or the
IdentityProviderDetails
data type.
describedServer_loggingRole :: Lens' DescribedServer (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
describedServer_postAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
describedServer_preAuthenticationLoginBanner :: Lens' DescribedServer (Maybe Text) Source #
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
describedServer_protocolDetails :: Lens' DescribedServer (Maybe ProtocolDetails) Source #
The protocol settings that are configured for your server.
- To indicate passive mode (for FTP and FTPS protocols), use the
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.
describedServer_protocols :: Lens' DescribedServer (Maybe (NonEmpty Protocol)) Source #
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSHFTPS
(File Transfer Protocol Secure): File transfer with TLS encryptionFTP
(File Transfer Protocol): Unencrypted file transferAS2
(Applicability Statement 2): used for transporting structured business-to-business data- If you select
FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. - If
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.
describedServer_securityPolicyName :: Lens' DescribedServer (Maybe Text) Source #
Specifies the name of the security policy that is attached to the server.
describedServer_serverId :: Lens' DescribedServer (Maybe Text) Source #
Specifies the unique system-assigned identifier for a server that you instantiate.
describedServer_state :: Lens' DescribedServer (Maybe State) Source #
The condition of the server that was described. A value of ONLINE
indicates that the server can accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot perform file transfer
operations.
The states of STARTING
and STOPPING
indicate that the server is in
an intermediate state, either not fully able to respond, or not fully
offline. The values of START_FAILED
or STOP_FAILED
can indicate an
error condition.
describedServer_tags :: Lens' DescribedServer (Maybe (NonEmpty Tag)) Source #
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
describedServer_userCount :: Lens' DescribedServer (Maybe Int) Source #
Specifies the number of users that are assigned to a server you
specified with the ServerId
.
describedServer_workflowDetails :: Lens' DescribedServer (Maybe WorkflowDetails) Source #
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In additon to a workflow to execute when a file is uploaded completely,
WorkflowDeatails
can also contain a workflow ID (and execution role)
for a workflow to execute on partial upload. A partial upload occurs
when a file is open when the session disconnects.
describedServer_arn :: Lens' DescribedServer Text Source #
Specifies the unique Amazon Resource Name (ARN) of the server.
DescribedUser
describedUser_homeDirectory :: Lens' DescribedUser (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
describedUser_homeDirectoryMappings :: Lens' DescribedUser (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry
and Target
pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target
. This value
can be set only when HomeDirectoryType
is set to LOGICAL.
In most cases, you can use this value instead of the session policy to
lock your user down to the designated home directory ("chroot
"). To
do this, you can set Entry
to '/' and set Target
to the
HomeDirectory parameter value.
describedUser_homeDirectoryType :: Lens' DescribedUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
describedUser_policy :: Lens' DescribedUser (Maybe Text) Source #
A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes
down a user's access to portions of their Amazon S3 bucket. Variables
that you can use inside this policy include ${Transfer:UserName}
,
${Transfer:HomeDirectory}
, and ${Transfer:HomeBucket}
.
describedUser_posixProfile :: Lens' DescribedUser (Maybe PosixProfile) Source #
Specifies the full POSIX identity, including user ID (Uid
), group ID
(Gid
), and any secondary groups IDs (SecondaryGids
), that controls
your users' access to your Amazon Elastic File System (Amazon EFS) file
systems. The POSIX permissions that are set on files and directories in
your file system determine the level of access your users get when
transferring files into and out of your Amazon EFS file systems.
describedUser_role :: Lens' DescribedUser (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
describedUser_sshPublicKeys :: Lens' DescribedUser (Maybe [SshPublicKey]) Source #
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
describedUser_tags :: Lens' DescribedUser (Maybe (NonEmpty Tag)) Source #
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
describedUser_userName :: Lens' DescribedUser (Maybe Text) Source #
Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.
describedUser_arn :: Lens' DescribedUser Text Source #
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
DescribedWorkflow
describedWorkflow_description :: Lens' DescribedWorkflow (Maybe Text) Source #
Specifies the text description for the workflow.
describedWorkflow_onExceptionSteps :: Lens' DescribedWorkflow (Maybe [WorkflowStep]) Source #
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
describedWorkflow_steps :: Lens' DescribedWorkflow (Maybe [WorkflowStep]) Source #
Specifies the details for the steps that are in the specified workflow.
describedWorkflow_tags :: Lens' DescribedWorkflow (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
describedWorkflow_workflowId :: Lens' DescribedWorkflow (Maybe Text) Source #
A unique identifier for the workflow.
describedWorkflow_arn :: Lens' DescribedWorkflow Text Source #
Specifies the unique Amazon Resource Name (ARN) for the workflow.
EfsFileLocation
efsFileLocation_fileSystemId :: Lens' EfsFileLocation (Maybe Text) Source #
The identifier of the file system, assigned by Amazon EFS.
efsFileLocation_path :: Lens' EfsFileLocation (Maybe Text) Source #
The pathname for the folder being used by a workflow.
EndpointDetails
endpointDetails_addressAllocationIds :: Lens' EndpointDetails (Maybe [Text]) Source #
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
This property can only be set when EndpointType
is set to VPC
and it
is only valid in the UpdateServer
API.
endpointDetails_securityGroupIds :: Lens' EndpointDetails (Maybe [Text]) Source #
A list of security groups IDs that are available to attach to your server's endpoint.
This property can only be set when EndpointType
is set to VPC
.
You can edit the SecurityGroupIds
property in the
UpdateServer
API only if you are changing the EndpointType
from PUBLIC
or
VPC_ENDPOINT
to VPC
. To change security groups associated with your
server's VPC endpoint after creation, use the Amazon EC2
ModifyVpcEndpoint
API.
endpointDetails_subnetIds :: Lens' EndpointDetails (Maybe [Text]) Source #
A list of subnet IDs that are required to host your server endpoint in your VPC.
This property can only be set when EndpointType
is set to VPC
.
endpointDetails_vpcEndpointId :: Lens' EndpointDetails (Maybe Text) Source #
The identifier of the VPC endpoint.
This property can only be set when EndpointType
is set to
VPC_ENDPOINT
.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
endpointDetails_vpcId :: Lens' EndpointDetails (Maybe Text) Source #
The VPC identifier of the VPC in which a server's endpoint will be hosted.
This property can only be set when EndpointType
is set to VPC
.
ExecutionError
executionError_type :: Lens' ExecutionError ExecutionErrorType Source #
Specifies the error type.
ALREADY_EXISTS
: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.BAD_REQUEST
: a general bad request: for example, a step that attempts to tag an EFS file returnsBAD_REQUEST
, as only S3 files can be tagged.CUSTOM_STEP_FAILED
: occurs when the custom step provided a callback that indicates failure.INTERNAL_SERVER_ERROR
: a catch-all error that can occur for a variety of reasons.NOT_FOUND
: occurs when a requested entity, for example a source file for a copy step, does not exist.PERMISSION_DENIED
: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.TIMEOUT
: occurs when the execution times out.You can set the
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.
executionError_message :: Lens' ExecutionError Text Source #
Specifies the descriptive message that corresponds to the ErrorType
.
ExecutionResults
executionResults_onExceptionSteps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult)) Source #
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
executionResults_steps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult)) Source #
Specifies the details for the steps that are in the specified workflow.
ExecutionStepResult
executionStepResult_error :: Lens' ExecutionStepResult (Maybe ExecutionError) Source #
Specifies the details for an error, if it occurred during execution of the specified workflow step.
executionStepResult_outputs :: Lens' ExecutionStepResult (Maybe Text) Source #
The values for the key/value pair applied as a tag to the file. Only
applicable if the step type is TAG
.
executionStepResult_stepType :: Lens' ExecutionStepResult (Maybe WorkflowStepType) Source #
One of the available step types.
- COPY: Copy the file to another location.
- CUSTOM: Perform a custom step with an Lambda function target.
- DELETE: Delete the file.
- TAG: Add a tag to the file.
FileLocation
fileLocation_efsFileLocation :: Lens' FileLocation (Maybe EfsFileLocation) Source #
Specifies the Amazon EFS identifier and the path for the file being used.
fileLocation_s3FileLocation :: Lens' FileLocation (Maybe S3FileLocation) Source #
Specifies the S3 details for the file being used, such as bucket, ETag, and so forth.
HomeDirectoryMapEntry
homeDirectoryMapEntry_entry :: Lens' HomeDirectoryMapEntry Text Source #
Represents an entry for HomeDirectoryMappings
.
homeDirectoryMapEntry_target :: Lens' HomeDirectoryMapEntry Text Source #
Represents the map target that is used in a HomeDirectorymapEntry
.
IdentityProviderDetails
identityProviderDetails_directoryId :: Lens' IdentityProviderDetails (Maybe Text) Source #
The identifier of the Directory Service directory that you want to stop sharing.
identityProviderDetails_function :: Lens' IdentityProviderDetails (Maybe Text) Source #
The ARN for a lambda function to use for the Identity provider.
identityProviderDetails_invocationRole :: Lens' IdentityProviderDetails (Maybe Text) Source #
Provides the type of InvocationRole
used to authenticate the user
account.
identityProviderDetails_url :: Lens' IdentityProviderDetails (Maybe Text) Source #
Provides the location of the service endpoint used to authenticate users.
InputFileLocation
inputFileLocation_efsFileLocation :: Lens' InputFileLocation (Maybe EfsFileLocation) Source #
Reserved for future use.
inputFileLocation_s3FileLocation :: Lens' InputFileLocation (Maybe S3InputFileLocation) Source #
Specifies the details for the S3 file being copied.
ListedAccess
listedAccess_externalId :: Lens' ListedAccess (Maybe Text) Source #
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
listedAccess_homeDirectory :: Lens' ListedAccess (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
listedAccess_homeDirectoryType :: Lens' ListedAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
listedAccess_role :: Lens' ListedAccess (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
ListedAgreement
listedAgreement_agreementId :: Lens' ListedAgreement (Maybe Text) Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
listedAgreement_arn :: Lens' ListedAgreement (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified agreement.
listedAgreement_description :: Lens' ListedAgreement (Maybe Text) Source #
The current description for the agreement. You can change it by calling
the UpdateAgreement
operation and providing a new description.
listedAgreement_localProfileId :: Lens' ListedAgreement (Maybe Text) Source #
A unique identifier for the AS2 local profile.
listedAgreement_partnerProfileId :: Lens' ListedAgreement (Maybe Text) Source #
A unique identifier for the partner profile.
listedAgreement_serverId :: Lens' ListedAgreement (Maybe Text) Source #
The unique identifier for the agreement.
listedAgreement_status :: Lens' ListedAgreement (Maybe AgreementStatusType) Source #
The agreement can be either ACTIVE
or INACTIVE
.
ListedCertificate
listedCertificate_activeDate :: Lens' ListedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes active.
listedCertificate_arn :: Lens' ListedCertificate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified certificate.
listedCertificate_certificateId :: Lens' ListedCertificate (Maybe Text) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
listedCertificate_description :: Lens' ListedCertificate (Maybe Text) Source #
The name or short description that's used to identify the certificate.
listedCertificate_inactiveDate :: Lens' ListedCertificate (Maybe UTCTime) Source #
An optional date that specifies when the certificate becomes inactive.
listedCertificate_status :: Lens' ListedCertificate (Maybe CertificateStatusType) Source #
The certificate can be either ACTIVE
, PENDING_ROTATION
, or
INACTIVE
. PENDING_ROTATION
means that this certificate will replace
the current certificate when it expires.
listedCertificate_type :: Lens' ListedCertificate (Maybe CertificateType) Source #
The type for the certificate. If a private key has been specified for
the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY
. If there is
no private key, the type is CERTIFICATE
.
listedCertificate_usage :: Lens' ListedCertificate (Maybe CertificateUsageType) Source #
Specifies whether this certificate is used for signing or encryption.
ListedConnector
listedConnector_arn :: Lens' ListedConnector (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified connector.
listedConnector_connectorId :: Lens' ListedConnector (Maybe Text) Source #
The unique identifier for the connector.
listedConnector_url :: Lens' ListedConnector (Maybe Text) Source #
The URL of the partner's AS2 endpoint.
ListedExecution
listedExecution_executionId :: Lens' ListedExecution (Maybe Text) Source #
A unique identifier for the execution of a workflow.
listedExecution_initialFileLocation :: Lens' ListedExecution (Maybe FileLocation) Source #
A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
listedExecution_serviceMetadata :: Lens' ListedExecution (Maybe ServiceMetadata) Source #
A container object for the session details that are associated with a workflow.
listedExecution_status :: Lens' ListedExecution (Maybe ExecutionStatus) Source #
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
ListedHostKey
listedHostKey_dateImported :: Lens' ListedHostKey (Maybe UTCTime) Source #
The date on which the host key was added to the server.
listedHostKey_description :: Lens' ListedHostKey (Maybe Text) Source #
The current description for the host key. You can change it by calling
the UpdateHostKey
operation and providing a new description.
listedHostKey_fingerprint :: Lens' ListedHostKey (Maybe Text) Source #
The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
listedHostKey_hostKeyId :: Lens' ListedHostKey (Maybe Text) Source #
A unique identifier for the host key.
listedHostKey_type :: Lens' ListedHostKey (Maybe Text) Source #
The encryption algorithm that is used for the host key. The Type
parameter is specified by using one of the following values:
ssh-rsa
ssh-ed25519
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
listedHostKey_arn :: Lens' ListedHostKey Text Source #
The unique Amazon Resource Name (ARN) of the host key.
ListedProfile
listedProfile_arn :: Lens' ListedProfile (Maybe Text) Source #
The Amazon Resource Name (ARN) of the specified profile.
listedProfile_as2Id :: Lens' ListedProfile (Maybe Text) Source #
The As2Id
is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From
header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To
header for
the AS2 messages sent to the partner using the StartFileTransfer
API
operation. This ID cannot include spaces.
listedProfile_profileId :: Lens' ListedProfile (Maybe Text) Source #
A unique identifier for the local or partner AS2 profile.
listedProfile_profileType :: Lens' ListedProfile (Maybe ProfileType) Source #
Indicates whether to list only LOCAL
type profiles or only PARTNER
type profiles. If not supplied in the request, the command lists all
types of profiles.
ListedServer
listedServer_domain :: Lens' ListedServer (Maybe Domain) Source #
Specifies the domain of the storage system that is used for file transfers.
listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType) Source #
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType) Source #
The mode of authentication for a server. The default value is
SERVICE_MANAGED
, which allows you to store and access user credentials
within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups
in Directory Service for Microsoft Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connector. This option also requires you to provide a Directory
ID by using the IdentityProviderDetails
parameter.
Use the API_GATEWAY
value to integrate with an identity provider of
your choosing. The API_GATEWAY
setting requires you to provide an
Amazon API Gateway endpoint URL to call for authentication by using the
IdentityProviderDetails
parameter.
Use the AWS_LAMBDA
value to directly use an Lambda function as your
identity provider. If you choose this value, you must specify the ARN
for the Lambda function in the Function
parameter or the
IdentityProviderDetails
data type.
listedServer_loggingRole :: Lens' ListedServer (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
listedServer_serverId :: Lens' ListedServer (Maybe Text) Source #
Specifies the unique system assigned identifier for the servers that were listed.
listedServer_state :: Lens' ListedServer (Maybe State) Source #
The condition of the server that was described. A value of ONLINE
indicates that the server can accept jobs and transfer files. A State
value of OFFLINE
means that the server cannot perform file transfer
operations.
The states of STARTING
and STOPPING
indicate that the server is in
an intermediate state, either not fully able to respond, or not fully
offline. The values of START_FAILED
or STOP_FAILED
can indicate an
error condition.
listedServer_userCount :: Lens' ListedServer (Maybe Int) Source #
Specifies the number of users that are assigned to a server you
specified with the ServerId
.
listedServer_arn :: Lens' ListedServer Text Source #
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
ListedUser
listedUser_homeDirectory :: Lens' ListedUser (Maybe Text) Source #
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
listedUser_homeDirectoryType :: Lens' ListedUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) that you want your users' home
directory to be when they log in to the server. If you set it to PATH
,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL
, you need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 or Amazon EFS paths visible to your users.
listedUser_role :: Lens' ListedUser (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
The IAM role that controls your users' access to your Amazon S3 bucket
for servers with Domain=S3
, or your EFS file system for servers with
Domain=EFS
.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int) Source #
Specifies the number of SSH public keys stored for the user you specified.
listedUser_userName :: Lens' ListedUser (Maybe Text) Source #
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
listedUser_arn :: Lens' ListedUser Text Source #
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
ListedWorkflow
listedWorkflow_arn :: Lens' ListedWorkflow (Maybe Text) Source #
Specifies the unique Amazon Resource Name (ARN) for the workflow.
listedWorkflow_description :: Lens' ListedWorkflow (Maybe Text) Source #
Specifies the text description for the workflow.
listedWorkflow_workflowId :: Lens' ListedWorkflow (Maybe Text) Source #
A unique identifier for the workflow.
LoggingConfiguration
loggingConfiguration_logGroupName :: Lens' LoggingConfiguration (Maybe Text) Source #
The name of the CloudWatch logging group for the Transfer Family server to which this workflow belongs.
loggingConfiguration_loggingRole :: Lens' LoggingConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
PosixProfile
posixProfile_secondaryGids :: Lens' PosixProfile (Maybe [Natural]) Source #
The secondary POSIX group IDs used for all EFS operations by this user.
posixProfile_uid :: Lens' PosixProfile Natural Source #
The POSIX user ID used for all EFS operations by this user.
posixProfile_gid :: Lens' PosixProfile Natural Source #
The POSIX group ID used for all EFS operations by this user.
ProtocolDetails
protocolDetails_as2Transports :: Lens' ProtocolDetails (Maybe (NonEmpty As2Transport)) Source #
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
protocolDetails_passiveIp :: Lens' ProtocolDetails (Maybe Text) Source #
Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:
aws transfer update-server --protocol-details PassiveIp=0.0.0.0
Replace 0.0.0.0
in the example above with the actual IP address you
want to use.
If you change the PassiveIp
value, you must stop and then restart your
Transfer Family server for the change to take effect. For details on
using passive mode (PASV) in a NAT environment, see
Configuring your FTPS server behind a firewall or NAT with Transfer Family.
Special values
The AUTO
and 0.0.0.0
are special values for the PassiveIp
parameter. The value PassiveIp=AUTO
is assigned by default to FTP and
FTPS type servers. In this case, the server automatically responds with
one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0
has a more unique application for its usage. For example, if you have a
High Availability (HA) Network Load Balancer (NLB) environment, where
you have 3 subnets, you can only specify a single IP address using the
PassiveIp
parameter. This reduces the effectiveness of having High
Availability. In this case, you can specify PassiveIp=0.0.0.0
. This
tells the client to use the same IP address as the Control connection
and utilize all AZs for their connections. Note, however, that not all
FTP clients support the PassiveIp=0.0.0.0
response. FileZilla and
WinSCP do support it. If you are using other clients, check to see if
your client supports the PassiveIp=0.0.0.0
response.
protocolDetails_setStatOption :: Lens' ProtocolDetails (Maybe SetStatOption) Source #
Use the SetStatOption
to ignore the error that is generated when the
client attempts to use SETSTAT
on a file you are uploading to an S3
bucket.
Some SFTP file transfer clients can attempt to change the attributes of
remote files, including timestamp and permissions, using commands, such
as SETSTAT
when uploading the file. However, these commands are not
compatible with object storage systems, such as Amazon S3. Due to this
incompatibility, file uploads from these clients can result in errors
even when the file is otherwise successfully uploaded.
Set the value to ENABLE_NO_OP
to have the Transfer Family server
ignore the SETSTAT
command, and upload files without needing to make
any changes to your SFTP client. While the SetStatOption
ENABLE_NO_OP
setting ignores the error, it does generate a log entry
in Amazon CloudWatch Logs, so you can determine when the client is
making a SETSTAT
call.
If you want to preserve the original timestamp for your file, and modify
other file attributes using SETSTAT
, you can use Amazon EFS as backend
storage with Transfer Family.
protocolDetails_tlsSessionResumptionMode :: Lens' ProtocolDetails (Maybe TlsSessionResumptionMode) Source #
A property used with Transfer Family servers that use the FTPS protocol.
TLS Session Resumption provides a mechanism to resume or share a
negotiated secret key between the control and data connection for an
FTPS session. TlsSessionResumptionMode
determines whether or not the
server resumes recent, negotiated sessions through a unique session ID.
This property is available during CreateServer
and UpdateServer
calls. If a TlsSessionResumptionMode
value is not specified during
CreateServer
, it is set to ENFORCED
by default.
DISABLED
: the server does not process TLS session resumption client requests and creates a new TLS session for each request.ENABLED
: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.ENFORCED
: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value toENFORCED
, test your clients.Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the
ENFORCED
value, you need to test your clients.
S3FileLocation
s3FileLocation_bucket :: Lens' S3FileLocation (Maybe Text) Source #
Specifies the S3 bucket that contains the file being used.
s3FileLocation_etag :: Lens' S3FileLocation (Maybe Text) Source #
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.
s3FileLocation_key :: Lens' S3FileLocation (Maybe Text) Source #
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
s3FileLocation_versionId :: Lens' S3FileLocation (Maybe Text) Source #
Specifies the file version.
S3InputFileLocation
s3InputFileLocation_bucket :: Lens' S3InputFileLocation (Maybe Text) Source #
Specifies the S3 bucket for the customer input file.
s3InputFileLocation_key :: Lens' S3InputFileLocation (Maybe Text) Source #
The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.
S3Tag
ServiceMetadata
serviceMetadata_userDetails :: Lens' ServiceMetadata UserDetails Source #
The Server ID (ServerId
), Session ID (SessionId
) and user
(UserName
) make up the UserDetails
.
SshPublicKey
sshPublicKey_dateImported :: Lens' SshPublicKey UTCTime Source #
Specifies the date that the public key was added to the user account.
sshPublicKey_sshPublicKeyBody :: Lens' SshPublicKey Text Source #
Specifies the content of the SSH public key as specified by the
PublicKeyId
.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
sshPublicKey_sshPublicKeyId :: Lens' SshPublicKey Text Source #
Specifies the SshPublicKeyId
parameter contains the identifier of the
public key.
Tag
tag_value :: Lens' Tag Text Source #
Contains one or more values that you assigned to the key name you create.
TagStepDetails
tagStepDetails_name :: Lens' TagStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
tagStepDetails_sourceFileLocation :: Lens' TagStepDetails (Maybe Text) Source #
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
- Enter
${previous.file}
to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. - Enter
${original.file}
to use the originally-uploaded file location as input for this step.
tagStepDetails_tags :: Lens' TagStepDetails (Maybe (NonEmpty S3Tag)) Source #
Array that contains from 1 to 10 key/value pairs.
UserDetails
userDetails_sessionId :: Lens' UserDetails (Maybe Text) Source #
The system-assigned unique identifier for a session that corresponds to the workflow.
userDetails_userName :: Lens' UserDetails Text Source #
A unique string that identifies a user account associated with a server.
userDetails_serverId :: Lens' UserDetails Text Source #
The system-assigned unique identifier for a Transfer server instance.
WorkflowDetail
workflowDetail_workflowId :: Lens' WorkflowDetail Text Source #
A unique identifier for the workflow.
workflowDetail_executionRole :: Lens' WorkflowDetail Text Source #
Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources
WorkflowDetails
workflowDetails_onPartialUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail]) Source #
A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.
A partial upload occurs when a file is open when the session disconnects.
workflowDetails_onUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail]) Source #
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
To remove an associated workflow from a server, you can provide an empty
OnUpload
object, as in the following example.
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
WorkflowStep
workflowStep_copyStepDetails :: Lens' WorkflowStep (Maybe CopyStepDetails) Source #
Details for a step that performs a file copy.
Consists of the following values:
- A description
- An S3 location for the destination of the file copy.
- A flag that indicates whether or not to overwrite an existing file
of the same name. The default is
FALSE
.
workflowStep_customStepDetails :: Lens' WorkflowStep (Maybe CustomStepDetails) Source #
Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
workflowStep_decryptStepDetails :: Lens' WorkflowStep (Maybe DecryptStepDetails) Source #
Undocumented member.
workflowStep_deleteStepDetails :: Lens' WorkflowStep (Maybe DeleteStepDetails) Source #
Details for a step that deletes the file.
workflowStep_tagStepDetails :: Lens' WorkflowStep (Maybe TagStepDetails) Source #
Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
workflowStep_type :: Lens' WorkflowStep (Maybe WorkflowStepType) Source #
Currently, the following step types are supported.
- COPY: Copy the file to another location.
- CUSTOM: Perform a custom step with an Lambda function target.
- DELETE: Delete the file.
- TAG: Add a tag to the file.