| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Transfer.Types
Contents
- Service Configuration
- Errors
- CustomStepStatus
- Domain
- EndpointType
- ExecutionErrorType
- ExecutionStatus
- HomeDirectoryType
- IdentityProviderType
- OverwriteExisting
- Protocol
- State
- WorkflowStepType
- CopyStepDetails
- CustomStepDetails
- DeleteStepDetails
- DescribedAccess
- DescribedExecution
- DescribedSecurityPolicy
- DescribedServer
- DescribedUser
- DescribedWorkflow
- EfsFileLocation
- EndpointDetails
- ExecutionError
- ExecutionResults
- ExecutionStepResult
- FileLocation
- HomeDirectoryMapEntry
- IdentityProviderDetails
- InputFileLocation
- ListedAccess
- ListedExecution
- ListedServer
- ListedUser
- ListedWorkflow
- LoggingConfiguration
- PosixProfile
- ProtocolDetails
- S3FileLocation
- S3InputFileLocation
- S3Tag
- ServiceMetadata
- SshPublicKey
- Tag
- TagStepDetails
- UserDetails
- WorkflowDetail
- WorkflowDetails
- WorkflowStep
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype CustomStepStatus where
- CustomStepStatus' { }
- pattern CustomStepStatus_FAILURE :: CustomStepStatus
- pattern CustomStepStatus_SUCCESS :: CustomStepStatus
- newtype Domain where
- Domain' {
- fromDomain :: Text
- pattern Domain_EFS :: Domain
- pattern Domain_S3 :: Domain
- Domain' {
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_PUBLIC :: EndpointType
- pattern EndpointType_VPC :: EndpointType
- pattern EndpointType_VPC_ENDPOINT :: EndpointType
- newtype ExecutionErrorType where
- newtype ExecutionStatus where
- ExecutionStatus' { }
- pattern ExecutionStatus_COMPLETED :: ExecutionStatus
- pattern ExecutionStatus_EXCEPTION :: ExecutionStatus
- pattern ExecutionStatus_HANDLING_EXCEPTION :: ExecutionStatus
- pattern ExecutionStatus_IN_PROGRESS :: ExecutionStatus
- newtype HomeDirectoryType where
- HomeDirectoryType' { }
- pattern HomeDirectoryType_LOGICAL :: HomeDirectoryType
- pattern HomeDirectoryType_PATH :: HomeDirectoryType
- newtype IdentityProviderType where
- newtype OverwriteExisting where
- OverwriteExisting' { }
- pattern OverwriteExisting_FALSE :: OverwriteExisting
- pattern OverwriteExisting_TRUE :: OverwriteExisting
- newtype Protocol where
- Protocol' {
- fromProtocol :: Text
- pattern Protocol_FTP :: Protocol
- pattern Protocol_FTPS :: Protocol
- pattern Protocol_SFTP :: Protocol
- Protocol' {
- newtype State where
- State' { }
- pattern State_OFFLINE :: State
- pattern State_ONLINE :: State
- pattern State_STARTING :: State
- pattern State_START_FAILED :: State
- pattern State_STOPPING :: State
- pattern State_STOP_FAILED :: State
- newtype WorkflowStepType where
- WorkflowStepType' { }
- pattern WorkflowStepType_COPY :: WorkflowStepType
- pattern WorkflowStepType_CUSTOM :: WorkflowStepType
- pattern WorkflowStepType_DELETE :: WorkflowStepType
- pattern WorkflowStepType_TAG :: WorkflowStepType
- data CopyStepDetails = CopyStepDetails' {}
- newCopyStepDetails :: CopyStepDetails
- copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation)
- copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting)
- copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text)
- data CustomStepDetails = CustomStepDetails' {}
- newCustomStepDetails :: CustomStepDetails
- customStepDetails_name :: Lens' CustomStepDetails (Maybe Text)
- customStepDetails_timeoutSeconds :: Lens' CustomStepDetails (Maybe Natural)
- customStepDetails_target :: Lens' CustomStepDetails (Maybe Text)
- data DeleteStepDetails = DeleteStepDetails' {}
- newDeleteStepDetails :: DeleteStepDetails
- deleteStepDetails_name :: Lens' DeleteStepDetails (Maybe Text)
- data DescribedAccess = DescribedAccess' {}
- newDescribedAccess :: DescribedAccess
- describedAccess_homeDirectoryType :: Lens' DescribedAccess (Maybe HomeDirectoryType)
- describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile)
- describedAccess_homeDirectoryMappings :: Lens' DescribedAccess (Maybe (NonEmpty HomeDirectoryMapEntry))
- describedAccess_role :: Lens' DescribedAccess (Maybe Text)
- describedAccess_policy :: Lens' DescribedAccess (Maybe Text)
- describedAccess_externalId :: Lens' DescribedAccess (Maybe Text)
- describedAccess_homeDirectory :: Lens' DescribedAccess (Maybe Text)
- data DescribedExecution = DescribedExecution' {}
- newDescribedExecution :: DescribedExecution
- describedExecution_status :: Lens' DescribedExecution (Maybe ExecutionStatus)
- describedExecution_executionId :: Lens' DescribedExecution (Maybe Text)
- describedExecution_results :: Lens' DescribedExecution (Maybe ExecutionResults)
- describedExecution_initialFileLocation :: Lens' DescribedExecution (Maybe FileLocation)
- describedExecution_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile)
- describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata)
- describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration)
- describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text)
- data DescribedSecurityPolicy = DescribedSecurityPolicy' {}
- newDescribedSecurityPolicy :: Text -> DescribedSecurityPolicy
- describedSecurityPolicy_fips :: Lens' DescribedSecurityPolicy (Maybe Bool)
- describedSecurityPolicy_sshMacs :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_sshKexs :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_tlsCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_sshCiphers :: Lens' DescribedSecurityPolicy (Maybe [Text])
- describedSecurityPolicy_securityPolicyName :: Lens' DescribedSecurityPolicy Text
- data DescribedServer = DescribedServer' {
- protocolDetails :: Maybe ProtocolDetails
- loggingRole :: Maybe Text
- state :: Maybe State
- identityProviderType :: Maybe IdentityProviderType
- protocols :: Maybe (NonEmpty Protocol)
- serverId :: Maybe Text
- domain :: Maybe Domain
- endpointType :: Maybe EndpointType
- securityPolicyName :: Maybe Text
- hostKeyFingerprint :: Maybe Text
- userCount :: Maybe Int
- certificate :: Maybe Text
- identityProviderDetails :: Maybe IdentityProviderDetails
- workflowDetails :: Maybe WorkflowDetails
- tags :: Maybe (NonEmpty Tag)
- endpointDetails :: Maybe EndpointDetails
- arn :: Text
- newDescribedServer :: Text -> DescribedServer
- describedServer_protocolDetails :: Lens' DescribedServer (Maybe ProtocolDetails)
- describedServer_loggingRole :: Lens' DescribedServer (Maybe Text)
- describedServer_state :: Lens' DescribedServer (Maybe State)
- describedServer_identityProviderType :: Lens' DescribedServer (Maybe IdentityProviderType)
- describedServer_protocols :: Lens' DescribedServer (Maybe (NonEmpty Protocol))
- describedServer_serverId :: Lens' DescribedServer (Maybe Text)
- describedServer_domain :: Lens' DescribedServer (Maybe Domain)
- describedServer_endpointType :: Lens' DescribedServer (Maybe EndpointType)
- describedServer_securityPolicyName :: Lens' DescribedServer (Maybe Text)
- describedServer_hostKeyFingerprint :: Lens' DescribedServer (Maybe Text)
- describedServer_userCount :: Lens' DescribedServer (Maybe Int)
- describedServer_certificate :: Lens' DescribedServer (Maybe Text)
- describedServer_identityProviderDetails :: Lens' DescribedServer (Maybe IdentityProviderDetails)
- describedServer_workflowDetails :: Lens' DescribedServer (Maybe WorkflowDetails)
- describedServer_tags :: Lens' DescribedServer (Maybe (NonEmpty Tag))
- describedServer_endpointDetails :: Lens' DescribedServer (Maybe EndpointDetails)
- describedServer_arn :: Lens' DescribedServer Text
- data DescribedUser = DescribedUser' {
- sshPublicKeys :: Maybe [SshPublicKey]
- homeDirectoryType :: Maybe HomeDirectoryType
- userName :: Maybe Text
- posixProfile :: Maybe PosixProfile
- homeDirectoryMappings :: Maybe (NonEmpty HomeDirectoryMapEntry)
- role' :: Maybe Text
- policy :: Maybe Text
- homeDirectory :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- arn :: Text
- newDescribedUser :: Text -> DescribedUser
- describedUser_sshPublicKeys :: Lens' DescribedUser (Maybe [SshPublicKey])
- describedUser_homeDirectoryType :: Lens' DescribedUser (Maybe HomeDirectoryType)
- describedUser_userName :: Lens' DescribedUser (Maybe Text)
- describedUser_posixProfile :: Lens' DescribedUser (Maybe PosixProfile)
- describedUser_homeDirectoryMappings :: Lens' DescribedUser (Maybe (NonEmpty HomeDirectoryMapEntry))
- describedUser_role :: Lens' DescribedUser (Maybe Text)
- describedUser_policy :: Lens' DescribedUser (Maybe Text)
- describedUser_homeDirectory :: Lens' DescribedUser (Maybe Text)
- describedUser_tags :: Lens' DescribedUser (Maybe (NonEmpty Tag))
- describedUser_arn :: Lens' DescribedUser Text
- data DescribedWorkflow = DescribedWorkflow' {
- onExceptionSteps :: Maybe [WorkflowStep]
- steps :: Maybe [WorkflowStep]
- workflowId :: Maybe Text
- description :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- arn :: Text
- newDescribedWorkflow :: Text -> DescribedWorkflow
- describedWorkflow_onExceptionSteps :: Lens' DescribedWorkflow (Maybe [WorkflowStep])
- describedWorkflow_steps :: Lens' DescribedWorkflow (Maybe [WorkflowStep])
- describedWorkflow_workflowId :: Lens' DescribedWorkflow (Maybe Text)
- describedWorkflow_description :: Lens' DescribedWorkflow (Maybe Text)
- describedWorkflow_tags :: Lens' DescribedWorkflow (Maybe (NonEmpty Tag))
- describedWorkflow_arn :: Lens' DescribedWorkflow Text
- data EfsFileLocation = EfsFileLocation' {}
- newEfsFileLocation :: EfsFileLocation
- efsFileLocation_path :: Lens' EfsFileLocation (Maybe Text)
- efsFileLocation_fileSystemId :: Lens' EfsFileLocation (Maybe Text)
- data EndpointDetails = EndpointDetails' {
- securityGroupIds :: Maybe [Text]
- subnetIds :: Maybe [Text]
- vpcId :: Maybe Text
- addressAllocationIds :: Maybe [Text]
- vpcEndpointId :: Maybe Text
- newEndpointDetails :: EndpointDetails
- endpointDetails_securityGroupIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_subnetIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_vpcId :: Lens' EndpointDetails (Maybe Text)
- endpointDetails_addressAllocationIds :: Lens' EndpointDetails (Maybe [Text])
- endpointDetails_vpcEndpointId :: Lens' EndpointDetails (Maybe Text)
- data ExecutionError = ExecutionError' {}
- newExecutionError :: ExecutionErrorType -> Text -> ExecutionError
- executionError_type :: Lens' ExecutionError ExecutionErrorType
- executionError_message :: Lens' ExecutionError Text
- data ExecutionResults = ExecutionResults' {}
- newExecutionResults :: ExecutionResults
- executionResults_onExceptionSteps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult))
- executionResults_steps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult))
- data ExecutionStepResult = ExecutionStepResult' {}
- newExecutionStepResult :: ExecutionStepResult
- executionStepResult_stepType :: Lens' ExecutionStepResult (Maybe WorkflowStepType)
- executionStepResult_error :: Lens' ExecutionStepResult (Maybe ExecutionError)
- executionStepResult_outputs :: Lens' ExecutionStepResult (Maybe Text)
- data FileLocation = FileLocation' {}
- newFileLocation :: FileLocation
- fileLocation_efsFileLocation :: Lens' FileLocation (Maybe EfsFileLocation)
- fileLocation_s3FileLocation :: Lens' FileLocation (Maybe S3FileLocation)
- data HomeDirectoryMapEntry = HomeDirectoryMapEntry' {}
- newHomeDirectoryMapEntry :: Text -> Text -> HomeDirectoryMapEntry
- homeDirectoryMapEntry_entry :: Lens' HomeDirectoryMapEntry Text
- homeDirectoryMapEntry_target :: Lens' HomeDirectoryMapEntry Text
- data IdentityProviderDetails = IdentityProviderDetails' {
- invocationRole :: Maybe Text
- directoryId :: Maybe Text
- url :: Maybe Text
- newIdentityProviderDetails :: IdentityProviderDetails
- identityProviderDetails_invocationRole :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_directoryId :: Lens' IdentityProviderDetails (Maybe Text)
- identityProviderDetails_url :: Lens' IdentityProviderDetails (Maybe Text)
- data InputFileLocation = InputFileLocation' {}
- newInputFileLocation :: InputFileLocation
- inputFileLocation_efsFileLocation :: Lens' InputFileLocation (Maybe EfsFileLocation)
- inputFileLocation_s3FileLocation :: Lens' InputFileLocation (Maybe S3InputFileLocation)
- data ListedAccess = ListedAccess' {}
- newListedAccess :: ListedAccess
- listedAccess_homeDirectoryType :: Lens' ListedAccess (Maybe HomeDirectoryType)
- listedAccess_role :: Lens' ListedAccess (Maybe Text)
- listedAccess_externalId :: Lens' ListedAccess (Maybe Text)
- listedAccess_homeDirectory :: Lens' ListedAccess (Maybe Text)
- data ListedExecution = ListedExecution' {}
- newListedExecution :: ListedExecution
- listedExecution_status :: Lens' ListedExecution (Maybe ExecutionStatus)
- listedExecution_executionId :: Lens' ListedExecution (Maybe Text)
- listedExecution_initialFileLocation :: Lens' ListedExecution (Maybe FileLocation)
- listedExecution_serviceMetadata :: Lens' ListedExecution (Maybe ServiceMetadata)
- data ListedServer = ListedServer' {}
- newListedServer :: Text -> ListedServer
- listedServer_loggingRole :: Lens' ListedServer (Maybe Text)
- listedServer_state :: Lens' ListedServer (Maybe State)
- listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType)
- listedServer_serverId :: Lens' ListedServer (Maybe Text)
- listedServer_domain :: Lens' ListedServer (Maybe Domain)
- listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType)
- listedServer_userCount :: Lens' ListedServer (Maybe Int)
- listedServer_arn :: Lens' ListedServer Text
- data ListedUser = ListedUser' {}
- newListedUser :: Text -> ListedUser
- listedUser_homeDirectoryType :: Lens' ListedUser (Maybe HomeDirectoryType)
- listedUser_userName :: Lens' ListedUser (Maybe Text)
- listedUser_role :: Lens' ListedUser (Maybe Text)
- listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int)
- listedUser_homeDirectory :: Lens' ListedUser (Maybe Text)
- listedUser_arn :: Lens' ListedUser Text
- data ListedWorkflow = ListedWorkflow' {
- arn :: Maybe Text
- workflowId :: Maybe Text
- description :: Maybe Text
- newListedWorkflow :: ListedWorkflow
- listedWorkflow_arn :: Lens' ListedWorkflow (Maybe Text)
- listedWorkflow_workflowId :: Lens' ListedWorkflow (Maybe Text)
- listedWorkflow_description :: Lens' ListedWorkflow (Maybe Text)
- data LoggingConfiguration = LoggingConfiguration' {}
- newLoggingConfiguration :: LoggingConfiguration
- loggingConfiguration_loggingRole :: Lens' LoggingConfiguration (Maybe Text)
- loggingConfiguration_logGroupName :: Lens' LoggingConfiguration (Maybe Text)
- data PosixProfile = PosixProfile' {}
- newPosixProfile :: Natural -> Natural -> PosixProfile
- posixProfile_secondaryGids :: Lens' PosixProfile (Maybe [Natural])
- posixProfile_uid :: Lens' PosixProfile Natural
- posixProfile_gid :: Lens' PosixProfile Natural
- data ProtocolDetails = ProtocolDetails' {}
- newProtocolDetails :: ProtocolDetails
- protocolDetails_passiveIp :: Lens' ProtocolDetails (Maybe Text)
- data S3FileLocation = S3FileLocation' {}
- newS3FileLocation :: S3FileLocation
- s3FileLocation_versionId :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_etag :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_bucket :: Lens' S3FileLocation (Maybe Text)
- s3FileLocation_key :: Lens' S3FileLocation (Maybe Text)
- data S3InputFileLocation = S3InputFileLocation' {}
- newS3InputFileLocation :: S3InputFileLocation
- s3InputFileLocation_bucket :: Lens' S3InputFileLocation (Maybe Text)
- s3InputFileLocation_key :: Lens' S3InputFileLocation (Maybe Text)
- data S3Tag = S3Tag' {}
- newS3Tag :: Text -> Text -> S3Tag
- s3Tag_key :: Lens' S3Tag Text
- s3Tag_value :: Lens' S3Tag Text
- data ServiceMetadata = ServiceMetadata' {}
- newServiceMetadata :: UserDetails -> ServiceMetadata
- serviceMetadata_userDetails :: Lens' ServiceMetadata UserDetails
- data SshPublicKey = SshPublicKey' {}
- newSshPublicKey :: UTCTime -> Text -> Text -> SshPublicKey
- sshPublicKey_dateImported :: Lens' SshPublicKey UTCTime
- sshPublicKey_sshPublicKeyBody :: Lens' SshPublicKey Text
- sshPublicKey_sshPublicKeyId :: Lens' SshPublicKey Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TagStepDetails = TagStepDetails' {}
- newTagStepDetails :: TagStepDetails
- tagStepDetails_name :: Lens' TagStepDetails (Maybe Text)
- tagStepDetails_tags :: Lens' TagStepDetails (Maybe (NonEmpty S3Tag))
- data UserDetails = UserDetails' {}
- newUserDetails :: Text -> Text -> UserDetails
- userDetails_sessionId :: Lens' UserDetails (Maybe Text)
- userDetails_userName :: Lens' UserDetails Text
- userDetails_serverId :: Lens' UserDetails Text
- data WorkflowDetail = WorkflowDetail' {
- workflowId :: Text
- executionRole :: Text
- newWorkflowDetail :: Text -> Text -> WorkflowDetail
- workflowDetail_workflowId :: Lens' WorkflowDetail Text
- workflowDetail_executionRole :: Lens' WorkflowDetail Text
- data WorkflowDetails = WorkflowDetails' {
- onUpload :: [WorkflowDetail]
- newWorkflowDetails :: WorkflowDetails
- workflowDetails_onUpload :: Lens' WorkflowDetails [WorkflowDetail]
- data WorkflowStep = WorkflowStep' {}
- newWorkflowStep :: WorkflowStep
- workflowStep_tagStepDetails :: Lens' WorkflowStep (Maybe TagStepDetails)
- workflowStep_deleteStepDetails :: Lens' WorkflowStep (Maybe DeleteStepDetails)
- workflowStep_copyStepDetails :: Lens' WorkflowStep (Maybe CopyStepDetails)
- workflowStep_type :: Lens' WorkflowStep (Maybe WorkflowStepType)
- workflowStep_customStepDetails :: Lens' WorkflowStep (Maybe CustomStepDetails)
Service Configuration
defaultService :: Service Source #
API version 2018-11-05 of the Amazon Transfer Family SDK configuration.
Errors
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the client submits a malformed request.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the UpdateServer is called for a file
transfer protocol-enabled server that has VPC as the endpoint type and
the server's VpcEndpointID is not in the available state.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
HTTP Status Code: 400
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The NextToken parameter that was passed is invalid.
_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.
_ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource does not exist.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request has failed because the Amazon Web ServicesTransfer Family service is not available.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
CustomStepStatus
newtype CustomStepStatus Source #
Constructors
| CustomStepStatus' | |
Fields | |
Bundled Patterns
| pattern CustomStepStatus_FAILURE :: CustomStepStatus | |
| pattern CustomStepStatus_SUCCESS :: CustomStepStatus |
Instances
Domain
Constructors
| Domain' | |
Fields
| |
Bundled Patterns
| pattern Domain_EFS :: Domain | |
| pattern Domain_S3 :: Domain |
Instances
EndpointType
newtype EndpointType Source #
Constructors
| EndpointType' | |
Fields | |
Bundled Patterns
| pattern EndpointType_PUBLIC :: EndpointType | |
| pattern EndpointType_VPC :: EndpointType | |
| pattern EndpointType_VPC_ENDPOINT :: EndpointType |
Instances
ExecutionErrorType
newtype ExecutionErrorType Source #
Constructors
| ExecutionErrorType' | |
Fields | |
Bundled Patterns
| pattern ExecutionErrorType_PERMISSION_DENIED :: ExecutionErrorType |
Instances
ExecutionStatus
newtype ExecutionStatus Source #
Constructors
| ExecutionStatus' | |
Fields | |
Bundled Patterns
| pattern ExecutionStatus_COMPLETED :: ExecutionStatus | |
| pattern ExecutionStatus_EXCEPTION :: ExecutionStatus | |
| pattern ExecutionStatus_HANDLING_EXCEPTION :: ExecutionStatus | |
| pattern ExecutionStatus_IN_PROGRESS :: ExecutionStatus |
Instances
HomeDirectoryType
newtype HomeDirectoryType Source #
Constructors
| HomeDirectoryType' | |
Fields | |
Bundled Patterns
| pattern HomeDirectoryType_LOGICAL :: HomeDirectoryType | |
| pattern HomeDirectoryType_PATH :: HomeDirectoryType |
Instances
IdentityProviderType
newtype IdentityProviderType Source #
Returns information related to the type of user authentication that is
in use for a file transfer protocol-enabled server's users. For
AWS_DIRECTORY_SERVICE or SERVICE_MANAGED authentication, the Secure
Shell (SSH) public keys are stored with a user on the server instance.
For API_GATEWAY authentication, your custom authentication method is
implemented by using an API call. The server can have only one method of
authentication.
Constructors
| IdentityProviderType' | |
Fields | |
Bundled Patterns
Instances
OverwriteExisting
newtype OverwriteExisting Source #
Constructors
| OverwriteExisting' | |
Fields | |
Bundled Patterns
| pattern OverwriteExisting_FALSE :: OverwriteExisting | |
| pattern OverwriteExisting_TRUE :: OverwriteExisting |
Instances
Protocol
Constructors
| Protocol' | |
Fields
| |
Bundled Patterns
| pattern Protocol_FTP :: Protocol | |
| pattern Protocol_FTPS :: Protocol | |
| pattern Protocol_SFTP :: Protocol |
Instances
State
Describes the condition of a file transfer protocol-enabled server with
respect to its ability to perform file operations. There are six
possible states: OFFLINE, ONLINE, STARTING, STOPPING,
START_FAILED, and STOP_FAILED.
OFFLINE indicates that the server exists, but that it is not available
for file operations. ONLINE indicates that the server is available to
perform file operations. STARTING indicates that the server's was
instantiated, but the server is not yet available to perform file
operations. Under normal conditions, it can take a couple of minutes for
the server to be completely operational. Both START_FAILED and
STOP_FAILED are error conditions.
Bundled Patterns
| pattern State_OFFLINE :: State | |
| pattern State_ONLINE :: State | |
| pattern State_STARTING :: State | |
| pattern State_START_FAILED :: State | |
| pattern State_STOPPING :: State | |
| pattern State_STOP_FAILED :: State |
Instances
WorkflowStepType
newtype WorkflowStepType Source #
Constructors
| WorkflowStepType' | |
Fields | |
Bundled Patterns
| pattern WorkflowStepType_COPY :: WorkflowStepType | |
| pattern WorkflowStepType_CUSTOM :: WorkflowStepType | |
| pattern WorkflowStepType_DELETE :: WorkflowStepType | |
| pattern WorkflowStepType_TAG :: WorkflowStepType |
Instances
CopyStepDetails
data CopyStepDetails Source #
Each step type has its own StepDetails structure.
See: newCopyStepDetails smart constructor.
Constructors
| CopyStepDetails' | |
Fields
| |
Instances
newCopyStepDetails :: CopyStepDetails Source #
Create a value of CopyStepDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationFileLocation:CopyStepDetails', copyStepDetails_destinationFileLocation - Undocumented member.
$sel:overwriteExisting:CopyStepDetails', copyStepDetails_overwriteExisting - A flag that indicates whether or not to overwrite an existing file of
the same name. The default is FALSE.
$sel:name:CopyStepDetails', copyStepDetails_name - The name of the step, used as an identifier.
copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation) Source #
Undocumented member.
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_name :: Lens' CopyStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
CustomStepDetails
data CustomStepDetails Source #
Each step type has its own StepDetails structure.
See: newCustomStepDetails smart constructor.
Constructors
| CustomStepDetails' | |
Instances
newCustomStepDetails :: CustomStepDetails Source #
Create a value of CustomStepDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:CustomStepDetails', customStepDetails_name - The name of the step, used as an identifier.
$sel:timeoutSeconds:CustomStepDetails', customStepDetails_timeoutSeconds - Timeout, in seconds, for the step.
$sel:target:CustomStepDetails', customStepDetails_target - The ARN for the lambda function that is being called.
customStepDetails_name :: Lens' CustomStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
customStepDetails_timeoutSeconds :: Lens' CustomStepDetails (Maybe Natural) Source #
Timeout, in seconds, for the step.
customStepDetails_target :: Lens' CustomStepDetails (Maybe Text) Source #
The ARN for the lambda function that is being called.
DeleteStepDetails
data DeleteStepDetails Source #
The name of the step, used to identify the delete step.
See: newDeleteStepDetails smart constructor.
Constructors
| DeleteStepDetails' | |
Instances
newDeleteStepDetails :: DeleteStepDetails Source #
Create a value of DeleteStepDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:DeleteStepDetails', deleteStepDetails_name - The name of the step, used as an identifier.
deleteStepDetails_name :: Lens' DeleteStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
DescribedAccess
data DescribedAccess Source #
Describes the properties of the access that was specified.
See: newDescribedAccess smart constructor.
Constructors
| DescribedAccess' | |
Fields
| |
Instances
newDescribedAccess :: DescribedAccess Source #
Create a value of DescribedAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeDirectoryType:DescribedAccess', describedAccess_homeDirectoryType - The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
$sel:posixProfile:DescribedAccess', describedAccess_posixProfile - Undocumented member.
$sel:homeDirectoryMappings:DescribedAccess', describedAccess_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry and Target pair, where
Entry shows how the path is made visible and Target is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Amazon Web Services
Identity and Access Management (IAM) role provides access to paths in
Target. This value can only be set when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to
lock down the associated access to the designated home directory
("chroot"). To do this, you can set Entry to '/' and set
Target to the HomeDirectory parameter value.
$sel:role':DescribedAccess', describedAccess_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls
your users' access to your Amazon S3 bucket or EFS file system. The
policies attached to this role determine the level of access that you
want to provide your users when transferring files into and out of your
Amazon S3 bucket or EFS file system. The IAM role should also contain a
trust relationship that allows the server to access your resources when
servicing your users' transfer requests.
$sel:policy:DescribedAccess', describedAccess_policy - A session policy for your user so that you can use the same IAM role
across multiple users. This policy scopes down user access to portions
of their Amazon S3 bucket. Variables that you can use inside this policy
include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
$sel:externalId:DescribedAccess', describedAccess_externalId - A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to
your Amazon S3 or Amazon EFS resources over the enabled protocols using
Amazon Web Services Transfer Family. If you know the group name, you can
view the SID values by running the following command using Windows
PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSidIn that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
$sel:homeDirectory:DescribedAccess', describedAccess_homeDirectory - The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory example is /bucket_name/home/mydirectory.
describedAccess_homeDirectoryType :: Lens' DescribedAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile) Source #
Undocumented member.
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 Amazon Web Services
Identity and Access Management (IAM) role provides access to paths in
Target. This value can only be set when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to
lock down the associated access to the designated home directory
("chroot"). To do this, you can set Entry to '/' and set
Target to the HomeDirectory parameter value.
describedAccess_role :: Lens' DescribedAccess (Maybe Text) Source #
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
describedAccess_policy :: Lens' DescribedAccess (Maybe Text) Source #
A session policy for your user so that you can use the same IAM role
across multiple users. This policy scopes down user access to portions
of their Amazon S3 bucket. Variables that you can use inside this policy
include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
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 Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSidIn that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
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.
DescribedExecution
data DescribedExecution Source #
The details for an execution object.
See: newDescribedExecution smart constructor.
Constructors
| DescribedExecution' | |
Fields
| |
Instances
newDescribedExecution :: DescribedExecution Source #
Create a value of DescribedExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DescribedExecution', describedExecution_status - The status is one of the execution. Can be in progress, completed,
exception encountered, or handling the exception.
$sel:executionId:DescribedExecution', describedExecution_executionId - A unique identifier for the execution of a workflow.
$sel:results:DescribedExecution', describedExecution_results - A structure that describes the execution results. This includes a list
of the steps along with the details of each step, error type and message
(if any), and the OnExceptionSteps structure.
$sel:initialFileLocation:DescribedExecution', describedExecution_initialFileLocation - A structure that describes the Amazon S3 or EFS file location. This is
the file location when the execution begins: if the file is being
copied, this is the initial (as opposed to destination) file location.
$sel:posixProfile:DescribedExecution', describedExecution_posixProfile - Undocumented member.
$sel:serviceMetadata:DescribedExecution', describedExecution_serviceMetadata - A container object for the session details associated with a workflow.
$sel:loggingConfiguration:DescribedExecution', describedExecution_loggingConfiguration - The IAM logging role associated with the execution.
$sel:executionRole:DescribedExecution', describedExecution_executionRole - The IAM role associated with the execution.
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.
describedExecution_executionId :: Lens' DescribedExecution (Maybe Text) Source #
A unique identifier for the execution of a workflow.
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_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_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile) Source #
Undocumented member.
describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata) Source #
A container object for the session details associated with a workflow.
describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration) Source #
The IAM logging role associated with the execution.
describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text) Source #
The IAM role associated with the execution.
DescribedSecurityPolicy
data DescribedSecurityPolicy Source #
Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.
See: newDescribedSecurityPolicy smart constructor.
Constructors
| DescribedSecurityPolicy' | |
Fields
| |
Instances
newDescribedSecurityPolicy Source #
Create a value of DescribedSecurityPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fips:DescribedSecurityPolicy', describedSecurityPolicy_fips - Specifies whether this policy enables Federal Information Processing
Standards (FIPS).
$sel:sshMacs:DescribedSecurityPolicy', describedSecurityPolicy_sshMacs - Specifies the enabled SSH message authentication code (MAC) encryption
algorithms in the security policy that is attached to the server.
$sel:sshKexs:DescribedSecurityPolicy', describedSecurityPolicy_sshKexs - Specifies the enabled SSH key exchange (KEX) encryption algorithms in
the security policy that is attached to the server.
$sel:tlsCiphers:DescribedSecurityPolicy', describedSecurityPolicy_tlsCiphers - Specifies the enabled Transport Layer Security (TLS) cipher encryption
algorithms in the security policy that is attached to the server.
$sel:sshCiphers:DescribedSecurityPolicy', describedSecurityPolicy_sshCiphers - Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in
the security policy that is attached to the server.
$sel:securityPolicyName:DescribedSecurityPolicy', describedSecurityPolicy_securityPolicyName - Specifies the name of the security policy that is attached to the
server.
describedSecurityPolicy_fips :: Lens' DescribedSecurityPolicy (Maybe Bool) Source #
Specifies whether this policy enables Federal Information Processing Standards (FIPS).
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_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_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_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_securityPolicyName :: Lens' DescribedSecurityPolicy Text Source #
Specifies the name of the security policy that is attached to the server.
DescribedServer
data DescribedServer Source #
Describes the properties of a file transfer protocol-enabled server that was specified.
See: newDescribedServer smart constructor.
Constructors
| DescribedServer' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribedServer |
Create a value of DescribedServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:protocolDetails:DescribedServer', describedServer_protocolDetails - The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode. Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall,
router, or load balancer.
$sel:loggingRole:DescribedServer', describedServer_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
Identity and Access Management (IAM) role that allows a server to turn
on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
set, user activity can be viewed in your CloudWatch logs.
$sel:state:DescribedServer', describedServer_state - Specifies the condition of a server for the server that was described. A
value of ONLINE indicates that the server can accept jobs and transfer
files. A State value of OFFLINE means that the server cannot perform
file transfer operations.
The states of STARTING and STOPPING indicate that the server is in
an intermediate state, either not fully able to respond, or not fully
offline. The values of START_FAILED or STOP_FAILED can indicate an
error condition.
$sel:identityProviderType:DescribedServer', describedServer_identityProviderType - Specifies the mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Amazon Web Services Managed Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connectors. This option also requires you to provide a
Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of
your choosing. The API_GATEWAY setting requires you to provide an API
Gateway endpoint URL to call for authentication using the
IdentityProviderDetails parameter.
$sel:protocols:DescribedServer', describedServer_protocols - Specifies the file transfer protocol or protocols over which your file
transfer protocol client can connect to your server's endpoint. The
available protocols are:
SFTP(Secure Shell (SSH) File Transfer Protocol): File transfer over SSHFTPS(File Transfer Protocol Secure): File transfer with TLS encryptionFTP(File Transfer Protocol): Unencrypted file transfer
$sel:serverId:DescribedServer', describedServer_serverId - Specifies the unique system-assigned identifier for a server that you
instantiate.
$sel:domain:DescribedServer', describedServer_domain - Specifies the domain of the storage system that is used for file
transfers.
$sel:endpointType:DescribedServer', describedServer_endpointType - Defines the type of endpoint that your server is connected to. If your
server is connected to a VPC endpoint, your server isn't accessible
over the public internet.
$sel:securityPolicyName:DescribedServer', describedServer_securityPolicyName - Specifies the name of the security policy that is attached to the
server.
$sel:hostKeyFingerprint:DescribedServer', describedServer_hostKeyFingerprint - Specifies the Base64-encoded SHA256 fingerprint of the server's host
key. This value is equivalent to the output of the
ssh-keygen -l -f my-new-server-key command.
$sel:userCount:DescribedServer', describedServer_userCount - Specifies the number of users that are assigned to a server you
specified with the ServerId.
$sel:certificate:DescribedServer', describedServer_certificate - Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM)
certificate. Required when Protocols is set to FTPS.
$sel:identityProviderDetails:DescribedServer', describedServer_identityProviderDetails - Specifies information to call a customer-supplied authentication API.
This field is not populated when the IdentityProviderType of a server
is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
$sel:workflowDetails:DescribedServer', describedServer_workflowDetails - Specifies the workflow ID for the workflow to assign and the execution
role used for executing the workflow.
$sel:tags:DescribedServer', describedServer_tags - Specifies the key-value pairs that you can use to search for and group
servers that were assigned to the server that was described.
$sel:endpointDetails:DescribedServer', describedServer_endpointDetails - The virtual private cloud (VPC) endpoint settings that are configured
for your server. When you host your endpoint within your VPC, you can
make it accessible only to resources within your VPC, or you can attach
Elastic IP addresses and make it accessible to clients over the
internet. Your VPC's default security groups are automatically assigned
to your endpoint.
$sel:arn:DescribedServer', describedServer_arn - Specifies the unique Amazon Resource Name (ARN) of the server.
describedServer_protocolDetails :: Lens' DescribedServer (Maybe ProtocolDetails) Source #
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode. Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall,
router, or load balancer.
describedServer_loggingRole :: Lens' DescribedServer (Maybe Text) Source #
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
describedServer_state :: Lens' DescribedServer (Maybe State) Source #
Specifies the condition of a server for the server that was described. A
value of ONLINE indicates that the server can accept jobs and transfer
files. A State value of OFFLINE means that the server cannot perform
file transfer operations.
The states of STARTING and STOPPING indicate that the server is in
an intermediate state, either not fully able to respond, or not fully
offline. The values of START_FAILED or STOP_FAILED can indicate an
error condition.
describedServer_identityProviderType :: Lens' DescribedServer (Maybe IdentityProviderType) Source #
Specifies the mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Amazon Web Services Managed Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connectors. This option also requires you to provide a
Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of
your choosing. The API_GATEWAY setting requires you to provide an API
Gateway endpoint URL to call for authentication using the
IdentityProviderDetails parameter.
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 transfer
describedServer_serverId :: Lens' DescribedServer (Maybe Text) Source #
Specifies the unique system-assigned identifier for a server that you instantiate.
describedServer_domain :: Lens' DescribedServer (Maybe Domain) Source #
Specifies the domain of the storage system that is used for file transfers.
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_securityPolicyName :: Lens' DescribedServer (Maybe Text) Source #
Specifies the name of the security policy that is attached to the server.
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_userCount :: Lens' DescribedServer (Maybe Int) Source #
Specifies the number of users that are assigned to a server you
specified with the ServerId.
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_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_workflowDetails :: Lens' DescribedServer (Maybe WorkflowDetails) Source #
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
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_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 it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
describedServer_arn :: Lens' DescribedServer Text Source #
Specifies the unique Amazon Resource Name (ARN) of the server.
DescribedUser
data DescribedUser Source #
Describes the properties of a user that was specified.
See: newDescribedUser smart constructor.
Constructors
| DescribedUser' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribedUser |
Create a value of DescribedUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sshPublicKeys:DescribedUser', describedUser_sshPublicKeys - Specifies the public key portion of the Secure Shell (SSH) keys stored
for the described user.
$sel:homeDirectoryType:DescribedUser', describedUser_homeDirectoryType - The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
$sel:userName:DescribedUser', describedUser_userName - Specifies the name of the user that was requested to be described. User
names are used for authentication purposes. This is the string that will
be used by your user when they log in to your server.
$sel:posixProfile:DescribedUser', describedUser_posixProfile - Specifies the full POSIX identity, including user ID (Uid), group ID
(Gid), and any secondary groups IDs (SecondaryGids), that controls
your users' access to your Amazon Elastic File System (Amazon EFS) file
systems. The POSIX permissions that are set on files and directories in
your file system determine the level of access your users get when
transferring files into and out of your Amazon EFS file systems.
$sel:homeDirectoryMappings:DescribedUser', describedUser_homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS
paths and keys should be visible to your user and how you want to make
them visible. You must specify the Entry and Target pair, where
Entry shows how the path is made visible and Target is the actual
Amazon S3 or Amazon EFS path. If you only specify a target, it is
displayed as is. You also must ensure that your Amazon Web Services
Identity and Access Management (IAM) role provides access to paths in
Target. This value can only be set when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to
lock your user down to the designated home directory ("chroot"). To
do this, you can set Entry to '/' and set Target to the
HomeDirectory parameter value.
$sel:role':DescribedUser', describedUser_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls
your users' access to your Amazon S3 bucket or EFS file system. The
policies attached to this role determine the level of access that you
want to provide your users when transferring files into and out of your
Amazon S3 bucket or EFS file system. The IAM role should also contain a
trust relationship that allows the server to access your resources when
servicing your users' transfer requests.
$sel:policy:DescribedUser', describedUser_policy - A session policy for your user so that you can use the same IAM role
across multiple users. This policy scopes down user access to portions
of their Amazon S3 bucket. Variables that you can use inside this policy
include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
$sel:homeDirectory:DescribedUser', describedUser_homeDirectory - The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory example is /bucket_name/home/mydirectory.
$sel:tags:DescribedUser', describedUser_tags - Specifies the key-value pairs for the user requested. Tag can be used to
search for and group users for a variety of purposes.
$sel:arn:DescribedUser', describedUser_arn - Specifies the unique Amazon Resource Name (ARN) for the user that was
requested to be described.
describedUser_sshPublicKeys :: Lens' DescribedUser (Maybe [SshPublicKey]) Source #
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
describedUser_homeDirectoryType :: Lens' DescribedUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
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_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_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 Amazon Web Services
Identity and Access Management (IAM) role provides access to paths in
Target. This value can only be set when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to
lock your user down to the designated home directory ("chroot"). To
do this, you can set Entry to '/' and set Target to the
HomeDirectory parameter value.
describedUser_role :: Lens' DescribedUser (Maybe Text) Source #
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
describedUser_policy :: Lens' DescribedUser (Maybe Text) Source #
A session policy for your user so that you can use the same IAM role
across multiple users. This policy scopes down user access to portions
of their Amazon S3 bucket. Variables that you can use inside this policy
include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
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_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_arn :: Lens' DescribedUser Text Source #
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
DescribedWorkflow
data DescribedWorkflow Source #
Describes the properties of the specified workflow
See: newDescribedWorkflow smart constructor.
Constructors
| DescribedWorkflow' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribedWorkflow |
Create a value of DescribedWorkflow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:onExceptionSteps:DescribedWorkflow', describedWorkflow_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during
execution of the workflow.
$sel:steps:DescribedWorkflow', describedWorkflow_steps - Specifies the details for the steps that are in the specified workflow.
$sel:workflowId:DescribedWorkflow', describedWorkflow_workflowId - A unique identifier for the workflow.
$sel:description:DescribedWorkflow', describedWorkflow_description - Specifies the text description for the workflow.
$sel:tags:DescribedWorkflow', describedWorkflow_tags - Key-value pairs that can be used to group and search for workflows. Tags
are metadata attached to workflows for any purpose.
$sel:arn:DescribedWorkflow', describedWorkflow_arn - Specifies the unique Amazon Resource Name (ARN) for the workflow.
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_workflowId :: Lens' DescribedWorkflow (Maybe Text) Source #
A unique identifier for the workflow.
describedWorkflow_description :: Lens' DescribedWorkflow (Maybe Text) Source #
Specifies the text description for the 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_arn :: Lens' DescribedWorkflow Text Source #
Specifies the unique Amazon Resource Name (ARN) for the workflow.
EfsFileLocation
data EfsFileLocation Source #
Reserved for future use.
See: newEfsFileLocation smart constructor.
Constructors
| EfsFileLocation' | |
Instances
newEfsFileLocation :: EfsFileLocation Source #
Create a value of EfsFileLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:path:EfsFileLocation', efsFileLocation_path - The pathname for the folder being used by a workflow.
$sel:fileSystemId:EfsFileLocation', efsFileLocation_fileSystemId - The ID of the file system, assigned by Amazon EFS.
efsFileLocation_path :: Lens' EfsFileLocation (Maybe Text) Source #
The pathname for the folder being used by a workflow.
efsFileLocation_fileSystemId :: Lens' EfsFileLocation (Maybe Text) Source #
The ID of the file system, assigned by Amazon EFS.
EndpointDetails
data EndpointDetails Source #
The virtual private cloud (VPC) endpoint settings that are configured
for your file transfer protocol-enabled server. With a VPC endpoint, you
can restrict access to your server and resources only within your VPC.
To control incoming internet traffic, invoke the UpdateServer API and
attach an Elastic IP address to your server's endpoint.
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your
account hasn't already done so before May 19, 2021. If you have already
created servers with EndpointType=VPC_ENDPOINT in your Amazon Web
Servicesaccount on or before May 19, 2021, you will not be affected.
After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
See: newEndpointDetails smart constructor.
Constructors
| EndpointDetails' | |
Fields
| |
Instances
newEndpointDetails :: EndpointDetails Source #
Create a value of EndpointDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:EndpointDetails', endpointDetails_securityGroupIds - A list of security groups IDs that are available to attach to your
server's endpoint.
This property can only be set when EndpointType is set to VPC.
You can edit the SecurityGroupIds property in the
UpdateServer
API only if you are changing the EndpointType from PUBLIC or
VPC_ENDPOINT to VPC. To change security groups associated with your
server's VPC endpoint after creation, use the Amazon EC2
ModifyVpcEndpoint
API.
$sel:subnetIds:EndpointDetails', endpointDetails_subnetIds - A list of subnet IDs that are required to host your server endpoint in
your VPC.
This property can only be set when EndpointType is set to VPC.
$sel:vpcId:EndpointDetails', endpointDetails_vpcId - The VPC ID of the VPC in which a server's endpoint will be hosted.
This property can only be set when EndpointType is set to VPC.
$sel:addressAllocationIds:EndpointDetails', endpointDetails_addressAllocationIds - A list of address allocation IDs that are required to attach an Elastic
IP address to your server's endpoint.
This property can only be set when EndpointType is set to VPC and it
is only valid in the UpdateServer API.
$sel:vpcEndpointId:EndpointDetails', endpointDetails_vpcEndpointId - The ID of the VPC endpoint.
This property can only be set when EndpointType is set to
VPC_ENDPOINT.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
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_vpcId :: Lens' EndpointDetails (Maybe Text) Source #
The VPC ID of the VPC in which a server's endpoint will be hosted.
This property can only be set when EndpointType is set to VPC.
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_vpcEndpointId :: Lens' EndpointDetails (Maybe Text) Source #
The ID of the VPC endpoint.
This property can only be set when EndpointType is set to
VPC_ENDPOINT.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
ExecutionError
data ExecutionError Source #
Specifies the error message and type, for an error that occurs during the execution of the workflow.
See: newExecutionError smart constructor.
Constructors
| ExecutionError' | |
Fields
| |
Instances
Arguments
| :: ExecutionErrorType | |
| -> Text | |
| -> ExecutionError |
Create a value of ExecutionError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':ExecutionError', executionError_type - Specifies the error type: currently, the only valid value is
PERMISSION_DENIED, which occurs if your policy does not contain the
correct permissions to complete one or more of the steps in the
workflow.
$sel:message:ExecutionError', executionError_message - Specifies the descriptive message that corresponds to the ErrorType.
executionError_type :: Lens' ExecutionError ExecutionErrorType Source #
Specifies the error type: currently, the only valid value is
PERMISSION_DENIED, which occurs if your policy does not contain the
correct permissions to complete one or more of the steps in the
workflow.
executionError_message :: Lens' ExecutionError Text Source #
Specifies the descriptive message that corresponds to the ErrorType.
ExecutionResults
data ExecutionResults Source #
Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.
See: newExecutionResults smart constructor.
Constructors
| ExecutionResults' | |
Fields
| |
Instances
newExecutionResults :: ExecutionResults Source #
Create a value of ExecutionResults with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:onExceptionSteps:ExecutionResults', executionResults_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during
execution of the workflow.
$sel:steps:ExecutionResults', executionResults_steps - Specifies the details for the steps that are in the specified workflow.
executionResults_onExceptionSteps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult)) Source #
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
executionResults_steps :: Lens' ExecutionResults (Maybe (NonEmpty ExecutionStepResult)) Source #
Specifies the details for the steps that are in the specified workflow.
ExecutionStepResult
data ExecutionStepResult Source #
Specifies the following details for the step: error (if any), outputs (if any), and the step type.
See: newExecutionStepResult smart constructor.
Constructors
| ExecutionStepResult' | |
Fields
| |
Instances
newExecutionStepResult :: ExecutionStepResult Source #
Create a value of ExecutionStepResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stepType:ExecutionStepResult', executionStepResult_stepType - One of the available step types.
- Copy: copy the file to another location
- Custom: custom step with a lambda target
- Delete: delete the file
- Tag: add a tag to the file
$sel:error:ExecutionStepResult', executionStepResult_error - Specifies the details for an error, if it occurred during execution of
the specified workfow step.
$sel:outputs:ExecutionStepResult', executionStepResult_outputs - The values for the key/value pair applied as a tag to the file. Only
applicable if the step type is TAG.
executionStepResult_stepType :: Lens' ExecutionStepResult (Maybe WorkflowStepType) Source #
One of the available step types.
- Copy: copy the file to another location
- Custom: custom step with a lambda target
- Delete: delete the file
- Tag: add a tag to the file
executionStepResult_error :: Lens' ExecutionStepResult (Maybe ExecutionError) Source #
Specifies the details for an error, if it occurred during execution of the specified workfow 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.
FileLocation
data FileLocation Source #
Specifies the Amazon S3 or EFS file details to be used in the step.
See: newFileLocation smart constructor.
Constructors
| FileLocation' | |
Fields
| |
Instances
newFileLocation :: FileLocation Source #
Create a value of FileLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:efsFileLocation:FileLocation', fileLocation_efsFileLocation - Specifies the Amazon EFS ID and the path for the file being used.
$sel:s3FileLocation:FileLocation', fileLocation_s3FileLocation - Specifies the S3 details for the file being used, such as bucket, Etag,
and so forth.
fileLocation_efsFileLocation :: Lens' FileLocation (Maybe EfsFileLocation) Source #
Specifies the Amazon EFS ID and the path for the file being used.
fileLocation_s3FileLocation :: Lens' FileLocation (Maybe S3FileLocation) Source #
Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.
HomeDirectoryMapEntry
data HomeDirectoryMapEntry Source #
Represents an object that contains entries and targets for
HomeDirectoryMappings.
The following is an Entry and Target pair example for chroot.
[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]If the target of a logical directory entry does not exist in Amazon S3
or EFS, the entry is ignored. As a workaround, you can use the Amazon S3
API or EFS API to create 0 byte objects as place holders for your
directory. If using the CLI, use the s3api or efsapi call instead of
s3 or efs so you can use the put-object operation. For example, you
use the following:
aws s3api put-object --bucket bucketname --key path/to/folder/.
Make sure that the end of the key name ends in a / for it to be
considered a folder.
See: newHomeDirectoryMapEntry smart constructor.
Constructors
| HomeDirectoryMapEntry' | |
Instances
newHomeDirectoryMapEntry Source #
Arguments
| :: Text | |
| -> Text | |
| -> HomeDirectoryMapEntry |
Create a value of HomeDirectoryMapEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entry:HomeDirectoryMapEntry', homeDirectoryMapEntry_entry - Represents an entry for HomeDirectoryMappings.
$sel:target:HomeDirectoryMapEntry', homeDirectoryMapEntry_target - Represents the map target that is used in a HomeDirectorymapEntry.
homeDirectoryMapEntry_entry :: Lens' HomeDirectoryMapEntry Text Source #
Represents an entry for HomeDirectoryMappings.
homeDirectoryMapEntry_target :: Lens' HomeDirectoryMapEntry Text Source #
Represents the map target that is used in a HomeDirectorymapEntry.
IdentityProviderDetails
data IdentityProviderDetails Source #
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.
See: newIdentityProviderDetails smart constructor.
Constructors
| IdentityProviderDetails' | |
Fields
| |
Instances
newIdentityProviderDetails :: IdentityProviderDetails Source #
Create a value of IdentityProviderDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:invocationRole:IdentityProviderDetails', identityProviderDetails_invocationRole - Provides the type of InvocationRole used to authenticate the user
account.
$sel:directoryId:IdentityProviderDetails', identityProviderDetails_directoryId - The identifier of the Amazon Web ServicesDirectory Service directory
that you want to stop sharing.
$sel:url:IdentityProviderDetails', identityProviderDetails_url - Provides the location of the service endpoint used to authenticate
users.
identityProviderDetails_invocationRole :: Lens' IdentityProviderDetails (Maybe Text) Source #
Provides the type of InvocationRole used to authenticate the user
account.
identityProviderDetails_directoryId :: Lens' IdentityProviderDetails (Maybe Text) Source #
The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.
identityProviderDetails_url :: Lens' IdentityProviderDetails (Maybe Text) Source #
Provides the location of the service endpoint used to authenticate users.
InputFileLocation
data InputFileLocation Source #
Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.
See: newInputFileLocation smart constructor.
Constructors
| InputFileLocation' | |
Fields
| |
Instances
newInputFileLocation :: InputFileLocation Source #
Create a value of InputFileLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:efsFileLocation:InputFileLocation', inputFileLocation_efsFileLocation - Reserved for future use.
$sel:s3FileLocation:InputFileLocation', inputFileLocation_s3FileLocation - Specifies the details for the S3 file being copied.
inputFileLocation_efsFileLocation :: Lens' InputFileLocation (Maybe EfsFileLocation) Source #
Reserved for future use.
inputFileLocation_s3FileLocation :: Lens' InputFileLocation (Maybe S3InputFileLocation) Source #
Specifies the details for the S3 file being copied.
ListedAccess
data ListedAccess Source #
Lists the properties for one or more specified associated accesses.
See: newListedAccess smart constructor.
Constructors
| ListedAccess' | |
Fields
| |
Instances
newListedAccess :: ListedAccess Source #
Create a value of ListedAccess with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeDirectoryType:ListedAccess', listedAccess_homeDirectoryType - The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
$sel:role':ListedAccess', listedAccess_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls
your users' access to your Amazon S3 bucket or EFS file system. The
policies attached to this role determine the level of access that you
want to provide your users when transferring files into and out of your
Amazon S3 bucket or EFS file system. The IAM role should also contain a
trust relationship that allows the server to access your resources when
servicing your users' transfer requests.
$sel:externalId:ListedAccess', listedAccess_externalId - A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to
your Amazon S3 or Amazon EFS resources over the enabled protocols using
Amazon Web Services Transfer Family. If you know the group name, you can
view the SID values by running the following command using Windows
PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSidIn that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
$sel:homeDirectory:ListedAccess', listedAccess_homeDirectory - The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory example is /bucket_name/home/mydirectory.
listedAccess_homeDirectoryType :: Lens' ListedAccess (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
listedAccess_role :: Lens' ListedAccess (Maybe Text) Source #
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
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 Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSidIn that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
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.
ListedExecution
data ListedExecution Source #
Returns properties of the execution that is specified.
See: newListedExecution smart constructor.
Constructors
| ListedExecution' | |
Fields
| |
Instances
newListedExecution :: ListedExecution Source #
Create a value of ListedExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:ListedExecution', listedExecution_status - The status is one of the execution. Can be in progress, completed,
exception encountered, or handling the exception.
$sel:executionId:ListedExecution', listedExecution_executionId - A unique identifier for the execution of a workflow.
$sel:initialFileLocation:ListedExecution', listedExecution_initialFileLocation - A structure that describes the Amazon S3 or EFS file location. This is
the file location when the execution begins: if the file is being
copied, this is the initial (as opposed to destination) file location.
$sel:serviceMetadata:ListedExecution', listedExecution_serviceMetadata - A container object for the session details associated with a workflow.
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.
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 associated with a workflow.
ListedServer
data ListedServer Source #
Returns properties of a file transfer protocol-enabled server that was specified.
See: newListedServer smart constructor.
Constructors
| ListedServer' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListedServer |
Create a value of ListedServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingRole:ListedServer', listedServer_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
Identity and Access Management (IAM) role that allows a server to turn
on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
set, user activity can be viewed in your CloudWatch logs.
$sel:state:ListedServer', listedServer_state - Specifies the condition of a server for the server that was described. A
value of ONLINE indicates that the server can accept jobs and transfer
files. A State value of OFFLINE means that the server cannot perform
file transfer operations.
The states of STARTING and STOPPING indicate that the server is in
an intermediate state, either not fully able to respond, or not fully
offline. The values of START_FAILED or STOP_FAILED can indicate an
error condition.
$sel:identityProviderType:ListedServer', listedServer_identityProviderType - Specifies the mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Amazon Web Services Managed Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connectors. This option also requires you to provide a
Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of
your choosing. The API_GATEWAY setting requires you to provide an API
Gateway endpoint URL to call for authentication using the
IdentityProviderDetails parameter.
$sel:serverId:ListedServer', listedServer_serverId - Specifies the unique system assigned identifier for the servers that
were listed.
$sel:domain:ListedServer', listedServer_domain - Specifies the domain of the storage system that is used for file
transfers.
$sel:endpointType:ListedServer', listedServer_endpointType - Specifies the type of VPC endpoint that your server is connected to. If
your server is connected to a VPC endpoint, your server isn't
accessible over the public internet.
$sel:userCount:ListedServer', listedServer_userCount - Specifies the number of users that are assigned to a server you
specified with the ServerId.
$sel:arn:ListedServer', listedServer_arn - Specifies the unique Amazon Resource Name (ARN) for a server to be
listed.
listedServer_loggingRole :: Lens' ListedServer (Maybe Text) Source #
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
listedServer_state :: Lens' ListedServer (Maybe State) Source #
Specifies the condition of a server for the server that was described. A
value of ONLINE indicates that the server can accept jobs and transfer
files. A State value of OFFLINE means that the server cannot perform
file transfer operations.
The states of STARTING and STOPPING indicate that the server is in
an intermediate state, either not fully able to respond, or not fully
offline. The values of START_FAILED or STOP_FAILED can indicate an
error condition.
listedServer_identityProviderType :: Lens' ListedServer (Maybe IdentityProviderType) Source #
Specifies the mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials
within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups
in Amazon Web Services Managed Active Directory or Microsoft Active
Directory in your on-premises environment or in Amazon Web Services
using AD Connectors. This option also requires you to provide a
Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of
your choosing. The API_GATEWAY setting requires you to provide an API
Gateway endpoint URL to call for authentication using the
IdentityProviderDetails parameter.
listedServer_serverId :: Lens' ListedServer (Maybe Text) Source #
Specifies the unique system assigned identifier for the servers that were listed.
listedServer_domain :: Lens' ListedServer (Maybe Domain) Source #
Specifies the domain of the storage system that is used for file transfers.
listedServer_endpointType :: Lens' ListedServer (Maybe EndpointType) Source #
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
listedServer_userCount :: Lens' ListedServer (Maybe Int) Source #
Specifies the number of users that are assigned to a server you
specified with the ServerId.
listedServer_arn :: Lens' ListedServer Text Source #
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
ListedUser
data ListedUser Source #
Returns properties of the user that you specify.
See: newListedUser smart constructor.
Constructors
| ListedUser' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListedUser |
Create a value of ListedUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeDirectoryType:ListedUser', listedUser_homeDirectoryType - The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
$sel:userName:ListedUser', listedUser_userName - Specifies the name of the user whose ARN was specified. User names are
used for authentication purposes.
$sel:role':ListedUser', listedUser_role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls
your users' access to your Amazon S3 bucket or EFS file system. The
policies attached to this role determine the level of access that you
want to provide your users when transferring files into and out of your
Amazon S3 bucket or EFS file system. The IAM role should also contain a
trust relationship that allows the server to access your resources when
servicing your users' transfer requests.
The IAM role that controls your users' access to your Amazon S3 bucket
for servers with Domain=S3, or your EFS file system for servers with
Domain=EFS.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
$sel:sshPublicKeyCount:ListedUser', listedUser_sshPublicKeyCount - Specifies the number of SSH public keys stored for the user you
specified.
$sel:homeDirectory:ListedUser', listedUser_homeDirectory - The landing directory (folder) for a user when they log in to the server
using the client.
A HomeDirectory example is /bucket_name/home/mydirectory.
$sel:arn:ListedUser', listedUser_arn - Provides the unique Amazon Resource Name (ARN) for the user that you
want to learn about.
listedUser_homeDirectoryType :: Lens' ListedUser (Maybe HomeDirectoryType) Source #
The type of landing directory (folder) you want your users' home
directory to be when they log into the server. If you set it to PATH,
the user will see the absolute Amazon S3 bucket or EFS paths as is in
their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to
make Amazon S3 or EFS paths visible to your users.
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_role :: Lens' ListedUser (Maybe Text) Source #
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
The IAM role that controls your users' access to your Amazon S3 bucket
for servers with Domain=S3, or your EFS file system for servers with
Domain=EFS.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int) Source #
Specifies the number of SSH public keys stored for the user you specified.
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_arn :: Lens' ListedUser Text Source #
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
ListedWorkflow
data ListedWorkflow Source #
Contains the ID, text description, and Amazon Resource Name (ARN) for the workflow.
See: newListedWorkflow smart constructor.
Constructors
| ListedWorkflow' | |
Fields
| |
Instances
newListedWorkflow :: ListedWorkflow Source #
Create a value of ListedWorkflow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ListedWorkflow', listedWorkflow_arn - Specifies the unique Amazon Resource Name (ARN) for the workflow.
$sel:workflowId:ListedWorkflow', listedWorkflow_workflowId - A unique identifier for the workflow.
$sel:description:ListedWorkflow', listedWorkflow_description - Specifies the text description for the workflow.
listedWorkflow_arn :: Lens' ListedWorkflow (Maybe Text) Source #
Specifies the unique Amazon Resource Name (ARN) for the workflow.
listedWorkflow_workflowId :: Lens' ListedWorkflow (Maybe Text) Source #
A unique identifier for the workflow.
listedWorkflow_description :: Lens' ListedWorkflow (Maybe Text) Source #
Specifies the text description for the workflow.
LoggingConfiguration
data LoggingConfiguration Source #
Consists of the logging role and the log group name.
See: newLoggingConfiguration smart constructor.
Constructors
| LoggingConfiguration' | |
Fields
| |
Instances
newLoggingConfiguration :: LoggingConfiguration Source #
Create a value of LoggingConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingRole:LoggingConfiguration', loggingConfiguration_loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
Identity and Access Management (IAM) role that allows a server to turn
on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When
set, user activity can be viewed in your CloudWatch logs.
$sel:logGroupName:LoggingConfiguration', loggingConfiguration_logGroupName - The name of the CloudWatch logging group for the Amazon Web Services
Transfer server to which this workflow belongs.
loggingConfiguration_loggingRole :: Lens' LoggingConfiguration (Maybe Text) Source #
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
loggingConfiguration_logGroupName :: Lens' LoggingConfiguration (Maybe Text) Source #
The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.
PosixProfile
data PosixProfile Source #
The full POSIX identity, including user ID (Uid), group ID (Gid),
and any secondary groups IDs (SecondaryGids), that controls your
users' access to your Amazon EFS file systems. The POSIX permissions
that are set on files and directories in your file system determine the
level of access your users get when transferring files into and out of
your Amazon EFS file systems.
See: newPosixProfile smart constructor.
Constructors
| PosixProfile' | |
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> PosixProfile |
Create a value of PosixProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secondaryGids:PosixProfile', posixProfile_secondaryGids - The secondary POSIX group IDs used for all EFS operations by this user.
$sel:uid:PosixProfile', posixProfile_uid - The POSIX user ID used for all EFS operations by this user.
$sel:gid:PosixProfile', posixProfile_gid - The POSIX group ID used for all EFS operations by this user.
posixProfile_secondaryGids :: Lens' PosixProfile (Maybe [Natural]) Source #
The secondary POSIX group IDs used for all EFS operations by this user.
posixProfile_uid :: Lens' PosixProfile Natural Source #
The POSIX user ID used for all EFS operations by this user.
posixProfile_gid :: Lens' PosixProfile Natural Source #
The POSIX group ID used for all EFS operations by this user.
ProtocolDetails
data ProtocolDetails Source #
The protocol settings that are configured for your server.
This type is only valid in the UpdateServer API.
See: newProtocolDetails smart constructor.
Constructors
| ProtocolDetails' | |
Fields
| |
Instances
newProtocolDetails :: ProtocolDetails Source #
Create a value of ProtocolDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:passiveIp:ProtocolDetails', protocolDetails_passiveIp - Indicates passive mode, for FTP and FTPS protocols. Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall,
router, or load balancer. For example:
aws transfer update-server --protocol-details PassiveIp=0.0.0.0
Replace 0.0.0.0 in the example above with the actual IP address you
want to use.
If you change the PassiveIp value, you must stop and then restart your
Transfer server for the change to take effect. For details on using
Passive IP (PASV) in a NAT environment, see
Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.
protocolDetails_passiveIp :: Lens' ProtocolDetails (Maybe Text) Source #
Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. For example:
aws transfer update-server --protocol-details PassiveIp=0.0.0.0
Replace 0.0.0.0 in the example above with the actual IP address you
want to use.
If you change the PassiveIp value, you must stop and then restart your
Transfer server for the change to take effect. For details on using
Passive IP (PASV) in a NAT environment, see
Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.
S3FileLocation
data S3FileLocation Source #
Specifies the details for the file location for the file being used in the workflow. Only applicable if you are using S3 storage.
See: newS3FileLocation smart constructor.
Constructors
| S3FileLocation' | |
Fields
| |
Instances
newS3FileLocation :: S3FileLocation Source #
Create a value of S3FileLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionId:S3FileLocation', s3FileLocation_versionId - Specifies the file version.
$sel:etag:S3FileLocation', s3FileLocation_etag - The entity tag is a hash of the object. The ETag reflects changes only
to the contents of an object, not its metadata.
$sel:bucket:S3FileLocation', s3FileLocation_bucket - Specifies the S3 bucket that contains the file being used.
$sel:key:S3FileLocation', s3FileLocation_key - The name assigned to the file when it was created in S3. You use the
object key to retrieve the object.
s3FileLocation_versionId :: Lens' S3FileLocation (Maybe Text) Source #
Specifies the file version.
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_bucket :: Lens' S3FileLocation (Maybe Text) Source #
Specifies the S3 bucket that contains the file being used.
s3FileLocation_key :: Lens' S3FileLocation (Maybe Text) Source #
The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
S3InputFileLocation
data S3InputFileLocation Source #
Specifies the customer input S3 file location. If it is used inside
copyStepDetails.DestinationFileLocation, it should be the S3 copy
destination.
You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.
For example, if your path is shared-files/bob/, your uploaded files
are copied to the shared-files/bob/, folder. If your path is
shared-files/today, each uploaded file is copied to the
shared-files folder and named today: each upload overwrites the
previous version of the bob file.
See: newS3InputFileLocation smart constructor.
Constructors
| S3InputFileLocation' | |
Instances
newS3InputFileLocation :: S3InputFileLocation Source #
Create a value of S3InputFileLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:S3InputFileLocation', s3InputFileLocation_bucket - Specifies the S3 bucket for the customer input file.
$sel:key:S3InputFileLocation', s3InputFileLocation_key - The name assigned to the file when it was created in S3. You use the
object key to retrieve the object.
s3InputFileLocation_bucket :: Lens' S3InputFileLocation (Maybe Text) Source #
Specifies the S3 bucket for the customer input file.
s3InputFileLocation_key :: Lens' S3InputFileLocation (Maybe Text) Source #
The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
S3Tag
Specifies the key-value pair that are assigned to a file during the execution of a Tagging step.
See: newS3Tag smart constructor.
Constructors
| S3Tag' | |
Instances
| Eq S3Tag Source # | |
| Read S3Tag Source # | |
| Show S3Tag Source # | |
| Generic S3Tag Source # | |
| NFData S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag | |
| Hashable S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag | |
| ToJSON S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag | |
| FromJSON S3Tag Source # | |
| type Rep S3Tag Source # | |
Defined in Amazonka.Transfer.Types.S3Tag type Rep S3Tag = D1 ('MetaData "S3Tag" "Amazonka.Transfer.Types.S3Tag" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "S3Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of S3Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:S3Tag', s3Tag_key - The name assigned to the tag that you create.
$sel:value:S3Tag', s3Tag_value - The value that corresponds to the key.
ServiceMetadata
data ServiceMetadata Source #
A container object for the session details associated with a workflow.
See: newServiceMetadata smart constructor.
Constructors
| ServiceMetadata' | |
Fields
| |
Instances
Arguments
| :: UserDetails | |
| -> ServiceMetadata |
Create a value of ServiceMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userDetails:ServiceMetadata', serviceMetadata_userDetails - The Server ID (ServerId), Session ID (SessionId) and user
(UserName) make up the UserDetails.
serviceMetadata_userDetails :: Lens' ServiceMetadata UserDetails Source #
The Server ID (ServerId), Session ID (SessionId) and user
(UserName) make up the UserDetails.
SshPublicKey
data SshPublicKey Source #
Provides information about the public Secure Shell (SSH) key that is
associated with a user account for the specific file transfer
protocol-enabled server (as identified by ServerId). The information
returned includes the date the key was imported, the public key
contents, and the public key ID. A user can store more than one SSH
public key associated with their user name on a specific server.
See: newSshPublicKey smart constructor.
Constructors
| SshPublicKey' | |
Fields
| |
Instances
Arguments
| :: UTCTime | |
| -> Text | |
| -> Text | |
| -> SshPublicKey |
Create a value of SshPublicKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateImported:SshPublicKey', sshPublicKey_dateImported - Specifies the date that the public key was added to the user account.
$sel:sshPublicKeyBody:SshPublicKey', sshPublicKey_sshPublicKeyBody - Specifies the content of the SSH public key as specified by the
PublicKeyId.
$sel:sshPublicKeyId:SshPublicKey', sshPublicKey_sshPublicKeyId - Specifies the SshPublicKeyId parameter contains the identifier of the
public key.
sshPublicKey_dateImported :: Lens' SshPublicKey UTCTime Source #
Specifies the date that the public key was added to the user account.
sshPublicKey_sshPublicKeyBody :: Lens' SshPublicKey Text Source #
Specifies the content of the SSH public key as specified by the
PublicKeyId.
sshPublicKey_sshPublicKeyId :: Lens' SshPublicKey Text Source #
Specifies the SshPublicKeyId parameter contains the identifier of the
public key.
Tag
Creates a key-value pair for a specific resource. Tags are metadata that
you can use to search for and group a resource for various purposes. You
can apply tags to servers, users, and roles. A tag key can take more
than one value. For example, to group servers for accounting purposes,
you might create a tag called Group and assign the values Research
and Accounting to that group.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.Transfer.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Transfer.Types.Tag" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The name assigned to the tag that you create.
$sel:value:Tag', tag_value - Contains one or more values that you assigned to the key name you
create.
tag_value :: Lens' Tag Text Source #
Contains one or more values that you assigned to the key name you create.
TagStepDetails
data TagStepDetails Source #
Each step type has its own StepDetails structure.
The key/value pairs used to tag a file during the execution of a workflow step.
See: newTagStepDetails smart constructor.
Constructors
| TagStepDetails' | |
Instances
newTagStepDetails :: TagStepDetails Source #
Create a value of TagStepDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TagStepDetails', tagStepDetails_name - The name of the step, used as an identifier.
$sel:tags:TagStepDetails', tagStepDetails_tags - Array that contains from 1 to 10 key/value pairs.
tagStepDetails_name :: Lens' TagStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
tagStepDetails_tags :: Lens' TagStepDetails (Maybe (NonEmpty S3Tag)) Source #
Array that contains from 1 to 10 key/value pairs.
UserDetails
data UserDetails Source #
Specifies the user name, server ID, and session ID for a workflow.
See: newUserDetails smart constructor.
Constructors
| UserDetails' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UserDetails |
Create a value of UserDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sessionId:UserDetails', userDetails_sessionId - The system-assigned unique identifier for a session that corresponds to
the workflow.
$sel:userName:UserDetails', userDetails_userName - A unique string that identifies a user account associated with a server.
$sel:serverId:UserDetails', userDetails_serverId - The system-assigned unique identifier for a Transfer server instance.
userDetails_sessionId :: Lens' UserDetails (Maybe Text) Source #
The system-assigned unique identifier for a session that corresponds to the workflow.
userDetails_userName :: Lens' UserDetails Text Source #
A unique string that identifies a user account associated with a server.
userDetails_serverId :: Lens' UserDetails Text Source #
The system-assigned unique identifier for a Transfer server instance.
WorkflowDetail
data WorkflowDetail Source #
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
See: newWorkflowDetail smart constructor.
Constructors
| WorkflowDetail' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> WorkflowDetail |
Create a value of WorkflowDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workflowId:WorkflowDetail', workflowDetail_workflowId - A unique identifier for the workflow.
$sel:executionRole:WorkflowDetail', workflowDetail_executionRole - Includes the necessary permissions for S3, EFS, and Lambda operations
that Transfer can assume, so that all workflow steps can operate on the
required resources
workflowDetail_workflowId :: Lens' WorkflowDetail Text Source #
A unique identifier for the workflow.
workflowDetail_executionRole :: Lens' WorkflowDetail Text Source #
Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources
WorkflowDetails
data WorkflowDetails Source #
Container for the WorkflowDetail data type. It is used by actions that
trigger a workflow to begin execution.
See: newWorkflowDetails smart constructor.
Constructors
| WorkflowDetails' | |
Fields
| |
Instances
newWorkflowDetails :: WorkflowDetails Source #
Create a value of WorkflowDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:onUpload:WorkflowDetails', workflowDetails_onUpload - A trigger that starts a workflow: the workflow begins to execute after a
file is uploaded.
workflowDetails_onUpload :: Lens' WorkflowDetails [WorkflowDetail] Source #
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
WorkflowStep
data WorkflowStep Source #
The basic building block of a workflow.
See: newWorkflowStep smart constructor.
Constructors
| WorkflowStep' | |
Fields
| |
Instances
newWorkflowStep :: WorkflowStep Source #
Create a value of WorkflowStep with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tagStepDetails:WorkflowStep', workflowStep_tagStepDetails - Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
$sel:deleteStepDetails:WorkflowStep', workflowStep_deleteStepDetails - Details for a step that deletes the file.
$sel:copyStepDetails:WorkflowStep', workflowStep_copyStepDetails - Details for a step that performs a file copy.
Consists of the following values:
- A description
- An S3 location for the destination of the file copy.
- A flag that indicates whether or not to overwrite an existing file
of the same name. The default is
FALSE.
$sel:type':WorkflowStep', workflowStep_type - Currently, the following step types are supported.
- Copy: copy the file to another location
- Custom: custom step with a lambda target
- Delete: delete the file
- Tag: add a tag to the file
$sel:customStepDetails:WorkflowStep', workflowStep_customStepDetails - Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
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_deleteStepDetails :: Lens' WorkflowStep (Maybe DeleteStepDetails) Source #
Details for a step that deletes the file.
workflowStep_copyStepDetails :: Lens' WorkflowStep (Maybe CopyStepDetails) Source #
Details for a step that performs a file copy.
Consists of the following values:
- A description
- An S3 location for the destination of the file copy.
- A flag that indicates whether or not to overwrite an existing file
of the same name. The default is
FALSE.
workflowStep_type :: Lens' WorkflowStep (Maybe WorkflowStepType) Source #
Currently, the following step types are supported.
- Copy: copy the file to another location
- Custom: custom step with a lambda target
- Delete: delete the file
- Tag: add a tag to the file
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).