amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer

Contents

Description

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

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

Synopsis

Service Configuration

defaultService :: Service Source #

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

Errors

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

AccessDeniedException

_AccessDeniedException :: AsError a => Fold a ServiceError Source #

You do not have sufficient access to perform this action.

ConflictException

_ConflictException :: AsError a => Fold a ServiceError Source #

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

InternalServiceError

_InternalServiceError :: AsError a => Fold a ServiceError Source #

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

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #

The NextToken parameter that was passed is invalid.

InvalidRequestException

_InvalidRequestException :: AsError a => Fold a ServiceError Source #

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

ResourceExistsException

_ResourceExistsException :: AsError a => Fold a ServiceError Source #

The requested resource does not exist.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

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

ServiceUnavailableException

_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #

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

ThrottlingException

_ThrottlingException :: AsError a => Fold a ServiceError Source #

The request was denied due to request throttling.

Waiters

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

ServerOffline

newServerOffline :: Wait DescribeServer Source #

Polls DescribeServer every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.

ServerOnline

newServerOnline :: Wait DescribeServer Source #

Polls DescribeServer every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.

Operations

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

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

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

CreateAccess

data CreateAccess Source #

See: newCreateAccess smart constructor.

Instances

Instances details
ToJSON CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

ToHeaders CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

ToPath CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

ToQuery CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

AWSRequest CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Associated Types

type AWSResponse CreateAccess #

Generic CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Associated Types

type Rep CreateAccess :: Type -> Type #

Read CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Show CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

NFData CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Methods

rnf :: CreateAccess -> () #

Eq CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Hashable CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

type AWSResponse CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

type Rep CreateAccess Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

newCreateAccess Source #

Create a value of CreateAccess with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

The following is an Entry and Target pair example.

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

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

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

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

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

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

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

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

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

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

CreateAccess, createAccess_posixProfile - Undocumented member.

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

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

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

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

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

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

data CreateAccessResponse Source #

See: newCreateAccessResponse smart constructor.

Instances

Instances details
Generic CreateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Associated Types

type Rep CreateAccessResponse :: Type -> Type #

Read CreateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Show CreateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

NFData CreateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

Methods

rnf :: CreateAccessResponse -> () #

Eq CreateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

type Rep CreateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAccess

type Rep CreateAccessResponse = D1 ('MetaData "CreateAccessResponse" "Amazonka.Transfer.CreateAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateAccessResponse Source #

Create a value of CreateAccessResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateAccessResponse', createAccessResponse_httpStatus - The response's http status code.

CreateAccess, createAccessResponse_serverId - The identifier of the server that the user is attached to.

CreateAccess, createAccessResponse_externalId - The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.

CreateAgreement

data CreateAgreement Source #

See: newCreateAgreement smart constructor.

Instances

Instances details
ToJSON CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

ToHeaders CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

ToPath CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

ToQuery CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

AWSRequest CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Associated Types

type AWSResponse CreateAgreement #

Generic CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Associated Types

type Rep CreateAgreement :: Type -> Type #

Read CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Show CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

NFData CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Methods

rnf :: CreateAgreement -> () #

Eq CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Hashable CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

type AWSResponse CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

type Rep CreateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

newCreateAgreement Source #

Create a value of CreateAgreement with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAgreement, createAgreement_description - A name or short description to identify the agreement.

CreateAgreement, createAgreement_status - The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

CreateAgreement, createAgreement_tags - Key-value pairs that can be used to group and search for agreements.

CreateAgreement, createAgreement_serverId - A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

CreateAgreement, createAgreement_localProfileId - A unique identifier for the AS2 local profile.

CreateAgreement, createAgreement_partnerProfileId - A unique identifier for the partner profile used in the agreement.

CreateAgreement, createAgreement_baseDirectory - The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is DOC-EXAMPLE-BUCKET/home/mydirectory.

CreateAgreement, createAgreement_accessRole - With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

data CreateAgreementResponse Source #

See: newCreateAgreementResponse smart constructor.

Instances

Instances details
Generic CreateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Associated Types

type Rep CreateAgreementResponse :: Type -> Type #

Read CreateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Show CreateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

NFData CreateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

Methods

rnf :: CreateAgreementResponse -> () #

Eq CreateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

type Rep CreateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateAgreement

type Rep CreateAgreementResponse = D1 ('MetaData "CreateAgreementResponse" "Amazonka.Transfer.CreateAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateAgreementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "agreementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateAgreementResponse Source #

Create a value of CreateAgreementResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateAgreementResponse', createAgreementResponse_httpStatus - The response's http status code.

CreateAgreementResponse, createAgreementResponse_agreementId - The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.

CreateConnector

data CreateConnector Source #

See: newCreateConnector smart constructor.

Instances

Instances details
ToJSON CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

ToHeaders CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

ToPath CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

ToQuery CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

AWSRequest CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Associated Types

type AWSResponse CreateConnector #

Generic CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Associated Types

type Rep CreateConnector :: Type -> Type #

Read CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Show CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

NFData CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Methods

rnf :: CreateConnector -> () #

Eq CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Hashable CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

type AWSResponse CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

type Rep CreateConnector Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

type Rep CreateConnector = D1 ('MetaData "CreateConnector" "Amazonka.Transfer.CreateConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateConnector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "as2Config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 As2ConnectorConfig) :*: S1 ('MetaSel ('Just "accessRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateConnector Source #

Create a value of CreateConnector with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateConnector, createConnector_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

CreateConnector, createConnector_tags - Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.

CreateConnector, createConnector_url - The URL of the partner's AS2 endpoint.

CreateConnector, createConnector_as2Config - A structure that contains the parameters for a connector object.

CreateConnector, createConnector_accessRole - With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

data CreateConnectorResponse Source #

See: newCreateConnectorResponse smart constructor.

Instances

Instances details
Generic CreateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Associated Types

type Rep CreateConnectorResponse :: Type -> Type #

Read CreateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Show CreateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

NFData CreateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

Methods

rnf :: CreateConnectorResponse -> () #

Eq CreateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

type Rep CreateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateConnector

type Rep CreateConnectorResponse = D1 ('MetaData "CreateConnectorResponse" "Amazonka.Transfer.CreateConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateConnectorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateConnectorResponse Source #

Create a value of CreateConnectorResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateConnectorResponse', createConnectorResponse_httpStatus - The response's http status code.

CreateConnectorResponse, createConnectorResponse_connectorId - The unique identifier for the connector, returned after the API call succeeds.

CreateProfile

data CreateProfile Source #

See: newCreateProfile smart constructor.

Instances

Instances details
ToJSON CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

ToHeaders CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

ToPath CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

ToQuery CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

AWSRequest CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Associated Types

type AWSResponse CreateProfile #

Generic CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Associated Types

type Rep CreateProfile :: Type -> Type #

Read CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Show CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

NFData CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Methods

rnf :: CreateProfile -> () #

Eq CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Hashable CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

type AWSResponse CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

type Rep CreateProfile Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

type Rep CreateProfile = D1 ('MetaData "CreateProfile" "Amazonka.Transfer.CreateProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "as2Id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "profileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProfileType))))

newCreateProfile Source #

Create a value of CreateProfile with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateProfile, createProfile_certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

CreateProfile, createProfile_tags - Key-value pairs that can be used to group and search for AS2 profiles.

CreateProfile, createProfile_as2Id - The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

CreateProfile, createProfile_profileType - Determines the type of profile to create:

  • Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party.
  • Specify PARTNER to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.

data CreateProfileResponse Source #

See: newCreateProfileResponse smart constructor.

Instances

Instances details
Generic CreateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Associated Types

type Rep CreateProfileResponse :: Type -> Type #

Read CreateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Show CreateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

NFData CreateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

Methods

rnf :: CreateProfileResponse -> () #

Eq CreateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

type Rep CreateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateProfile

type Rep CreateProfileResponse = D1 ('MetaData "CreateProfileResponse" "Amazonka.Transfer.CreateProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateProfileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateProfileResponse Source #

Create a value of CreateProfileResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateProfileResponse', createProfileResponse_httpStatus - The response's http status code.

CreateProfileResponse, createProfileResponse_profileId - The unique identifier for the AS2 profile, returned after the API call succeeds.

CreateServer

data CreateServer Source #

See: newCreateServer smart constructor.

Instances

Instances details
ToJSON CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

ToHeaders CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

ToPath CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

ToQuery CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

AWSRequest CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

Associated Types

type AWSResponse CreateServer #

Generic CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

Associated Types

type Rep CreateServer :: Type -> Type #

Show CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

NFData CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

Methods

rnf :: CreateServer -> () #

Eq CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

Hashable CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

type AWSResponse CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

type Rep CreateServer Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

type Rep CreateServer = D1 ('MetaData "CreateServer" "Amazonka.Transfer.CreateServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateServer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :*: S1 ('MetaSel ('Just "endpointDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDetails)))) :*: ((S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType)) :*: S1 ('MetaSel ('Just "hostKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderDetails)) :*: S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderType))))) :*: (((S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "postAuthenticationLoginBanner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "preAuthenticationLoginBanner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "protocolDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolDetails)))) :*: ((S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol))) :*: S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "workflowDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowDetails)))))))

newCreateServer :: CreateServer Source #

Create a value of CreateServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$sel:hostKey:CreateServer', createServer_hostKey - The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N "" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

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

For more information, see Update host keys for your SFTP-enabled server in the Transfer Family User Guide.

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

CreateServer, createServer_identityProviderType - The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

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

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

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter or the IdentityProviderDetails data type.

CreateServer, createServer_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

CreateServer, createServer_postAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

CreateServer, createServer_preAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

CreateServer, createServer_protocolDetails - The protocol settings that are configured for your server.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.
  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

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

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
  • FTP (File Transfer Protocol): Unencrypted file transfer
  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data
  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.
  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.
  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

CreateServer, createServer_securityPolicyName - Specifies the name of the security policy that is attached to the server.

CreateServer, createServer_tags - Key-value pairs that can be used to group and search for servers.

CreateServer, createServer_workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

data CreateServerResponse Source #

See: newCreateServerResponse smart constructor.

Instances

Instances details
Generic CreateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

Associated Types

type Rep CreateServerResponse :: Type -> Type #

Read CreateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

Show CreateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

NFData CreateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

Methods

rnf :: CreateServerResponse -> () #

Eq CreateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

type Rep CreateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateServer

type Rep CreateServerResponse = D1 ('MetaData "CreateServerResponse" "Amazonka.Transfer.CreateServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateServerResponse Source #

Create a value of CreateServerResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateServerResponse', createServerResponse_httpStatus - The response's http status code.

CreateServerResponse, createServerResponse_serverId - The service-assigned identifier of the server that is created.

CreateUser

data CreateUser Source #

See: newCreateUser smart constructor.

Instances

Instances details
ToJSON CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

ToHeaders CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Methods

toHeaders :: CreateUser -> [Header] #

ToPath CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

ToQuery CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

AWSRequest CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Associated Types

type AWSResponse CreateUser #

Generic CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Associated Types

type Rep CreateUser :: Type -> Type #

Read CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Show CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

NFData CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Methods

rnf :: CreateUser -> () #

Eq CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Hashable CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

type AWSResponse CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

type Rep CreateUser Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

newCreateUser Source #

Create a value of CreateUser with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

The following is an Entry and Target pair example.

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

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

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

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

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

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

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

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

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

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

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

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

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

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

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

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

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

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Instances

Instances details
Generic CreateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Associated Types

type Rep CreateUserResponse :: Type -> Type #

Read CreateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Show CreateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

NFData CreateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

Methods

rnf :: CreateUserResponse -> () #

Eq CreateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

type Rep CreateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateUser

type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.Transfer.CreateUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateUserResponse Source #

Create a value of CreateUserResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.

CreateUser, createUserResponse_serverId - The identifier of the server that the user is attached to.

CreateUser, createUserResponse_userName - A unique string that identifies a user account associated with a server.

CreateWorkflow

data CreateWorkflow Source #

See: newCreateWorkflow smart constructor.

Instances

Instances details
ToJSON CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

ToHeaders CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

ToPath CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

ToQuery CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

AWSRequest CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Associated Types

type AWSResponse CreateWorkflow #

Generic CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Associated Types

type Rep CreateWorkflow :: Type -> Type #

Read CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Show CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

NFData CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

rnf :: CreateWorkflow -> () #

Eq CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Hashable CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type AWSResponse CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type Rep CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type Rep CreateWorkflow = D1 ('MetaData "CreateWorkflow" "Amazonka.Transfer.CreateWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateWorkflow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WorkflowStep]))))

newCreateWorkflow :: CreateWorkflow Source #

Create a value of CreateWorkflow with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateWorkflow, createWorkflow_description - A textual description for the workflow.

CreateWorkflow, createWorkflow_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

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

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

CreateWorkflow, createWorkflow_steps - Specifies the details for the steps that are in the specified workflow.

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

  • COPY: Copy the file to another location.
  • CUSTOM: Perform a custom step with an Lambda function target.
  • DELETE: Delete the file.
  • TAG: Add a tag to the file.

Currently, copying and tagging are supported only on S3.

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

data CreateWorkflowResponse Source #

See: newCreateWorkflowResponse smart constructor.

Instances

Instances details
Generic CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Associated Types

type Rep CreateWorkflowResponse :: Type -> Type #

Read CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Show CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

NFData CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

rnf :: CreateWorkflowResponse -> () #

Eq CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type Rep CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type Rep CreateWorkflowResponse = D1 ('MetaData "CreateWorkflowResponse" "Amazonka.Transfer.CreateWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateWorkflowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateWorkflowResponse Source #

Create a value of CreateWorkflowResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateWorkflowResponse', createWorkflowResponse_httpStatus - The response's http status code.

CreateWorkflowResponse, createWorkflowResponse_workflowId - A unique identifier for the workflow.

DeleteAccess

data DeleteAccess Source #

See: newDeleteAccess smart constructor.

Constructors

DeleteAccess' Text Text 

Instances

Instances details
ToJSON DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

ToHeaders DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

ToPath DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

ToQuery DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

AWSRequest DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Associated Types

type AWSResponse DeleteAccess #

Generic DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Associated Types

type Rep DeleteAccess :: Type -> Type #

Read DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Show DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

NFData DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Methods

rnf :: DeleteAccess -> () #

Eq DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Hashable DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

type AWSResponse DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

type Rep DeleteAccess Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

type Rep DeleteAccess = D1 ('MetaData "DeleteAccess" "Amazonka.Transfer.DeleteAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteAccess Source #

Create a value of DeleteAccess with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteAccess, deleteAccess_serverId - A system-assigned unique identifier for a server that has this user assigned.

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

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

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

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

data DeleteAccessResponse Source #

See: newDeleteAccessResponse smart constructor.

Constructors

DeleteAccessResponse' 

Instances

Instances details
Generic DeleteAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Associated Types

type Rep DeleteAccessResponse :: Type -> Type #

Read DeleteAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Show DeleteAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

NFData DeleteAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

Methods

rnf :: DeleteAccessResponse -> () #

Eq DeleteAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

type Rep DeleteAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAccess

type Rep DeleteAccessResponse = D1 ('MetaData "DeleteAccessResponse" "Amazonka.Transfer.DeleteAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteAccessResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAccessResponse :: DeleteAccessResponse Source #

Create a value of DeleteAccessResponse with all optional fields omitted.

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

DeleteAgreement

data DeleteAgreement Source #

See: newDeleteAgreement smart constructor.

Constructors

DeleteAgreement' Text Text 

Instances

Instances details
ToJSON DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

ToHeaders DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

ToPath DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

ToQuery DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

AWSRequest DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Associated Types

type AWSResponse DeleteAgreement #

Generic DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Associated Types

type Rep DeleteAgreement :: Type -> Type #

Read DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Show DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

NFData DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Methods

rnf :: DeleteAgreement -> () #

Eq DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Hashable DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

type AWSResponse DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

type Rep DeleteAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

type Rep DeleteAgreement = D1 ('MetaData "DeleteAgreement" "Amazonka.Transfer.DeleteAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteAgreement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agreementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteAgreement Source #

Create a value of DeleteAgreement with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteAgreement, deleteAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

DeleteAgreement, deleteAgreement_serverId - The server identifier associated with the agreement that you are deleting.

data DeleteAgreementResponse Source #

See: newDeleteAgreementResponse smart constructor.

Instances

Instances details
Generic DeleteAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Associated Types

type Rep DeleteAgreementResponse :: Type -> Type #

Read DeleteAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Show DeleteAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

NFData DeleteAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

Methods

rnf :: DeleteAgreementResponse -> () #

Eq DeleteAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

type Rep DeleteAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteAgreement

type Rep DeleteAgreementResponse = D1 ('MetaData "DeleteAgreementResponse" "Amazonka.Transfer.DeleteAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteAgreementResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAgreementResponse :: DeleteAgreementResponse Source #

Create a value of DeleteAgreementResponse with all optional fields omitted.

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

DeleteCertificate

data DeleteCertificate Source #

See: newDeleteCertificate smart constructor.

Constructors

DeleteCertificate' Text 

Instances

Instances details
ToJSON DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

ToHeaders DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

ToPath DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

ToQuery DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

AWSRequest DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Associated Types

type AWSResponse DeleteCertificate #

Generic DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Associated Types

type Rep DeleteCertificate :: Type -> Type #

Read DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Show DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

NFData DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Methods

rnf :: DeleteCertificate -> () #

Eq DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Hashable DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

type AWSResponse DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

type Rep DeleteCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

type Rep DeleteCertificate = D1 ('MetaData "DeleteCertificate" "Amazonka.Transfer.DeleteCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteCertificate Source #

Create a value of DeleteCertificate with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteCertificate, deleteCertificate_certificateId - The identifier of the certificate object that you are deleting.

data DeleteCertificateResponse Source #

See: newDeleteCertificateResponse smart constructor.

Instances

Instances details
Generic DeleteCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Associated Types

type Rep DeleteCertificateResponse :: Type -> Type #

Read DeleteCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Show DeleteCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

NFData DeleteCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

Eq DeleteCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

type Rep DeleteCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteCertificate

type Rep DeleteCertificateResponse = D1 ('MetaData "DeleteCertificateResponse" "Amazonka.Transfer.DeleteCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteCertificateResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteCertificateResponse :: DeleteCertificateResponse Source #

Create a value of DeleteCertificateResponse with all optional fields omitted.

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

DeleteConnector

data DeleteConnector Source #

See: newDeleteConnector smart constructor.

Constructors

DeleteConnector' Text 

Instances

Instances details
ToJSON DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

ToHeaders DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

ToPath DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

ToQuery DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

AWSRequest DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Associated Types

type AWSResponse DeleteConnector #

Generic DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Associated Types

type Rep DeleteConnector :: Type -> Type #

Read DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Show DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

NFData DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Methods

rnf :: DeleteConnector -> () #

Eq DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Hashable DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

type AWSResponse DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

type Rep DeleteConnector Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

type Rep DeleteConnector = D1 ('MetaData "DeleteConnector" "Amazonka.Transfer.DeleteConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteConnector'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteConnector Source #

Create a value of DeleteConnector with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteConnector, deleteConnector_connectorId - The unique identifier for the connector.

data DeleteConnectorResponse Source #

See: newDeleteConnectorResponse smart constructor.

Instances

Instances details
Generic DeleteConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Associated Types

type Rep DeleteConnectorResponse :: Type -> Type #

Read DeleteConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Show DeleteConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

NFData DeleteConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

Methods

rnf :: DeleteConnectorResponse -> () #

Eq DeleteConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

type Rep DeleteConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteConnector

type Rep DeleteConnectorResponse = D1 ('MetaData "DeleteConnectorResponse" "Amazonka.Transfer.DeleteConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteConnectorResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteConnectorResponse :: DeleteConnectorResponse Source #

Create a value of DeleteConnectorResponse with all optional fields omitted.

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

DeleteHostKey

data DeleteHostKey Source #

See: newDeleteHostKey smart constructor.

Constructors

DeleteHostKey' Text Text 

Instances

Instances details
ToJSON DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

ToHeaders DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

ToPath DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

ToQuery DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

AWSRequest DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Associated Types

type AWSResponse DeleteHostKey #

Generic DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Associated Types

type Rep DeleteHostKey :: Type -> Type #

Read DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Show DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

NFData DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Methods

rnf :: DeleteHostKey -> () #

Eq DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Hashable DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

type AWSResponse DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

type Rep DeleteHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

type Rep DeleteHostKey = D1 ('MetaData "DeleteHostKey" "Amazonka.Transfer.DeleteHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteHostKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteHostKey Source #

Create a value of DeleteHostKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteHostKey, deleteHostKey_serverId - The identifier of the server that contains the host key that you are deleting.

DeleteHostKey, deleteHostKey_hostKeyId - The identifier of the host key that you are deleting.

data DeleteHostKeyResponse Source #

See: newDeleteHostKeyResponse smart constructor.

Instances

Instances details
Generic DeleteHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Associated Types

type Rep DeleteHostKeyResponse :: Type -> Type #

Read DeleteHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Show DeleteHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

NFData DeleteHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

Methods

rnf :: DeleteHostKeyResponse -> () #

Eq DeleteHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

type Rep DeleteHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteHostKey

type Rep DeleteHostKeyResponse = D1 ('MetaData "DeleteHostKeyResponse" "Amazonka.Transfer.DeleteHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteHostKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteHostKeyResponse :: DeleteHostKeyResponse Source #

Create a value of DeleteHostKeyResponse with all optional fields omitted.

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

DeleteProfile

data DeleteProfile Source #

See: newDeleteProfile smart constructor.

Constructors

DeleteProfile' Text 

Instances

Instances details
ToJSON DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

ToHeaders DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

ToPath DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

ToQuery DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

AWSRequest DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Associated Types

type AWSResponse DeleteProfile #

Generic DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Associated Types

type Rep DeleteProfile :: Type -> Type #

Read DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Show DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

NFData DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Methods

rnf :: DeleteProfile -> () #

Eq DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Hashable DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

type AWSResponse DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

type Rep DeleteProfile Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

type Rep DeleteProfile = D1 ('MetaData "DeleteProfile" "Amazonka.Transfer.DeleteProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteProfile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteProfile Source #

Create a value of DeleteProfile with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteProfile, deleteProfile_profileId - The identifier of the profile that you are deleting.

data DeleteProfileResponse Source #

See: newDeleteProfileResponse smart constructor.

Instances

Instances details
Generic DeleteProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Associated Types

type Rep DeleteProfileResponse :: Type -> Type #

Read DeleteProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Show DeleteProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

NFData DeleteProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

Methods

rnf :: DeleteProfileResponse -> () #

Eq DeleteProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

type Rep DeleteProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteProfile

type Rep DeleteProfileResponse = D1 ('MetaData "DeleteProfileResponse" "Amazonka.Transfer.DeleteProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteProfileResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteProfileResponse :: DeleteProfileResponse Source #

Create a value of DeleteProfileResponse with all optional fields omitted.

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

DeleteServer

data DeleteServer Source #

See: newDeleteServer smart constructor.

Constructors

DeleteServer' Text 

Instances

Instances details
ToJSON DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

ToHeaders DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

ToPath DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

ToQuery DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

AWSRequest DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Associated Types

type AWSResponse DeleteServer #

Generic DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Associated Types

type Rep DeleteServer :: Type -> Type #

Read DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Show DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

NFData DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Methods

rnf :: DeleteServer -> () #

Eq DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Hashable DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

type AWSResponse DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

type Rep DeleteServer Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

type Rep DeleteServer = D1 ('MetaData "DeleteServer" "Amazonka.Transfer.DeleteServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteServer Source #

Create a value of DeleteServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteServer, deleteServer_serverId - A unique system-assigned identifier for a server instance.

data DeleteServerResponse Source #

See: newDeleteServerResponse smart constructor.

Constructors

DeleteServerResponse' 

Instances

Instances details
Generic DeleteServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Associated Types

type Rep DeleteServerResponse :: Type -> Type #

Read DeleteServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Show DeleteServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

NFData DeleteServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

Methods

rnf :: DeleteServerResponse -> () #

Eq DeleteServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

type Rep DeleteServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteServer

type Rep DeleteServerResponse = D1 ('MetaData "DeleteServerResponse" "Amazonka.Transfer.DeleteServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteServerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteServerResponse :: DeleteServerResponse Source #

Create a value of DeleteServerResponse with all optional fields omitted.

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

DeleteSshPublicKey

data DeleteSshPublicKey Source #

See: newDeleteSshPublicKey smart constructor.

Instances

Instances details
ToJSON DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

ToHeaders DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

ToPath DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

ToQuery DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

AWSRequest DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Associated Types

type AWSResponse DeleteSshPublicKey #

Generic DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Associated Types

type Rep DeleteSshPublicKey :: Type -> Type #

Read DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Show DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

NFData DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Methods

rnf :: DeleteSshPublicKey -> () #

Eq DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Hashable DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

type AWSResponse DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

type Rep DeleteSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

type Rep DeleteSshPublicKey = D1 ('MetaData "DeleteSshPublicKey" "Amazonka.Transfer.DeleteSshPublicKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteSshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteSshPublicKey Source #

Create a value of DeleteSshPublicKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteSshPublicKey, deleteSshPublicKey_serverId - A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

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

DeleteSshPublicKey, deleteSshPublicKey_userName - A unique string that identifies a user whose public key is being deleted.

data DeleteSshPublicKeyResponse Source #

See: newDeleteSshPublicKeyResponse smart constructor.

Instances

Instances details
Generic DeleteSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Associated Types

type Rep DeleteSshPublicKeyResponse :: Type -> Type #

Read DeleteSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Show DeleteSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

NFData DeleteSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

Eq DeleteSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

type Rep DeleteSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteSshPublicKey

type Rep DeleteSshPublicKeyResponse = D1 ('MetaData "DeleteSshPublicKeyResponse" "Amazonka.Transfer.DeleteSshPublicKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteSshPublicKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteSshPublicKeyResponse :: DeleteSshPublicKeyResponse Source #

Create a value of DeleteSshPublicKeyResponse with all optional fields omitted.

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

DeleteUser

data DeleteUser Source #

See: newDeleteUser smart constructor.

Constructors

DeleteUser' Text Text 

Instances

Instances details
ToJSON DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

ToHeaders DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Methods

toHeaders :: DeleteUser -> [Header] #

ToPath DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

ToQuery DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

AWSRequest DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Associated Types

type AWSResponse DeleteUser #

Generic DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Associated Types

type Rep DeleteUser :: Type -> Type #

Read DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Show DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

NFData DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Methods

rnf :: DeleteUser -> () #

Eq DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Hashable DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

type AWSResponse DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

type Rep DeleteUser Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

type Rep DeleteUser = D1 ('MetaData "DeleteUser" "Amazonka.Transfer.DeleteUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteUser Source #

Create a value of DeleteUser with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteUser, deleteUser_serverId - A system-assigned unique identifier for a server instance that has the user assigned to it.

DeleteUser, deleteUser_userName - A unique string that identifies a user that is being deleted from a server.

data DeleteUserResponse Source #

See: newDeleteUserResponse smart constructor.

Constructors

DeleteUserResponse' 

Instances

Instances details
Generic DeleteUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Associated Types

type Rep DeleteUserResponse :: Type -> Type #

Read DeleteUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Show DeleteUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

NFData DeleteUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

Methods

rnf :: DeleteUserResponse -> () #

Eq DeleteUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

type Rep DeleteUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteUser

type Rep DeleteUserResponse = D1 ('MetaData "DeleteUserResponse" "Amazonka.Transfer.DeleteUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteUserResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteUserResponse :: DeleteUserResponse Source #

Create a value of DeleteUserResponse with all optional fields omitted.

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

DeleteWorkflow

data DeleteWorkflow Source #

See: newDeleteWorkflow smart constructor.

Constructors

DeleteWorkflow' Text 

Instances

Instances details
ToJSON DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

ToHeaders DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

ToPath DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

ToQuery DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

AWSRequest DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Associated Types

type AWSResponse DeleteWorkflow #

Generic DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Associated Types

type Rep DeleteWorkflow :: Type -> Type #

Read DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Show DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

NFData DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Methods

rnf :: DeleteWorkflow -> () #

Eq DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Hashable DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

type AWSResponse DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

type Rep DeleteWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

type Rep DeleteWorkflow = D1 ('MetaData "DeleteWorkflow" "Amazonka.Transfer.DeleteWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteWorkflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteWorkflow Source #

Create a value of DeleteWorkflow with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteWorkflow, deleteWorkflow_workflowId - A unique identifier for the workflow.

data DeleteWorkflowResponse Source #

See: newDeleteWorkflowResponse smart constructor.

Instances

Instances details
Generic DeleteWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Associated Types

type Rep DeleteWorkflowResponse :: Type -> Type #

Read DeleteWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Show DeleteWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

NFData DeleteWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

Methods

rnf :: DeleteWorkflowResponse -> () #

Eq DeleteWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

type Rep DeleteWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DeleteWorkflow

type Rep DeleteWorkflowResponse = D1 ('MetaData "DeleteWorkflowResponse" "Amazonka.Transfer.DeleteWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteWorkflowResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteWorkflowResponse :: DeleteWorkflowResponse Source #

Create a value of DeleteWorkflowResponse with all optional fields omitted.

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

DescribeAccess

data DescribeAccess Source #

See: newDescribeAccess smart constructor.

Constructors

DescribeAccess' Text Text 

Instances

Instances details
ToJSON DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

ToHeaders DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

ToPath DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

ToQuery DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

AWSRequest DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type AWSResponse DescribeAccess #

Generic DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type Rep DescribeAccess :: Type -> Type #

Read DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Show DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

NFData DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Methods

rnf :: DescribeAccess -> () #

Eq DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Hashable DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

type AWSResponse DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

type Rep DescribeAccess Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

type Rep DescribeAccess = D1 ('MetaData "DescribeAccess" "Amazonka.Transfer.DescribeAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAccess Source #

Create a value of DescribeAccess with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeAccess, describeAccess_serverId - A system-assigned unique identifier for a server that has this access assigned.

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

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

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

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

data DescribeAccessResponse Source #

See: newDescribeAccessResponse smart constructor.

Instances

Instances details
Generic DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Associated Types

type Rep DescribeAccessResponse :: Type -> Type #

Read DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Show DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

NFData DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

Methods

rnf :: DescribeAccessResponse -> () #

Eq DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

type Rep DescribeAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAccess

type Rep DescribeAccessResponse = D1 ('MetaData "DescribeAccessResponse" "Amazonka.Transfer.DescribeAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "access") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedAccess))))

newDescribeAccessResponse Source #

Create a value of DescribeAccessResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeAccessResponse', describeAccessResponse_httpStatus - The response's http status code.

DescribeAccess, describeAccessResponse_serverId - A system-assigned unique identifier for a server that has this access assigned.

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

DescribeAgreement

data DescribeAgreement Source #

See: newDescribeAgreement smart constructor.

Instances

Instances details
ToJSON DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

ToHeaders DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

ToPath DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

ToQuery DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

AWSRequest DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Associated Types

type AWSResponse DescribeAgreement #

Generic DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Associated Types

type Rep DescribeAgreement :: Type -> Type #

Read DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Show DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

NFData DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Methods

rnf :: DescribeAgreement -> () #

Eq DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Hashable DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

type AWSResponse DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

type Rep DescribeAgreement Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

type Rep DescribeAgreement = D1 ('MetaData "DescribeAgreement" "Amazonka.Transfer.DescribeAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeAgreement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agreementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAgreement Source #

Create a value of DescribeAgreement with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeAgreement, describeAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

DescribeAgreement, describeAgreement_serverId - The server identifier that's associated with the agreement.

data DescribeAgreementResponse Source #

See: newDescribeAgreementResponse smart constructor.

Instances

Instances details
Generic DescribeAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Associated Types

type Rep DescribeAgreementResponse :: Type -> Type #

Read DescribeAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Show DescribeAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

NFData DescribeAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

Eq DescribeAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

type Rep DescribeAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeAgreement

type Rep DescribeAgreementResponse = D1 ('MetaData "DescribeAgreementResponse" "Amazonka.Transfer.DescribeAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeAgreementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "agreement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedAgreement)))

newDescribeAgreementResponse Source #

Create a value of DescribeAgreementResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeAgreementResponse', describeAgreementResponse_httpStatus - The response's http status code.

$sel:agreement:DescribeAgreementResponse', describeAgreementResponse_agreement - The details for the specified agreement, returned as a DescribedAgreement object.

DescribeCertificate

data DescribeCertificate Source #

See: newDescribeCertificate smart constructor.

Instances

Instances details
ToJSON DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

ToHeaders DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

ToPath DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

ToQuery DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

AWSRequest DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

Associated Types

type AWSResponse DescribeCertificate #

Generic DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

Associated Types

type Rep DescribeCertificate :: Type -> Type #

Read DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

Show DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

NFData DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

Methods

rnf :: DescribeCertificate -> () #

Eq DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

Hashable DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

type AWSResponse DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

type Rep DescribeCertificate Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

type Rep DescribeCertificate = D1 ('MetaData "DescribeCertificate" "Amazonka.Transfer.DescribeCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeCertificate Source #

Create a value of DescribeCertificate with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeCertificate, describeCertificate_certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

data DescribeCertificateResponse Source #

See: newDescribeCertificateResponse smart constructor.

Instances

Instances details
Generic DescribeCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

Associated Types

type Rep DescribeCertificateResponse :: Type -> Type #

Show DescribeCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

NFData DescribeCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

Eq DescribeCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

type Rep DescribeCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeCertificate

type Rep DescribeCertificateResponse = D1 ('MetaData "DescribeCertificateResponse" "Amazonka.Transfer.DescribeCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeCertificateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedCertificate)))

newDescribeCertificateResponse Source #

Create a value of DescribeCertificateResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeCertificateResponse', describeCertificateResponse_httpStatus - The response's http status code.

DescribeCertificateResponse, describeCertificateResponse_certificate - The details for the specified certificate, returned as an object.

DescribeConnector

data DescribeConnector Source #

See: newDescribeConnector smart constructor.

Constructors

DescribeConnector' Text 

Instances

Instances details
ToJSON DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

ToHeaders DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

ToPath DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

ToQuery DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

AWSRequest DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Associated Types

type AWSResponse DescribeConnector #

Generic DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Associated Types

type Rep DescribeConnector :: Type -> Type #

Read DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Show DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

NFData DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Methods

rnf :: DescribeConnector -> () #

Eq DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Hashable DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

type AWSResponse DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

type Rep DescribeConnector Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

type Rep DescribeConnector = D1 ('MetaData "DescribeConnector" "Amazonka.Transfer.DescribeConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeConnector'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeConnector Source #

Create a value of DescribeConnector with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeConnector, describeConnector_connectorId - The unique identifier for the connector.

data DescribeConnectorResponse Source #

See: newDescribeConnectorResponse smart constructor.

Instances

Instances details
Generic DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Associated Types

type Rep DescribeConnectorResponse :: Type -> Type #

Read DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Show DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

NFData DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

Eq DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

type Rep DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeConnector

type Rep DescribeConnectorResponse = D1 ('MetaData "DescribeConnectorResponse" "Amazonka.Transfer.DescribeConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeConnectorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "connector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedConnector)))

newDescribeConnectorResponse Source #

Create a value of DescribeConnectorResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeConnectorResponse', describeConnectorResponse_httpStatus - The response's http status code.

$sel:connector:DescribeConnectorResponse', describeConnectorResponse_connector - The structure that contains the details of the connector.

DescribeExecution

data DescribeExecution Source #

See: newDescribeExecution smart constructor.

Instances

Instances details
ToJSON DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

ToHeaders DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

ToPath DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

ToQuery DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

AWSRequest DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Associated Types

type AWSResponse DescribeExecution #

Generic DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Associated Types

type Rep DescribeExecution :: Type -> Type #

Read DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Show DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

NFData DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Methods

rnf :: DescribeExecution -> () #

Eq DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Hashable DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

type AWSResponse DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

type Rep DescribeExecution Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

type Rep DescribeExecution = D1 ('MetaData "DescribeExecution" "Amazonka.Transfer.DescribeExecution" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeExecution Source #

Create a value of DescribeExecution with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeExecution, describeExecution_executionId - A unique identifier for the execution of a workflow.

DescribeExecution, describeExecution_workflowId - A unique identifier for the workflow.

data DescribeExecutionResponse Source #

See: newDescribeExecutionResponse smart constructor.

Instances

Instances details
Generic DescribeExecutionResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Associated Types

type Rep DescribeExecutionResponse :: Type -> Type #

Read DescribeExecutionResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Show DescribeExecutionResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

NFData DescribeExecutionResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

Eq DescribeExecutionResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

type Rep DescribeExecutionResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeExecution

type Rep DescribeExecutionResponse = D1 ('MetaData "DescribeExecutionResponse" "Amazonka.Transfer.DescribeExecution" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "execution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedExecution))))

newDescribeExecutionResponse Source #

Create a value of DescribeExecutionResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeExecutionResponse', describeExecutionResponse_httpStatus - The response's http status code.

DescribeExecution, describeExecutionResponse_workflowId - A unique identifier for the workflow.

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

DescribeHostKey

data DescribeHostKey Source #

See: newDescribeHostKey smart constructor.

Constructors

DescribeHostKey' Text Text 

Instances

Instances details
ToJSON DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

ToHeaders DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

ToPath DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

ToQuery DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

AWSRequest DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Associated Types

type AWSResponse DescribeHostKey #

Generic DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Associated Types

type Rep DescribeHostKey :: Type -> Type #

Read DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Show DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

NFData DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Methods

rnf :: DescribeHostKey -> () #

Eq DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Hashable DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

type AWSResponse DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

type Rep DescribeHostKey Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

type Rep DescribeHostKey = D1 ('MetaData "DescribeHostKey" "Amazonka.Transfer.DescribeHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeHostKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeHostKey Source #

Create a value of DescribeHostKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeHostKey, describeHostKey_serverId - The identifier of the server that contains the host key that you want described.

DescribeHostKey, describeHostKey_hostKeyId - The identifier of the host key that you want described.

data DescribeHostKeyResponse Source #

See: newDescribeHostKeyResponse smart constructor.

Instances

Instances details
Generic DescribeHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Associated Types

type Rep DescribeHostKeyResponse :: Type -> Type #

Read DescribeHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Show DescribeHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

NFData DescribeHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

Methods

rnf :: DescribeHostKeyResponse -> () #

Eq DescribeHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

type Rep DescribeHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeHostKey

type Rep DescribeHostKeyResponse = D1 ('MetaData "DescribeHostKeyResponse" "Amazonka.Transfer.DescribeHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeHostKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "hostKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedHostKey)))

newDescribeHostKeyResponse Source #

Create a value of DescribeHostKeyResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeHostKeyResponse', describeHostKeyResponse_httpStatus - The response's http status code.

$sel:hostKey:DescribeHostKeyResponse', describeHostKeyResponse_hostKey - Returns the details for the specified host key.

DescribeProfile

data DescribeProfile Source #

See: newDescribeProfile smart constructor.

Constructors

DescribeProfile' Text 

Instances

Instances details
ToJSON DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

ToHeaders DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

ToPath DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

ToQuery DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

AWSRequest DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Associated Types

type AWSResponse DescribeProfile #

Generic DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Associated Types

type Rep DescribeProfile :: Type -> Type #

Read DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Show DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

NFData DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Methods

rnf :: DescribeProfile -> () #

Eq DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Hashable DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

type AWSResponse DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

type Rep DescribeProfile Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

type Rep DescribeProfile = D1 ('MetaData "DescribeProfile" "Amazonka.Transfer.DescribeProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeProfile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeProfile Source #

Create a value of DescribeProfile with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeProfile, describeProfile_profileId - The identifier of the profile that you want described.

data DescribeProfileResponse Source #

See: newDescribeProfileResponse smart constructor.

Instances

Instances details
Generic DescribeProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Associated Types

type Rep DescribeProfileResponse :: Type -> Type #

Read DescribeProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Show DescribeProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

NFData DescribeProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

Methods

rnf :: DescribeProfileResponse -> () #

Eq DescribeProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

type Rep DescribeProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeProfile

type Rep DescribeProfileResponse = D1 ('MetaData "DescribeProfileResponse" "Amazonka.Transfer.DescribeProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeProfileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "profile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedProfile)))

newDescribeProfileResponse Source #

Create a value of DescribeProfileResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeProfileResponse', describeProfileResponse_httpStatus - The response's http status code.

$sel:profile:DescribeProfileResponse', describeProfileResponse_profile - The details of the specified profile, returned as an object.

DescribeSecurityPolicy

data DescribeSecurityPolicy Source #

See: newDescribeSecurityPolicy smart constructor.

Instances

Instances details
ToJSON DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

ToHeaders DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

ToPath DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

ToQuery DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

AWSRequest DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Associated Types

type AWSResponse DescribeSecurityPolicy #

Generic DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Associated Types

type Rep DescribeSecurityPolicy :: Type -> Type #

Read DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Show DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

NFData DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Methods

rnf :: DescribeSecurityPolicy -> () #

Eq DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Hashable DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

type AWSResponse DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

type Rep DescribeSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

type Rep DescribeSecurityPolicy = D1 ('MetaData "DescribeSecurityPolicy" "Amazonka.Transfer.DescribeSecurityPolicy" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeSecurityPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeSecurityPolicy Source #

Create a value of DescribeSecurityPolicy with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSecurityPolicy, describeSecurityPolicy_securityPolicyName - Specifies the name of the security policy that is attached to the server.

data DescribeSecurityPolicyResponse Source #

See: newDescribeSecurityPolicyResponse smart constructor.

Instances

Instances details
Generic DescribeSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Associated Types

type Rep DescribeSecurityPolicyResponse :: Type -> Type #

Read DescribeSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Show DescribeSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

NFData DescribeSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

Eq DescribeSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

type Rep DescribeSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeSecurityPolicy

type Rep DescribeSecurityPolicyResponse = D1 ('MetaData "DescribeSecurityPolicyResponse" "Amazonka.Transfer.DescribeSecurityPolicy" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeSecurityPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedSecurityPolicy)))

newDescribeSecurityPolicyResponse Source #

Create a value of DescribeSecurityPolicyResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeSecurityPolicyResponse', describeSecurityPolicyResponse_httpStatus - The response's http status code.

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

DescribeServer

data DescribeServer Source #

See: newDescribeServer smart constructor.

Constructors

DescribeServer' Text 

Instances

Instances details
ToJSON DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

ToHeaders DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

ToPath DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

ToQuery DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

AWSRequest DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type AWSResponse DescribeServer #

Generic DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type Rep DescribeServer :: Type -> Type #

Read DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Show DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

NFData DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Methods

rnf :: DescribeServer -> () #

Eq DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Hashable DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type AWSResponse DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type Rep DescribeServer Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type Rep DescribeServer = D1 ('MetaData "DescribeServer" "Amazonka.Transfer.DescribeServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeServer Source #

Create a value of DescribeServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeServer, describeServer_serverId - A system-assigned unique identifier for a server.

data DescribeServerResponse Source #

See: newDescribeServerResponse smart constructor.

Instances

Instances details
Generic DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Associated Types

type Rep DescribeServerResponse :: Type -> Type #

Read DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Show DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

NFData DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

Methods

rnf :: DescribeServerResponse -> () #

Eq DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type Rep DescribeServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeServer

type Rep DescribeServerResponse = D1 ('MetaData "DescribeServerResponse" "Amazonka.Transfer.DescribeServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "server") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedServer)))

newDescribeServerResponse Source #

Create a value of DescribeServerResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeServerResponse', describeServerResponse_httpStatus - The response's http status code.

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

DescribeUser

data DescribeUser Source #

See: newDescribeUser smart constructor.

Constructors

DescribeUser' Text Text 

Instances

Instances details
ToJSON DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

ToHeaders DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

ToPath DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

ToQuery DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

AWSRequest DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Associated Types

type AWSResponse DescribeUser #

Generic DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Associated Types

type Rep DescribeUser :: Type -> Type #

Read DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Show DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

NFData DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Methods

rnf :: DescribeUser -> () #

Eq DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Hashable DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

type AWSResponse DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

type Rep DescribeUser Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.Transfer.DescribeUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeUser Source #

Create a value of DescribeUser with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeUser, describeUser_serverId - A system-assigned unique identifier for a server that has this user assigned.

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

data DescribeUserResponse Source #

See: newDescribeUserResponse smart constructor.

Instances

Instances details
Generic DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Associated Types

type Rep DescribeUserResponse :: Type -> Type #

Read DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Show DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

NFData DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

Methods

rnf :: DescribeUserResponse -> () #

Eq DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

type Rep DescribeUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeUser

type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.Transfer.DescribeUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedUser))))

newDescribeUserResponse Source #

Create a value of DescribeUserResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

DescribeUser, describeUserResponse_serverId - A system-assigned unique identifier for a server that has this user assigned.

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

DescribeWorkflow

data DescribeWorkflow Source #

See: newDescribeWorkflow smart constructor.

Constructors

DescribeWorkflow' Text 

Instances

Instances details
ToJSON DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

ToHeaders DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

ToPath DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

ToQuery DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

AWSRequest DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Associated Types

type AWSResponse DescribeWorkflow #

Generic DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Associated Types

type Rep DescribeWorkflow :: Type -> Type #

Read DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Show DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

NFData DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Methods

rnf :: DescribeWorkflow -> () #

Eq DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Hashable DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

type AWSResponse DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

type Rep DescribeWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

type Rep DescribeWorkflow = D1 ('MetaData "DescribeWorkflow" "Amazonka.Transfer.DescribeWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeWorkflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeWorkflow Source #

Create a value of DescribeWorkflow with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeWorkflow, describeWorkflow_workflowId - A unique identifier for the workflow.

data DescribeWorkflowResponse Source #

See: newDescribeWorkflowResponse smart constructor.

Instances

Instances details
Generic DescribeWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Associated Types

type Rep DescribeWorkflowResponse :: Type -> Type #

Read DescribeWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Show DescribeWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

NFData DescribeWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

Eq DescribeWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

type Rep DescribeWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.DescribeWorkflow

type Rep DescribeWorkflowResponse = D1 ('MetaData "DescribeWorkflowResponse" "Amazonka.Transfer.DescribeWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeWorkflowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workflow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedWorkflow)))

newDescribeWorkflowResponse Source #

Create a value of DescribeWorkflowResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeWorkflowResponse', describeWorkflowResponse_httpStatus - The response's http status code.

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

ImportCertificate

data ImportCertificate Source #

See: newImportCertificate smart constructor.

Instances

Instances details
ToJSON ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

ToHeaders ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

ToPath ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

ToQuery ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

AWSRequest ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

Associated Types

type AWSResponse ImportCertificate #

Generic ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

Associated Types

type Rep ImportCertificate :: Type -> Type #

Show ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

NFData ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

Methods

rnf :: ImportCertificate -> () #

Eq ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

Hashable ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

type AWSResponse ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

type Rep ImportCertificate Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

newImportCertificate Source #

Create a value of ImportCertificate with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ImportCertificate, importCertificate_activeDate - An optional date that specifies when the certificate becomes active.

ImportCertificate, importCertificate_certificateChain - An optional list of certificates that make up the chain for the certificate that's being imported.

ImportCertificate, importCertificate_description - A short description that helps identify the certificate.

ImportCertificate, importCertificate_inactiveDate - An optional date that specifies when the certificate becomes inactive.

$sel:privateKey:ImportCertificate', importCertificate_privateKey - The file that contains the private key for the certificate that's being imported.

ImportCertificate, importCertificate_tags - Key-value pairs that can be used to group and search for certificates.

ImportCertificate, importCertificate_usage - Specifies whether this certificate is used for signing or encryption.

ImportCertificate, importCertificate_certificate - The file that contains the certificate to import.

data ImportCertificateResponse Source #

See: newImportCertificateResponse smart constructor.

Instances

Instances details
Generic ImportCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

Associated Types

type Rep ImportCertificateResponse :: Type -> Type #

Read ImportCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

Show ImportCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

NFData ImportCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

Eq ImportCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

type Rep ImportCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportCertificate

type Rep ImportCertificateResponse = D1 ('MetaData "ImportCertificateResponse" "Amazonka.Transfer.ImportCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportCertificateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newImportCertificateResponse Source #

Create a value of ImportCertificateResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ImportCertificateResponse', importCertificateResponse_httpStatus - The response's http status code.

ImportCertificateResponse, importCertificateResponse_certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

ImportHostKey

data ImportHostKey Source #

See: newImportHostKey smart constructor.

Instances

Instances details
ToJSON ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

ToHeaders ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

ToPath ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

ToQuery ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

AWSRequest ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

Associated Types

type AWSResponse ImportHostKey #

Generic ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

Associated Types

type Rep ImportHostKey :: Type -> Type #

Show ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

NFData ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

Methods

rnf :: ImportHostKey -> () #

Eq ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

Hashable ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

type AWSResponse ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

type Rep ImportHostKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

type Rep ImportHostKey = D1 ('MetaData "ImportHostKey" "Amazonka.Transfer.ImportHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportHostKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newImportHostKey Source #

Create a value of ImportHostKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ImportHostKey, importHostKey_description - The text description that identifies this host key.

ImportHostKey, importHostKey_tags - Key-value pairs that can be used to group and search for host keys.

ImportHostKey, importHostKey_serverId - The identifier of the server that contains the host key that you are importing.

$sel:hostKeyBody:ImportHostKey', importHostKey_hostKeyBody - The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

data ImportHostKeyResponse Source #

See: newImportHostKeyResponse smart constructor.

Instances

Instances details
Generic ImportHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

Associated Types

type Rep ImportHostKeyResponse :: Type -> Type #

Read ImportHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

Show ImportHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

NFData ImportHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

Methods

rnf :: ImportHostKeyResponse -> () #

Eq ImportHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

type Rep ImportHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportHostKey

type Rep ImportHostKeyResponse = D1 ('MetaData "ImportHostKeyResponse" "Amazonka.Transfer.ImportHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportHostKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImportHostKeyResponse Source #

Create a value of ImportHostKeyResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ImportHostKeyResponse', importHostKeyResponse_httpStatus - The response's http status code.

ImportHostKey, importHostKeyResponse_serverId - Returns the server identifier that contains the imported key.

ImportHostKeyResponse, importHostKeyResponse_hostKeyId - Returns the host key identifier for the imported key.

ImportSshPublicKey

data ImportSshPublicKey Source #

See: newImportSshPublicKey smart constructor.

Instances

Instances details
ToJSON ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

ToHeaders ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

ToPath ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

ToQuery ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

AWSRequest ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type AWSResponse ImportSshPublicKey #

Generic ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type Rep ImportSshPublicKey :: Type -> Type #

Read ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Show ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

NFData ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Methods

rnf :: ImportSshPublicKey -> () #

Eq ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Hashable ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type AWSResponse ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKey = D1 ('MetaData "ImportSshPublicKey" "Amazonka.Transfer.ImportSshPublicKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportSshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sshPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImportSshPublicKey Source #

Create a value of ImportSshPublicKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ImportSshPublicKey, importSshPublicKey_serverId - A system-assigned unique identifier for a server.

ImportSshPublicKey, importSshPublicKey_sshPublicKeyBody - The public key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

ImportSshPublicKey, importSshPublicKey_userName - The name of the user account that is assigned to one or more servers.

data ImportSshPublicKeyResponse Source #

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

See: newImportSshPublicKeyResponse smart constructor.

Instances

Instances details
Generic ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Associated Types

type Rep ImportSshPublicKeyResponse :: Type -> Type #

Read ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Show ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

NFData ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

Eq ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.ImportSshPublicKey

type Rep ImportSshPublicKeyResponse = D1 ('MetaData "ImportSshPublicKeyResponse" "Amazonka.Transfer.ImportSshPublicKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ImportSshPublicKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImportSshPublicKeyResponse Source #

Create a value of ImportSshPublicKeyResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ImportSshPublicKeyResponse', importSshPublicKeyResponse_httpStatus - The response's http status code.

ImportSshPublicKey, importSshPublicKeyResponse_serverId - A system-assigned unique identifier for a server.

ImportSshPublicKeyResponse, importSshPublicKeyResponse_sshPublicKeyId - The name given to a public key by the system that was imported.

ImportSshPublicKey, importSshPublicKeyResponse_userName - A user name assigned to the ServerID value that you specified.

ListAccesses (Paginated)

data ListAccesses Source #

See: newListAccesses smart constructor.

Instances

Instances details
ToJSON ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

ToHeaders ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

ToPath ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

ToQuery ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

AWSPager ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

AWSRequest ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Associated Types

type AWSResponse ListAccesses #

Generic ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Associated Types

type Rep ListAccesses :: Type -> Type #

Read ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Show ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

NFData ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Methods

rnf :: ListAccesses -> () #

Eq ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Hashable ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

type AWSResponse ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

type Rep ListAccesses Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

type Rep ListAccesses = D1 ('MetaData "ListAccesses" "Amazonka.Transfer.ListAccesses" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListAccesses'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListAccesses Source #

Create a value of ListAccesses with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

ListAccesses, listAccesses_nextToken - When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

ListAccesses, listAccesses_serverId - A system-assigned unique identifier for a server that has users assigned to it.

data ListAccessesResponse Source #

See: newListAccessesResponse smart constructor.

Instances

Instances details
Generic ListAccessesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Associated Types

type Rep ListAccessesResponse :: Type -> Type #

Read ListAccessesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Show ListAccessesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

NFData ListAccessesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

Methods

rnf :: ListAccessesResponse -> () #

Eq ListAccessesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

type Rep ListAccessesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAccesses

type Rep ListAccessesResponse = D1 ('MetaData "ListAccessesResponse" "Amazonka.Transfer.ListAccesses" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListAccessesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accesses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedAccess]))))

newListAccessesResponse Source #

Create a value of ListAccessesResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAccesses, listAccessesResponse_nextToken - When you can get additional results from the ListAccesses call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional accesses.

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

ListAccesses, listAccessesResponse_serverId - A system-assigned unique identifier for a server that has users assigned to it.

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

ListAgreements (Paginated)

data ListAgreements Source #

See: newListAgreements smart constructor.

Instances

Instances details
ToJSON ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

ToHeaders ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

ToPath ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

ToQuery ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

AWSPager ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

AWSRequest ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Associated Types

type AWSResponse ListAgreements #

Generic ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Associated Types

type Rep ListAgreements :: Type -> Type #

Read ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Show ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

NFData ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Methods

rnf :: ListAgreements -> () #

Eq ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Hashable ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

type AWSResponse ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

type Rep ListAgreements Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

type Rep ListAgreements = D1 ('MetaData "ListAgreements" "Amazonka.Transfer.ListAgreements" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListAgreements'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListAgreements Source #

Create a value of ListAgreements with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListAgreements', listAgreements_maxResults - The maximum number of agreements to return.

ListAgreements, listAgreements_nextToken - When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

ListAgreements, listAgreements_serverId - The identifier of the server for which you want a list of agreements.

data ListAgreementsResponse Source #

See: newListAgreementsResponse smart constructor.

Instances

Instances details
Generic ListAgreementsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Associated Types

type Rep ListAgreementsResponse :: Type -> Type #

Read ListAgreementsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Show ListAgreementsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

NFData ListAgreementsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

Methods

rnf :: ListAgreementsResponse -> () #

Eq ListAgreementsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

type Rep ListAgreementsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListAgreements

type Rep ListAgreementsResponse = D1 ('MetaData "ListAgreementsResponse" "Amazonka.Transfer.ListAgreements" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListAgreementsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "agreements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedAgreement]))))

newListAgreementsResponse Source #

Create a value of ListAgreementsResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAgreements, listAgreementsResponse_nextToken - Returns a token that you can use to call ListAgreements again and receive additional results, if there are any.

$sel:httpStatus:ListAgreementsResponse', listAgreementsResponse_httpStatus - The response's http status code.

$sel:agreements:ListAgreementsResponse', listAgreementsResponse_agreements - Returns an array, where each item contains the details of an agreement.

ListCertificates (Paginated)

data ListCertificates Source #

See: newListCertificates smart constructor.

Instances

Instances details
ToJSON ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

ToHeaders ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

ToPath ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

ToQuery ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

AWSPager ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

AWSRequest ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Associated Types

type AWSResponse ListCertificates #

Generic ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Associated Types

type Rep ListCertificates :: Type -> Type #

Read ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Show ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

NFData ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Methods

rnf :: ListCertificates -> () #

Eq ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Hashable ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

type AWSResponse ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

type Rep ListCertificates Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

type Rep ListCertificates = D1 ('MetaData "ListCertificates" "Amazonka.Transfer.ListCertificates" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListCertificates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListCertificates :: ListCertificates Source #

Create a value of ListCertificates with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListCertificates', listCertificates_maxResults - The maximum number of certificates to return.

ListCertificates, listCertificates_nextToken - When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.

data ListCertificatesResponse Source #

See: newListCertificatesResponse smart constructor.

Instances

Instances details
Generic ListCertificatesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Associated Types

type Rep ListCertificatesResponse :: Type -> Type #

Read ListCertificatesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Show ListCertificatesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

NFData ListCertificatesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

Eq ListCertificatesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

type Rep ListCertificatesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListCertificates

type Rep ListCertificatesResponse = D1 ('MetaData "ListCertificatesResponse" "Amazonka.Transfer.ListCertificates" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListCertificatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "certificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedCertificate]))))

newListCertificatesResponse Source #

Create a value of ListCertificatesResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListCertificates, listCertificatesResponse_nextToken - Returns the next token, which you can use to list the next certificate.

$sel:httpStatus:ListCertificatesResponse', listCertificatesResponse_httpStatus - The response's http status code.

$sel:certificates:ListCertificatesResponse', listCertificatesResponse_certificates - Returns an array of the certificates that are specified in the ListCertificates call.

ListConnectors (Paginated)

data ListConnectors Source #

See: newListConnectors smart constructor.

Instances

Instances details
ToJSON ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

ToHeaders ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

ToPath ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

ToQuery ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

AWSPager ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

AWSRequest ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Associated Types

type AWSResponse ListConnectors #

Generic ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Associated Types

type Rep ListConnectors :: Type -> Type #

Read ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Show ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

NFData ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

rnf :: ListConnectors -> () #

Eq ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Hashable ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

type AWSResponse ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

type Rep ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

type Rep ListConnectors = D1 ('MetaData "ListConnectors" "Amazonka.Transfer.ListConnectors" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListConnectors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListConnectors :: ListConnectors Source #

Create a value of ListConnectors with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListConnectors', listConnectors_maxResults - The maximum number of connectors to return.

ListConnectors, listConnectors_nextToken - When you can get additional results from the ListConnectors call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional connectors.

data ListConnectorsResponse Source #

See: newListConnectorsResponse smart constructor.

Instances

Instances details
Generic ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Associated Types

type Rep ListConnectorsResponse :: Type -> Type #

Read ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Show ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

NFData ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

rnf :: ListConnectorsResponse -> () #

Eq ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

type Rep ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

type Rep ListConnectorsResponse = D1 ('MetaData "ListConnectorsResponse" "Amazonka.Transfer.ListConnectors" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListConnectorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "connectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedConnector]))))

newListConnectorsResponse Source #

Create a value of ListConnectorsResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListConnectors, listConnectorsResponse_nextToken - Returns a token that you can use to call ListConnectors again and receive additional results, if there are any.

$sel:httpStatus:ListConnectorsResponse', listConnectorsResponse_httpStatus - The response's http status code.

$sel:connectors:ListConnectorsResponse', listConnectorsResponse_connectors - Returns an array, where each item contains the details of a connector.

ListExecutions (Paginated)

data ListExecutions Source #

See: newListExecutions smart constructor.

Instances

Instances details
ToJSON ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

ToHeaders ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

ToPath ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

ToQuery ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

AWSPager ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

AWSRequest ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Associated Types

type AWSResponse ListExecutions #

Generic ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Associated Types

type Rep ListExecutions :: Type -> Type #

Read ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Show ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

NFData ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Methods

rnf :: ListExecutions -> () #

Eq ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Hashable ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

type AWSResponse ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

type Rep ListExecutions Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

type Rep ListExecutions = D1 ('MetaData "ListExecutions" "Amazonka.Transfer.ListExecutions" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListExecutions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListExecutions Source #

Create a value of ListExecutions with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

ListExecutions, listExecutions_nextToken - ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

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

aws transfer list-executions --max-results 10

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

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

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

ListExecutions, listExecutions_workflowId - A unique identifier for the workflow.

data ListExecutionsResponse Source #

See: newListExecutionsResponse smart constructor.

Instances

Instances details
Generic ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Associated Types

type Rep ListExecutionsResponse :: Type -> Type #

Read ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Show ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

NFData ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

Methods

rnf :: ListExecutionsResponse -> () #

Eq ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

type Rep ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListExecutions

type Rep ListExecutionsResponse = D1 ('MetaData "ListExecutionsResponse" "Amazonka.Transfer.ListExecutions" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListExecutionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedExecution]))))

newListExecutionsResponse Source #

Create a value of ListExecutionsResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListExecutions, listExecutionsResponse_nextToken - ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

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

ListExecutions, listExecutionsResponse_workflowId - A unique identifier for the workflow.

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

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

ListHostKeys

data ListHostKeys Source #

See: newListHostKeys smart constructor.

Instances

Instances details
ToJSON ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

ToHeaders ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

ToPath ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

ToQuery ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

AWSRequest ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Associated Types

type AWSResponse ListHostKeys #

Generic ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Associated Types

type Rep ListHostKeys :: Type -> Type #

Read ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Show ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

NFData ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

rnf :: ListHostKeys -> () #

Eq ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Hashable ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type AWSResponse ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type Rep ListHostKeys Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type Rep ListHostKeys = D1 ('MetaData "ListHostKeys" "Amazonka.Transfer.ListHostKeys" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListHostKeys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListHostKeys Source #

Create a value of ListHostKeys with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListHostKeys', listHostKeys_maxResults - The maximum number of host keys to return.

ListHostKeys, listHostKeys_nextToken - When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.

ListHostKeys, listHostKeys_serverId - The identifier of the server that contains the host keys that you want to view.

data ListHostKeysResponse Source #

See: newListHostKeysResponse smart constructor.

Instances

Instances details
Generic ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Associated Types

type Rep ListHostKeysResponse :: Type -> Type #

Read ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Show ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

NFData ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

Methods

rnf :: ListHostKeysResponse -> () #

Eq ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type Rep ListHostKeysResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListHostKeys

type Rep ListHostKeysResponse = D1 ('MetaData "ListHostKeysResponse" "Amazonka.Transfer.ListHostKeys" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListHostKeysResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedHostKey]))))

newListHostKeysResponse Source #

Create a value of ListHostKeysResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListHostKeys, listHostKeysResponse_nextToken - Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

$sel:httpStatus:ListHostKeysResponse', listHostKeysResponse_httpStatus - The response's http status code.

ListHostKeys, listHostKeysResponse_serverId - Returns the server identifier that contains the listed host keys.

$sel:hostKeys:ListHostKeysResponse', listHostKeysResponse_hostKeys - Returns an array, where each item contains the details of a host key.

ListProfiles (Paginated)

data ListProfiles Source #

See: newListProfiles smart constructor.

Instances

Instances details
ToJSON ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

ToHeaders ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

ToPath ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

ToQuery ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

AWSPager ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

AWSRequest ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Associated Types

type AWSResponse ListProfiles #

Generic ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Associated Types

type Rep ListProfiles :: Type -> Type #

Read ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Show ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

NFData ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

rnf :: ListProfiles -> () #

Eq ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Hashable ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type AWSResponse ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type Rep ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type Rep ListProfiles = D1 ('MetaData "ListProfiles" "Amazonka.Transfer.ListProfiles" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListProfiles'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "profileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileType)))))

newListProfiles :: ListProfiles Source #

Create a value of ListProfiles with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:ListProfiles', listProfiles_maxResults - The maximum number of profiles to return.

ListProfiles, listProfiles_nextToken - When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

ListProfiles, listProfiles_profileType - Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

data ListProfilesResponse Source #

See: newListProfilesResponse smart constructor.

Instances

Instances details
Generic ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Associated Types

type Rep ListProfilesResponse :: Type -> Type #

Read ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Show ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

NFData ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

rnf :: ListProfilesResponse -> () #

Eq ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type Rep ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type Rep ListProfilesResponse = D1 ('MetaData "ListProfilesResponse" "Amazonka.Transfer.ListProfiles" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "profiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedProfile]))))

newListProfilesResponse Source #

Create a value of ListProfilesResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListProfiles, listProfilesResponse_nextToken - Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

$sel:httpStatus:ListProfilesResponse', listProfilesResponse_httpStatus - The response's http status code.

$sel:profiles:ListProfilesResponse', listProfilesResponse_profiles - Returns an array, where each item contains the details of a profile.

ListSecurityPolicies (Paginated)

data ListSecurityPolicies Source #

See: newListSecurityPolicies smart constructor.

Instances

Instances details
ToJSON ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

ToHeaders ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

ToPath ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

ToQuery ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

AWSPager ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

AWSRequest ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Associated Types

type AWSResponse ListSecurityPolicies #

Generic ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Associated Types

type Rep ListSecurityPolicies :: Type -> Type #

Read ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Show ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

NFData ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Methods

rnf :: ListSecurityPolicies -> () #

Eq ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Hashable ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

type AWSResponse ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

type Rep ListSecurityPolicies Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

type Rep ListSecurityPolicies = D1 ('MetaData "ListSecurityPolicies" "Amazonka.Transfer.ListSecurityPolicies" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListSecurityPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListSecurityPolicies :: ListSecurityPolicies Source #

Create a value of ListSecurityPolicies with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

ListSecurityPolicies, listSecurityPolicies_nextToken - When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.

data ListSecurityPoliciesResponse Source #

See: newListSecurityPoliciesResponse smart constructor.

Instances

Instances details
Generic ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Associated Types

type Rep ListSecurityPoliciesResponse :: Type -> Type #

Read ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Show ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

NFData ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

Eq ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

type Rep ListSecurityPoliciesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListSecurityPolicies

type Rep ListSecurityPoliciesResponse = D1 ('MetaData "ListSecurityPoliciesResponse" "Amazonka.Transfer.ListSecurityPolicies" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListSecurityPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "securityPolicyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListSecurityPoliciesResponse Source #

Create a value of ListSecurityPoliciesResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListSecurityPolicies, listSecurityPoliciesResponse_nextToken - When you can get additional results from the ListSecurityPolicies operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing security policies.

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

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

ListServers (Paginated)

data ListServers Source #

See: newListServers smart constructor.

Constructors

ListServers' (Maybe Natural) (Maybe Text) 

Instances

Instances details
ToJSON ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

ToHeaders ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

toHeaders :: ListServers -> [Header] #

ToPath ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

ToQuery ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

AWSPager ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

AWSRequest ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Associated Types

type AWSResponse ListServers #

Generic ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Associated Types

type Rep ListServers :: Type -> Type #

Read ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Show ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

NFData ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

rnf :: ListServers -> () #

Eq ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Hashable ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type AWSResponse ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type Rep ListServers Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type Rep ListServers = D1 ('MetaData "ListServers" "Amazonka.Transfer.ListServers" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListServers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListServers :: ListServers Source #

Create a value of ListServers with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

ListServers, listServers_nextToken - When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

data ListServersResponse Source #

See: newListServersResponse smart constructor.

Instances

Instances details
Generic ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Associated Types

type Rep ListServersResponse :: Type -> Type #

Read ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Show ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

NFData ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

Methods

rnf :: ListServersResponse -> () #

Eq ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type Rep ListServersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListServers

type Rep ListServersResponse = D1 ('MetaData "ListServersResponse" "Amazonka.Transfer.ListServers" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListServersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "servers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedServer]))))

newListServersResponse Source #

Create a value of ListServersResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListServers, listServersResponse_nextToken - When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

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

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

ListTagsForResource (Paginated)

data ListTagsForResource Source #

See: newListTagsForResource smart constructor.

Instances

Instances details
ToJSON ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

ToHeaders ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

ToPath ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

ToQuery ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

AWSPager ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

AWSRequest ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Associated Types

type AWSResponse ListTagsForResource #

Generic ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Associated Types

type Rep ListTagsForResource :: Type -> Type #

Read ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Show ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

NFData ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Methods

rnf :: ListTagsForResource -> () #

Eq ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Hashable ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type AWSResponse ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResource Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.Transfer.ListTagsForResource" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListTagsForResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListTagsForResource Source #

Create a value of ListTagsForResource with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

ListTagsForResource, listTagsForResource_nextToken - When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

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

data ListTagsForResourceResponse Source #

See: newListTagsForResourceResponse smart constructor.

Instances

Instances details
Generic ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Associated Types

type Rep ListTagsForResourceResponse :: Type -> Type #

Read ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Show ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

NFData ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

Eq ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListTagsForResource

type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.Transfer.ListTagsForResource" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTagsForResourceResponse Source #

Create a value of ListTagsForResourceResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListTagsForResource, listTagsForResourceResponse_arn - The ARN you specified to list the tags of.

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

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

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

ListUsers (Paginated)

data ListUsers Source #

See: newListUsers smart constructor.

Instances

Instances details
ToJSON ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

ToHeaders ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Methods

toHeaders :: ListUsers -> [Header] #

ToPath ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

ToQuery ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

AWSPager ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

AWSRequest ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Associated Types

type AWSResponse ListUsers #

Generic ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Associated Types

type Rep ListUsers :: Type -> Type #

Read ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Show ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

NFData ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Methods

rnf :: ListUsers -> () #

Eq ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Hashable ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

type AWSResponse ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

type Rep ListUsers Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.Transfer.ListUsers" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListUsers Source #

Arguments

:: Text

ListUsers

-> ListUsers 

Create a value of ListUsers with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

ListUsers, listUsers_nextToken - When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

ListUsers, listUsers_serverId - A system-assigned unique identifier for a server that has users assigned to it.

data ListUsersResponse Source #

See: newListUsersResponse smart constructor.

Instances

Instances details
Generic ListUsersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Associated Types

type Rep ListUsersResponse :: Type -> Type #

Read ListUsersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Show ListUsersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

NFData ListUsersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

Methods

rnf :: ListUsersResponse -> () #

Eq ListUsersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

type Rep ListUsersResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListUsers

type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.Transfer.ListUsers" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedUser]))))

newListUsersResponse Source #

Create a value of ListUsersResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListUsers, listUsersResponse_nextToken - When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

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

ListUsers, listUsersResponse_serverId - A system-assigned unique identifier for a server that the users are assigned to.

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

ListWorkflows (Paginated)

data ListWorkflows Source #

See: newListWorkflows smart constructor.

Instances

Instances details
ToJSON ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

ToHeaders ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

ToPath ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

ToQuery ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

AWSPager ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

AWSRequest ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Associated Types

type AWSResponse ListWorkflows #

Generic ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Associated Types

type Rep ListWorkflows :: Type -> Type #

Read ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Show ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

NFData ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Methods

rnf :: ListWorkflows -> () #

Eq ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Hashable ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type AWSResponse ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type Rep ListWorkflows Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type Rep ListWorkflows = D1 ('MetaData "ListWorkflows" "Amazonka.Transfer.ListWorkflows" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListWorkflows'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListWorkflows :: ListWorkflows Source #

Create a value of ListWorkflows with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

ListWorkflows, listWorkflows_nextToken - ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

data ListWorkflowsResponse Source #

See: newListWorkflowsResponse smart constructor.

Instances

Instances details
Generic ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Associated Types

type Rep ListWorkflowsResponse :: Type -> Type #

Read ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Show ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

NFData ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

Methods

rnf :: ListWorkflowsResponse -> () #

Eq ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type Rep ListWorkflowsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListWorkflows

type Rep ListWorkflowsResponse = D1 ('MetaData "ListWorkflowsResponse" "Amazonka.Transfer.ListWorkflows" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListWorkflowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workflows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedWorkflow]))))

newListWorkflowsResponse Source #

Create a value of ListWorkflowsResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListWorkflows, listWorkflowsResponse_nextToken - ListWorkflows returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional workflows.

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

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

SendWorkflowStepState

data SendWorkflowStepState Source #

See: newSendWorkflowStepState smart constructor.

Instances

Instances details
ToJSON SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

ToHeaders SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

ToPath SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

ToQuery SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

AWSRequest SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Associated Types

type AWSResponse SendWorkflowStepState #

Generic SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Associated Types

type Rep SendWorkflowStepState :: Type -> Type #

Read SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Show SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

NFData SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Methods

rnf :: SendWorkflowStepState -> () #

Eq SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Hashable SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

type AWSResponse SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

type Rep SendWorkflowStepState Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

type Rep SendWorkflowStepState = D1 ('MetaData "SendWorkflowStepState" "Amazonka.Transfer.SendWorkflowStepState" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "SendWorkflowStepState'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CustomStepStatus))))

newSendWorkflowStepState Source #

Create a value of SendWorkflowStepState with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SendWorkflowStepState, sendWorkflowStepState_workflowId - A unique identifier for the workflow.

SendWorkflowStepState, sendWorkflowStepState_executionId - A unique identifier for the execution of a workflow.

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

SendWorkflowStepState, sendWorkflowStepState_status - Indicates whether the specified step succeeded or failed.

data SendWorkflowStepStateResponse Source #

See: newSendWorkflowStepStateResponse smart constructor.

Instances

Instances details
Generic SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Associated Types

type Rep SendWorkflowStepStateResponse :: Type -> Type #

Read SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Show SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

NFData SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

Eq SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

type Rep SendWorkflowStepStateResponse Source # 
Instance details

Defined in Amazonka.Transfer.SendWorkflowStepState

type Rep SendWorkflowStepStateResponse = D1 ('MetaData "SendWorkflowStepStateResponse" "Amazonka.Transfer.SendWorkflowStepState" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "SendWorkflowStepStateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendWorkflowStepStateResponse Source #

Create a value of SendWorkflowStepStateResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SendWorkflowStepStateResponse', sendWorkflowStepStateResponse_httpStatus - The response's http status code.

StartFileTransfer

data StartFileTransfer Source #

See: newStartFileTransfer smart constructor.

Instances

Instances details
ToJSON StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

ToHeaders StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

ToPath StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

ToQuery StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

AWSRequest StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Associated Types

type AWSResponse StartFileTransfer #

Generic StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Associated Types

type Rep StartFileTransfer :: Type -> Type #

Read StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Show StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

NFData StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Methods

rnf :: StartFileTransfer -> () #

Eq StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Hashable StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

type AWSResponse StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

type Rep StartFileTransfer Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

type Rep StartFileTransfer = D1 ('MetaData "StartFileTransfer" "Amazonka.Transfer.StartFileTransfer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StartFileTransfer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sendFilePaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newStartFileTransfer Source #

Create a value of StartFileTransfer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartFileTransfer, startFileTransfer_connectorId - The unique identifier for the connector.

$sel:sendFilePaths:StartFileTransfer', startFileTransfer_sendFilePaths - An array of strings. Each string represents the absolute path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt .

data StartFileTransferResponse Source #

See: newStartFileTransferResponse smart constructor.

Instances

Instances details
Generic StartFileTransferResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Associated Types

type Rep StartFileTransferResponse :: Type -> Type #

Read StartFileTransferResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Show StartFileTransferResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

NFData StartFileTransferResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

Eq StartFileTransferResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

type Rep StartFileTransferResponse Source # 
Instance details

Defined in Amazonka.Transfer.StartFileTransfer

type Rep StartFileTransferResponse = D1 ('MetaData "StartFileTransferResponse" "Amazonka.Transfer.StartFileTransfer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StartFileTransferResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "transferId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartFileTransferResponse Source #

Create a value of StartFileTransferResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:StartFileTransferResponse', startFileTransferResponse_httpStatus - The response's http status code.

$sel:transferId:StartFileTransferResponse', startFileTransferResponse_transferId - Returns the unique identifier for this file transfer.

StartServer

data StartServer Source #

See: newStartServer smart constructor.

Constructors

StartServer' Text 

Instances

Instances details
ToJSON StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

ToHeaders StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Methods

toHeaders :: StartServer -> [Header] #

ToPath StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

ToQuery StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

AWSRequest StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Associated Types

type AWSResponse StartServer #

Generic StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Associated Types

type Rep StartServer :: Type -> Type #

Read StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Show StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

NFData StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Methods

rnf :: StartServer -> () #

Eq StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

Hashable StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

type AWSResponse StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

type Rep StartServer Source # 
Instance details

Defined in Amazonka.Transfer.StartServer

type Rep StartServer = D1 ('MetaData "StartServer" "Amazonka.Transfer.StartServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StartServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartServer Source #

Create a value of StartServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartServer, startServer_serverId - A system-assigned unique identifier for a server that you start.

data StartServerResponse Source #

See: newStartServerResponse smart constructor.

Constructors

StartServerResponse' 

newStartServerResponse :: StartServerResponse Source #

Create a value of StartServerResponse with all optional fields omitted.

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

StopServer

data StopServer Source #

See: newStopServer smart constructor.

Constructors

StopServer' Text 

Instances

Instances details
ToJSON StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

ToHeaders StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Methods

toHeaders :: StopServer -> [Header] #

ToPath StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

ToQuery StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

AWSRequest StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Associated Types

type AWSResponse StopServer #

Generic StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Associated Types

type Rep StopServer :: Type -> Type #

Read StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Show StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

NFData StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Methods

rnf :: StopServer -> () #

Eq StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Hashable StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

type AWSResponse StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

type Rep StopServer Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

type Rep StopServer = D1 ('MetaData "StopServer" "Amazonka.Transfer.StopServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StopServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopServer Source #

Arguments

:: Text

StopServer

-> StopServer 

Create a value of StopServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StopServer, stopServer_serverId - A system-assigned unique identifier for a server that you stopped.

data StopServerResponse Source #

See: newStopServerResponse smart constructor.

Constructors

StopServerResponse' 

Instances

Instances details
Generic StopServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Associated Types

type Rep StopServerResponse :: Type -> Type #

Read StopServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Show StopServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

NFData StopServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

Methods

rnf :: StopServerResponse -> () #

Eq StopServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

type Rep StopServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.StopServer

type Rep StopServerResponse = D1 ('MetaData "StopServerResponse" "Amazonka.Transfer.StopServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "StopServerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopServerResponse :: StopServerResponse Source #

Create a value of StopServerResponse with all optional fields omitted.

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

TagResource

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' Text (NonEmpty Tag) 

Instances

Instances details
ToJSON TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

Associated Types

type AWSResponse TagResource #

Generic TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

Read TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

NFData TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

Methods

rnf :: TagResource -> () #

Eq TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

Hashable TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.Transfer.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Transfer.TagResource" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Tag))))

newTagResource Source #

Create a value of TagResource with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TagResource, tagResource_arn - An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

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

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse' 

newTagResourceResponse :: TagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

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

TestIdentityProvider

data TestIdentityProvider Source #

See: newTestIdentityProvider smart constructor.

Instances

Instances details
ToJSON TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

ToHeaders TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

ToPath TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

ToQuery TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

AWSRequest TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

Associated Types

type AWSResponse TestIdentityProvider #

Generic TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

Associated Types

type Rep TestIdentityProvider :: Type -> Type #

Show TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

NFData TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

Methods

rnf :: TestIdentityProvider -> () #

Eq TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

Hashable TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

type AWSResponse TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

type Rep TestIdentityProvider Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

type Rep TestIdentityProvider = D1 ('MetaData "TestIdentityProvider" "Amazonka.Transfer.TestIdentityProvider" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TestIdentityProvider'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "serverProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protocol)) :*: S1 ('MetaSel ('Just "sourceIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTestIdentityProvider Source #

Create a value of TestIdentityProvider with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:serverProtocol:TestIdentityProvider', testIdentityProvider_serverProtocol - The type of file transfer protocol to be tested.

The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP)
  • File Transfer Protocol Secure (FTPS)
  • File Transfer Protocol (FTP)

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

$sel:userPassword:TestIdentityProvider', testIdentityProvider_userPassword - The password of the user account to be tested.

TestIdentityProvider, testIdentityProvider_serverId - A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

TestIdentityProvider, testIdentityProvider_userName - The name of the user account to be tested.

data TestIdentityProviderResponse Source #

See: newTestIdentityProviderResponse smart constructor.

Instances

Instances details
Generic TestIdentityProviderResponse Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

Associated Types

type Rep TestIdentityProviderResponse :: Type -> Type #

Read TestIdentityProviderResponse Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

Show TestIdentityProviderResponse Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

NFData TestIdentityProviderResponse Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

Eq TestIdentityProviderResponse Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

type Rep TestIdentityProviderResponse Source # 
Instance details

Defined in Amazonka.Transfer.TestIdentityProvider

type Rep TestIdentityProviderResponse = D1 ('MetaData "TestIdentityProviderResponse" "Amazonka.Transfer.TestIdentityProvider" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TestIdentityProviderResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "response") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTestIdentityProviderResponse Source #

Create a value of TestIdentityProviderResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

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

$sel:httpStatus:TestIdentityProviderResponse', testIdentityProviderResponse_httpStatus - The response's http status code.

$sel:statusCode:TestIdentityProviderResponse', testIdentityProviderResponse_statusCode - The HTTP status code that is the response from your API Gateway.

TestIdentityProviderResponse, testIdentityProviderResponse_url - The endpoint of the service used to authenticate a user.

UntagResource

data UntagResource Source #

See: newUntagResource smart constructor.

Instances

Instances details
ToJSON UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

ToHeaders UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

ToPath UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

ToQuery UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

AWSRequest UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Associated Types

type AWSResponse UntagResource #

Generic UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type #

Read UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Show UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

NFData UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Methods

rnf :: UntagResource -> () #

Eq UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Hashable UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

type AWSResponse UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

type Rep UntagResource Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.Transfer.UntagResource" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newUntagResource Source #

Create a value of UntagResource with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UntagResource, untagResource_arn - The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

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

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Instances

Instances details
Generic UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type #

Read UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Show UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

NFData UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

Methods

rnf :: UntagResourceResponse -> () #

Eq UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

type Rep UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Transfer.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.Transfer.UntagResource" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUntagResourceResponse :: UntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

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

UpdateAccess

data UpdateAccess Source #

See: newUpdateAccess smart constructor.

Instances

Instances details
ToJSON UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

ToHeaders UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

ToPath UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

ToQuery UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

AWSRequest UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Associated Types

type AWSResponse UpdateAccess #

Generic UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Associated Types

type Rep UpdateAccess :: Type -> Type #

Read UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Show UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

NFData UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Methods

rnf :: UpdateAccess -> () #

Eq UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Hashable UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

type AWSResponse UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

type Rep UpdateAccess Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

newUpdateAccess Source #

Create a value of UpdateAccess with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

The following is an Entry and Target pair example.

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

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

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

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

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

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

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

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

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

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

UpdateAccess, updateAccess_posixProfile - Undocumented member.

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

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

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

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

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

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

data UpdateAccessResponse Source #

See: newUpdateAccessResponse smart constructor.

Instances

Instances details
Generic UpdateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Associated Types

type Rep UpdateAccessResponse :: Type -> Type #

Read UpdateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Show UpdateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

NFData UpdateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

Methods

rnf :: UpdateAccessResponse -> () #

Eq UpdateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

type Rep UpdateAccessResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAccess

type Rep UpdateAccessResponse = D1 ('MetaData "UpdateAccessResponse" "Amazonka.Transfer.UpdateAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateAccessResponse Source #

Create a value of UpdateAccessResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateAccessResponse', updateAccessResponse_httpStatus - The response's http status code.

UpdateAccess, updateAccessResponse_serverId - The identifier of the server that the user is attached to.

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

UpdateAgreement

data UpdateAgreement Source #

See: newUpdateAgreement smart constructor.

Instances

Instances details
ToJSON UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

ToHeaders UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

ToPath UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

ToQuery UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

AWSRequest UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Associated Types

type AWSResponse UpdateAgreement #

Generic UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Associated Types

type Rep UpdateAgreement :: Type -> Type #

Read UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Show UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

NFData UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Methods

rnf :: UpdateAgreement -> () #

Eq UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Hashable UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

type AWSResponse UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

type Rep UpdateAgreement Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

newUpdateAgreement Source #

Create a value of UpdateAgreement with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateAgreement, updateAgreement_accessRole - With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

UpdateAgreement, updateAgreement_baseDirectory - To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .

UpdateAgreement, updateAgreement_description - To replace the existing description, provide a short description for the agreement.

UpdateAgreement, updateAgreement_localProfileId - A unique identifier for the AS2 local profile.

To change the local profile identifier, provide a new value here.

UpdateAgreement, updateAgreement_partnerProfileId - A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

UpdateAgreement, updateAgreement_status - You can update the status for the agreement, either activating an inactive agreement or the reverse.

UpdateAgreement, updateAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

UpdateAgreement, updateAgreement_serverId - A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

data UpdateAgreementResponse Source #

See: newUpdateAgreementResponse smart constructor.

Instances

Instances details
Generic UpdateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Associated Types

type Rep UpdateAgreementResponse :: Type -> Type #

Read UpdateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Show UpdateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

NFData UpdateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

Methods

rnf :: UpdateAgreementResponse -> () #

Eq UpdateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

type Rep UpdateAgreementResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateAgreement

type Rep UpdateAgreementResponse = D1 ('MetaData "UpdateAgreementResponse" "Amazonka.Transfer.UpdateAgreement" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateAgreementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "agreementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateAgreementResponse Source #

Create a value of UpdateAgreementResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateAgreementResponse', updateAgreementResponse_httpStatus - The response's http status code.

UpdateAgreement, updateAgreementResponse_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

UpdateCertificate

data UpdateCertificate Source #

See: newUpdateCertificate smart constructor.

Instances

Instances details
ToJSON UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

ToHeaders UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

ToPath UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

ToQuery UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

AWSRequest UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Associated Types

type AWSResponse UpdateCertificate #

Generic UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Associated Types

type Rep UpdateCertificate :: Type -> Type #

Read UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Show UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

NFData UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Methods

rnf :: UpdateCertificate -> () #

Eq UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Hashable UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

type AWSResponse UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

type Rep UpdateCertificate Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

type Rep UpdateCertificate = D1 ('MetaData "UpdateCertificate" "Amazonka.Transfer.UpdateCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "activeDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inactiveDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateCertificate Source #

Create a value of UpdateCertificate with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateCertificate, updateCertificate_activeDate - An optional date that specifies when the certificate becomes active.

UpdateCertificate, updateCertificate_description - A short description to help identify the certificate.

UpdateCertificate, updateCertificate_inactiveDate - An optional date that specifies when the certificate becomes inactive.

UpdateCertificate, updateCertificate_certificateId - The identifier of the certificate object that you are updating.

data UpdateCertificateResponse Source #

See: newUpdateCertificateResponse smart constructor.

Instances

Instances details
Generic UpdateCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Associated Types

type Rep UpdateCertificateResponse :: Type -> Type #

Read UpdateCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Show UpdateCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

NFData UpdateCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

Eq UpdateCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

type Rep UpdateCertificateResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateCertificate

type Rep UpdateCertificateResponse = D1 ('MetaData "UpdateCertificateResponse" "Amazonka.Transfer.UpdateCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateCertificateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateCertificateResponse Source #

Create a value of UpdateCertificateResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateCertificateResponse', updateCertificateResponse_httpStatus - The response's http status code.

UpdateCertificate, updateCertificateResponse_certificateId - Returns the identifier of the certificate object that you are updating.

UpdateConnector

data UpdateConnector Source #

See: newUpdateConnector smart constructor.

Instances

Instances details
ToJSON UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

ToHeaders UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

ToPath UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

ToQuery UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

AWSRequest UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Associated Types

type AWSResponse UpdateConnector #

Generic UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Associated Types

type Rep UpdateConnector :: Type -> Type #

Read UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Show UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

NFData UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Methods

rnf :: UpdateConnector -> () #

Eq UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Hashable UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

type AWSResponse UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

type Rep UpdateConnector Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

type Rep UpdateConnector = D1 ('MetaData "UpdateConnector" "Amazonka.Transfer.UpdateConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateConnector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "as2Config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe As2ConnectorConfig))) :*: (S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateConnector Source #

Create a value of UpdateConnector with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateConnector, updateConnector_accessRole - With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

UpdateConnector, updateConnector_as2Config - A structure that contains the parameters for a connector object.

UpdateConnector, updateConnector_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

UpdateConnector, updateConnector_url - The URL of the partner's AS2 endpoint.

UpdateConnector, updateConnector_connectorId - The unique identifier for the connector.

data UpdateConnectorResponse Source #

See: newUpdateConnectorResponse smart constructor.

Instances

Instances details
Generic UpdateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Associated Types

type Rep UpdateConnectorResponse :: Type -> Type #

Read UpdateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Show UpdateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

NFData UpdateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

Methods

rnf :: UpdateConnectorResponse -> () #

Eq UpdateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

type Rep UpdateConnectorResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateConnector

type Rep UpdateConnectorResponse = D1 ('MetaData "UpdateConnectorResponse" "Amazonka.Transfer.UpdateConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateConnectorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateConnectorResponse Source #

Create a value of UpdateConnectorResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateConnectorResponse', updateConnectorResponse_httpStatus - The response's http status code.

UpdateConnector, updateConnectorResponse_connectorId - Returns the identifier of the connector object that you are updating.

UpdateHostKey

data UpdateHostKey Source #

See: newUpdateHostKey smart constructor.

Instances

Instances details
ToJSON UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

ToHeaders UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

ToPath UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

ToQuery UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

AWSRequest UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Associated Types

type AWSResponse UpdateHostKey #

Generic UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Associated Types

type Rep UpdateHostKey :: Type -> Type #

Read UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Show UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

NFData UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

rnf :: UpdateHostKey -> () #

Eq UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Hashable UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

type AWSResponse UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

type Rep UpdateHostKey Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

type Rep UpdateHostKey = D1 ('MetaData "UpdateHostKey" "Amazonka.Transfer.UpdateHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateHostKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "hostKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateHostKey Source #

Create a value of UpdateHostKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateHostKey, updateHostKey_serverId - The identifier of the server that contains the host key that you are updating.

UpdateHostKey, updateHostKey_hostKeyId - The identifier of the host key that you are updating.

UpdateHostKey, updateHostKey_description - An updated description for the host key.

data UpdateHostKeyResponse Source #

See: newUpdateHostKeyResponse smart constructor.

Instances

Instances details
Generic UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Associated Types

type Rep UpdateHostKeyResponse :: Type -> Type #

Read UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Show UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

NFData UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

Methods

rnf :: UpdateHostKeyResponse -> () #

Eq UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

type Rep UpdateHostKeyResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateHostKey

type Rep UpdateHostKeyResponse = D1 ('MetaData "UpdateHostKeyResponse" "Amazonka.Transfer.UpdateHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateHostKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateHostKeyResponse Source #

Create a value of UpdateHostKeyResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateHostKeyResponse', updateHostKeyResponse_httpStatus - The response's http status code.

UpdateHostKey, updateHostKeyResponse_serverId - Returns the server identifier for the server that contains the updated host key.

UpdateHostKey, updateHostKeyResponse_hostKeyId - Returns the host key identifier for the updated host key.

UpdateProfile

data UpdateProfile Source #

See: newUpdateProfile smart constructor.

Constructors

UpdateProfile' (Maybe [Text]) Text 

Instances

Instances details
ToJSON UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

ToHeaders UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

ToPath UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

ToQuery UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

AWSRequest UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Associated Types

type AWSResponse UpdateProfile #

Generic UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Associated Types

type Rep UpdateProfile :: Type -> Type #

Read UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Show UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

NFData UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Methods

rnf :: UpdateProfile -> () #

Eq UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Hashable UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

type AWSResponse UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

type Rep UpdateProfile Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

type Rep UpdateProfile = D1 ('MetaData "UpdateProfile" "Amazonka.Transfer.UpdateProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateProfile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateProfile Source #

Create a value of UpdateProfile with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateProfile, updateProfile_certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

UpdateProfile, updateProfile_profileId - The identifier of the profile object that you are updating.

data UpdateProfileResponse Source #

See: newUpdateProfileResponse smart constructor.

Instances

Instances details
Generic UpdateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Associated Types

type Rep UpdateProfileResponse :: Type -> Type #

Read UpdateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Show UpdateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

NFData UpdateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

Methods

rnf :: UpdateProfileResponse -> () #

Eq UpdateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

type Rep UpdateProfileResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateProfile

type Rep UpdateProfileResponse = D1 ('MetaData "UpdateProfileResponse" "Amazonka.Transfer.UpdateProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateProfileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateProfileResponse Source #

Create a value of UpdateProfileResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateProfileResponse', updateProfileResponse_httpStatus - The response's http status code.

UpdateProfile, updateProfileResponse_profileId - Returns the identifier for the profile that's being updated.

UpdateServer

data UpdateServer Source #

See: newUpdateServer smart constructor.

Instances

Instances details
ToJSON UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

ToHeaders UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

ToPath UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

ToQuery UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

AWSRequest UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

Associated Types

type AWSResponse UpdateServer #

Generic UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

Associated Types

type Rep UpdateServer :: Type -> Type #

Show UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

NFData UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

Methods

rnf :: UpdateServer -> () #

Eq UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

Hashable UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

type AWSResponse UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

type Rep UpdateServer Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

type Rep UpdateServer = D1 ('MetaData "UpdateServer" "Amazonka.Transfer.UpdateServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateServer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endpointDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDetails)) :*: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType)))) :*: (S1 ('MetaSel ('Just "hostKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderDetails)) :*: S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "postAuthenticationLoginBanner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "preAuthenticationLoginBanner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "protocolDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolDetails)))) :*: ((S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol))) :*: S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "workflowDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowDetails)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateServer Source #

Create a value of UpdateServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

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

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

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

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

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

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

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

$sel:hostKey:UpdateServer', updateServer_hostKey - The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

Use the following command to generate an RSA 2048 bit key with no passphrase:

ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

Use a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or 4096.

Use the following command to generate an ECDSA 256 bit key with no passphrase:

ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

Valid values for the -b option for ECDSA are 256, 384, and 521.

Use the following command to generate an ED25519 key with no passphrase:

ssh-keygen -t ed25519 -N "" -f my-new-server-key.

For all of these commands, you can replace my-new-server-key with a string of your choice.

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

For more information, see Update host keys for your SFTP-enabled server in the Transfer Family User Guide.

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

UpdateServer, updateServer_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

UpdateServer, updateServer_postAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

UpdateServer, updateServer_preAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

UpdateServer, updateServer_protocolDetails - The protocol settings that are configured for your server.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.
  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

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

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
  • FTP (File Transfer Protocol): Unencrypted file transfer
  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data
  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.
  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.
  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

UpdateServer, updateServer_securityPolicyName - Specifies the name of the security policy that is attached to the server.

UpdateServer, updateServer_workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

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

data UpdateServerResponse Source #

See: newUpdateServerResponse smart constructor.

Instances

Instances details
Generic UpdateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

Associated Types

type Rep UpdateServerResponse :: Type -> Type #

Read UpdateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

Show UpdateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

NFData UpdateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

Methods

rnf :: UpdateServerResponse -> () #

Eq UpdateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

type Rep UpdateServerResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateServer

type Rep UpdateServerResponse = D1 ('MetaData "UpdateServerResponse" "Amazonka.Transfer.UpdateServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateServerResponse Source #

Create a value of UpdateServerResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateServerResponse', updateServerResponse_httpStatus - The response's http status code.

UpdateServer, updateServerResponse_serverId - A system-assigned unique identifier for a server that the user account is assigned to.

UpdateUser

data UpdateUser Source #

See: newUpdateUser smart constructor.

Instances

Instances details
ToJSON UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

ToHeaders UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Methods

toHeaders :: UpdateUser -> [Header] #

ToPath UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

ToQuery UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

AWSRequest UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Associated Types

type AWSResponse UpdateUser #

Generic UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Associated Types

type Rep UpdateUser :: Type -> Type #

Read UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Show UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

NFData UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Methods

rnf :: UpdateUser -> () #

Eq UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Hashable UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

type AWSResponse UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

type Rep UpdateUser Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

newUpdateUser Source #

Create a value of UpdateUser with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

The following is an Entry and Target pair example.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data UpdateUserResponse Source #

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

See: newUpdateUserResponse smart constructor.

Instances

Instances details
Generic UpdateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Associated Types

type Rep UpdateUserResponse :: Type -> Type #

Read UpdateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Show UpdateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

NFData UpdateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

Methods

rnf :: UpdateUserResponse -> () #

Eq UpdateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

type Rep UpdateUserResponse Source # 
Instance details

Defined in Amazonka.Transfer.UpdateUser

type Rep UpdateUserResponse = D1 ('MetaData "UpdateUserResponse" "Amazonka.Transfer.UpdateUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UpdateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateUserResponse Source #

Create a value of UpdateUserResponse with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateUserResponse', updateUserResponse_httpStatus - The response's http status code.

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

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

Types

AgreementStatusType

newtype AgreementStatusType Source #

Instances

Instances details
FromJSON AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

FromJSONKey AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToJSON AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToJSONKey AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToByteString AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToHeader AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToLog AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToQuery AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

FromText AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToText AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

FromXML AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

ToXML AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

Generic AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

Associated Types

type Rep AgreementStatusType :: Type -> Type #

Read AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

Show AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

NFData AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

Methods

rnf :: AgreementStatusType -> () #

Eq AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

Ord AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

Hashable AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

type Rep AgreementStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.AgreementStatusType

type Rep AgreementStatusType = D1 ('MetaData "AgreementStatusType" "Amazonka.Transfer.Types.AgreementStatusType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "AgreementStatusType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAgreementStatusType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

As2Transport

newtype As2Transport Source #

Constructors

As2Transport' 

Bundled Patterns

pattern As2Transport_HTTP :: As2Transport 

Instances

Instances details
FromJSON As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

FromJSONKey As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToJSON As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToJSONKey As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToByteString As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToHeader As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToLog As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToQuery As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

FromText As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToText As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

Methods

toText :: As2Transport -> Text #

FromXML As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

ToXML As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

Methods

toXML :: As2Transport -> XML #

Generic As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

Associated Types

type Rep As2Transport :: Type -> Type #

Read As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

Show As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

NFData As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

Methods

rnf :: As2Transport -> () #

Eq As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

Ord As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

Hashable As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

type Rep As2Transport Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2Transport

type Rep As2Transport = D1 ('MetaData "As2Transport" "Amazonka.Transfer.Types.As2Transport" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "As2Transport'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAs2Transport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CertificateStatusType

newtype CertificateStatusType Source #

Instances

Instances details
FromJSON CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

FromJSONKey CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToJSON CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToJSONKey CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToByteString CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToHeader CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToLog CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToQuery CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

FromText CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToText CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

FromXML CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

ToXML CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

Generic CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

Associated Types

type Rep CertificateStatusType :: Type -> Type #

Read CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

Show CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

NFData CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

Methods

rnf :: CertificateStatusType -> () #

Eq CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

Ord CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

Hashable CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

type Rep CertificateStatusType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateStatusType

type Rep CertificateStatusType = D1 ('MetaData "CertificateStatusType" "Amazonka.Transfer.Types.CertificateStatusType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "CertificateStatusType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCertificateStatusType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CertificateType

newtype CertificateType Source #

Constructors

CertificateType' 

Instances

Instances details
FromJSON CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

FromJSONKey CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToJSON CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToJSONKey CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToByteString CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToHeader CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToLog CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToQuery CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

FromText CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToText CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

FromXML CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

ToXML CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

Methods

toXML :: CertificateType -> XML #

Generic CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

Associated Types

type Rep CertificateType :: Type -> Type #

Read CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

Show CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

NFData CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

Methods

rnf :: CertificateType -> () #

Eq CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

Ord CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

Hashable CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

type Rep CertificateType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateType

type Rep CertificateType = D1 ('MetaData "CertificateType" "Amazonka.Transfer.Types.CertificateType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "CertificateType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCertificateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CertificateUsageType

newtype CertificateUsageType Source #

Instances

Instances details
FromJSON CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

FromJSONKey CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToJSON CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToJSONKey CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToByteString CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToHeader CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToLog CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToQuery CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

FromText CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToText CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

FromXML CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

ToXML CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

Generic CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

Associated Types

type Rep CertificateUsageType :: Type -> Type #

Read CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

Show CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

NFData CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

Methods

rnf :: CertificateUsageType -> () #

Eq CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

Ord CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

Hashable CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

type Rep CertificateUsageType Source # 
Instance details

Defined in Amazonka.Transfer.Types.CertificateUsageType

type Rep CertificateUsageType = D1 ('MetaData "CertificateUsageType" "Amazonka.Transfer.Types.CertificateUsageType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "CertificateUsageType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCertificateUsageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CompressionEnum

newtype CompressionEnum Source #

Constructors

CompressionEnum' 

Instances

Instances details
FromJSON CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

FromJSONKey CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToJSON CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToJSONKey CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToByteString CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToHeader CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToLog CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToQuery CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

FromText CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToText CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

FromXML CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

ToXML CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

Methods

toXML :: CompressionEnum -> XML #

Generic CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

Associated Types

type Rep CompressionEnum :: Type -> Type #

Read CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

Show CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

NFData CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

Methods

rnf :: CompressionEnum -> () #

Eq CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

Ord CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

Hashable CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

type Rep CompressionEnum Source # 
Instance details

Defined in Amazonka.Transfer.Types.CompressionEnum

type Rep CompressionEnum = D1 ('MetaData "CompressionEnum" "Amazonka.Transfer.Types.CompressionEnum" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "CompressionEnum'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCompressionEnum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CustomStepStatus

newtype CustomStepStatus Source #

Instances

Instances details
FromJSON CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

FromJSONKey CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToJSON CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToJSONKey CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToByteString CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToHeader CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToLog CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToQuery CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

FromText CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToText CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

FromXML CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

ToXML CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

Generic CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

Associated Types

type Rep CustomStepStatus :: Type -> Type #

Read CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

Show CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

NFData CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

Methods

rnf :: CustomStepStatus -> () #

Eq CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

Ord CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

Hashable CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

type Rep CustomStepStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepStatus

type Rep CustomStepStatus = D1 ('MetaData "CustomStepStatus" "Amazonka.Transfer.Types.CustomStepStatus" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "CustomStepStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCustomStepStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Domain

newtype Domain Source #

Constructors

Domain' 

Fields

Bundled Patterns

pattern Domain_EFS :: Domain 
pattern Domain_S3 :: Domain 

Instances

Instances details
FromJSON Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

FromJSONKey Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

ToJSON Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

ToJSONKey Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

ToByteString Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Methods

toBS :: Domain -> ByteString #

ToHeader Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Methods

toHeader :: HeaderName -> Domain -> [Header] #

ToLog Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

ToQuery Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

FromText Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

ToText Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Methods

toText :: Domain -> Text #

FromXML Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

ToXML Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Methods

toXML :: Domain -> XML #

Generic Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Associated Types

type Rep Domain :: Type -> Type #

Methods

from :: Domain -> Rep Domain x #

to :: Rep Domain x -> Domain #

Read Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Show Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

NFData Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Methods

rnf :: Domain -> () #

Eq Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Methods

(==) :: Domain -> Domain -> Bool #

(/=) :: Domain -> Domain -> Bool #

Ord Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Hashable Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

Methods

hashWithSalt :: Int -> Domain -> Int #

hash :: Domain -> Int #

type Rep Domain Source # 
Instance details

Defined in Amazonka.Transfer.Types.Domain

type Rep Domain = D1 ('MetaData "Domain" "Amazonka.Transfer.Types.Domain" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "Domain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EncryptionAlg

newtype EncryptionAlg Source #

Constructors

EncryptionAlg' 

Instances

Instances details
FromJSON EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

FromJSONKey EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToJSON EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToJSONKey EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToByteString EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToHeader EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToLog EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToQuery EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

FromText EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToText EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

Methods

toText :: EncryptionAlg -> Text #

FromXML EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

ToXML EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

Methods

toXML :: EncryptionAlg -> XML #

Generic EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

Associated Types

type Rep EncryptionAlg :: Type -> Type #

Read EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

Show EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

NFData EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

Methods

rnf :: EncryptionAlg -> () #

Eq EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

Ord EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

Hashable EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

type Rep EncryptionAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionAlg

type Rep EncryptionAlg = D1 ('MetaData "EncryptionAlg" "Amazonka.Transfer.Types.EncryptionAlg" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "EncryptionAlg'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEncryptionAlg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EncryptionType

newtype EncryptionType Source #

Constructors

EncryptionType' 

Bundled Patterns

pattern EncryptionType_PGP :: EncryptionType 

Instances

Instances details
FromJSON EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

FromJSONKey EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToJSON EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToJSONKey EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToByteString EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToHeader EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToLog EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToQuery EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

FromText EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToText EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

FromXML EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

ToXML EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

Methods

toXML :: EncryptionType -> XML #

Generic EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

Associated Types

type Rep EncryptionType :: Type -> Type #

Read EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

Show EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

NFData EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

Methods

rnf :: EncryptionType -> () #

Eq EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

Ord EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

Hashable EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

type Rep EncryptionType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EncryptionType

type Rep EncryptionType = D1 ('MetaData "EncryptionType" "Amazonka.Transfer.Types.EncryptionType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "EncryptionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EndpointType

newtype EndpointType Source #

Constructors

EndpointType' 

Instances

Instances details
FromJSON EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

FromJSONKey EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToJSON EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToJSONKey EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToByteString EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToHeader EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToLog EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToQuery EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

FromText EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToText EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

Methods

toText :: EndpointType -> Text #

FromXML EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

ToXML EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

Methods

toXML :: EndpointType -> XML #

Generic EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

Associated Types

type Rep EndpointType :: Type -> Type #

Read EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

Show EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

NFData EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

Methods

rnf :: EndpointType -> () #

Eq EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

Ord EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

Hashable EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

type Rep EndpointType Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointType

type Rep EndpointType = D1 ('MetaData "EndpointType" "Amazonka.Transfer.Types.EndpointType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "EndpointType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExecutionErrorType

newtype ExecutionErrorType Source #

Instances

Instances details
FromJSON ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

FromJSONKey ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToJSON ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToJSONKey ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToByteString ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToHeader ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToLog ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToQuery ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

FromText ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToText ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

FromXML ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

ToXML ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

Generic ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

Associated Types

type Rep ExecutionErrorType :: Type -> Type #

Read ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

Show ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

NFData ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

Methods

rnf :: ExecutionErrorType -> () #

Eq ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

Ord ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

Hashable ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

type Rep ExecutionErrorType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionErrorType

type Rep ExecutionErrorType = D1 ('MetaData "ExecutionErrorType" "Amazonka.Transfer.Types.ExecutionErrorType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "ExecutionErrorType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExecutionErrorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExecutionStatus

newtype ExecutionStatus Source #

Constructors

ExecutionStatus' 

Instances

Instances details
FromJSON ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

FromJSONKey ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToJSON ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToJSONKey ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToByteString ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToHeader ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToLog ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToQuery ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

FromText ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToText ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

FromXML ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

ToXML ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

Methods

toXML :: ExecutionStatus -> XML #

Generic ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

Associated Types

type Rep ExecutionStatus :: Type -> Type #

Read ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

Show ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

NFData ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

Methods

rnf :: ExecutionStatus -> () #

Eq ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

Ord ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

Hashable ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

type Rep ExecutionStatus Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStatus

type Rep ExecutionStatus = D1 ('MetaData "ExecutionStatus" "Amazonka.Transfer.Types.ExecutionStatus" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "ExecutionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExecutionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

HomeDirectoryType

newtype HomeDirectoryType Source #

Instances

Instances details
FromJSON HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

FromJSONKey HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToJSON HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToJSONKey HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToByteString HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToHeader HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToLog HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToQuery HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

FromText HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToText HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

FromXML HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

ToXML HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

Generic HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

Associated Types

type Rep HomeDirectoryType :: Type -> Type #

Read HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

Show HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

NFData HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

Methods

rnf :: HomeDirectoryType -> () #

Eq HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

Ord HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

Hashable HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

type Rep HomeDirectoryType Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryType

type Rep HomeDirectoryType = D1 ('MetaData "HomeDirectoryType" "Amazonka.Transfer.Types.HomeDirectoryType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "HomeDirectoryType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromHomeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IdentityProviderType

newtype IdentityProviderType Source #

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

Instances

Instances details
FromJSON IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

FromJSONKey IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToJSON IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToJSONKey IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToByteString IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToHeader IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToLog IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToQuery IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

FromText IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToText IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

FromXML IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

ToXML IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

Generic IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

Associated Types

type Rep IdentityProviderType :: Type -> Type #

Read IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

Show IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

NFData IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

Methods

rnf :: IdentityProviderType -> () #

Eq IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

Ord IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

Hashable IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

type Rep IdentityProviderType Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderType

type Rep IdentityProviderType = D1 ('MetaData "IdentityProviderType" "Amazonka.Transfer.Types.IdentityProviderType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "IdentityProviderType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIdentityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MdnResponse

newtype MdnResponse Source #

Constructors

MdnResponse' 

Bundled Patterns

pattern MdnResponse_NONE :: MdnResponse 
pattern MdnResponse_SYNC :: MdnResponse 

Instances

Instances details
FromJSON MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

FromJSONKey MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToJSON MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToJSONKey MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToByteString MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToHeader MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToLog MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToQuery MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

FromText MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToText MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

Methods

toText :: MdnResponse -> Text #

FromXML MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

ToXML MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

Methods

toXML :: MdnResponse -> XML #

Generic MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

Associated Types

type Rep MdnResponse :: Type -> Type #

Read MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

Show MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

NFData MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

Methods

rnf :: MdnResponse -> () #

Eq MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

Ord MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

Hashable MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

type Rep MdnResponse Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnResponse

type Rep MdnResponse = D1 ('MetaData "MdnResponse" "Amazonka.Transfer.Types.MdnResponse" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "MdnResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMdnResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MdnSigningAlg

newtype MdnSigningAlg Source #

Constructors

MdnSigningAlg' 

Instances

Instances details
FromJSON MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

FromJSONKey MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToJSON MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToJSONKey MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToByteString MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToHeader MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToLog MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToQuery MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

FromText MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToText MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

Methods

toText :: MdnSigningAlg -> Text #

FromXML MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

ToXML MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

Methods

toXML :: MdnSigningAlg -> XML #

Generic MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

Associated Types

type Rep MdnSigningAlg :: Type -> Type #

Read MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

Show MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

NFData MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

Methods

rnf :: MdnSigningAlg -> () #

Eq MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

Ord MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

Hashable MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

type Rep MdnSigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.MdnSigningAlg

type Rep MdnSigningAlg = D1 ('MetaData "MdnSigningAlg" "Amazonka.Transfer.Types.MdnSigningAlg" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "MdnSigningAlg'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMdnSigningAlg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OverwriteExisting

newtype OverwriteExisting Source #

Instances

Instances details
FromJSON OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

FromJSONKey OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToJSON OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToJSONKey OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToByteString OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToHeader OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToLog OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToQuery OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

FromText OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToText OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

FromXML OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

ToXML OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

Generic OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

Associated Types

type Rep OverwriteExisting :: Type -> Type #

Read OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

Show OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

NFData OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

Methods

rnf :: OverwriteExisting -> () #

Eq OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

Ord OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

Hashable OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

type Rep OverwriteExisting Source # 
Instance details

Defined in Amazonka.Transfer.Types.OverwriteExisting

type Rep OverwriteExisting = D1 ('MetaData "OverwriteExisting" "Amazonka.Transfer.Types.OverwriteExisting" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "OverwriteExisting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOverwriteExisting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ProfileType

newtype ProfileType Source #

Constructors

ProfileType' 

Bundled Patterns

pattern ProfileType_LOCAL :: ProfileType 
pattern ProfileType_PARTNER :: ProfileType 

Instances

Instances details
FromJSON ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

FromJSONKey ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToJSON ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToJSONKey ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToByteString ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToHeader ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToLog ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToQuery ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

FromText ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToText ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

Methods

toText :: ProfileType -> Text #

FromXML ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

ToXML ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

Methods

toXML :: ProfileType -> XML #

Generic ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

Associated Types

type Rep ProfileType :: Type -> Type #

Read ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

Show ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

NFData ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

Methods

rnf :: ProfileType -> () #

Eq ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

Ord ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

Hashable ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

type Rep ProfileType Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProfileType

type Rep ProfileType = D1 ('MetaData "ProfileType" "Amazonka.Transfer.Types.ProfileType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "ProfileType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromProfileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Protocol

newtype Protocol Source #

Constructors

Protocol' 

Fields

Bundled Patterns

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

Instances

Instances details
FromJSON Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

FromJSONKey Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

ToJSON Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

ToJSONKey Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

ToByteString Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Methods

toBS :: Protocol -> ByteString #

ToHeader Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Methods

toHeader :: HeaderName -> Protocol -> [Header] #

ToLog Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

ToQuery Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

FromText Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

ToText Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Methods

toText :: Protocol -> Text #

FromXML Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

ToXML Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Methods

toXML :: Protocol -> XML #

Generic Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Associated Types

type Rep Protocol :: Type -> Type #

Methods

from :: Protocol -> Rep Protocol x #

to :: Rep Protocol x -> Protocol #

Read Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Show Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

NFData Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Methods

rnf :: Protocol -> () #

Eq Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Ord Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Hashable Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

Methods

hashWithSalt :: Int -> Protocol -> Int #

hash :: Protocol -> Int #

type Rep Protocol Source # 
Instance details

Defined in Amazonka.Transfer.Types.Protocol

type Rep Protocol = D1 ('MetaData "Protocol" "Amazonka.Transfer.Types.Protocol" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "Protocol'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SetStatOption

newtype SetStatOption Source #

Constructors

SetStatOption' 

Instances

Instances details
FromJSON SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

FromJSONKey SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToJSON SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToJSONKey SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToByteString SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToHeader SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToLog SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToQuery SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

FromText SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToText SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

Methods

toText :: SetStatOption -> Text #

FromXML SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

ToXML SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

Methods

toXML :: SetStatOption -> XML #

Generic SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

Associated Types

type Rep SetStatOption :: Type -> Type #

Read SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

Show SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

NFData SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

Methods

rnf :: SetStatOption -> () #

Eq SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

Ord SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

Hashable SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

type Rep SetStatOption Source # 
Instance details

Defined in Amazonka.Transfer.Types.SetStatOption

type Rep SetStatOption = D1 ('MetaData "SetStatOption" "Amazonka.Transfer.Types.SetStatOption" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "SetStatOption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSetStatOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SigningAlg

newtype SigningAlg Source #

Constructors

SigningAlg' 

Fields

Instances

Instances details
FromJSON SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

FromJSONKey SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToJSON SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToJSONKey SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToByteString SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToHeader SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToLog SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToQuery SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

FromText SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToText SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

Methods

toText :: SigningAlg -> Text #

FromXML SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

ToXML SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

Methods

toXML :: SigningAlg -> XML #

Generic SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

Associated Types

type Rep SigningAlg :: Type -> Type #

Read SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

Show SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

NFData SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

Methods

rnf :: SigningAlg -> () #

Eq SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

Ord SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

Hashable SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

type Rep SigningAlg Source # 
Instance details

Defined in Amazonka.Transfer.Types.SigningAlg

type Rep SigningAlg = D1 ('MetaData "SigningAlg" "Amazonka.Transfer.Types.SigningAlg" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "SigningAlg'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSigningAlg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

State

newtype State Source #

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

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

Constructors

State' 

Fields

Bundled Patterns

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

Instances

Instances details
FromJSON State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

FromJSONKey State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

ToJSON State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

ToJSONKey State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

ToByteString State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

toBS :: State -> ByteString #

ToHeader State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

toHeader :: HeaderName -> State -> [Header] #

ToLog State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

ToQuery State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

toQuery :: State -> QueryString #

FromText State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

ToText State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

toText :: State -> Text #

FromXML State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

parseXML :: [Node] -> Either String State #

ToXML State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

toXML :: State -> XML #

Generic State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Associated Types

type Rep State :: Type -> Type #

Methods

from :: State -> Rep State x #

to :: Rep State x -> State #

Read State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Show State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

showsPrec :: Int -> State -> ShowS #

show :: State -> String #

showList :: [State] -> ShowS #

NFData State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

rnf :: State -> () #

Eq State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

(==) :: State -> State -> Bool #

(/=) :: State -> State -> Bool #

Ord State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

compare :: State -> State -> Ordering #

(<) :: State -> State -> Bool #

(<=) :: State -> State -> Bool #

(>) :: State -> State -> Bool #

(>=) :: State -> State -> Bool #

max :: State -> State -> State #

min :: State -> State -> State #

Hashable State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

Methods

hashWithSalt :: Int -> State -> Int #

hash :: State -> Int #

type Rep State Source # 
Instance details

Defined in Amazonka.Transfer.Types.State

type Rep State = D1 ('MetaData "State" "Amazonka.Transfer.Types.State" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "State'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TlsSessionResumptionMode

newtype TlsSessionResumptionMode Source #

Instances

Instances details
FromJSON TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

FromJSONKey TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToJSON TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToJSONKey TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToByteString TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToHeader TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToLog TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToQuery TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

FromText TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToText TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

FromXML TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

ToXML TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

Generic TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

Associated Types

type Rep TlsSessionResumptionMode :: Type -> Type #

Read TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

Show TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

NFData TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

Eq TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

Ord TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

Hashable TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

type Rep TlsSessionResumptionMode Source # 
Instance details

Defined in Amazonka.Transfer.Types.TlsSessionResumptionMode

type Rep TlsSessionResumptionMode = D1 ('MetaData "TlsSessionResumptionMode" "Amazonka.Transfer.Types.TlsSessionResumptionMode" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "TlsSessionResumptionMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTlsSessionResumptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WorkflowStepType

newtype WorkflowStepType Source #

Instances

Instances details
FromJSON WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

FromJSONKey WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToJSON WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToJSONKey WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToByteString WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToHeader WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToLog WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToQuery WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

FromText WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToText WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

FromXML WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

ToXML WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

Generic WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

Associated Types

type Rep WorkflowStepType :: Type -> Type #

Read WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

Show WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

NFData WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

Methods

rnf :: WorkflowStepType -> () #

Eq WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

Ord WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

Hashable WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

type Rep WorkflowStepType Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStepType

type Rep WorkflowStepType = D1 ('MetaData "WorkflowStepType" "Amazonka.Transfer.Types.WorkflowStepType" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'True) (C1 ('MetaCons "WorkflowStepType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWorkflowStepType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

As2ConnectorConfig

data As2ConnectorConfig Source #

Contains the details for a connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.

See: newAs2ConnectorConfig smart constructor.

Instances

Instances details
FromJSON As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

ToJSON As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

Generic As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

Associated Types

type Rep As2ConnectorConfig :: Type -> Type #

Read As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

Show As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

NFData As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

Methods

rnf :: As2ConnectorConfig -> () #

Eq As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

Hashable As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

type Rep As2ConnectorConfig Source # 
Instance details

Defined in Amazonka.Transfer.Types.As2ConnectorConfig

type Rep As2ConnectorConfig = D1 ('MetaData "As2ConnectorConfig" "Amazonka.Transfer.Types.As2ConnectorConfig" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "As2ConnectorConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "compression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionEnum)) :*: S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlg))) :*: (S1 ('MetaSel ('Just "localProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mdnResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MdnResponse)))) :*: ((S1 ('MetaSel ('Just "mdnSigningAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MdnSigningAlg)) :*: S1 ('MetaSel ('Just "messageSubject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "partnerProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SigningAlg))))))

newAs2ConnectorConfig :: As2ConnectorConfig Source #

Create a value of As2ConnectorConfig with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:compression:As2ConnectorConfig', as2ConnectorConfig_compression - Specifies whether the AS2 file is compressed.

$sel:encryptionAlgorithm:As2ConnectorConfig', as2ConnectorConfig_encryptionAlgorithm - The algorithm that is used to encrypt the file.

$sel:localProfileId:As2ConnectorConfig', as2ConnectorConfig_localProfileId - A unique identifier for the AS2 local profile.

$sel:mdnResponse:As2ConnectorConfig', as2ConnectorConfig_mdnResponse - Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

  • SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
  • NONE: Specifies that no MDN response is required.

$sel:mdnSigningAlgorithm:As2ConnectorConfig', as2ConnectorConfig_mdnSigningAlgorithm - The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlogorithm is used.

$sel:messageSubject:As2ConnectorConfig', as2ConnectorConfig_messageSubject - Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

$sel:partnerProfileId:As2ConnectorConfig', as2ConnectorConfig_partnerProfileId - A unique identifier for the partner profile for the connector.

$sel:signingAlgorithm:As2ConnectorConfig', as2ConnectorConfig_signingAlgorithm - The algorithm that is used to sign the AS2 messages sent with the connector.

CopyStepDetails

data CopyStepDetails Source #

Each step type has its own StepDetails structure.

See: newCopyStepDetails smart constructor.

Instances

Instances details
FromJSON CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

ToJSON CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

Generic CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

Associated Types

type Rep CopyStepDetails :: Type -> Type #

Read CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

Show CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

NFData CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

rnf :: CopyStepDetails -> () #

Eq CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

Hashable CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

type Rep CopyStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CopyStepDetails

type Rep CopyStepDetails = D1 ('MetaData "CopyStepDetails" "Amazonka.Transfer.Types.CopyStepDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CopyStepDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "destinationFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFileLocation)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "overwriteExisting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OverwriteExisting)) :*: S1 ('MetaSel ('Just "sourceFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCopyStepDetails :: CopyStepDetails Source #

Create a value of CopyStepDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:destinationFileLocation:CopyStepDetails', copyStepDetails_destinationFileLocation - Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

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

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

$sel:sourceFileLocation:CopyStepDetails', copyStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
  • Enter ${original.file} to use the originally-uploaded file location as input for this step.

CustomStepDetails

data CustomStepDetails Source #

Each step type has its own StepDetails structure.

See: newCustomStepDetails smart constructor.

Instances

Instances details
FromJSON CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

ToJSON CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Generic CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Associated Types

type Rep CustomStepDetails :: Type -> Type #

Read CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Show CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

NFData CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Methods

rnf :: CustomStepDetails -> () #

Eq CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Hashable CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

type Rep CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

type Rep CustomStepDetails = D1 ('MetaData "CustomStepDetails" "Amazonka.Transfer.Types.CustomStepDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CustomStepDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newCustomStepDetails :: CustomStepDetails Source #

Create a value of CustomStepDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:sourceFileLocation:CustomStepDetails', customStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
  • Enter ${original.file} to use the originally-uploaded file location as input for this step.

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

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

DecryptStepDetails

data DecryptStepDetails Source #

See: newDecryptStepDetails smart constructor.

Instances

Instances details
FromJSON DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

ToJSON DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

Generic DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

Associated Types

type Rep DecryptStepDetails :: Type -> Type #

Read DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

Show DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

NFData DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

Methods

rnf :: DecryptStepDetails -> () #

Eq DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

Hashable DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

type Rep DecryptStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DecryptStepDetails

type Rep DecryptStepDetails = D1 ('MetaData "DecryptStepDetails" "Amazonka.Transfer.Types.DecryptStepDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DecryptStepDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "overwriteExisting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OverwriteExisting))) :*: (S1 ('MetaSel ('Just "sourceFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionType) :*: S1 ('MetaSel ('Just "destinationFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputFileLocation)))))

DeleteStepDetails

data DeleteStepDetails Source #

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

See: newDeleteStepDetails smart constructor.

Instances

Instances details
FromJSON DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

ToJSON DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

Generic DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

Associated Types

type Rep DeleteStepDetails :: Type -> Type #

Read DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

Show DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

NFData DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

Methods

rnf :: DeleteStepDetails -> () #

Eq DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

Hashable DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

type Rep DeleteStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.DeleteStepDetails

type Rep DeleteStepDetails = D1 ('MetaData "DeleteStepDetails" "Amazonka.Transfer.Types.DeleteStepDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteStepDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDeleteStepDetails :: DeleteStepDetails Source #

Create a value of DeleteStepDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:sourceFileLocation:DeleteStepDetails', deleteStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
  • Enter ${original.file} to use the originally-uploaded file location as input for this step.

DescribedAccess

data DescribedAccess Source #

Describes the properties of the access that was specified.

See: newDescribedAccess smart constructor.

Instances

Instances details
FromJSON DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

Generic DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

Associated Types

type Rep DescribedAccess :: Type -> Type #

Read DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

Show DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

NFData DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

Methods

rnf :: DescribedAccess -> () #

Eq DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

Hashable DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

type Rep DescribedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAccess

newDescribedAccess :: DescribedAccess Source #

Create a value of DescribedAccess with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

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

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

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

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

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

DescribedAgreement

data DescribedAgreement Source #

Describes the properties of an agreement.

See: newDescribedAgreement smart constructor.

Instances

Instances details
FromJSON DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

Generic DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

Associated Types

type Rep DescribedAgreement :: Type -> Type #

Read DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

Show DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

NFData DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

Methods

rnf :: DescribedAgreement -> () #

Eq DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

Hashable DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

type Rep DescribedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedAgreement

newDescribedAgreement Source #

Create a value of DescribedAgreement with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessRole:DescribedAgreement', describedAgreement_accessRole - With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

$sel:agreementId:DescribedAgreement', describedAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

$sel:baseDirectory:DescribedAgreement', describedAgreement_baseDirectory - The landing directory (folder) for files that are transferred by using the AS2 protocol.

$sel:description:DescribedAgreement', describedAgreement_description - The name or short description that's used to identify the agreement.

$sel:localProfileId:DescribedAgreement', describedAgreement_localProfileId - A unique identifier for the AS2 local profile.

$sel:partnerProfileId:DescribedAgreement', describedAgreement_partnerProfileId - A unique identifier for the partner profile used in the agreement.

$sel:serverId:DescribedAgreement', describedAgreement_serverId - A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

$sel:status:DescribedAgreement', describedAgreement_status - The current status of the agreement, either ACTIVE or INACTIVE.

$sel:tags:DescribedAgreement', describedAgreement_tags - Key-value pairs that can be used to group and search for agreements.

$sel:arn:DescribedAgreement', describedAgreement_arn - The unique Amazon Resource Name (ARN) for the agreement.

DescribedCertificate

data DescribedCertificate Source #

Describes the properties of a certificate.

See: newDescribedCertificate smart constructor.

Instances

Instances details
FromJSON DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Generic DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Associated Types

type Rep DescribedCertificate :: Type -> Type #

Show DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

NFData DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Methods

rnf :: DescribedCertificate -> () #

Eq DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

Hashable DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

type Rep DescribedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedCertificate

type Rep DescribedCertificate = D1 ('MetaData "DescribedCertificate" "Amazonka.Transfer.Types.DescribedCertificate" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedCertificate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "activeDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "certificateChain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "certificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inactiveDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "notAfterDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "notBeforeDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "serial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateStatusType)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateType))) :*: (S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateUsageType)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribedCertificate Source #

Create a value of DescribedCertificate with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activeDate:DescribedCertificate', describedCertificate_activeDate - An optional date that specifies when the certificate becomes active.

$sel:certificate:DescribedCertificate', describedCertificate_certificate - The file name for the certificate.

$sel:certificateChain:DescribedCertificate', describedCertificate_certificateChain - The list of certificates that make up the chain for the certificate.

$sel:certificateId:DescribedCertificate', describedCertificate_certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

$sel:description:DescribedCertificate', describedCertificate_description - The name or description that's used to identity the certificate.

$sel:inactiveDate:DescribedCertificate', describedCertificate_inactiveDate - An optional date that specifies when the certificate becomes inactive.

$sel:notAfterDate:DescribedCertificate', describedCertificate_notAfterDate - The final date that the certificate is valid.

$sel:notBeforeDate:DescribedCertificate', describedCertificate_notBeforeDate - The earliest date that the certificate is valid.

$sel:serial:DescribedCertificate', describedCertificate_serial - The serial number for the certificate.

$sel:status:DescribedCertificate', describedCertificate_status - The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

$sel:tags:DescribedCertificate', describedCertificate_tags - Key-value pairs that can be used to group and search for certificates.

$sel:type':DescribedCertificate', describedCertificate_type - If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

$sel:usage:DescribedCertificate', describedCertificate_usage - Specifies whether this certificate is used for signing or encryption.

$sel:arn:DescribedCertificate', describedCertificate_arn - The unique Amazon Resource Name (ARN) for the certificate.

DescribedConnector

data DescribedConnector Source #

Describes the parameters for the connector, as identified by the ConnectorId.

See: newDescribedConnector smart constructor.

Instances

Instances details
FromJSON DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

Generic DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

Associated Types

type Rep DescribedConnector :: Type -> Type #

Read DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

Show DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

NFData DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

Methods

rnf :: DescribedConnector -> () #

Eq DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

Hashable DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

type Rep DescribedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedConnector

newDescribedConnector Source #

Create a value of DescribedConnector with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessRole:DescribedConnector', describedConnector_accessRole - With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

$sel:as2Config:DescribedConnector', describedConnector_as2Config - A structure that contains the parameters for a connector object.

$sel:connectorId:DescribedConnector', describedConnector_connectorId - The unique identifier for the connector.

$sel:loggingRole:DescribedConnector', describedConnector_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

$sel:tags:DescribedConnector', describedConnector_tags - Key-value pairs that can be used to group and search for connectors.

$sel:url:DescribedConnector', describedConnector_url - The URL of the partner's AS2 endpoint.

$sel:arn:DescribedConnector', describedConnector_arn - The unique Amazon Resource Name (ARN) for the connector.

DescribedExecution

data DescribedExecution Source #

The details for an execution object.

See: newDescribedExecution smart constructor.

Instances

Instances details
FromJSON DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

Generic DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

Associated Types

type Rep DescribedExecution :: Type -> Type #

Read DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

Show DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

NFData DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

Methods

rnf :: DescribedExecution -> () #

Eq DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

Hashable DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

type Rep DescribedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedExecution

newDescribedExecution :: DescribedExecution Source #

Create a value of DescribedExecution with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

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

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

$sel:status:DescribedExecution', describedExecution_status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

DescribedHostKey

data DescribedHostKey Source #

The details for a server host key.

See: newDescribedHostKey smart constructor.

Instances

Instances details
FromJSON DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

Generic DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

Associated Types

type Rep DescribedHostKey :: Type -> Type #

Read DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

Show DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

NFData DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

Methods

rnf :: DescribedHostKey -> () #

Eq DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

Hashable DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

type Rep DescribedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedHostKey

type Rep DescribedHostKey = D1 ('MetaData "DescribedHostKey" "Amazonka.Transfer.Types.DescribedHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedHostKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dateImported") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hostKeyFingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "hostKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedHostKey Source #

Create a value of DescribedHostKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dateImported:DescribedHostKey', describedHostKey_dateImported - The date on which the host key was added to the server.

$sel:description:DescribedHostKey', describedHostKey_description - The text description for this host key.

$sel:hostKeyFingerprint:DescribedHostKey', describedHostKey_hostKeyFingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

$sel:hostKeyId:DescribedHostKey', describedHostKey_hostKeyId - A unique identifier for the host key.

$sel:tags:DescribedHostKey', describedHostKey_tags - Key-value pairs that can be used to group and search for host keys.

$sel:type':DescribedHostKey', describedHostKey_type - The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

  • ssh-rsa
  • ssh-ed25519
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521

$sel:arn:DescribedHostKey', describedHostKey_arn - The unique Amazon Resource Name (ARN) for the host key.

DescribedProfile

data DescribedProfile Source #

The details for a local or partner AS2 profile.

See: newDescribedProfile smart constructor.

Instances

Instances details
FromJSON DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

Generic DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

Associated Types

type Rep DescribedProfile :: Type -> Type #

Read DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

Show DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

NFData DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

Methods

rnf :: DescribedProfile -> () #

Eq DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

Hashable DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

type Rep DescribedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedProfile

type Rep DescribedProfile = D1 ('MetaData "DescribedProfile" "Amazonka.Transfer.Types.DescribedProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "as2Id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "certificateIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "profileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileType)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedProfile Source #

Create a value of DescribedProfile with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:as2Id:DescribedProfile', describedProfile_as2Id - The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

$sel:certificateIds:DescribedProfile', describedProfile_certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

$sel:profileId:DescribedProfile', describedProfile_profileId - A unique identifier for the local or partner AS2 profile.

$sel:profileType:DescribedProfile', describedProfile_profileType - Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

$sel:tags:DescribedProfile', describedProfile_tags - Key-value pairs that can be used to group and search for profiles.

$sel:arn:DescribedProfile', describedProfile_arn - The unique Amazon Resource Name (ARN) for the profile.

DescribedSecurityPolicy

data DescribedSecurityPolicy Source #

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

See: newDescribedSecurityPolicy smart constructor.

Instances

Instances details
FromJSON DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

Generic DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

Associated Types

type Rep DescribedSecurityPolicy :: Type -> Type #

Read DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

Show DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

NFData DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

Methods

rnf :: DescribedSecurityPolicy -> () #

Eq DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

Hashable DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

type Rep DescribedSecurityPolicy Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedSecurityPolicy

type Rep DescribedSecurityPolicy = D1 ('MetaData "DescribedSecurityPolicy" "Amazonka.Transfer.Types.DescribedSecurityPolicy" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedSecurityPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fips") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sshCiphers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sshKexs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "sshMacs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "tlsCiphers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedSecurityPolicy Source #

Create a value of DescribedSecurityPolicy with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fips:DescribedSecurityPolicy', describedSecurityPolicy_fips - Specifies whether this policy enables Federal Information Processing Standards (FIPS).

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

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

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

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

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

DescribedServer

data DescribedServer Source #

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

See: newDescribedServer smart constructor.

Instances

Instances details
FromJSON DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

Generic DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

Associated Types

type Rep DescribedServer :: Type -> Type #

Read DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

Show DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

NFData DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

Methods

rnf :: DescribedServer -> () #

Eq DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

Hashable DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

type Rep DescribedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedServer

type Rep DescribedServer = D1 ('MetaData "DescribedServer" "Amazonka.Transfer.Types.DescribedServer" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedServer'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain))) :*: (S1 ('MetaSel ('Just "endpointDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDetails)) :*: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType)))) :*: ((S1 ('MetaSel ('Just "hostKeyFingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderDetails))) :*: (S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderType)) :*: (S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "postAuthenticationLoginBanner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "preAuthenticationLoginBanner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "protocolDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolDetails))) :*: (S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol))) :*: (S1 ('MetaSel ('Just "securityPolicyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "userCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "workflowDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowDetails)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newDescribedServer Source #

Create a value of DescribedServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

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

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

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

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

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter or the IdentityProviderDetails data type.

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

$sel:postAuthenticationLoginBanner:DescribedServer', describedServer_postAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

$sel:preAuthenticationLoginBanner:DescribedServer', describedServer_preAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

$sel:protocolDetails:DescribedServer', describedServer_protocolDetails - The protocol settings that are configured for your server.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.
  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

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

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
  • FTP (File Transfer Protocol): Unencrypted file transfer
  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data
  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.
  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.
  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

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

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

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

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

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

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

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

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

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

DescribedUser

data DescribedUser Source #

Describes the properties of a user that was specified.

See: newDescribedUser smart constructor.

Instances

Instances details
FromJSON DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

Generic DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

Associated Types

type Rep DescribedUser :: Type -> Type #

Read DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

Show DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

NFData DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

Methods

rnf :: DescribedUser -> () #

Eq DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

Hashable DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

type Rep DescribedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedUser

newDescribedUser Source #

Create a value of DescribedUser with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

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

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

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

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

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

$sel:sshPublicKeys:DescribedUser', describedUser_sshPublicKeys - Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

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

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

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

DescribedWorkflow

data DescribedWorkflow Source #

Describes the properties of the specified workflow

See: newDescribedWorkflow smart constructor.

Instances

Instances details
FromJSON DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

Generic DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

Associated Types

type Rep DescribedWorkflow :: Type -> Type #

Read DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

Show DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

NFData DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

Methods

rnf :: DescribedWorkflow -> () #

Eq DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

Hashable DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

type Rep DescribedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.DescribedWorkflow

type Rep DescribedWorkflow = D1 ('MetaData "DescribedWorkflow" "Amazonka.Transfer.Types.DescribedWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedWorkflow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep])) :*: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep])))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedWorkflow Source #

Create a value of DescribedWorkflow with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:onExceptionSteps:DescribedWorkflow', describedWorkflow_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

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

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

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

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

EfsFileLocation

data EfsFileLocation Source #

Reserved for future use.

See: newEfsFileLocation smart constructor.

Instances

Instances details
FromJSON EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

ToJSON EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

Generic EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

Associated Types

type Rep EfsFileLocation :: Type -> Type #

Read EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

Show EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

NFData EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

Methods

rnf :: EfsFileLocation -> () #

Eq EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

Hashable EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

type Rep EfsFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.EfsFileLocation

type Rep EfsFileLocation = D1 ('MetaData "EfsFileLocation" "Amazonka.Transfer.Types.EfsFileLocation" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "EfsFileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEfsFileLocation :: EfsFileLocation Source #

Create a value of EfsFileLocation with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:path:EfsFileLocation', efsFileLocation_path - The pathname for the folder being used by a workflow.

EndpointDetails

data EndpointDetails Source #

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

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

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

See: newEndpointDetails smart constructor.

Instances

Instances details
FromJSON EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

ToJSON EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

Generic EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

Associated Types

type Rep EndpointDetails :: Type -> Type #

Read EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

Show EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

NFData EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

Methods

rnf :: EndpointDetails -> () #

Eq EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

Hashable EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

type Rep EndpointDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.EndpointDetails

type Rep EndpointDetails = D1 ('MetaData "EndpointDetails" "Amazonka.Transfer.Types.EndpointDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "EndpointDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "addressAllocationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "vpcEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEndpointDetails :: EndpointDetails Source #

Create a value of EndpointDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

$sel:securityGroupIds:EndpointDetails', endpointDetails_securityGroupIds - A list of security groups IDs that are available to attach to your server's endpoint.

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

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

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

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

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

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

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

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

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

ExecutionError

data ExecutionError Source #

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

See: newExecutionError smart constructor.

Instances

Instances details
FromJSON ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

Generic ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

Associated Types

type Rep ExecutionError :: Type -> Type #

Read ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

Show ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

NFData ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

Methods

rnf :: ExecutionError -> () #

Eq ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

Hashable ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

type Rep ExecutionError Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionError

type Rep ExecutionError = D1 ('MetaData "ExecutionError" "Amazonka.Transfer.Types.ExecutionError" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ExecutionError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutionErrorType) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newExecutionError Source #

Create a value of ExecutionError with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:type':ExecutionError', executionError_type - Specifies the error type.

  • ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.
  • BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.
  • CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.
  • INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.
  • NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.
  • PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.
  • TIMEOUT: occurs when the execution times out.

    You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

  • THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

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

ExecutionResults

data ExecutionResults Source #

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

See: newExecutionResults smart constructor.

Instances

Instances details
FromJSON ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

Generic ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

Associated Types

type Rep ExecutionResults :: Type -> Type #

Read ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

Show ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

NFData ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

Methods

rnf :: ExecutionResults -> () #

Eq ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

Hashable ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

type Rep ExecutionResults Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionResults

type Rep ExecutionResults = D1 ('MetaData "ExecutionResults" "Amazonka.Transfer.Types.ExecutionResults" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ExecutionResults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExecutionStepResult))) :*: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExecutionStepResult)))))

newExecutionResults :: ExecutionResults Source #

Create a value of ExecutionResults with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:onExceptionSteps:ExecutionResults', executionResults_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

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

ExecutionStepResult

data ExecutionStepResult Source #

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

See: newExecutionStepResult smart constructor.

Instances

Instances details
FromJSON ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

Generic ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

Associated Types

type Rep ExecutionStepResult :: Type -> Type #

Read ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

Show ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

NFData ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

Methods

rnf :: ExecutionStepResult -> () #

Eq ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

Hashable ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

type Rep ExecutionStepResult Source # 
Instance details

Defined in Amazonka.Transfer.Types.ExecutionStepResult

type Rep ExecutionStepResult = D1 ('MetaData "ExecutionStepResult" "Amazonka.Transfer.Types.ExecutionStepResult" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ExecutionStepResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionError)) :*: (S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stepType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowStepType)))))

newExecutionStepResult :: ExecutionStepResult Source #

Create a value of ExecutionStepResult with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

$sel:stepType:ExecutionStepResult', executionStepResult_stepType - One of the available step types.

  • COPY: Copy the file to another location.
  • CUSTOM: Perform a custom step with an Lambda function target.
  • DELETE: Delete the file.
  • TAG: Add a tag to the file.

FileLocation

data FileLocation Source #

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

See: newFileLocation smart constructor.

Instances

Instances details
FromJSON FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

Generic FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

Associated Types

type Rep FileLocation :: Type -> Type #

Read FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

Show FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

NFData FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

Methods

rnf :: FileLocation -> () #

Eq FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

Hashable FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

type Rep FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.FileLocation

type Rep FileLocation = D1 ('MetaData "FileLocation" "Amazonka.Transfer.Types.FileLocation" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "FileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "efsFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EfsFileLocation)) :*: S1 ('MetaSel ('Just "s3FileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3FileLocation))))

newFileLocation :: FileLocation Source #

Create a value of FileLocation with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:efsFileLocation:FileLocation', fileLocation_efsFileLocation - Specifies the Amazon EFS identifier and the path for the file being used.

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

HomeDirectoryMapEntry

data HomeDirectoryMapEntry Source #

Represents an object that contains entries and targets for HomeDirectoryMappings.

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

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

See: newHomeDirectoryMapEntry smart constructor.

Instances

Instances details
FromJSON HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

ToJSON HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

Generic HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

Associated Types

type Rep HomeDirectoryMapEntry :: Type -> Type #

Read HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

Show HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

NFData HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

Methods

rnf :: HomeDirectoryMapEntry -> () #

Eq HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

Hashable HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

type Rep HomeDirectoryMapEntry Source # 
Instance details

Defined in Amazonka.Transfer.Types.HomeDirectoryMapEntry

type Rep HomeDirectoryMapEntry = D1 ('MetaData "HomeDirectoryMapEntry" "Amazonka.Transfer.Types.HomeDirectoryMapEntry" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "HomeDirectoryMapEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newHomeDirectoryMapEntry Source #

Create a value of HomeDirectoryMapEntry with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entry:HomeDirectoryMapEntry', homeDirectoryMapEntry_entry - Represents an entry for HomeDirectoryMappings.

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

IdentityProviderDetails

data IdentityProviderDetails Source #

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

See: newIdentityProviderDetails smart constructor.

Instances

Instances details
FromJSON IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

ToJSON IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

Generic IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

Associated Types

type Rep IdentityProviderDetails :: Type -> Type #

Read IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

Show IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

NFData IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

Methods

rnf :: IdentityProviderDetails -> () #

Eq IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

Hashable IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

type Rep IdentityProviderDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.IdentityProviderDetails

type Rep IdentityProviderDetails = D1 ('MetaData "IdentityProviderDetails" "Amazonka.Transfer.Types.IdentityProviderDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "IdentityProviderDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "invocationRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newIdentityProviderDetails :: IdentityProviderDetails Source #

Create a value of IdentityProviderDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:function:IdentityProviderDetails', identityProviderDetails_function - The ARN for a lambda function to use for the Identity provider.

$sel:invocationRole:IdentityProviderDetails', identityProviderDetails_invocationRole - Provides the type of InvocationRole used to authenticate the user account.

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

InputFileLocation

data InputFileLocation Source #

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

See: newInputFileLocation smart constructor.

Instances

Instances details
FromJSON InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

ToJSON InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

Generic InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

Associated Types

type Rep InputFileLocation :: Type -> Type #

Read InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

Show InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

NFData InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

Methods

rnf :: InputFileLocation -> () #

Eq InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

Hashable InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

type Rep InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.InputFileLocation

type Rep InputFileLocation = D1 ('MetaData "InputFileLocation" "Amazonka.Transfer.Types.InputFileLocation" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "InputFileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "efsFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EfsFileLocation)) :*: S1 ('MetaSel ('Just "s3FileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3InputFileLocation))))

newInputFileLocation :: InputFileLocation Source #

Create a value of InputFileLocation with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:efsFileLocation:InputFileLocation', inputFileLocation_efsFileLocation - Reserved for future use.

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

ListedAccess

data ListedAccess Source #

Lists the properties for one or more specified associated accesses.

See: newListedAccess smart constructor.

Instances

Instances details
FromJSON ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

Generic ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

Associated Types

type Rep ListedAccess :: Type -> Type #

Read ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

Show ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

NFData ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

Methods

rnf :: ListedAccess -> () #

Eq ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

Hashable ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

type Rep ListedAccess Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAccess

type Rep ListedAccess = D1 ('MetaData "ListedAccess" "Amazonka.Transfer.Types.ListedAccess" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedAccess'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :*: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListedAccess :: ListedAccess Source #

Create a value of ListedAccess with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

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

ListedAgreement

data ListedAgreement Source #

Describes the properties of an agreement.

See: newListedAgreement smart constructor.

Instances

Instances details
FromJSON ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

Generic ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

Associated Types

type Rep ListedAgreement :: Type -> Type #

Read ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

Show ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

NFData ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

Methods

rnf :: ListedAgreement -> () #

Eq ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

Hashable ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

type Rep ListedAgreement Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedAgreement

newListedAgreement :: ListedAgreement Source #

Create a value of ListedAgreement with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agreementId:ListedAgreement', listedAgreement_agreementId - A unique identifier for the agreement. This identifier is returned when you create an agreement.

$sel:arn:ListedAgreement', listedAgreement_arn - The Amazon Resource Name (ARN) of the specified agreement.

$sel:description:ListedAgreement', listedAgreement_description - The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

$sel:localProfileId:ListedAgreement', listedAgreement_localProfileId - A unique identifier for the AS2 local profile.

$sel:partnerProfileId:ListedAgreement', listedAgreement_partnerProfileId - A unique identifier for the partner profile.

$sel:serverId:ListedAgreement', listedAgreement_serverId - The unique identifier for the agreement.

$sel:status:ListedAgreement', listedAgreement_status - The agreement can be either ACTIVE or INACTIVE.

ListedCertificate

data ListedCertificate Source #

Describes the properties of a certificate.

See: newListedCertificate smart constructor.

Instances

Instances details
FromJSON ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

Generic ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

Associated Types

type Rep ListedCertificate :: Type -> Type #

Read ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

Show ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

NFData ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

Methods

rnf :: ListedCertificate -> () #

Eq ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

Hashable ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

type Rep ListedCertificate Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedCertificate

newListedCertificate :: ListedCertificate Source #

Create a value of ListedCertificate with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activeDate:ListedCertificate', listedCertificate_activeDate - An optional date that specifies when the certificate becomes active.

$sel:arn:ListedCertificate', listedCertificate_arn - The Amazon Resource Name (ARN) of the specified certificate.

$sel:certificateId:ListedCertificate', listedCertificate_certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

$sel:description:ListedCertificate', listedCertificate_description - The name or short description that's used to identify the certificate.

$sel:inactiveDate:ListedCertificate', listedCertificate_inactiveDate - An optional date that specifies when the certificate becomes inactive.

$sel:status:ListedCertificate', listedCertificate_status - The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

$sel:type':ListedCertificate', listedCertificate_type - The type for the certificate. If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

$sel:usage:ListedCertificate', listedCertificate_usage - Specifies whether this certificate is used for signing or encryption.

ListedConnector

data ListedConnector Source #

Returns details of the connector that is specified.

See: newListedConnector smart constructor.

Instances

Instances details
FromJSON ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

Generic ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

Associated Types

type Rep ListedConnector :: Type -> Type #

Read ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

Show ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

NFData ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

Methods

rnf :: ListedConnector -> () #

Eq ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

Hashable ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

type Rep ListedConnector Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedConnector

type Rep ListedConnector = D1 ('MetaData "ListedConnector" "Amazonka.Transfer.Types.ListedConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedConnector'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListedConnector :: ListedConnector Source #

Create a value of ListedConnector with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:ListedConnector', listedConnector_arn - The Amazon Resource Name (ARN) of the specified connector.

$sel:connectorId:ListedConnector', listedConnector_connectorId - The unique identifier for the connector.

$sel:url:ListedConnector', listedConnector_url - The URL of the partner's AS2 endpoint.

ListedExecution

data ListedExecution Source #

Returns properties of the execution that is specified.

See: newListedExecution smart constructor.

Instances

Instances details
FromJSON ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

Generic ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

Associated Types

type Rep ListedExecution :: Type -> Type #

Read ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

Show ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

NFData ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

Methods

rnf :: ListedExecution -> () #

Eq ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

Hashable ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

type Rep ListedExecution Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedExecution

type Rep ListedExecution = D1 ('MetaData "ListedExecution" "Amazonka.Transfer.Types.ListedExecution" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "initialFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileLocation))) :*: (S1 ('MetaSel ('Just "serviceMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceMetadata)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus)))))

newListedExecution :: ListedExecution Source #

Create a value of ListedExecution with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

$sel:status:ListedExecution', listedExecution_status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

ListedHostKey

data ListedHostKey Source #

Returns properties of the host key that's specified.

See: newListedHostKey smart constructor.

Instances

Instances details
FromJSON ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

Generic ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

Associated Types

type Rep ListedHostKey :: Type -> Type #

Read ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

Show ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

NFData ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

Methods

rnf :: ListedHostKey -> () #

Eq ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

Hashable ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

type Rep ListedHostKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedHostKey

type Rep ListedHostKey = D1 ('MetaData "ListedHostKey" "Amazonka.Transfer.Types.ListedHostKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedHostKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dateImported") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hostKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListedHostKey Source #

Create a value of ListedHostKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dateImported:ListedHostKey', listedHostKey_dateImported - The date on which the host key was added to the server.

$sel:description:ListedHostKey', listedHostKey_description - The current description for the host key. You can change it by calling the UpdateHostKey operation and providing a new description.

$sel:fingerprint:ListedHostKey', listedHostKey_fingerprint - The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

$sel:hostKeyId:ListedHostKey', listedHostKey_hostKeyId - A unique identifier for the host key.

$sel:type':ListedHostKey', listedHostKey_type - The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

  • ssh-rsa
  • ssh-ed25519
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521

$sel:arn:ListedHostKey', listedHostKey_arn - The unique Amazon Resource Name (ARN) of the host key.

ListedProfile

data ListedProfile Source #

Returns the properties of the profile that was specified.

See: newListedProfile smart constructor.

Instances

Instances details
FromJSON ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Generic ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Associated Types

type Rep ListedProfile :: Type -> Type #

Read ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Show ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

NFData ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Methods

rnf :: ListedProfile -> () #

Eq ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Hashable ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

type Rep ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

type Rep ListedProfile = D1 ('MetaData "ListedProfile" "Amazonka.Transfer.Types.ListedProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "as2Id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "profileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileType)))))

newListedProfile :: ListedProfile Source #

Create a value of ListedProfile with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:ListedProfile', listedProfile_arn - The Amazon Resource Name (ARN) of the specified profile.

$sel:as2Id:ListedProfile', listedProfile_as2Id - The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

$sel:profileId:ListedProfile', listedProfile_profileId - A unique identifier for the local or partner AS2 profile.

$sel:profileType:ListedProfile', listedProfile_profileType - Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

ListedServer

data ListedServer Source #

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

See: newListedServer smart constructor.

Instances

Instances details
FromJSON ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

Generic ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

Associated Types

type Rep ListedServer :: Type -> Type #

Read ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

Show ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

NFData ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

Methods

rnf :: ListedServer -> () #

Eq ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

Hashable ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

type Rep ListedServer Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedServer

newListedServer Source #

Create a value of ListedServer with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter or the IdentityProviderDetails data type.

$sel:loggingRole:ListedServer', listedServer_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

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

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

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

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

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

ListedUser

data ListedUser Source #

Returns properties of the user that you specify.

See: newListedUser smart constructor.

Instances

Instances details
FromJSON ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

Generic ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

Associated Types

type Rep ListedUser :: Type -> Type #

Read ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

Show ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

NFData ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

Methods

rnf :: ListedUser -> () #

Eq ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

Hashable ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

type Rep ListedUser Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedUser

type Rep ListedUser = D1 ('MetaData "ListedUser" "Amazonka.Transfer.Types.ListedUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "homeDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "homeDirectoryType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HomeDirectoryType)) :*: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "sshPublicKeyCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListedUser Source #

Create a value of ListedUser with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

A HomeDirectory example is /bucket_name/home/mydirectory.

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

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

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

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

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

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

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

ListedWorkflow

data ListedWorkflow Source #

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

See: newListedWorkflow smart constructor.

Instances

Instances details
FromJSON ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

Generic ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

Associated Types

type Rep ListedWorkflow :: Type -> Type #

Read ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

Show ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

NFData ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

Methods

rnf :: ListedWorkflow -> () #

Eq ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

Hashable ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

type Rep ListedWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedWorkflow

type Rep ListedWorkflow = D1 ('MetaData "ListedWorkflow" "Amazonka.Transfer.Types.ListedWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedWorkflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListedWorkflow :: ListedWorkflow Source #

Create a value of ListedWorkflow with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

LoggingConfiguration

data LoggingConfiguration Source #

Consists of the logging role and the log group name.

See: newLoggingConfiguration smart constructor.

Instances

Instances details
FromJSON LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

Generic LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

Associated Types

type Rep LoggingConfiguration :: Type -> Type #

Read LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

Show LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

NFData LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

Methods

rnf :: LoggingConfiguration -> () #

Eq LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

Hashable LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

type Rep LoggingConfiguration Source # 
Instance details

Defined in Amazonka.Transfer.Types.LoggingConfiguration

type Rep LoggingConfiguration = D1 ('MetaData "LoggingConfiguration" "Amazonka.Transfer.Types.LoggingConfiguration" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "LoggingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newLoggingConfiguration :: LoggingConfiguration Source #

Create a value of LoggingConfiguration with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:loggingRole:LoggingConfiguration', loggingConfiguration_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

PosixProfile

data PosixProfile Source #

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

See: newPosixProfile smart constructor.

Instances

Instances details
FromJSON PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

ToJSON PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

Generic PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

Associated Types

type Rep PosixProfile :: Type -> Type #

Read PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

Show PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

NFData PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

Methods

rnf :: PosixProfile -> () #

Eq PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

Hashable PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

type Rep PosixProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.PosixProfile

type Rep PosixProfile = D1 ('MetaData "PosixProfile" "Amazonka.Transfer.Types.PosixProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "PosixProfile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secondaryGids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural])) :*: (S1 ('MetaSel ('Just "uid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "gid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newPosixProfile Source #

Create a value of PosixProfile with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:secondaryGids:PosixProfile', posixProfile_secondaryGids - The secondary POSIX group IDs used for all EFS operations by this user.

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

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

ProtocolDetails

data ProtocolDetails Source #

The protocol settings that are configured for your server.

See: newProtocolDetails smart constructor.

Instances

Instances details
FromJSON ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

ToJSON ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

Generic ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

Associated Types

type Rep ProtocolDetails :: Type -> Type #

Read ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

Show ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

NFData ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

rnf :: ProtocolDetails -> () #

Eq ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

Hashable ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

type Rep ProtocolDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.ProtocolDetails

type Rep ProtocolDetails = D1 ('MetaData "ProtocolDetails" "Amazonka.Transfer.Types.ProtocolDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ProtocolDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "as2Transports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty As2Transport))) :*: S1 ('MetaSel ('Just "passiveIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "setStatOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SetStatOption)) :*: S1 ('MetaSel ('Just "tlsSessionResumptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsSessionResumptionMode)))))

newProtocolDetails :: ProtocolDetails Source #

Create a value of ProtocolDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:as2Transports:ProtocolDetails', protocolDetails_as2Transports - Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

$sel:passiveIp:ProtocolDetails', protocolDetails_passiveIp - Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:

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

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

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

Special values

The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The value PassiveIp=AUTO is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the PassiveIp parameter. This reduces the effectiveness of having High Availability. In this case, you can specify PassiveIp=0.0.0.0. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the PassiveIp=0.0.0.0 response.

$sel:setStatOption:ProtocolDetails', protocolDetails_setStatOption - Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.

Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.

Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. While the SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.

$sel:tlsSessionResumptionMode:ProtocolDetails', protocolDetails_tlsSessionResumptionMode - A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls. If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

  • DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.
  • ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.
  • ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to ENFORCED, test your clients.

    Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the ENFORCED value, you need to test your clients.

S3FileLocation

data S3FileLocation Source #

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

See: newS3FileLocation smart constructor.

Instances

Instances details
FromJSON S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

Generic S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

Associated Types

type Rep S3FileLocation :: Type -> Type #

Read S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

Show S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

NFData S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

Methods

rnf :: S3FileLocation -> () #

Eq S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

Hashable S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

type Rep S3FileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3FileLocation

type Rep S3FileLocation = D1 ('MetaData "S3FileLocation" "Amazonka.Transfer.Types.S3FileLocation" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "S3FileLocation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "etag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newS3FileLocation :: S3FileLocation Source #

Create a value of S3FileLocation with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

$sel:versionId:S3FileLocation', s3FileLocation_versionId - Specifies the file version.

S3InputFileLocation

data S3InputFileLocation Source #

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

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

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

See: newS3InputFileLocation smart constructor.

Instances

Instances details
FromJSON S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

ToJSON S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

Generic S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

Associated Types

type Rep S3InputFileLocation :: Type -> Type #

Read S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

Show S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

NFData S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

Methods

rnf :: S3InputFileLocation -> () #

Eq S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

Hashable S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

type Rep S3InputFileLocation Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3InputFileLocation

type Rep S3InputFileLocation = D1 ('MetaData "S3InputFileLocation" "Amazonka.Transfer.Types.S3InputFileLocation" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "S3InputFileLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newS3InputFileLocation :: S3InputFileLocation Source #

Create a value of S3InputFileLocation with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bucket:S3InputFileLocation', s3InputFileLocation_bucket - Specifies the S3 bucket for the customer input file.

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

S3Tag

data S3Tag Source #

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

See: newS3Tag smart constructor.

Constructors

S3Tag' Text Text 

Instances

Instances details
FromJSON S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

ToJSON S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

Generic S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

Associated Types

type Rep S3Tag :: Type -> Type #

Methods

from :: S3Tag -> Rep S3Tag x #

to :: Rep S3Tag x -> S3Tag #

Read S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

Show S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

Methods

showsPrec :: Int -> S3Tag -> ShowS #

show :: S3Tag -> String #

showList :: [S3Tag] -> ShowS #

NFData S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

Methods

rnf :: S3Tag -> () #

Eq S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

Methods

(==) :: S3Tag -> S3Tag -> Bool #

(/=) :: S3Tag -> S3Tag -> Bool #

Hashable S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

Methods

hashWithSalt :: Int -> S3Tag -> Int #

hash :: S3Tag -> Int #

type Rep S3Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.S3Tag

type Rep S3Tag = D1 ('MetaData "S3Tag" "Amazonka.Transfer.Types.S3Tag" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "S3Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newS3Tag Source #

Create a value of S3Tag with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:S3Tag', s3Tag_key - The name assigned to the tag that you create.

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

ServiceMetadata

data ServiceMetadata Source #

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

See: newServiceMetadata smart constructor.

Instances

Instances details
FromJSON ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

Generic ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

Associated Types

type Rep ServiceMetadata :: Type -> Type #

Read ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

Show ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

NFData ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

Methods

rnf :: ServiceMetadata -> () #

Eq ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

Hashable ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

type Rep ServiceMetadata Source # 
Instance details

Defined in Amazonka.Transfer.Types.ServiceMetadata

type Rep ServiceMetadata = D1 ('MetaData "ServiceMetadata" "Amazonka.Transfer.Types.ServiceMetadata" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ServiceMetadata'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserDetails)))

newServiceMetadata Source #

Create a value of ServiceMetadata with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userDetails:ServiceMetadata', serviceMetadata_userDetails - The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the UserDetails.

SshPublicKey

data SshPublicKey Source #

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

See: newSshPublicKey smart constructor.

Instances

Instances details
FromJSON SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

Generic SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

Associated Types

type Rep SshPublicKey :: Type -> Type #

Read SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

Show SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

NFData SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

Methods

rnf :: SshPublicKey -> () #

Eq SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

Hashable SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

type Rep SshPublicKey Source # 
Instance details

Defined in Amazonka.Transfer.Types.SshPublicKey

type Rep SshPublicKey = D1 ('MetaData "SshPublicKey" "Amazonka.Transfer.Types.SshPublicKey" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "SshPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dateImported") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "sshPublicKeyBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sshPublicKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSshPublicKey Source #

Create a value of SshPublicKey with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dateImported:SshPublicKey', sshPublicKey_dateImported - Specifies the date that the public key was added to the user account.

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

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

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

Tag

data Tag Source #

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

See: newTag smart constructor.

Constructors

Tag' Text Text 

Instances

Instances details
FromJSON Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

ToJSON Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

Generic Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Read Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Hashable Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.Transfer.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Transfer.Types.Tag" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Create a value of Tag with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:Tag', tag_key - The name assigned to the tag that you create.

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

TagStepDetails

data TagStepDetails Source #

Each step type has its own StepDetails structure.

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

See: newTagStepDetails smart constructor.

Instances

Instances details
FromJSON TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

ToJSON TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

Generic TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

Associated Types

type Rep TagStepDetails :: Type -> Type #

Read TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

Show TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

NFData TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

Methods

rnf :: TagStepDetails -> () #

Eq TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

Hashable TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

type Rep TagStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.TagStepDetails

type Rep TagStepDetails = D1 ('MetaData "TagStepDetails" "Amazonka.Transfer.Types.TagStepDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TagStepDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty S3Tag))))))

newTagStepDetails :: TagStepDetails Source #

Create a value of TagStepDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:sourceFileLocation:TagStepDetails', tagStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
  • Enter ${original.file} to use the originally-uploaded file location as input for this step.

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

UserDetails

data UserDetails Source #

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

See: newUserDetails smart constructor.

Constructors

UserDetails' (Maybe Text) Text Text 

Instances

Instances details
FromJSON UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

Generic UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

Associated Types

type Rep UserDetails :: Type -> Type #

Read UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

Show UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

NFData UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

Methods

rnf :: UserDetails -> () #

Eq UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

Hashable UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

type Rep UserDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.UserDetails

type Rep UserDetails = D1 ('MetaData "UserDetails" "Amazonka.Transfer.Types.UserDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "UserDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUserDetails Source #

Create a value of UserDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sessionId:UserDetails', userDetails_sessionId - The system-assigned unique identifier for a session that corresponds to the workflow.

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

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

WorkflowDetail

data WorkflowDetail Source #

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

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

See: newWorkflowDetail smart constructor.

Constructors

WorkflowDetail' Text Text 

Instances

Instances details
FromJSON WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

ToJSON WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Generic WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Associated Types

type Rep WorkflowDetail :: Type -> Type #

Read WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Show WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

NFData WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Methods

rnf :: WorkflowDetail -> () #

Eq WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Hashable WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

type Rep WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

type Rep WorkflowDetail = D1 ('MetaData "WorkflowDetail" "Amazonka.Transfer.Types.WorkflowDetail" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "WorkflowDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newWorkflowDetail Source #

Create a value of WorkflowDetail with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:workflowId:WorkflowDetail', workflowDetail_workflowId - A unique identifier for the workflow.

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

WorkflowDetails

data WorkflowDetails Source #

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

See: newWorkflowDetails smart constructor.

Instances

Instances details
FromJSON WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

ToJSON WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

Generic WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

Associated Types

type Rep WorkflowDetails :: Type -> Type #

Read WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

Show WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

NFData WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

Methods

rnf :: WorkflowDetails -> () #

Eq WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

Hashable WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

type Rep WorkflowDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetails

type Rep WorkflowDetails = D1 ('MetaData "WorkflowDetails" "Amazonka.Transfer.Types.WorkflowDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "WorkflowDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "onPartialUpload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowDetail])) :*: S1 ('MetaSel ('Just "onUpload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowDetail]))))

newWorkflowDetails :: WorkflowDetails Source #

Create a value of WorkflowDetails with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:onPartialUpload:WorkflowDetails', workflowDetails_onPartialUpload - A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

$sel:onUpload:WorkflowDetails', workflowDetails_onUpload - A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

WorkflowStep

data WorkflowStep Source #

The basic building block of a workflow.

See: newWorkflowStep smart constructor.

Instances

Instances details
FromJSON WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

ToJSON WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Generic WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Associated Types

type Rep WorkflowStep :: Type -> Type #

Read WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Show WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

NFData WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

rnf :: WorkflowStep -> () #

Eq WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Hashable WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

type Rep WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

newWorkflowStep :: WorkflowStep Source #

Create a value of WorkflowStep with all optional fields omitted.

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

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

Consists of the following values:

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

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

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

$sel:decryptStepDetails:WorkflowStep', workflowStep_decryptStepDetails - Undocumented member.

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

$sel:tagStepDetails:WorkflowStep', workflowStep_tagStepDetails - Details for a step that creates one or more tags.

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

WorkflowStep, workflowStep_type - Currently, the following step types are supported.

  • COPY: Copy the file to another location.
  • CUSTOM: Perform a custom step with an Lambda function target.
  • DELETE: Delete the file.
  • TAG: Add a tag to the file.