const (
    // AgreementStatusTypeActive is a AgreementStatusType enum value
    AgreementStatusTypeActive = "ACTIVE"

    // AgreementStatusTypeInactive is a AgreementStatusType enum value
    AgreementStatusTypeInactive = "INACTIVE"
)

const (
    // CertificateStatusTypeActive is a CertificateStatusType enum value
    CertificateStatusTypeActive = "ACTIVE"

    // CertificateStatusTypePendingRotation is a CertificateStatusType enum value
    CertificateStatusTypePendingRotation = "PENDING_ROTATION"

    // CertificateStatusTypeInactive is a CertificateStatusType enum value
    CertificateStatusTypeInactive = "INACTIVE"
)

const (
    // CertificateTypeCertificate is a CertificateType enum value
    CertificateTypeCertificate = "CERTIFICATE"

    // CertificateTypeCertificateWithPrivateKey is a CertificateType enum value
    CertificateTypeCertificateWithPrivateKey = "CERTIFICATE_WITH_PRIVATE_KEY"
)

const (
    // CertificateUsageTypeSigning is a CertificateUsageType enum value
    CertificateUsageTypeSigning = "SIGNING"

    // CertificateUsageTypeEncryption is a CertificateUsageType enum value
    CertificateUsageTypeEncryption = "ENCRYPTION"

    // CertificateUsageTypeTls is a CertificateUsageType enum value
    CertificateUsageTypeTls = "TLS"
)

const (
    // CompressionEnumZlib is a CompressionEnum enum value
    CompressionEnumZlib = "ZLIB"

    // CompressionEnumDisabled is a CompressionEnum enum value
    CompressionEnumDisabled = "DISABLED"
)

const (
    // CustomStepStatusSuccess is a CustomStepStatus enum value
    CustomStepStatusSuccess = "SUCCESS"

    // CustomStepStatusFailure is a CustomStepStatus enum value
    CustomStepStatusFailure = "FAILURE"
)

const (
    // DirectoryListingOptimizationEnabled is a DirectoryListingOptimization enum value
    DirectoryListingOptimizationEnabled = "ENABLED"

    // DirectoryListingOptimizationDisabled is a DirectoryListingOptimization enum value
    DirectoryListingOptimizationDisabled = "DISABLED"
)

const (
    // DomainS3 is a Domain enum value
    DomainS3 = "S3"

    // DomainEfs is a Domain enum value
    DomainEfs = "EFS"
)

const (
    // EncryptionAlgAes128Cbc is a EncryptionAlg enum value
    EncryptionAlgAes128Cbc = "AES128_CBC"

    // EncryptionAlgAes192Cbc is a EncryptionAlg enum value
    EncryptionAlgAes192Cbc = "AES192_CBC"

    // EncryptionAlgAes256Cbc is a EncryptionAlg enum value
    EncryptionAlgAes256Cbc = "AES256_CBC"

    // EncryptionAlgDesEde3Cbc is a EncryptionAlg enum value
    EncryptionAlgDesEde3Cbc = "DES_EDE3_CBC"

    // EncryptionAlgNone is a EncryptionAlg enum value
    EncryptionAlgNone = "NONE"
)

const (
    // EndpointTypePublic is a EndpointType enum value
    EndpointTypePublic = "PUBLIC"

    // EndpointTypeVpc is a EndpointType enum value
    EndpointTypeVpc = "VPC"

    // EndpointTypeVpcEndpoint is a EndpointType enum value
    EndpointTypeVpcEndpoint = "VPC_ENDPOINT"
)

const (
    // ExecutionErrorTypePermissionDenied is a ExecutionErrorType enum value
    ExecutionErrorTypePermissionDenied = "PERMISSION_DENIED"

    // ExecutionErrorTypeCustomStepFailed is a ExecutionErrorType enum value
    ExecutionErrorTypeCustomStepFailed = "CUSTOM_STEP_FAILED"

    // ExecutionErrorTypeThrottled is a ExecutionErrorType enum value
    ExecutionErrorTypeThrottled = "THROTTLED"

    // ExecutionErrorTypeAlreadyExists is a ExecutionErrorType enum value
    ExecutionErrorTypeAlreadyExists = "ALREADY_EXISTS"

    // ExecutionErrorTypeNotFound is a ExecutionErrorType enum value
    ExecutionErrorTypeNotFound = "NOT_FOUND"

    // ExecutionErrorTypeBadRequest is a ExecutionErrorType enum value
    ExecutionErrorTypeBadRequest = "BAD_REQUEST"

    // ExecutionErrorTypeTimeout is a ExecutionErrorType enum value
    ExecutionErrorTypeTimeout = "TIMEOUT"

    // ExecutionErrorTypeInternalServerError is a ExecutionErrorType enum value
    ExecutionErrorTypeInternalServerError = "INTERNAL_SERVER_ERROR"
)

const (
    // ExecutionStatusInProgress is a ExecutionStatus enum value
    ExecutionStatusInProgress = "IN_PROGRESS"

    // ExecutionStatusCompleted is a ExecutionStatus enum value
    ExecutionStatusCompleted = "COMPLETED"

    // ExecutionStatusException is a ExecutionStatus enum value
    ExecutionStatusException = "EXCEPTION"

    // ExecutionStatusHandlingException is a ExecutionStatus enum value
    ExecutionStatusHandlingException = "HANDLING_EXCEPTION"
)

const (
    // HomeDirectoryTypePath is a HomeDirectoryType enum value
    HomeDirectoryTypePath = "PATH"

    // HomeDirectoryTypeLogical is a HomeDirectoryType enum value
    HomeDirectoryTypeLogical = "LOGICAL"
)

const (
    // IdentityProviderTypeServiceManaged is a IdentityProviderType enum value
    IdentityProviderTypeServiceManaged = "SERVICE_MANAGED"

    // IdentityProviderTypeApiGateway is a IdentityProviderType enum value
    IdentityProviderTypeApiGateway = "API_GATEWAY"

    // IdentityProviderTypeAwsDirectoryService is a IdentityProviderType enum value
    IdentityProviderTypeAwsDirectoryService = "AWS_DIRECTORY_SERVICE"

    // IdentityProviderTypeAwsLambda is a IdentityProviderType enum value
    IdentityProviderTypeAwsLambda = "AWS_LAMBDA"
)

const (
    // MapTypeFile is a MapType enum value
    MapTypeFile = "FILE"

    // MapTypeDirectory is a MapType enum value
    MapTypeDirectory = "DIRECTORY"
)

const (
    // MdnResponseSync is a MdnResponse enum value
    MdnResponseSync = "SYNC"

    // MdnResponseNone is a MdnResponse enum value
    MdnResponseNone = "NONE"
)

const (
    // MdnSigningAlgSha256 is a MdnSigningAlg enum value
    MdnSigningAlgSha256 = "SHA256"

    // MdnSigningAlgSha384 is a MdnSigningAlg enum value
    MdnSigningAlgSha384 = "SHA384"

    // MdnSigningAlgSha512 is a MdnSigningAlg enum value
    MdnSigningAlgSha512 = "SHA512"

    // MdnSigningAlgSha1 is a MdnSigningAlg enum value
    MdnSigningAlgSha1 = "SHA1"

    // MdnSigningAlgNone is a MdnSigningAlg enum value
    MdnSigningAlgNone = "NONE"

    // MdnSigningAlgDefault is a MdnSigningAlg enum value
    MdnSigningAlgDefault = "DEFAULT"
)

const (
    // OverwriteExistingTrue is a OverwriteExisting enum value
    OverwriteExistingTrue = "TRUE"

    // OverwriteExistingFalse is a OverwriteExisting enum value
    OverwriteExistingFalse = "FALSE"
)

const (
    // ProfileTypeLocal is a ProfileType enum value
    ProfileTypeLocal = "LOCAL"

    // ProfileTypePartner is a ProfileType enum value
    ProfileTypePartner = "PARTNER"
)

const (
    // ProtocolSftp is a Protocol enum value
    ProtocolSftp = "SFTP"

    // ProtocolFtp is a Protocol enum value
    ProtocolFtp = "FTP"

    // ProtocolFtps is a Protocol enum value
    ProtocolFtps = "FTPS"

    // ProtocolAs2 is a Protocol enum value
    ProtocolAs2 = "AS2"
)

const (
    // SecurityPolicyProtocolSftp is a SecurityPolicyProtocol enum value
    SecurityPolicyProtocolSftp = "SFTP"

    // SecurityPolicyProtocolFtps is a SecurityPolicyProtocol enum value
    SecurityPolicyProtocolFtps = "FTPS"
)

const (
    // SecurityPolicyResourceTypeServer is a SecurityPolicyResourceType enum value
    SecurityPolicyResourceTypeServer = "SERVER"

    // SecurityPolicyResourceTypeConnector is a SecurityPolicyResourceType enum value
    SecurityPolicyResourceTypeConnector = "CONNECTOR"
)

const (
    // SetStatOptionDefault is a SetStatOption enum value
    SetStatOptionDefault = "DEFAULT"

    // SetStatOptionEnableNoOp is a SetStatOption enum value
    SetStatOptionEnableNoOp = "ENABLE_NO_OP"
)

const (
    // SftpAuthenticationMethodsPassword is a SftpAuthenticationMethods enum value
    SftpAuthenticationMethodsPassword = "PASSWORD"

    // SftpAuthenticationMethodsPublicKey is a SftpAuthenticationMethods enum value
    SftpAuthenticationMethodsPublicKey = "PUBLIC_KEY"

    // SftpAuthenticationMethodsPublicKeyOrPassword is a SftpAuthenticationMethods enum value
    SftpAuthenticationMethodsPublicKeyOrPassword = "PUBLIC_KEY_OR_PASSWORD"

    // SftpAuthenticationMethodsPublicKeyAndPassword is a SftpAuthenticationMethods enum value
    SftpAuthenticationMethodsPublicKeyAndPassword = "PUBLIC_KEY_AND_PASSWORD"
)

const (
    // SigningAlgSha256 is a SigningAlg enum value
    SigningAlgSha256 = "SHA256"

    // SigningAlgSha384 is a SigningAlg enum value
    SigningAlgSha384 = "SHA384"

    // SigningAlgSha512 is a SigningAlg enum value
    SigningAlgSha512 = "SHA512"

    // SigningAlgSha1 is a SigningAlg enum value
    SigningAlgSha1 = "SHA1"

    // SigningAlgNone is a SigningAlg enum value
    SigningAlgNone = "NONE"
)

const (
    // StateOffline is a State enum value
    StateOffline = "OFFLINE"

    // StateOnline is a State enum value
    StateOnline = "ONLINE"

    // StateStarting is a State enum value
    StateStarting = "STARTING"

    // StateStopping is a State enum value
    StateStopping = "STOPPING"

    // StateStartFailed is a State enum value
    StateStartFailed = "START_FAILED"

    // StateStopFailed is a State enum value
    StateStopFailed = "STOP_FAILED"
)

const (
    // TlsSessionResumptionModeDisabled is a TlsSessionResumptionMode enum value
    TlsSessionResumptionModeDisabled = "DISABLED"

    // TlsSessionResumptionModeEnabled is a TlsSessionResumptionMode enum value
    TlsSessionResumptionModeEnabled = "ENABLED"

    // TlsSessionResumptionModeEnforced is a TlsSessionResumptionMode enum value
    TlsSessionResumptionModeEnforced = "ENFORCED"
)

const (
    // WorkflowStepTypeCopy is a WorkflowStepType enum value
    WorkflowStepTypeCopy = "COPY"

    // WorkflowStepTypeCustom is a WorkflowStepType enum value
    WorkflowStepTypeCustom = "CUSTOM"

    // WorkflowStepTypeTag is a WorkflowStepType enum value
    WorkflowStepTypeTag = "TAG"

    // WorkflowStepTypeDelete is a WorkflowStepType enum value
    WorkflowStepTypeDelete = "DELETE"

    // WorkflowStepTypeDecrypt is a WorkflowStepType enum value
    WorkflowStepTypeDecrypt = "DECRYPT"
)

const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // You do not have sufficient access to perform this action.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    //
    // 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.
    ErrCodeConflictException = "ConflictException"

    // ErrCodeInternalServiceError for service response error code
    // "InternalServiceError".
    //
    // This exception is thrown when an error occurs in the Transfer Family service.
    ErrCodeInternalServiceError = "InternalServiceError"

    // ErrCodeInvalidNextTokenException for service response error code
    // "InvalidNextTokenException".
    //
    // The NextToken parameter that was passed is invalid.
    ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

    // ErrCodeInvalidRequestException for service response error code
    // "InvalidRequestException".
    //
    // This exception is thrown when the client submits a malformed request.
    ErrCodeInvalidRequestException = "InvalidRequestException"

    // ErrCodeResourceExistsException for service response error code
    // "ResourceExistsException".
    //
    // The requested resource does not exist, or exists in a region other than the
    // one specified for the command.
    ErrCodeResourceExistsException = "ResourceExistsException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
    // Family service.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceUnavailableException for service response error code
    // "ServiceUnavailableException".
    //
    // The request has failed because the Amazon Web ServicesTransfer Family service
    // is not available.
    ErrCodeServiceUnavailableException = "ServiceUnavailableException"

    // ErrCodeThrottlingException for service response error code
    // "ThrottlingException".
    //
    // The request was denied due to request throttling.
    ErrCodeThrottlingException = "ThrottlingException"
)

const (
    ServiceName = "Transfer" // Name of service.
    EndpointsID = "transfer" // ID to lookup a service endpoint with.
    ServiceID   = "Transfer" // ServiceID is a unique identifier of a specific service.
)

const (
    // As2TransportHttp is a As2Transport enum value
    As2TransportHttp = "HTTP"
)

const (
    // EncryptionTypePgp is a EncryptionType enum value
    EncryptionTypePgp = "PGP"
)

func AgreementStatusType_Values ¶

func AgreementStatusType_Values() []string

AgreementStatusType_Values returns all elements of the AgreementStatusType enum

func As2Transport_Values ¶

func As2Transport_Values() []string

As2Transport_Values returns all elements of the As2Transport enum

func CertificateStatusType_Values ¶

func CertificateStatusType_Values() []string

CertificateStatusType_Values returns all elements of the CertificateStatusType enum

func CertificateType_Values ¶

func CertificateType_Values() []string

CertificateType_Values returns all elements of the CertificateType enum

func CertificateUsageType_Values ¶

func CertificateUsageType_Values() []string

CertificateUsageType_Values returns all elements of the CertificateUsageType enum

func CompressionEnum_Values ¶

func CompressionEnum_Values() []string

CompressionEnum_Values returns all elements of the CompressionEnum enum

func CustomStepStatus_Values ¶

func CustomStepStatus_Values() []string

CustomStepStatus_Values returns all elements of the CustomStepStatus enum

func DirectoryListingOptimization_Values ¶

func DirectoryListingOptimization_Values() []string

DirectoryListingOptimization_Values returns all elements of the DirectoryListingOptimization enum

func Domain_Values ¶

func Domain_Values() []string

Domain_Values returns all elements of the Domain enum

func EncryptionAlg_Values ¶

func EncryptionAlg_Values() []string

EncryptionAlg_Values returns all elements of the EncryptionAlg enum

func EncryptionType_Values ¶

func EncryptionType_Values() []string

EncryptionType_Values returns all elements of the EncryptionType enum

func EndpointType_Values ¶

func EndpointType_Values() []string

EndpointType_Values returns all elements of the EndpointType enum

func ExecutionErrorType_Values ¶

func ExecutionErrorType_Values() []string

ExecutionErrorType_Values returns all elements of the ExecutionErrorType enum

func ExecutionStatus_Values ¶

func ExecutionStatus_Values() []string

ExecutionStatus_Values returns all elements of the ExecutionStatus enum

func HomeDirectoryType_Values ¶

func HomeDirectoryType_Values() []string

HomeDirectoryType_Values returns all elements of the HomeDirectoryType enum

func IdentityProviderType_Values ¶

func IdentityProviderType_Values() []string

IdentityProviderType_Values returns all elements of the IdentityProviderType enum

func MapType_Values ¶

func MapType_Values() []string

MapType_Values returns all elements of the MapType enum

func MdnResponse_Values ¶

func MdnResponse_Values() []string

MdnResponse_Values returns all elements of the MdnResponse enum

func MdnSigningAlg_Values ¶

func MdnSigningAlg_Values() []string

MdnSigningAlg_Values returns all elements of the MdnSigningAlg enum

func OverwriteExisting_Values ¶

func OverwriteExisting_Values() []string

OverwriteExisting_Values returns all elements of the OverwriteExisting enum

func ProfileType_Values ¶

func ProfileType_Values() []string

ProfileType_Values returns all elements of the ProfileType enum

func Protocol_Values ¶

func Protocol_Values() []string

Protocol_Values returns all elements of the Protocol enum

func SecurityPolicyProtocol_Values ¶

func SecurityPolicyProtocol_Values() []string

SecurityPolicyProtocol_Values returns all elements of the SecurityPolicyProtocol enum

func SecurityPolicyResourceType_Values ¶

func SecurityPolicyResourceType_Values() []string

SecurityPolicyResourceType_Values returns all elements of the SecurityPolicyResourceType enum

func SetStatOption_Values ¶

func SetStatOption_Values() []string

SetStatOption_Values returns all elements of the SetStatOption enum

func SftpAuthenticationMethods_Values ¶

func SftpAuthenticationMethods_Values() []string

SftpAuthenticationMethods_Values returns all elements of the SftpAuthenticationMethods enum

func SigningAlg_Values ¶

func SigningAlg_Values() []string

SigningAlg_Values returns all elements of the SigningAlg enum

func State_Values ¶

func State_Values() []string

State_Values returns all elements of the State enum

func TlsSessionResumptionMode_Values ¶

func TlsSessionResumptionMode_Values() []string

TlsSessionResumptionMode_Values returns all elements of the TlsSessionResumptionMode enum

func WorkflowStepType_Values ¶

func WorkflowStepType_Values() []string

WorkflowStepType_Values returns all elements of the WorkflowStepType enum

type AccessDeniedException ¶

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code ¶

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error ¶

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString ¶

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message ¶

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr ¶

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID ¶

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode ¶

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String ¶

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type As2ConnectorConfig ¶

type As2ConnectorConfig struct {

    // Provides Basic authentication support to the AS2 Connectors API. To use Basic
    // authentication, you must provide the name or Amazon Resource Name (ARN) of
    // a secret in Secrets Manager.
    //
    // The default value for this parameter is null, which indicates that Basic
    // authentication is not enabled for the connector.
    //
    // If the connector should use Basic authentication, the secret needs to be
    // in the following format:
    //
    // { "Username": "user-name", "Password": "user-password" }
    //
    // Replace user-name and user-password with the credentials for the actual user
    // that is being authenticated.
    //
    // Note the following:
    //
    //    * You are storing these credentials in Secrets Manager, not passing them
    //    directly into this API.
    //
    //    * If you are using the API, SDKs, or CloudFormation to configure your
    //    connector, then you must create the secret before you can enable Basic
    //    authentication. However, if you are using the Amazon Web Services management
    //    console, you can have the system create the secret for you.
    //
    // If you have previously enabled Basic authentication for a connector, you
    // can disable it by using the UpdateConnector API call. For example, if you
    // are using the CLI, you can run the following command to remove Basic authentication:
    //
    // update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'
    BasicAuthSecretId *string `type:"string"`

    // Specifies whether the AS2 file is compressed.
    Compression *string `type:"string" enum:"CompressionEnum"`

    // The algorithm that is used to encrypt the file.
    //
    // Note the following:
    //
    //    * Do not use the DES_EDE3_CBC algorithm unless you must support a legacy
    //    client that requires it, as it is a weak encryption algorithm.
    //
    //    * You can only specify NONE if the URL for your connector uses HTTPS.
    //    Using HTTPS ensures that no traffic is sent in clear text.
    EncryptionAlgorithm *string `type:"string" enum:"EncryptionAlg"`

    // A unique identifier for the AS2 local profile.
    LocalProfileId *string `min:"19" type:"string"`

    // 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.
    MdnResponse *string `type:"string" enum:"MdnResponse"`

    // The signing algorithm for the MDN response.
    //
    // If set to DEFAULT (or not set at all), the value for SigningAlgorithm is
    // used.
    MdnSigningAlgorithm *string `type:"string" enum:"MdnSigningAlg"`

    // Used as the Subject HTTP header attribute in AS2 messages that are being
    // sent with the connector.
    MessageSubject *string `min:"1" type:"string"`

    // A unique identifier for the partner profile for the connector.
    PartnerProfileId *string `min:"19" type:"string"`

    // The algorithm that is used to sign the AS2 messages sent with the connector.
    SigningAlgorithm *string `type:"string" enum:"SigningAlg"`
    // contains filtered or unexported fields
}

Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.

func (As2ConnectorConfig) GoString ¶

func (s As2ConnectorConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*As2ConnectorConfig) SetBasicAuthSecretId ¶

func (s *As2ConnectorConfig) SetBasicAuthSecretId(v string) *As2ConnectorConfig

SetBasicAuthSecretId sets the BasicAuthSecretId field's value.

func (*As2ConnectorConfig) SetCompression ¶

func (s *As2ConnectorConfig) SetCompression(v string) *As2ConnectorConfig

SetCompression sets the Compression field's value.

func (*As2ConnectorConfig) SetEncryptionAlgorithm ¶

func (s *As2ConnectorConfig) SetEncryptionAlgorithm(v string) *As2ConnectorConfig

SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.

func (*As2ConnectorConfig) SetLocalProfileId ¶

func (s *As2ConnectorConfig) SetLocalProfileId(v string) *As2ConnectorConfig

SetLocalProfileId sets the LocalProfileId field's value.

func (*As2ConnectorConfig) SetMdnResponse ¶

func (s *As2ConnectorConfig) SetMdnResponse(v string) *As2ConnectorConfig

SetMdnResponse sets the MdnResponse field's value.

func (*As2ConnectorConfig) SetMdnSigningAlgorithm ¶

func (s *As2ConnectorConfig) SetMdnSigningAlgorithm(v string) *As2ConnectorConfig

SetMdnSigningAlgorithm sets the MdnSigningAlgorithm field's value.

func (*As2ConnectorConfig) SetMessageSubject ¶

func (s *As2ConnectorConfig) SetMessageSubject(v string) *As2ConnectorConfig

SetMessageSubject sets the MessageSubject field's value.

func (*As2ConnectorConfig) SetPartnerProfileId ¶

func (s *As2ConnectorConfig) SetPartnerProfileId(v string) *As2ConnectorConfig

SetPartnerProfileId sets the PartnerProfileId field's value.

func (*As2ConnectorConfig) SetSigningAlgorithm ¶

func (s *As2ConnectorConfig) SetSigningAlgorithm(v string) *As2ConnectorConfig

SetSigningAlgorithm sets the SigningAlgorithm field's value.

func (As2ConnectorConfig) String ¶

func (s As2ConnectorConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*As2ConnectorConfig) Validate ¶

func (s *As2ConnectorConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException ¶

type ConflictException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

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.

func (*ConflictException) Code ¶

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error ¶

func (s *ConflictException) Error() string

func (ConflictException) GoString ¶

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message ¶

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr ¶

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID ¶

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode ¶

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String ¶

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyStepDetails ¶

type CopyStepDetails struct {

    // Specifies the location for the file being copied. Use ${Transfer:UserName}
    // or ${Transfer:UploadDate} in this field to parametrize the destination prefix
    // by username or uploaded date.
    //
    //    * Set the value of DestinationFileLocation to ${Transfer:UserName} to
    //    copy uploaded files to an Amazon S3 bucket that is prefixed with the name
    //    of the Transfer Family user that uploaded the file.
    //
    //    * Set the value of DestinationFileLocation to ${Transfer:UploadDate} to
    //    copy uploaded files to an Amazon S3 bucket that is prefixed with the date
    //    of the upload. The system resolves UploadDate to a date format of YYYY-MM-DD,
    //    based on the date the file is uploaded in UTC.
    DestinationFileLocation *InputFileLocation `type:"structure"`

    // The name of the step, used as an identifier.
    Name *string `type:"string"`

    // A flag that indicates whether to overwrite an existing file of the same name.
    // The default is FALSE.
    //
    // If the workflow is processing a file that has the same name as an existing
    // file, the behavior is as follows:
    //
    //    * If OverwriteExisting is TRUE, the existing file is replaced with the
    //    file being processed.
    //
    //    * If OverwriteExisting is FALSE, nothing happens, and the workflow processing
    //    stops.
    OverwriteExisting *string `type:"string" enum:"OverwriteExisting"`

    // 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.
    //
    //    * To use the previous file as the input, enter ${previous.file}. In this
    //    case, this workflow step uses the output file from the previous workflow
    //    step as input. This is the default value.
    //
    //    * To use the originally uploaded file location as input for this step,
    //    enter ${original.file}.
    SourceFileLocation *string `type:"string"`
    // contains filtered or unexported fields
}

Each step type has its own StepDetails structure.

func (CopyStepDetails) GoString ¶

func (s CopyStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyStepDetails) SetDestinationFileLocation ¶

func (s *CopyStepDetails) SetDestinationFileLocation(v *InputFileLocation) *CopyStepDetails

SetDestinationFileLocation sets the DestinationFileLocation field's value.

func (*CopyStepDetails) SetName ¶

func (s *CopyStepDetails) SetName(v string) *CopyStepDetails

SetName sets the Name field's value.

func (*CopyStepDetails) SetOverwriteExisting ¶

func (s *CopyStepDetails) SetOverwriteExisting(v string) *CopyStepDetails

SetOverwriteExisting sets the OverwriteExisting field's value.

func (*CopyStepDetails) SetSourceFileLocation ¶

func (s *CopyStepDetails) SetSourceFileLocation(v string) *CopyStepDetails

SetSourceFileLocation sets the SourceFileLocation field's value.

func (CopyStepDetails) String ¶

func (s CopyStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyStepDetails) Validate ¶

func (s *CopyStepDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAccessInput ¶

type CreateAccessInput struct {

    // 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: =,.@:/-
    //
    // ExternalId is a required field
    ExternalId *string `min:"1" type:"string" required:"true"`

    // 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.
    //
    // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
    HomeDirectory *string `type:"string"`

    // 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" } ]
    HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"`

    // 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 Amazon EFS path as is in their file
    // transfer protocol clients. If you set it to 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.
    //
    // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings
    // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide
    // an absolute path using the HomeDirectory parameter. You cannot have both
    // HomeDirectory and HomeDirectoryMappings in your template.
    HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

    // 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 (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html).
    //
    // For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
    // in the Security Token Service API Reference.
    Policy *string `type:"string"`

    // 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.
    PosixProfile *PosixProfile `type:"structure"`

    // 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.
    //
    // Role is a required field
    Role *string `min:"20" type:"string" required:"true"`

    // A system-assigned unique identifier for a server instance. This is the specific
    // server that you added your user to.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateAccessInput) GoString ¶

func (s CreateAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessInput) SetExternalId ¶

func (s *CreateAccessInput) SetExternalId(v string) *CreateAccessInput

SetExternalId sets the ExternalId field's value.

func (*CreateAccessInput) SetHomeDirectory ¶

func (s *CreateAccessInput) SetHomeDirectory(v string) *CreateAccessInput

SetHomeDirectory sets the HomeDirectory field's value.

func (*CreateAccessInput) SetHomeDirectoryMappings ¶

func (s *CreateAccessInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *CreateAccessInput

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*CreateAccessInput) SetHomeDirectoryType ¶

func (s *CreateAccessInput) SetHomeDirectoryType(v string) *CreateAccessInput

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*CreateAccessInput) SetPolicy ¶

func (s *CreateAccessInput) SetPolicy(v string) *CreateAccessInput

SetPolicy sets the Policy field's value.

func (*CreateAccessInput) SetPosixProfile ¶

func (s *CreateAccessInput) SetPosixProfile(v *PosixProfile) *CreateAccessInput

SetPosixProfile sets the PosixProfile field's value.

func (*CreateAccessInput) SetRole ¶

func (s *CreateAccessInput) SetRole(v string) *CreateAccessInput

SetRole sets the Role field's value.

func (*CreateAccessInput) SetServerId ¶

func (s *CreateAccessInput) SetServerId(v string) *CreateAccessInput

SetServerId sets the ServerId field's value.

func (CreateAccessInput) String ¶

func (s CreateAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessInput) Validate ¶

func (s *CreateAccessInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAccessOutput ¶

type CreateAccessOutput struct {

    // 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.
    //
    // ExternalId is a required field
    ExternalId *string `min:"1" type:"string" required:"true"`

    // The identifier of the server that the user is attached to.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateAccessOutput) GoString ¶

func (s CreateAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessOutput) SetExternalId ¶

func (s *CreateAccessOutput) SetExternalId(v string) *CreateAccessOutput

SetExternalId sets the ExternalId field's value.

func (*CreateAccessOutput) SetServerId ¶

func (s *CreateAccessOutput) SetServerId(v string) *CreateAccessOutput

SetServerId sets the ServerId field's value.

func (CreateAccessOutput) String ¶

func (s CreateAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAgreementInput ¶

type CreateAgreementInput struct {

    // Connectors are used to send files using either the AS2 or SFTP protocol.
    // For the access role, provide the Amazon Resource Name (ARN) of the Identity
    // and Access Management role to use.
    //
    // For AS2 connectors
    //
    // 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.
    //
    // If you are using Basic authentication for your AS2 connector, the access
    // role requires the secretsmanager:GetSecretValue permission for the secret.
    // If the secret is encrypted using a customer-managed key instead of the Amazon
    // Web Services managed key in Secrets Manager, then the role also needs the
    // kms:Decrypt permission for that key.
    //
    // For SFTP connectors
    //
    // Make sure that the access role provides read and write access to the parent
    // directory of the file location that's used in the StartFileTransfer request.
    // Additionally, make sure that the role provides secretsmanager:GetSecretValue
    // permission to Secrets Manager.
    //
    // AccessRole is a required field
    AccessRole *string `min:"20" type:"string" required:"true"`

    // The landing directory (folder) for files transferred by using the AS2 protocol.
    //
    // A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.
    //
    // BaseDirectory is a required field
    BaseDirectory *string `type:"string" required:"true"`

    // A name or short description to identify the agreement.
    Description *string `min:"1" type:"string"`

    // A unique identifier for the AS2 local profile.
    //
    // LocalProfileId is a required field
    LocalProfileId *string `min:"19" type:"string" required:"true"`

    // A unique identifier for the partner profile used in the agreement.
    //
    // PartnerProfileId is a required field
    PartnerProfileId *string `min:"19" type:"string" required:"true"`

    // A system-assigned unique identifier for a server instance. This is the specific
    // server that the agreement uses.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
    Status *string `type:"string" enum:"AgreementStatusType"`

    // Key-value pairs that can be used to group and search for agreements.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (CreateAgreementInput) GoString ¶

func (s CreateAgreementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgreementInput) SetAccessRole ¶

func (s *CreateAgreementInput) SetAccessRole(v string) *CreateAgreementInput

SetAccessRole sets the AccessRole field's value.

func (*CreateAgreementInput) SetBaseDirectory ¶

func (s *CreateAgreementInput) SetBaseDirectory(v string) *CreateAgreementInput

SetBaseDirectory sets the BaseDirectory field's value.

func (*CreateAgreementInput) SetDescription ¶

func (s *CreateAgreementInput) SetDescription(v string) *CreateAgreementInput

SetDescription sets the Description field's value.

func (*CreateAgreementInput) SetLocalProfileId ¶

func (s *CreateAgreementInput) SetLocalProfileId(v string) *CreateAgreementInput

SetLocalProfileId sets the LocalProfileId field's value.

func (*CreateAgreementInput) SetPartnerProfileId ¶

func (s *CreateAgreementInput) SetPartnerProfileId(v string) *CreateAgreementInput

SetPartnerProfileId sets the PartnerProfileId field's value.

func (*CreateAgreementInput) SetServerId ¶

func (s *CreateAgreementInput) SetServerId(v string) *CreateAgreementInput

SetServerId sets the ServerId field's value.

func (*CreateAgreementInput) SetStatus ¶

func (s *CreateAgreementInput) SetStatus(v string) *CreateAgreementInput

SetStatus sets the Status field's value.

func (*CreateAgreementInput) SetTags ¶

func (s *CreateAgreementInput) SetTags(v []*Tag) *CreateAgreementInput

SetTags sets the Tags field's value.

func (CreateAgreementInput) String ¶

func (s CreateAgreementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgreementInput) Validate ¶

func (s *CreateAgreementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAgreementOutput ¶

type CreateAgreementOutput struct {

    // 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.
    //
    // AgreementId is a required field
    AgreementId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateAgreementOutput) GoString ¶

func (s CreateAgreementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgreementOutput) SetAgreementId ¶

func (s *CreateAgreementOutput) SetAgreementId(v string) *CreateAgreementOutput

SetAgreementId sets the AgreementId field's value.

func (CreateAgreementOutput) String ¶

func (s CreateAgreementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateConnectorInput ¶

type CreateConnectorInput struct {

    // Connectors are used to send files using either the AS2 or SFTP protocol.
    // For the access role, provide the Amazon Resource Name (ARN) of the Identity
    // and Access Management role to use.
    //
    // For AS2 connectors
    //
    // 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.
    //
    // If you are using Basic authentication for your AS2 connector, the access
    // role requires the secretsmanager:GetSecretValue permission for the secret.
    // If the secret is encrypted using a customer-managed key instead of the Amazon
    // Web Services managed key in Secrets Manager, then the role also needs the
    // kms:Decrypt permission for that key.
    //
    // For SFTP connectors
    //
    // Make sure that the access role provides read and write access to the parent
    // directory of the file location that's used in the StartFileTransfer request.
    // Additionally, make sure that the role provides secretsmanager:GetSecretValue
    // permission to Secrets Manager.
    //
    // AccessRole is a required field
    AccessRole *string `min:"20" type:"string" required:"true"`

    // A structure that contains the parameters for an AS2 connector object.
    As2Config *As2ConnectorConfig `type:"structure"`

    // 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.
    LoggingRole *string `min:"20" type:"string"`

    // Specifies the name of the security policy for the connector.
    SecurityPolicyName *string `type:"string"`

    // A structure that contains the parameters for an SFTP connector object.
    SftpConfig *SftpConnectorConfig `type:"structure"`

    // Key-value pairs that can be used to group and search for connectors. Tags
    // are metadata attached to connectors for any purpose.
    Tags []*Tag `min:"1" type:"list"`

    // The URL of the partner's AS2 or SFTP endpoint.
    //
    // Url is a required field
    Url *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateConnectorInput) GoString ¶

func (s CreateConnectorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectorInput) SetAccessRole ¶

func (s *CreateConnectorInput) SetAccessRole(v string) *CreateConnectorInput

SetAccessRole sets the AccessRole field's value.

func (*CreateConnectorInput) SetAs2Config ¶

func (s *CreateConnectorInput) SetAs2Config(v *As2ConnectorConfig) *CreateConnectorInput

SetAs2Config sets the As2Config field's value.

func (*CreateConnectorInput) SetLoggingRole ¶

func (s *CreateConnectorInput) SetLoggingRole(v string) *CreateConnectorInput

SetLoggingRole sets the LoggingRole field's value.

func (*CreateConnectorInput) SetSecurityPolicyName ¶

func (s *CreateConnectorInput) SetSecurityPolicyName(v string) *CreateConnectorInput

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*CreateConnectorInput) SetSftpConfig ¶

func (s *CreateConnectorInput) SetSftpConfig(v *SftpConnectorConfig) *CreateConnectorInput

SetSftpConfig sets the SftpConfig field's value.

func (*CreateConnectorInput) SetTags ¶

func (s *CreateConnectorInput) SetTags(v []*Tag) *CreateConnectorInput

SetTags sets the Tags field's value.

func (*CreateConnectorInput) SetUrl ¶

func (s *CreateConnectorInput) SetUrl(v string) *CreateConnectorInput

SetUrl sets the Url field's value.

func (CreateConnectorInput) String ¶

func (s CreateConnectorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectorInput) Validate ¶

func (s *CreateConnectorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectorOutput ¶

type CreateConnectorOutput struct {

    // The unique identifier for the connector, returned after the API call succeeds.
    //
    // ConnectorId is a required field
    ConnectorId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateConnectorOutput) GoString ¶

func (s CreateConnectorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectorOutput) SetConnectorId ¶

func (s *CreateConnectorOutput) SetConnectorId(v string) *CreateConnectorOutput

SetConnectorId sets the ConnectorId field's value.

func (CreateConnectorOutput) String ¶

func (s CreateConnectorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateProfileInput ¶

type CreateProfileInput struct {

    // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130).
    // 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.
    //
    // As2Id is a required field
    As2Id *string `min:"1" type:"string" required:"true"`

    // An array of identifiers for the imported certificates. You use this identifier
    // for working with profiles and partner profiles.
    CertificateIds []*string `type:"list"`

    // 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.
    //
    // ProfileType is a required field
    ProfileType *string `type:"string" required:"true" enum:"ProfileType"`

    // Key-value pairs that can be used to group and search for AS2 profiles.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (CreateProfileInput) GoString ¶

func (s CreateProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProfileInput) SetAs2Id ¶

func (s *CreateProfileInput) SetAs2Id(v string) *CreateProfileInput

SetAs2Id sets the As2Id field's value.

func (*CreateProfileInput) SetCertificateIds ¶

func (s *CreateProfileInput) SetCertificateIds(v []*string) *CreateProfileInput

SetCertificateIds sets the CertificateIds field's value.

func (*CreateProfileInput) SetProfileType ¶

func (s *CreateProfileInput) SetProfileType(v string) *CreateProfileInput

SetProfileType sets the ProfileType field's value.

func (*CreateProfileInput) SetTags ¶

func (s *CreateProfileInput) SetTags(v []*Tag) *CreateProfileInput

SetTags sets the Tags field's value.

func (CreateProfileInput) String ¶

func (s CreateProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProfileInput) Validate ¶

func (s *CreateProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateProfileOutput ¶

type CreateProfileOutput struct {

    // The unique identifier for the AS2 profile, returned after the API call succeeds.
    //
    // ProfileId is a required field
    ProfileId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateProfileOutput) GoString ¶

func (s CreateProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProfileOutput) SetProfileId ¶

func (s *CreateProfileOutput) SetProfileId(v string) *CreateProfileOutput

SetProfileId sets the ProfileId field's value.

func (CreateProfileOutput) String ¶

func (s CreateProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateServerInput ¶

type CreateServerInput struct {

    // 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 (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html)
    // in the Certificate Manager User Guide.
    //
    // To import an existing certificate into ACM, see Importing certificates into
    // ACM (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
    // in the Certificate Manager User Guide.
    //
    // To request a private certificate to use FTPS through private IP addresses,
    // see Request a private certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html)
    // 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.
    Certificate *string `type:"string"`

    // 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.
    Domain *string `type:"string" enum:"Domain"`

    // 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.
    EndpointDetails *EndpointDetails `type:"structure"`

    // 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.
    EndpointType *string `type:"string" enum:"EndpointType"`

    // 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 Manage host keys for your SFTP-enabled server (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key)
    // in the Transfer Family User Guide.
    //
    // HostKey is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by CreateServerInput's
    // String and GoString methods.
    HostKey *string `type:"string" sensitive:"true"`

    // Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon
    // Web Services_LAMBDA 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.
    IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

    // 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 for the IdentityProviderDetails data type.
    IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`

    // 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.
    LoggingRole *string `type:"string"`

    // 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.
    PostAuthenticationLoginBanner *string `type:"string"`

    // 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.
    PreAuthenticationLoginBanner *string `type:"string"`

    // 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.
    ProtocolDetails *ProtocolDetails `type:"structure"`

    // 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 either AWS_DIRECTORY_SERVICE,
    //    AWS_LAMBDA, 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 any of the supported identity
    //    types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.
    //
    //    * If Protocol includes AS2, then the EndpointType must be VPC, and domain
    //    must be Amazon S3.
    Protocols []*string `min:"1" type:"list" enum:"Protocol"`

    // Specifies whether or not performance for your Amazon S3 directories is optimized.
    // This is disabled by default.
    //
    // By default, home directory mappings have a TYPE of DIRECTORY. If you enable
    // this option, you would then need to explicitly set the HomeDirectoryMapEntry
    // Type to FILE if you want a mapping to have a file target.
    S3StorageOptions *S3StorageOptions `type:"structure"`

    // Specifies the name of the security policy for the server.
    SecurityPolicyName *string `type:"string"`

    // Specifies the log groups to which your server logs are sent.
    //
    // To specify a log group, you must provide the ARN for an existing log group.
    // In this case, the format of the log group is as follows:
    //
    // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
    //
    // For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
    //
    // If you have previously specified a log group for a server, you can clear
    // it, and in effect turn off structured logging, by providing an empty value
    // for this parameter in an update-server call. For example:
    //
    // update-server --server-id s-1234567890abcdef0 --structured-log-destinations
    StructuredLogDestinations []*string `type:"list"`

    // Key-value pairs that can be used to group and search for servers.
    Tags []*Tag `min:"1" type:"list"`

    // Specifies the workflow ID for the workflow to assign and the execution role
    // that's used for executing the workflow.
    //
    // In addition to a workflow to execute when a file is uploaded completely,
    // WorkflowDetails can also contain a workflow ID (and execution role) for a
    // workflow to execute on partial upload. A partial upload occurs when the server
    // session disconnects while the file is still being uploaded.
    WorkflowDetails *WorkflowDetails `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateServerInput) GoString ¶

func (s CreateServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServerInput) SetCertificate ¶

func (s *CreateServerInput) SetCertificate(v string) *CreateServerInput

SetCertificate sets the Certificate field's value.

func (*CreateServerInput) SetDomain ¶

func (s *CreateServerInput) SetDomain(v string) *CreateServerInput

SetDomain sets the Domain field's value.

func (*CreateServerInput) SetEndpointDetails ¶

func (s *CreateServerInput) SetEndpointDetails(v *EndpointDetails) *CreateServerInput

SetEndpointDetails sets the EndpointDetails field's value.

func (*CreateServerInput) SetEndpointType ¶

func (s *CreateServerInput) SetEndpointType(v string) *CreateServerInput

SetEndpointType sets the EndpointType field's value.

func (*CreateServerInput) SetHostKey ¶

func (s *CreateServerInput) SetHostKey(v string) *CreateServerInput

SetHostKey sets the HostKey field's value.

func (*CreateServerInput) SetIdentityProviderDetails ¶

func (s *CreateServerInput) SetIdentityProviderDetails(v *IdentityProviderDetails) *CreateServerInput

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*CreateServerInput) SetIdentityProviderType ¶

func (s *CreateServerInput) SetIdentityProviderType(v string) *CreateServerInput

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*CreateServerInput) SetLoggingRole ¶

func (s *CreateServerInput) SetLoggingRole(v string) *CreateServerInput

SetLoggingRole sets the LoggingRole field's value.

func (*CreateServerInput) SetPostAuthenticationLoginBanner ¶

func (s *CreateServerInput) SetPostAuthenticationLoginBanner(v string) *CreateServerInput

SetPostAuthenticationLoginBanner sets the PostAuthenticationLoginBanner field's value.

func (*CreateServerInput) SetPreAuthenticationLoginBanner ¶

func (s *CreateServerInput) SetPreAuthenticationLoginBanner(v string) *CreateServerInput

SetPreAuthenticationLoginBanner sets the PreAuthenticationLoginBanner field's value.

func (*CreateServerInput) SetProtocolDetails ¶

func (s *CreateServerInput) SetProtocolDetails(v *ProtocolDetails) *CreateServerInput

SetProtocolDetails sets the ProtocolDetails field's value.

func (*CreateServerInput) SetProtocols ¶

func (s *CreateServerInput) SetProtocols(v []*string) *CreateServerInput

SetProtocols sets the Protocols field's value.

func (*CreateServerInput) SetS3StorageOptions ¶

func (s *CreateServerInput) SetS3StorageOptions(v *S3StorageOptions) *CreateServerInput

SetS3StorageOptions sets the S3StorageOptions field's value.

func (*CreateServerInput) SetSecurityPolicyName ¶

func (s *CreateServerInput) SetSecurityPolicyName(v string) *CreateServerInput

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*CreateServerInput) SetStructuredLogDestinations ¶

func (s *CreateServerInput) SetStructuredLogDestinations(v []*string) *CreateServerInput

SetStructuredLogDestinations sets the StructuredLogDestinations field's value.

func (*CreateServerInput) SetTags ¶

func (s *CreateServerInput) SetTags(v []*Tag) *CreateServerInput

SetTags sets the Tags field's value.

func (*CreateServerInput) SetWorkflowDetails ¶

func (s *CreateServerInput) SetWorkflowDetails(v *WorkflowDetails) *CreateServerInput

SetWorkflowDetails sets the WorkflowDetails field's value.

func (CreateServerInput) String ¶

func (s CreateServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServerInput) Validate ¶

func (s *CreateServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateServerOutput ¶

type CreateServerOutput struct {

    // The service-assigned identifier of the server that is created.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateServerOutput) GoString ¶

func (s CreateServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServerOutput) SetServerId ¶

func (s *CreateServerOutput) SetServerId(v string) *CreateServerOutput

SetServerId sets the ServerId field's value.

func (CreateServerOutput) String ¶

func (s CreateServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateUserInput ¶

type CreateUserInput struct {

    // 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.
    //
    // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
    HomeDirectory *string `type:"string"`

    // 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 value the user should see for their
    // home directory when they log in.
    //
    // The following is an Entry and Target pair example for chroot.
    //
    // [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
    HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"`

    // 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 Amazon EFS path as is in their file
    // transfer protocol clients. If you set it to 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.
    //
    // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings
    // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide
    // an absolute path using the HomeDirectory parameter. You cannot have both
    // HomeDirectory and HomeDirectoryMappings in your template.
    HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

    // 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 (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html).
    //
    // For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
    // in the Amazon Web Services Security Token Service API Reference.
    Policy *string `type:"string"`

    // 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.
    PosixProfile *PosixProfile `type:"structure"`

    // 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.
    //
    // Role is a required field
    Role *string `min:"20" type:"string" required:"true"`

    // A system-assigned unique identifier for a server instance. This is the specific
    // server that you added your user to.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // The public portion of the Secure Shell (SSH) key used to authenticate the
    // user to the server.
    //
    // The three standard SSH public key format elements are <key type>, <body base64>,
    // and an optional <comment>, with spaces between each element.
    //
    // Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    //
    //    * For RSA keys, the key type is ssh-rsa.
    //
    //    * For ED25519 keys, the key type is ssh-ed25519.
    //
    //    * For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384,
    //    or ecdsa-sha2-nistp521, depending on the size of the key you generated.
    SshPublicKeyBody *string `type:"string"`

    // Key-value pairs that can be used to group and search for users. Tags are
    // metadata attached to users for any purpose.
    Tags []*Tag `min:"1" type:"list"`

    // 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.
    //
    // UserName is a required field
    UserName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateUserInput) GoString ¶

func (s CreateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserInput) SetHomeDirectory ¶

func (s *CreateUserInput) SetHomeDirectory(v string) *CreateUserInput

SetHomeDirectory sets the HomeDirectory field's value.

func (*CreateUserInput) SetHomeDirectoryMappings ¶

func (s *CreateUserInput) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *CreateUserInput

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*CreateUserInput) SetHomeDirectoryType ¶

func (s *CreateUserInput) SetHomeDirectoryType(v string) *CreateUserInput

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*CreateUserInput) SetPolicy ¶

func (s *CreateUserInput) SetPolicy(v string) *CreateUserInput

SetPolicy sets the Policy field's value.

func (*CreateUserInput) SetPosixProfile ¶

func (s *CreateUserInput) SetPosixProfile(v *PosixProfile) *CreateUserInput

SetPosixProfile sets the PosixProfile field's value.

func (*CreateUserInput) SetRole ¶

func (s *CreateUserInput) SetRole(v string) *CreateUserInput

SetRole sets the Role field's value.

func (*CreateUserInput) SetServerId ¶

func (s *CreateUserInput) SetServerId(v string) *CreateUserInput

SetServerId sets the ServerId field's value.

func (*CreateUserInput) SetSshPublicKeyBody ¶

func (s *CreateUserInput) SetSshPublicKeyBody(v string) *CreateUserInput

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*CreateUserInput) SetTags ¶

func (s *CreateUserInput) SetTags(v []*Tag) *CreateUserInput

SetTags sets the Tags field's value.

func (*CreateUserInput) SetUserName ¶

func (s *CreateUserInput) SetUserName(v string) *CreateUserInput

SetUserName sets the UserName field's value.

func (CreateUserInput) String ¶

func (s CreateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserInput) Validate ¶

func (s *CreateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateUserOutput ¶

type CreateUserOutput struct {

    // The identifier of the server that the user is attached to.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // A unique string that identifies a Transfer Family user.
    //
    // UserName is a required field
    UserName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateUserOutput) GoString ¶

func (s CreateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUserOutput) SetServerId ¶

func (s *CreateUserOutput) SetServerId(v string) *CreateUserOutput

SetServerId sets the ServerId field's value.

func (*CreateUserOutput) SetUserName ¶

func (s *CreateUserOutput) SetUserName(v string) *CreateUserOutput

SetUserName sets the UserName field's value.

func (CreateUserOutput) String ¶

func (s CreateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkflowInput ¶

type CreateWorkflowInput struct {

    // A textual description for the workflow.
    Description *string `type:"string"`

    // 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.
    OnExceptionSteps []*WorkflowStep `type:"list"`

    // 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.
    //
    //    * DECRYPT - Decrypt a file that was encrypted before it was uploaded.
    //
    //    * 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 Amazon S3 bucket and key, or the
    // Amazon EFS file system ID and path.
    //
    // Steps is a required field
    Steps []*WorkflowStep `type:"list" required:"true"`

    // Key-value pairs that can be used to group and search for workflows. Tags
    // are metadata attached to workflows for any purpose.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (CreateWorkflowInput) GoString ¶

func (s CreateWorkflowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkflowInput) SetDescription ¶

func (s *CreateWorkflowInput) SetDescription(v string) *CreateWorkflowInput

SetDescription sets the Description field's value.

func (*CreateWorkflowInput) SetOnExceptionSteps ¶

func (s *CreateWorkflowInput) SetOnExceptionSteps(v []*WorkflowStep) *CreateWorkflowInput

SetOnExceptionSteps sets the OnExceptionSteps field's value.

func (*CreateWorkflowInput) SetSteps ¶

func (s *CreateWorkflowInput) SetSteps(v []*WorkflowStep) *CreateWorkflowInput

SetSteps sets the Steps field's value.

func (*CreateWorkflowInput) SetTags ¶

func (s *CreateWorkflowInput) SetTags(v []*Tag) *CreateWorkflowInput

SetTags sets the Tags field's value.

func (CreateWorkflowInput) String ¶

func (s CreateWorkflowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkflowInput) Validate ¶

func (s *CreateWorkflowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkflowOutput ¶

type CreateWorkflowOutput struct {

    // A unique identifier for the workflow.
    //
    // WorkflowId is a required field
    WorkflowId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateWorkflowOutput) GoString ¶

func (s CreateWorkflowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkflowOutput) SetWorkflowId ¶

func (s *CreateWorkflowOutput) SetWorkflowId(v string) *CreateWorkflowOutput

SetWorkflowId sets the WorkflowId field's value.

func (CreateWorkflowOutput) String ¶

func (s CreateWorkflowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomStepDetails ¶

type CustomStepDetails struct {

    // The name of the step, used as an identifier.
    Name *string `type:"string"`

    // 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.
    //
    //    * To use the previous file as the input, enter ${previous.file}. In this
    //    case, this workflow step uses the output file from the previous workflow
    //    step as input. This is the default value.
    //
    //    * To use the originally uploaded file location as input for this step,
    //    enter ${original.file}.
    SourceFileLocation *string `type:"string"`

    // The ARN for the Lambda function that is being called.
    Target *string `type:"string"`

    // Timeout, in seconds, for the step.
    TimeoutSeconds *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

Each step type has its own StepDetails structure.

func (CustomStepDetails) GoString ¶

func (s CustomStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomStepDetails) SetName ¶

func (s *CustomStepDetails) SetName(v string) *CustomStepDetails

SetName sets the Name field's value.

func (*CustomStepDetails) SetSourceFileLocation ¶

func (s *CustomStepDetails) SetSourceFileLocation(v string) *CustomStepDetails

SetSourceFileLocation sets the SourceFileLocation field's value.

func (*CustomStepDetails) SetTarget ¶

func (s *CustomStepDetails) SetTarget(v string) *CustomStepDetails

SetTarget sets the Target field's value.

func (*CustomStepDetails) SetTimeoutSeconds ¶

func (s *CustomStepDetails) SetTimeoutSeconds(v int64) *CustomStepDetails

SetTimeoutSeconds sets the TimeoutSeconds field's value.

func (CustomStepDetails) String ¶

func (s CustomStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomStepDetails) Validate ¶

func (s *CustomStepDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DecryptStepDetails ¶

type DecryptStepDetails struct {

    // Specifies the location for the file being decrypted. Use ${Transfer:UserName}
    // or ${Transfer:UploadDate} in this field to parametrize the destination prefix
    // by username or uploaded date.
    //
    //    * Set the value of DestinationFileLocation to ${Transfer:UserName} to
    //    decrypt uploaded files to an Amazon S3 bucket that is prefixed with the
    //    name of the Transfer Family user that uploaded the file.
    //
    //    * Set the value of DestinationFileLocation to ${Transfer:UploadDate} to
    //    decrypt uploaded files to an Amazon S3 bucket that is prefixed with the
    //    date of the upload. The system resolves UploadDate to a date format of
    //    YYYY-MM-DD, based on the date the file is uploaded in UTC.
    //
    // DestinationFileLocation is a required field
    DestinationFileLocation *InputFileLocation `type:"structure" required:"true"`

    // The name of the step, used as an identifier.
    Name *string `type:"string"`

    // A flag that indicates whether to overwrite an existing file of the same name.
    // The default is FALSE.
    //
    // If the workflow is processing a file that has the same name as an existing
    // file, the behavior is as follows:
    //
    //    * If OverwriteExisting is TRUE, the existing file is replaced with the
    //    file being processed.
    //
    //    * If OverwriteExisting is FALSE, nothing happens, and the workflow processing
    //    stops.
    OverwriteExisting *string `type:"string" enum:"OverwriteExisting"`

    // 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.
    //
    //    * To use the previous file as the input, enter ${previous.file}. In this
    //    case, this workflow step uses the output file from the previous workflow
    //    step as input. This is the default value.
    //
    //    * To use the originally uploaded file location as input for this step,
    //    enter ${original.file}.
    SourceFileLocation *string `type:"string"`

    // The type of encryption used. Currently, this value must be PGP.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"EncryptionType"`
    // contains filtered or unexported fields
}

Each step type has its own StepDetails structure.

func (DecryptStepDetails) GoString ¶

func (s DecryptStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecryptStepDetails) SetDestinationFileLocation ¶

func (s *DecryptStepDetails) SetDestinationFileLocation(v *InputFileLocation) *DecryptStepDetails

SetDestinationFileLocation sets the DestinationFileLocation field's value.

func (*DecryptStepDetails) SetName ¶

func (s *DecryptStepDetails) SetName(v string) *DecryptStepDetails

SetName sets the Name field's value.

func (*DecryptStepDetails) SetOverwriteExisting ¶

func (s *DecryptStepDetails) SetOverwriteExisting(v string) *DecryptStepDetails

SetOverwriteExisting sets the OverwriteExisting field's value.

func (*DecryptStepDetails) SetSourceFileLocation ¶

func (s *DecryptStepDetails) SetSourceFileLocation(v string) *DecryptStepDetails

SetSourceFileLocation sets the SourceFileLocation field's value.

func (*DecryptStepDetails) SetType ¶

func (s *DecryptStepDetails) SetType(v string) *DecryptStepDetails

SetType sets the Type field's value.

func (DecryptStepDetails) String ¶

func (s DecryptStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecryptStepDetails) Validate ¶

func (s *DecryptStepDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessInput ¶

type DeleteAccessInput struct {

    // 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: =,.@:/-
    //
    // ExternalId is a required field
    ExternalId *string `min:"1" type:"string" required:"true"`

    // A system-assigned unique identifier for a server that has this user assigned.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAccessInput) GoString ¶

func (s DeleteAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessInput) SetExternalId ¶

func (s *DeleteAccessInput) SetExternalId(v string) *DeleteAccessInput

SetExternalId sets the ExternalId field's value.

func (*DeleteAccessInput) SetServerId ¶

func (s *DeleteAccessInput) SetServerId(v string) *DeleteAccessInput

SetServerId sets the ServerId field's value.

func (DeleteAccessInput) String ¶

func (s DeleteAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessInput) Validate ¶

func (s *DeleteAccessInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessOutput ¶

type DeleteAccessOutput struct {
    // contains filtered or unexported fields
}

func (DeleteAccessOutput) GoString ¶

func (s DeleteAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAccessOutput) String ¶

func (s DeleteAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAgreementInput ¶

type DeleteAgreementInput struct {

    // A unique identifier for the agreement. This identifier is returned when you
    // create an agreement.
    //
    // AgreementId is a required field
    AgreementId *string `min:"19" type:"string" required:"true"`

    // The server identifier associated with the agreement that you are deleting.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAgreementInput) GoString ¶

func (s DeleteAgreementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgreementInput) SetAgreementId ¶

func (s *DeleteAgreementInput) SetAgreementId(v string) *DeleteAgreementInput

SetAgreementId sets the AgreementId field's value.

func (*DeleteAgreementInput) SetServerId ¶

func (s *DeleteAgreementInput) SetServerId(v string) *DeleteAgreementInput

SetServerId sets the ServerId field's value.

func (DeleteAgreementInput) String ¶

func (s DeleteAgreementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgreementInput) Validate ¶

func (s *DeleteAgreementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAgreementOutput ¶

type DeleteAgreementOutput struct {
    // contains filtered or unexported fields
}

func (DeleteAgreementOutput) GoString ¶

func (s DeleteAgreementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAgreementOutput) String ¶

func (s DeleteAgreementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCertificateInput ¶

type DeleteCertificateInput struct {

    // The identifier of the certificate object that you are deleting.
    //
    // CertificateId is a required field
    CertificateId *string `min:"22" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteCertificateInput) GoString ¶

func (s DeleteCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCertificateInput) SetCertificateId ¶

func (s *DeleteCertificateInput) SetCertificateId(v string) *DeleteCertificateInput

SetCertificateId sets the CertificateId field's value.

func (DeleteCertificateInput) String ¶

func (s DeleteCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCertificateInput) Validate ¶

func (s *DeleteCertificateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCertificateOutput ¶

type DeleteCertificateOutput struct {
    // contains filtered or unexported fields
}

func (DeleteCertificateOutput) GoString ¶

func (s DeleteCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCertificateOutput) String ¶

func (s DeleteCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteConnectorInput ¶

type DeleteConnectorInput struct {

    // The unique identifier for the connector.
    //
    // ConnectorId is a required field
    ConnectorId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteConnectorInput) GoString ¶

func (s DeleteConnectorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectorInput) SetConnectorId ¶

func (s *DeleteConnectorInput) SetConnectorId(v string) *DeleteConnectorInput

SetConnectorId sets the ConnectorId field's value.

func (DeleteConnectorInput) String ¶

func (s DeleteConnectorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectorInput) Validate ¶

func (s *DeleteConnectorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConnectorOutput ¶

type DeleteConnectorOutput struct {
    // contains filtered or unexported fields
}

func (DeleteConnectorOutput) GoString ¶

func (s DeleteConnectorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteConnectorOutput) String ¶

func (s DeleteConnectorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteHostKeyInput ¶

type DeleteHostKeyInput struct {

    // The identifier of the host key that you are deleting.
    //
    // HostKeyId is a required field
    HostKeyId *string `min:"25" type:"string" required:"true"`

    // The identifier of the server that contains the host key that you are deleting.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteHostKeyInput) GoString ¶

func (s DeleteHostKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteHostKeyInput) SetHostKeyId ¶

func (s *DeleteHostKeyInput) SetHostKeyId(v string) *DeleteHostKeyInput

SetHostKeyId sets the HostKeyId field's value.

func (*DeleteHostKeyInput) SetServerId ¶

func (s *DeleteHostKeyInput) SetServerId(v string) *DeleteHostKeyInput

SetServerId sets the ServerId field's value.

func (DeleteHostKeyInput) String ¶

func (s DeleteHostKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteHostKeyInput) Validate ¶

func (s *DeleteHostKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteHostKeyOutput ¶

type DeleteHostKeyOutput struct {
    // contains filtered or unexported fields
}

func (DeleteHostKeyOutput) GoString ¶

func (s DeleteHostKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteHostKeyOutput) String ¶

func (s DeleteHostKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteProfileInput ¶

type DeleteProfileInput struct {

    // The identifier of the profile that you are deleting.
    //
    // ProfileId is a required field
    ProfileId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteProfileInput) GoString ¶

func (s DeleteProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProfileInput) SetProfileId ¶

func (s *DeleteProfileInput) SetProfileId(v string) *DeleteProfileInput

SetProfileId sets the ProfileId field's value.

func (DeleteProfileInput) String ¶

func (s DeleteProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProfileInput) Validate ¶

func (s *DeleteProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteProfileOutput ¶

type DeleteProfileOutput struct {
    // contains filtered or unexported fields
}

func (DeleteProfileOutput) GoString ¶

func (s DeleteProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteProfileOutput) String ¶

func (s DeleteProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteServerInput ¶

type DeleteServerInput struct {

    // A unique system-assigned identifier for a server instance.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteServerInput) GoString ¶

func (s DeleteServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteServerInput) SetServerId ¶

func (s *DeleteServerInput) SetServerId(v string) *DeleteServerInput

SetServerId sets the ServerId field's value.

func (DeleteServerInput) String ¶

func (s DeleteServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteServerInput) Validate ¶

func (s *DeleteServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteServerOutput ¶

type DeleteServerOutput struct {
    // contains filtered or unexported fields
}

func (DeleteServerOutput) GoString ¶

func (s DeleteServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteServerOutput) String ¶

func (s DeleteServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSshPublicKeyInput ¶

type DeleteSshPublicKeyInput struct {

    // A system-assigned unique identifier for a file transfer protocol-enabled
    // server instance that has the user assigned to it.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // A unique identifier used to reference your user's specific SSH key.
    //
    // SshPublicKeyId is a required field
    SshPublicKeyId *string `min:"21" type:"string" required:"true"`

    // A unique string that identifies a user whose public key is being deleted.
    //
    // UserName is a required field
    UserName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteSshPublicKeyInput) GoString ¶

func (s DeleteSshPublicKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSshPublicKeyInput) SetServerId ¶

func (s *DeleteSshPublicKeyInput) SetServerId(v string) *DeleteSshPublicKeyInput

SetServerId sets the ServerId field's value.

func (*DeleteSshPublicKeyInput) SetSshPublicKeyId ¶

func (s *DeleteSshPublicKeyInput) SetSshPublicKeyId(v string) *DeleteSshPublicKeyInput

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (*DeleteSshPublicKeyInput) SetUserName ¶

func (s *DeleteSshPublicKeyInput) SetUserName(v string) *DeleteSshPublicKeyInput

SetUserName sets the UserName field's value.

func (DeleteSshPublicKeyInput) String ¶

func (s DeleteSshPublicKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSshPublicKeyInput) Validate ¶

func (s *DeleteSshPublicKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSshPublicKeyOutput ¶

type DeleteSshPublicKeyOutput struct {
    // contains filtered or unexported fields
}

func (DeleteSshPublicKeyOutput) GoString ¶

func (s DeleteSshPublicKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSshPublicKeyOutput) String ¶

func (s DeleteSshPublicKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStepDetails ¶

type DeleteStepDetails struct {

    // The name of the step, used as an identifier.
    Name *string `type:"string"`

    // 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.
    //
    //    * To use the previous file as the input, enter ${previous.file}. In this
    //    case, this workflow step uses the output file from the previous workflow
    //    step as input. This is the default value.
    //
    //    * To use the originally uploaded file location as input for this step,
    //    enter ${original.file}.
    SourceFileLocation *string `type:"string"`
    // contains filtered or unexported fields
}

The name of the step, used to identify the delete step.

func (DeleteStepDetails) GoString ¶

func (s DeleteStepDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStepDetails) SetName ¶

func (s *DeleteStepDetails) SetName(v string) *DeleteStepDetails

SetName sets the Name field's value.

func (*DeleteStepDetails) SetSourceFileLocation ¶

func (s *DeleteStepDetails) SetSourceFileLocation(v string) *DeleteStepDetails

SetSourceFileLocation sets the SourceFileLocation field's value.

func (DeleteStepDetails) String ¶

func (s DeleteStepDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteUserInput ¶

type DeleteUserInput struct {

    // A system-assigned unique identifier for a server instance that has the user
    // assigned to it.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // A unique string that identifies a user that is being deleted from a server.
    //
    // UserName is a required field
    UserName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteUserInput) GoString ¶

func (s DeleteUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserInput) SetServerId ¶

func (s *DeleteUserInput) SetServerId(v string) *DeleteUserInput

SetServerId sets the ServerId field's value.

func (*DeleteUserInput) SetUserName ¶

func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput

SetUserName sets the UserName field's value.

func (DeleteUserInput) String ¶

func (s DeleteUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteUserInput) Validate ¶

func (s *DeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserOutput ¶

type DeleteUserOutput struct {
    // contains filtered or unexported fields
}

func (DeleteUserOutput) GoString ¶

func (s DeleteUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteUserOutput) String ¶

func (s DeleteUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkflowInput ¶

type DeleteWorkflowInput struct {

    // A unique identifier for the workflow.
    //
    // WorkflowId is a required field
    WorkflowId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteWorkflowInput) GoString ¶

func (s DeleteWorkflowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkflowInput) SetWorkflowId ¶

func (s *DeleteWorkflowInput) SetWorkflowId(v string) *DeleteWorkflowInput

SetWorkflowId sets the WorkflowId field's value.

func (DeleteWorkflowInput) String ¶

func (s DeleteWorkflowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkflowInput) Validate ¶

func (s *DeleteWorkflowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkflowOutput ¶

type DeleteWorkflowOutput struct {
    // contains filtered or unexported fields
}

func (DeleteWorkflowOutput) GoString ¶

func (s DeleteWorkflowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkflowOutput) String ¶

func (s DeleteWorkflowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccessInput ¶

type DescribeAccessInput struct {

    // 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: =,.@:/-
    //
    // ExternalId is a required field
    ExternalId *string `min:"1" type:"string" required:"true"`

    // A system-assigned unique identifier for a server that has this access assigned.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeAccessInput) GoString ¶

func (s DescribeAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessInput) SetExternalId ¶

func (s *DescribeAccessInput) SetExternalId(v string) *DescribeAccessInput

SetExternalId sets the ExternalId field's value.

func (*DescribeAccessInput) SetServerId ¶

func (s *DescribeAccessInput) SetServerId(v string) *DescribeAccessInput

SetServerId sets the ServerId field's value.

func (DescribeAccessInput) String ¶

func (s DescribeAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessInput) Validate ¶

func (s *DescribeAccessInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccessOutput ¶

type DescribeAccessOutput struct {

    // The external identifier of the server that the access is attached to.
    //
    // Access is a required field
    Access *DescribedAccess `type:"structure" required:"true"`

    // A system-assigned unique identifier for a server that has this access assigned.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeAccessOutput) GoString ¶

func (s DescribeAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessOutput) SetAccess ¶

func (s *DescribeAccessOutput) SetAccess(v *DescribedAccess) *DescribeAccessOutput

SetAccess sets the Access field's value.

func (*DescribeAccessOutput) SetServerId ¶

func (s *DescribeAccessOutput) SetServerId(v string) *DescribeAccessOutput

SetServerId sets the ServerId field's value.

func (DescribeAccessOutput) String ¶

func (s DescribeAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAgreementInput ¶

type DescribeAgreementInput struct {

    // A unique identifier for the agreement. This identifier is returned when you
    // create an agreement.
    //
    // AgreementId is a required field
    AgreementId *string `min:"19" type:"string" required:"true"`

    // The server identifier that's associated with the agreement.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeAgreementInput) GoString ¶

func (s DescribeAgreementInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAgreementInput) SetAgreementId ¶

func (s *DescribeAgreementInput) SetAgreementId(v string) *DescribeAgreementInput

SetAgreementId sets the AgreementId field's value.

func (*DescribeAgreementInput) SetServerId ¶

func (s *DescribeAgreementInput) SetServerId(v string) *DescribeAgreementInput

SetServerId sets the ServerId field's value.

func (DescribeAgreementInput) String ¶

func (s DescribeAgreementInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAgreementInput) Validate ¶

func (s *DescribeAgreementInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAgreementOutput ¶

type DescribeAgreementOutput struct {

    // The details for the specified agreement, returned as a DescribedAgreement
    // object.
    //
    // Agreement is a required field
    Agreement *DescribedAgreement `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeAgreementOutput) GoString ¶

func (s DescribeAgreementOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAgreementOutput) SetAgreement ¶

func (s *DescribeAgreementOutput) SetAgreement(v *DescribedAgreement) *DescribeAgreementOutput

SetAgreement sets the Agreement field's value.

func (DescribeAgreementOutput) String ¶

func (s DescribeAgreementOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCertificateInput ¶

type DescribeCertificateInput struct {

    // An array of identifiers for the imported certificates. You use this identifier
    // for working with profiles and partner profiles.
    //
    // CertificateId is a required field
    CertificateId *string `min:"22" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeCertificateInput) GoString ¶

func (s DescribeCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificateInput) SetCertificateId ¶

func (s *DescribeCertificateInput) SetCertificateId(v string) *DescribeCertificateInput

SetCertificateId sets the CertificateId field's value.

func (DescribeCertificateInput) String ¶

func (s DescribeCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificateInput) Validate ¶

func (s *DescribeCertificateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCertificateOutput ¶

type DescribeCertificateOutput struct {

    // The details for the specified certificate, returned as an object.
    //
    // Certificate is a required field
    Certificate *DescribedCertificate `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeCertificateOutput) GoString ¶

func (s DescribeCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCertificateOutput) SetCertificate ¶

func (s *DescribeCertificateOutput) SetCertificate(v *DescribedCertificate) *DescribeCertificateOutput

SetCertificate sets the Certificate field's value.

func (DescribeCertificateOutput) String ¶

func (s DescribeCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeConnectorInput ¶

type DescribeConnectorInput struct {

    // The unique identifier for the connector.
    //
    // ConnectorId is a required field
    ConnectorId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeConnectorInput) GoString ¶

func (s DescribeConnectorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectorInput) SetConnectorId ¶

func (s *DescribeConnectorInput) SetConnectorId(v string) *DescribeConnectorInput

SetConnectorId sets the ConnectorId field's value.

func (DescribeConnectorInput) String ¶

func (s DescribeConnectorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectorInput) Validate ¶

func (s *DescribeConnectorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeConnectorOutput ¶

type DescribeConnectorOutput struct {

    // The structure that contains the details of the connector.
    //
    // Connector is a required field
    Connector *DescribedConnector `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeConnectorOutput) GoString ¶

func (s DescribeConnectorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectorOutput) SetConnector ¶

func (s *DescribeConnectorOutput) SetConnector(v *DescribedConnector) *DescribeConnectorOutput

SetConnector sets the Connector field's value.

func (DescribeConnectorOutput) String ¶

func (s DescribeConnectorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExecutionInput ¶

type DescribeExecutionInput struct {

    // A unique identifier for the execution of a workflow.
    //
    // ExecutionId is a required field
    ExecutionId *string `min:"36" type:"string" required:"true"`

    // A unique identifier for the workflow.
    //
    // WorkflowId is a required field
    WorkflowId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeExecutionInput) GoString ¶

func (s DescribeExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExecutionInput) SetExecutionId ¶

func (s *DescribeExecutionInput) SetExecutionId(v string) *DescribeExecutionInput

SetExecutionId sets the ExecutionId field's value.

func (*DescribeExecutionInput) SetWorkflowId ¶

func (s *DescribeExecutionInput) SetWorkflowId(v string) *DescribeExecutionInput

SetWorkflowId sets the WorkflowId field's value.

func (DescribeExecutionInput) String ¶

func (s DescribeExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExecutionInput) Validate ¶

func (s *DescribeExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeExecutionOutput ¶

type DescribeExecutionOutput struct {

    // The structure that contains the details of the workflow' execution.
    //
    // Execution is a required field
    Execution *DescribedExecution `type:"structure" required:"true"`

    // A unique identifier for the workflow.
    //
    // WorkflowId is a required field
    WorkflowId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeExecutionOutput) GoString ¶

func (s DescribeExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExecutionOutput) SetExecution ¶

func (s *DescribeExecutionOutput) SetExecution(v *DescribedExecution) *DescribeExecutionOutput

SetExecution sets the Execution field's value.

func (*DescribeExecutionOutput) SetWorkflowId ¶

func (s *DescribeExecutionOutput) SetWorkflowId(v string) *DescribeExecutionOutput

SetWorkflowId sets the WorkflowId field's value.

func (DescribeExecutionOutput) String ¶

func (s DescribeExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeHostKeyInput ¶

type DescribeHostKeyInput struct {

    // The identifier of the host key that you want described.
    //
    // HostKeyId is a required field
    HostKeyId *string `min:"25" type:"string" required:"true"`

    // The identifier of the server that contains the host key that you want described.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeHostKeyInput) GoString ¶

func (s DescribeHostKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeHostKeyInput) SetHostKeyId ¶

func (s *DescribeHostKeyInput) SetHostKeyId(v string) *DescribeHostKeyInput

SetHostKeyId sets the HostKeyId field's value.

func (*DescribeHostKeyInput) SetServerId ¶

func (s *DescribeHostKeyInput) SetServerId(v string) *DescribeHostKeyInput

SetServerId sets the ServerId field's value.

func (DescribeHostKeyInput) String ¶

func (s DescribeHostKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeHostKeyInput) Validate ¶

func (s *DescribeHostKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeHostKeyOutput ¶

type DescribeHostKeyOutput struct {

    // Returns the details for the specified host key.
    //
    // HostKey is a required field
    HostKey *DescribedHostKey `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeHostKeyOutput) GoString ¶

func (s DescribeHostKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeHostKeyOutput) SetHostKey ¶

func (s *DescribeHostKeyOutput) SetHostKey(v *DescribedHostKey) *DescribeHostKeyOutput

SetHostKey sets the HostKey field's value.

func (DescribeHostKeyOutput) String ¶

func (s DescribeHostKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeProfileInput ¶

type DescribeProfileInput struct {

    // The identifier of the profile that you want described.
    //
    // ProfileId is a required field
    ProfileId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeProfileInput) GoString ¶

func (s DescribeProfileInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProfileInput) SetProfileId ¶

func (s *DescribeProfileInput) SetProfileId(v string) *DescribeProfileInput

SetProfileId sets the ProfileId field's value.

func (DescribeProfileInput) String ¶

func (s DescribeProfileInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProfileInput) Validate ¶

func (s *DescribeProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeProfileOutput ¶

type DescribeProfileOutput struct {

    // The details of the specified profile, returned as an object.
    //
    // Profile is a required field
    Profile *DescribedProfile `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeProfileOutput) GoString ¶

func (s DescribeProfileOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProfileOutput) SetProfile ¶

func (s *DescribeProfileOutput) SetProfile(v *DescribedProfile) *DescribeProfileOutput

SetProfile sets the Profile field's value.

func (DescribeProfileOutput) String ¶

func (s DescribeProfileOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSecurityPolicyInput ¶

type DescribeSecurityPolicyInput struct {

    // Specify the text name of the security policy for which you want the details.
    //
    // SecurityPolicyName is a required field
    SecurityPolicyName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeSecurityPolicyInput) GoString ¶

func (s DescribeSecurityPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityPolicyInput) SetSecurityPolicyName ¶

func (s *DescribeSecurityPolicyInput) SetSecurityPolicyName(v string) *DescribeSecurityPolicyInput

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (DescribeSecurityPolicyInput) String ¶

func (s DescribeSecurityPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityPolicyInput) Validate ¶

func (s *DescribeSecurityPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSecurityPolicyOutput ¶

type DescribeSecurityPolicyOutput struct {

    // An array containing the properties of the security policy.
    //
    // SecurityPolicy is a required field
    SecurityPolicy *DescribedSecurityPolicy `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeSecurityPolicyOutput) GoString ¶

func (s DescribeSecurityPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSecurityPolicyOutput) SetSecurityPolicy ¶

func (s *DescribeSecurityPolicyOutput) SetSecurityPolicy(v *DescribedSecurityPolicy) *DescribeSecurityPolicyOutput

SetSecurityPolicy sets the SecurityPolicy field's value.

func (DescribeSecurityPolicyOutput) String ¶

func (s DescribeSecurityPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeServerInput ¶

type DescribeServerInput struct {

    // A system-assigned unique identifier for a server.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeServerInput) GoString ¶

func (s DescribeServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServerInput) SetServerId ¶

func (s *DescribeServerInput) SetServerId(v string) *DescribeServerInput

SetServerId sets the ServerId field's value.

func (DescribeServerInput) String ¶

func (s DescribeServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServerInput) Validate ¶

func (s *DescribeServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeServerOutput ¶

type DescribeServerOutput struct {

    // An array containing the properties of a server with the ServerID you specified.
    //
    // Server is a required field
    Server *DescribedServer `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeServerOutput) GoString ¶

func (s DescribeServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServerOutput) SetServer ¶

func (s *DescribeServerOutput) SetServer(v *DescribedServer) *DescribeServerOutput

SetServer sets the Server field's value.

func (DescribeServerOutput) String ¶

func (s DescribeServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeUserInput ¶

type DescribeUserInput struct {

    // A system-assigned unique identifier for a server that has this user assigned.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // 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.
    //
    // UserName is a required field
    UserName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeUserInput) GoString ¶

func (s DescribeUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUserInput) SetServerId ¶

func (s *DescribeUserInput) SetServerId(v string) *DescribeUserInput

SetServerId sets the ServerId field's value.

func (*DescribeUserInput) SetUserName ¶

func (s *DescribeUserInput) SetUserName(v string) *DescribeUserInput

SetUserName sets the UserName field's value.

func (DescribeUserInput) String ¶

func (s DescribeUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUserInput) Validate ¶

func (s *DescribeUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserOutput ¶

type DescribeUserOutput struct {

    // A system-assigned unique identifier for a server that has this user assigned.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // An array containing the properties of the Transfer Family user for the ServerID
    // value that you specified.
    //
    // User is a required field
    User *DescribedUser `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeUserOutput) GoString ¶

func (s DescribeUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeUserOutput) SetServerId ¶

func (s *DescribeUserOutput) SetServerId(v string) *DescribeUserOutput

SetServerId sets the ServerId field's value.

func (*DescribeUserOutput) SetUser ¶

func (s *DescribeUserOutput) SetUser(v *DescribedUser) *DescribeUserOutput

SetUser sets the User field's value.

func (DescribeUserOutput) String ¶

func (s DescribeUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkflowInput ¶

type DescribeWorkflowInput struct {

    // A unique identifier for the workflow.
    //
    // WorkflowId is a required field
    WorkflowId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeWorkflowInput) GoString ¶

func (s DescribeWorkflowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkflowInput) SetWorkflowId ¶

func (s *DescribeWorkflowInput) SetWorkflowId(v string) *DescribeWorkflowInput

SetWorkflowId sets the WorkflowId field's value.

func (DescribeWorkflowInput) String ¶

func (s DescribeWorkflowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkflowInput) Validate ¶

func (s *DescribeWorkflowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeWorkflowOutput ¶

type DescribeWorkflowOutput struct {

    // The structure that contains the details of the workflow.
    //
    // Workflow is a required field
    Workflow *DescribedWorkflow `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeWorkflowOutput) GoString ¶

func (s DescribeWorkflowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkflowOutput) SetWorkflow ¶

func (s *DescribeWorkflowOutput) SetWorkflow(v *DescribedWorkflow) *DescribeWorkflowOutput

SetWorkflow sets the Workflow field's value.

func (DescribeWorkflowOutput) String ¶

func (s DescribeWorkflowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedAccess ¶

type DescribedAccess struct {

    // 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: =,.@:/-
    ExternalId *string `min:"1" type:"string"`

    // 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.
    //
    // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
    HomeDirectory *string `type:"string"`

    // 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.
    HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"`

    // 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 Amazon EFS path as is in their file
    // transfer protocol clients. If you set it to 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.
    //
    // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings
    // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide
    // an absolute path using the HomeDirectory parameter. You cannot have both
    // HomeDirectory and HomeDirectoryMappings in your template.
    HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

    // 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}.
    Policy *string `type:"string"`

    // 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.
    PosixProfile *PosixProfile `type:"structure"`

    // 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.
    Role *string `min:"20" type:"string"`
    // contains filtered or unexported fields
}

Describes the properties of the access that was specified.

func (DescribedAccess) GoString ¶

func (s DescribedAccess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedAccess) SetExternalId ¶

func (s *DescribedAccess) SetExternalId(v string) *DescribedAccess

SetExternalId sets the ExternalId field's value.

func (*DescribedAccess) SetHomeDirectory ¶

func (s *DescribedAccess) SetHomeDirectory(v string) *DescribedAccess

SetHomeDirectory sets the HomeDirectory field's value.

func (*DescribedAccess) SetHomeDirectoryMappings ¶

func (s *DescribedAccess) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *DescribedAccess

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*DescribedAccess) SetHomeDirectoryType ¶

func (s *DescribedAccess) SetHomeDirectoryType(v string) *DescribedAccess

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*DescribedAccess) SetPolicy ¶

func (s *DescribedAccess) SetPolicy(v string) *DescribedAccess

SetPolicy sets the Policy field's value.

func (*DescribedAccess) SetPosixProfile ¶

func (s *DescribedAccess) SetPosixProfile(v *PosixProfile) *DescribedAccess

SetPosixProfile sets the PosixProfile field's value.

func (*DescribedAccess) SetRole ¶

func (s *DescribedAccess) SetRole(v string) *DescribedAccess

SetRole sets the Role field's value.

func (DescribedAccess) String ¶

func (s DescribedAccess) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedAgreement ¶

type DescribedAgreement struct {

    // Connectors are used to send files using either the AS2 or SFTP protocol.
    // For the access role, provide the Amazon Resource Name (ARN) of the Identity
    // and Access Management role to use.
    //
    // For AS2 connectors
    //
    // 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.
    //
    // If you are using Basic authentication for your AS2 connector, the access
    // role requires the secretsmanager:GetSecretValue permission for the secret.
    // If the secret is encrypted using a customer-managed key instead of the Amazon
    // Web Services managed key in Secrets Manager, then the role also needs the
    // kms:Decrypt permission for that key.
    //
    // For SFTP connectors
    //
    // Make sure that the access role provides read and write access to the parent
    // directory of the file location that's used in the StartFileTransfer request.
    // Additionally, make sure that the role provides secretsmanager:GetSecretValue
    // permission to Secrets Manager.
    AccessRole *string `min:"20" type:"string"`

    // A unique identifier for the agreement. This identifier is returned when you
    // create an agreement.
    AgreementId *string `min:"19" type:"string"`

    // The unique Amazon Resource Name (ARN) for the agreement.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // The landing directory (folder) for files that are transferred by using the
    // AS2 protocol.
    BaseDirectory *string `type:"string"`

    // The name or short description that's used to identify the agreement.
    Description *string `min:"1" type:"string"`

    // A unique identifier for the AS2 local profile.
    LocalProfileId *string `min:"19" type:"string"`

    // A unique identifier for the partner profile used in the agreement.
    PartnerProfileId *string `min:"19" type:"string"`

    // A system-assigned unique identifier for a server instance. This identifier
    // indicates the specific server that the agreement uses.
    ServerId *string `min:"19" type:"string"`

    // The current status of the agreement, either ACTIVE or INACTIVE.
    Status *string `type:"string" enum:"AgreementStatusType"`

    // Key-value pairs that can be used to group and search for agreements.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

Describes the properties of an agreement.

func (DescribedAgreement) GoString ¶

func (s DescribedAgreement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedAgreement) SetAccessRole ¶

func (s *DescribedAgreement) SetAccessRole(v string) *DescribedAgreement

SetAccessRole sets the AccessRole field's value.

func (*DescribedAgreement) SetAgreementId ¶

func (s *DescribedAgreement) SetAgreementId(v string) *DescribedAgreement

SetAgreementId sets the AgreementId field's value.

func (*DescribedAgreement) SetArn ¶

func (s *DescribedAgreement) SetArn(v string) *DescribedAgreement

SetArn sets the Arn field's value.

func (*DescribedAgreement) SetBaseDirectory ¶

func (s *DescribedAgreement) SetBaseDirectory(v string) *DescribedAgreement

SetBaseDirectory sets the BaseDirectory field's value.

func (*DescribedAgreement) SetDescription ¶

func (s *DescribedAgreement) SetDescription(v string) *DescribedAgreement

SetDescription sets the Description field's value.

func (*DescribedAgreement) SetLocalProfileId ¶

func (s *DescribedAgreement) SetLocalProfileId(v string) *DescribedAgreement

SetLocalProfileId sets the LocalProfileId field's value.

func (*DescribedAgreement) SetPartnerProfileId ¶

func (s *DescribedAgreement) SetPartnerProfileId(v string) *DescribedAgreement

SetPartnerProfileId sets the PartnerProfileId field's value.

func (*DescribedAgreement) SetServerId ¶

func (s *DescribedAgreement) SetServerId(v string) *DescribedAgreement

SetServerId sets the ServerId field's value.

func (*DescribedAgreement) SetStatus ¶

func (s *DescribedAgreement) SetStatus(v string) *DescribedAgreement

SetStatus sets the Status field's value.

func (*DescribedAgreement) SetTags ¶

func (s *DescribedAgreement) SetTags(v []*Tag) *DescribedAgreement

SetTags sets the Tags field's value.

func (DescribedAgreement) String ¶

func (s DescribedAgreement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedCertificate ¶

type DescribedCertificate struct {

    // An optional date that specifies when the certificate becomes active.
    ActiveDate *time.Time `type:"timestamp"`

    // The unique Amazon Resource Name (ARN) for the certificate.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // The file name for the certificate.
    //
    // Certificate is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by DescribedCertificate's
    // String and GoString methods.
    Certificate *string `min:"1" type:"string" sensitive:"true"`

    // The list of certificates that make up the chain for the certificate.
    //
    // CertificateChain is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by DescribedCertificate's
    // String and GoString methods.
    CertificateChain *string `min:"1" type:"string" sensitive:"true"`

    // An array of identifiers for the imported certificates. You use this identifier
    // for working with profiles and partner profiles.
    CertificateId *string `min:"22" type:"string"`

    // The name or description that's used to identity the certificate.
    Description *string `min:"1" type:"string"`

    // An optional date that specifies when the certificate becomes inactive.
    InactiveDate *time.Time `type:"timestamp"`

    // The final date that the certificate is valid.
    NotAfterDate *time.Time `type:"timestamp"`

    // The earliest date that the certificate is valid.
    NotBeforeDate *time.Time `type:"timestamp"`

    // The serial number for the certificate.
    Serial *string `type:"string"`

    // The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION
    // means that this certificate will replace the current certificate when it
    // expires.
    Status *string `type:"string" enum:"CertificateStatusType"`

    // Key-value pairs that can be used to group and search for certificates.
    Tags []*Tag `min:"1" type:"list"`

    // 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.
    Type *string `type:"string" enum:"CertificateType"`

    // Specifies how this certificate is used. It can be used in the following ways:
    //
    //    * SIGNING: For signing AS2 messages
    //
    //    * ENCRYPTION: For encrypting AS2 messages
    //
    //    * TLS: For securing AS2 communications sent over HTTPS
    Usage *string `type:"string" enum:"CertificateUsageType"`
    // contains filtered or unexported fields
}

Describes the properties of a certificate.

func (DescribedCertificate) GoString ¶

func (s DescribedCertificate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedCertificate) SetActiveDate ¶

func (s *DescribedCertificate) SetActiveDate(v time.Time) *DescribedCertificate

SetActiveDate sets the ActiveDate field's value.

func (*DescribedCertificate) SetArn ¶

func (s *DescribedCertificate) SetArn(v string) *DescribedCertificate

SetArn sets the Arn field's value.

func (*DescribedCertificate) SetCertificate ¶

func (s *DescribedCertificate) SetCertificate(v string) *DescribedCertificate

SetCertificate sets the Certificate field's value.

func (*DescribedCertificate) SetCertificateChain ¶

func (s *DescribedCertificate) SetCertificateChain(v string) *DescribedCertificate

SetCertificateChain sets the CertificateChain field's value.

func (*DescribedCertificate) SetCertificateId ¶

func (s *DescribedCertificate) SetCertificateId(v string) *DescribedCertificate

SetCertificateId sets the CertificateId field's value.

func (*DescribedCertificate) SetDescription ¶

func (s *DescribedCertificate) SetDescription(v string) *DescribedCertificate

SetDescription sets the Description field's value.

func (*DescribedCertificate) SetInactiveDate ¶

func (s *DescribedCertificate) SetInactiveDate(v time.Time) *DescribedCertificate

SetInactiveDate sets the InactiveDate field's value.

func (*DescribedCertificate) SetNotAfterDate ¶

func (s *DescribedCertificate) SetNotAfterDate(v time.Time) *DescribedCertificate

SetNotAfterDate sets the NotAfterDate field's value.

func (*DescribedCertificate) SetNotBeforeDate ¶

func (s *DescribedCertificate) SetNotBeforeDate(v time.Time) *DescribedCertificate

SetNotBeforeDate sets the NotBeforeDate field's value.

func (*DescribedCertificate) SetSerial ¶

func (s *DescribedCertificate) SetSerial(v string) *DescribedCertificate

SetSerial sets the Serial field's value.

func (*DescribedCertificate) SetStatus ¶

func (s *DescribedCertificate) SetStatus(v string) *DescribedCertificate

SetStatus sets the Status field's value.

func (*DescribedCertificate) SetTags ¶

func (s *DescribedCertificate) SetTags(v []*Tag) *DescribedCertificate

SetTags sets the Tags field's value.

func (*DescribedCertificate) SetType ¶

func (s *DescribedCertificate) SetType(v string) *DescribedCertificate

SetType sets the Type field's value.

func (*DescribedCertificate) SetUsage ¶

func (s *DescribedCertificate) SetUsage(v string) *DescribedCertificate

SetUsage sets the Usage field's value.

func (DescribedCertificate) String ¶

func (s DescribedCertificate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedConnector ¶

type DescribedConnector struct {

    // Connectors are used to send files using either the AS2 or SFTP protocol.
    // For the access role, provide the Amazon Resource Name (ARN) of the Identity
    // and Access Management role to use.
    //
    // For AS2 connectors
    //
    // 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.
    //
    // If you are using Basic authentication for your AS2 connector, the access
    // role requires the secretsmanager:GetSecretValue permission for the secret.
    // If the secret is encrypted using a customer-managed key instead of the Amazon
    // Web Services managed key in Secrets Manager, then the role also needs the
    // kms:Decrypt permission for that key.
    //
    // For SFTP connectors
    //
    // Make sure that the access role provides read and write access to the parent
    // directory of the file location that's used in the StartFileTransfer request.
    // Additionally, make sure that the role provides secretsmanager:GetSecretValue
    // permission to Secrets Manager.
    AccessRole *string `min:"20" type:"string"`

    // The unique Amazon Resource Name (ARN) for the connector.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // A structure that contains the parameters for an AS2 connector object.
    As2Config *As2ConnectorConfig `type:"structure"`

    // The unique identifier for the connector.
    ConnectorId *string `min:"19" type:"string"`

    // 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.
    LoggingRole *string `min:"20" type:"string"`

    // The text name of the security policy for the specified connector.
    SecurityPolicyName *string `type:"string"`

    // The list of egress IP addresses of this connector. These IP addresses are
    // assigned automatically when you create the connector.
    ServiceManagedEgressIpAddresses []*string `type:"list"`

    // A structure that contains the parameters for an SFTP connector object.
    SftpConfig *SftpConnectorConfig `type:"structure"`

    // Key-value pairs that can be used to group and search for connectors.
    Tags []*Tag `min:"1" type:"list"`

    // The URL of the partner's AS2 or SFTP endpoint.
    Url *string `type:"string"`
    // contains filtered or unexported fields
}

Describes the parameters for the connector, as identified by the ConnectorId.

func (DescribedConnector) GoString ¶

func (s DescribedConnector) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedConnector) SetAccessRole ¶

func (s *DescribedConnector) SetAccessRole(v string) *DescribedConnector

SetAccessRole sets the AccessRole field's value.

func (*DescribedConnector) SetArn ¶

func (s *DescribedConnector) SetArn(v string) *DescribedConnector

SetArn sets the Arn field's value.

func (*DescribedConnector) SetAs2Config ¶

func (s *DescribedConnector) SetAs2Config(v *As2ConnectorConfig) *DescribedConnector

SetAs2Config sets the As2Config field's value.

func (*DescribedConnector) SetConnectorId ¶

func (s *DescribedConnector) SetConnectorId(v string) *DescribedConnector

SetConnectorId sets the ConnectorId field's value.

func (*DescribedConnector) SetLoggingRole ¶

func (s *DescribedConnector) SetLoggingRole(v string) *DescribedConnector

SetLoggingRole sets the LoggingRole field's value.

func (*DescribedConnector) SetSecurityPolicyName ¶

func (s *DescribedConnector) SetSecurityPolicyName(v string) *DescribedConnector

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*DescribedConnector) SetServiceManagedEgressIpAddresses ¶

func (s *DescribedConnector) SetServiceManagedEgressIpAddresses(v []*string) *DescribedConnector

SetServiceManagedEgressIpAddresses sets the ServiceManagedEgressIpAddresses field's value.

func (*DescribedConnector) SetSftpConfig ¶

func (s *DescribedConnector) SetSftpConfig(v *SftpConnectorConfig) *DescribedConnector

SetSftpConfig sets the SftpConfig field's value.

func (*DescribedConnector) SetTags ¶

func (s *DescribedConnector) SetTags(v []*Tag) *DescribedConnector

SetTags sets the Tags field's value.

func (*DescribedConnector) SetUrl ¶

func (s *DescribedConnector) SetUrl(v string) *DescribedConnector

SetUrl sets the Url field's value.

func (DescribedConnector) String ¶

func (s DescribedConnector) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedExecution ¶

type DescribedExecution struct {

    // A unique identifier for the execution of a workflow.
    ExecutionId *string `min:"36" type:"string"`

    // The IAM role associated with the execution.
    ExecutionRole *string `min:"20" type:"string"`

    // 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.
    InitialFileLocation *FileLocation `type:"structure"`

    // The IAM logging role associated with the execution.
    LoggingConfiguration *LoggingConfiguration `type:"structure"`

    // 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.
    PosixProfile *PosixProfile `type:"structure"`

    // 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.
    Results *ExecutionResults `type:"structure"`

    // A container object for the session details that are associated with a workflow.
    ServiceMetadata *ServiceMetadata `type:"structure"`

    // The status is one of the execution. Can be in progress, completed, exception
    // encountered, or handling the exception.
    Status *string `type:"string" enum:"ExecutionStatus"`
    // contains filtered or unexported fields
}

The details for an execution object.

func (DescribedExecution) GoString ¶

func (s DescribedExecution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedExecution) SetExecutionId ¶

func (s *DescribedExecution) SetExecutionId(v string) *DescribedExecution

SetExecutionId sets the ExecutionId field's value.

func (*DescribedExecution) SetExecutionRole ¶

func (s *DescribedExecution) SetExecutionRole(v string) *DescribedExecution

SetExecutionRole sets the ExecutionRole field's value.

func (*DescribedExecution) SetInitialFileLocation ¶

func (s *DescribedExecution) SetInitialFileLocation(v *FileLocation) *DescribedExecution

SetInitialFileLocation sets the InitialFileLocation field's value.

func (*DescribedExecution) SetLoggingConfiguration ¶

func (s *DescribedExecution) SetLoggingConfiguration(v *LoggingConfiguration) *DescribedExecution

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (*DescribedExecution) SetPosixProfile ¶

func (s *DescribedExecution) SetPosixProfile(v *PosixProfile) *DescribedExecution

SetPosixProfile sets the PosixProfile field's value.

func (*DescribedExecution) SetResults ¶

func (s *DescribedExecution) SetResults(v *ExecutionResults) *DescribedExecution

SetResults sets the Results field's value.

func (*DescribedExecution) SetServiceMetadata ¶

func (s *DescribedExecution) SetServiceMetadata(v *ServiceMetadata) *DescribedExecution

SetServiceMetadata sets the ServiceMetadata field's value.

func (*DescribedExecution) SetStatus ¶

func (s *DescribedExecution) SetStatus(v string) *DescribedExecution

SetStatus sets the Status field's value.

func (DescribedExecution) String ¶

func (s DescribedExecution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedHostKey ¶

type DescribedHostKey struct {

    // The unique Amazon Resource Name (ARN) for the host key.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // The date on which the host key was added to the server.
    DateImported *time.Time `type:"timestamp"`

    // The text description for this host key.
    Description *string `type:"string"`

    // The public key fingerprint, which is a short sequence of bytes used to identify
    // the longer public key.
    HostKeyFingerprint *string `type:"string"`

    // A unique identifier for the host key.
    HostKeyId *string `min:"25" type:"string"`

    // Key-value pairs that can be used to group and search for host keys.
    Tags []*Tag `min:"1" type:"list"`

    // 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
    Type *string `type:"string"`
    // contains filtered or unexported fields
}

The details for a server host key.

func (DescribedHostKey) GoString ¶

func (s DescribedHostKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedHostKey) SetArn ¶

func (s *DescribedHostKey) SetArn(v string) *DescribedHostKey

SetArn sets the Arn field's value.

func (*DescribedHostKey) SetDateImported ¶

func (s *DescribedHostKey) SetDateImported(v time.Time) *DescribedHostKey

SetDateImported sets the DateImported field's value.

func (*DescribedHostKey) SetDescription ¶

func (s *DescribedHostKey) SetDescription(v string) *DescribedHostKey

SetDescription sets the Description field's value.

func (*DescribedHostKey) SetHostKeyFingerprint ¶

func (s *DescribedHostKey) SetHostKeyFingerprint(v string) *DescribedHostKey

SetHostKeyFingerprint sets the HostKeyFingerprint field's value.

func (*DescribedHostKey) SetHostKeyId ¶

func (s *DescribedHostKey) SetHostKeyId(v string) *DescribedHostKey

SetHostKeyId sets the HostKeyId field's value.

func (*DescribedHostKey) SetTags ¶

func (s *DescribedHostKey) SetTags(v []*Tag) *DescribedHostKey

SetTags sets the Tags field's value.

func (*DescribedHostKey) SetType ¶

func (s *DescribedHostKey) SetType(v string) *DescribedHostKey

SetType sets the Type field's value.

func (DescribedHostKey) String ¶

func (s DescribedHostKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedProfile ¶

type DescribedProfile struct {

    // The unique Amazon Resource Name (ARN) for the profile.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130).
    // 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.
    As2Id *string `min:"1" type:"string"`

    // An array of identifiers for the imported certificates. You use this identifier
    // for working with profiles and partner profiles.
    CertificateIds []*string `type:"list"`

    // A unique identifier for the local or partner AS2 profile.
    ProfileId *string `min:"19" type:"string"`

    // 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.
    ProfileType *string `type:"string" enum:"ProfileType"`

    // Key-value pairs that can be used to group and search for profiles.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

The details for a local or partner AS2 profile.

func (DescribedProfile) GoString ¶

func (s DescribedProfile) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedProfile) SetArn ¶

func (s *DescribedProfile) SetArn(v string) *DescribedProfile

SetArn sets the Arn field's value.

func (*DescribedProfile) SetAs2Id ¶

func (s *DescribedProfile) SetAs2Id(v string) *DescribedProfile

SetAs2Id sets the As2Id field's value.

func (*DescribedProfile) SetCertificateIds ¶

func (s *DescribedProfile) SetCertificateIds(v []*string) *DescribedProfile

SetCertificateIds sets the CertificateIds field's value.

func (*DescribedProfile) SetProfileId ¶

func (s *DescribedProfile) SetProfileId(v string) *DescribedProfile

SetProfileId sets the ProfileId field's value.

func (*DescribedProfile) SetProfileType ¶

func (s *DescribedProfile) SetProfileType(v string) *DescribedProfile

SetProfileType sets the ProfileType field's value.

func (*DescribedProfile) SetTags ¶

func (s *DescribedProfile) SetTags(v []*Tag) *DescribedProfile

SetTags sets the Tags field's value.

func (DescribedProfile) String ¶

func (s DescribedProfile) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedSecurityPolicy ¶

type DescribedSecurityPolicy struct {

    // Specifies whether this policy enables Federal Information Processing Standards
    // (FIPS). This parameter applies to both server and connector security policies.
    Fips *bool `type:"boolean"`

    // Lists the file transfer protocols that the security policy applies to.
    Protocols []*string `min:"1" type:"list" enum:"SecurityPolicyProtocol"`

    // The text name of the specified security policy.
    //
    // SecurityPolicyName is a required field
    SecurityPolicyName *string `type:"string" required:"true"`

    // Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the
    // security policy that is attached to the server or connector. This parameter
    // applies to both server and connector security policies.
    SshCiphers []*string `type:"list"`

    // Lists the host key algorithms for the security policy.
    //
    // This parameter only applies to security policies for connectors.
    SshHostKeyAlgorithms []*string `type:"list"`

    // Lists the enabled SSH key exchange (KEX) encryption algorithms in the security
    // policy that is attached to the server or connector. This parameter applies
    // to both server and connector security policies.
    SshKexs []*string `type:"list"`

    // Lists the enabled SSH message authentication code (MAC) encryption algorithms
    // in the security policy that is attached to the server or connector. This
    // parameter applies to both server and connector security policies.
    SshMacs []*string `type:"list"`

    // Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms
    // in the security policy that is attached to the server.
    //
    // This parameter only applies to security policies for servers.
    TlsCiphers []*string `type:"list"`

    // The resource type to which the security policy applies, either server or
    // connector.
    Type *string `type:"string" enum:"SecurityPolicyResourceType"`
    // contains filtered or unexported fields
}

Describes the properties of a security policy that you specify. For more information about security policies, see Working with security policies for servers (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) or Working with security policies for SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html).

func (DescribedSecurityPolicy) GoString ¶

func (s DescribedSecurityPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedSecurityPolicy) SetFips ¶

func (s *DescribedSecurityPolicy) SetFips(v bool) *DescribedSecurityPolicy

SetFips sets the Fips field's value.

func (*DescribedSecurityPolicy) SetProtocols ¶

func (s *DescribedSecurityPolicy) SetProtocols(v []*string) *DescribedSecurityPolicy

SetProtocols sets the Protocols field's value.

func (*DescribedSecurityPolicy) SetSecurityPolicyName ¶

func (s *DescribedSecurityPolicy) SetSecurityPolicyName(v string) *DescribedSecurityPolicy

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*DescribedSecurityPolicy) SetSshCiphers ¶

func (s *DescribedSecurityPolicy) SetSshCiphers(v []*string) *DescribedSecurityPolicy

SetSshCiphers sets the SshCiphers field's value.

func (*DescribedSecurityPolicy) SetSshHostKeyAlgorithms ¶

func (s *DescribedSecurityPolicy) SetSshHostKeyAlgorithms(v []*string) *DescribedSecurityPolicy

SetSshHostKeyAlgorithms sets the SshHostKeyAlgorithms field's value.

func (*DescribedSecurityPolicy) SetSshKexs ¶

func (s *DescribedSecurityPolicy) SetSshKexs(v []*string) *DescribedSecurityPolicy

SetSshKexs sets the SshKexs field's value.

func (*DescribedSecurityPolicy) SetSshMacs ¶

func (s *DescribedSecurityPolicy) SetSshMacs(v []*string) *DescribedSecurityPolicy

SetSshMacs sets the SshMacs field's value.

func (*DescribedSecurityPolicy) SetTlsCiphers ¶

func (s *DescribedSecurityPolicy) SetTlsCiphers(v []*string) *DescribedSecurityPolicy

SetTlsCiphers sets the TlsCiphers field's value.

func (*DescribedSecurityPolicy) SetType ¶

func (s *DescribedSecurityPolicy) SetType(v string) *DescribedSecurityPolicy

SetType sets the Type field's value.

func (DescribedSecurityPolicy) String ¶

func (s DescribedSecurityPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedServer ¶

type DescribedServer struct {

    // Specifies the unique Amazon Resource Name (ARN) of the server.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // The list of egress IP addresses of this server. These IP addresses are only
    // relevant for servers that use the AS2 protocol. They are used for sending
    // asynchronous MDNs.
    //
    // These IP addresses are assigned automatically when you create an AS2 server.
    // Additionally, if you update an existing server and add the AS2 protocol,
    // static IP addresses are assigned as well.
    As2ServiceManagedEgressIpAddresses []*string `type:"list"`

    // Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
    // Required when Protocols is set to FTPS.
    Certificate *string `type:"string"`

    // Specifies 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.
    Domain *string `type:"string" enum:"Domain"`

    // 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.
    EndpointDetails *EndpointDetails `type:"structure"`

    // 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.
    EndpointType *string `type:"string" enum:"EndpointType"`

    // 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.
    HostKeyFingerprint *string `type:"string"`

    // 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.
    IdentityProviderDetails *IdentityProviderDetails `type:"structure"`

    // 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 for the IdentityProviderDetails data type.
    IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`

    // 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.
    LoggingRole *string `type:"string"`

    // 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.
    PostAuthenticationLoginBanner *string `type:"string"`

    // 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.
    PreAuthenticationLoginBanner *string `type:"string"`

    // 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.
    ProtocolDetails *ProtocolDetails `type:"structure"`

    // 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 either AWS_DIRECTORY_SERVICE,
    //    AWS_LAMBDA, 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 any of the supported identity
    //    types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.
    //
    //    * If Protocol includes AS2, then the EndpointType must be VPC, and domain
    //    must be Amazon S3.
    Protocols []*string `min:"1" type:"list" enum:"Protocol"`

    // Specifies whether or not performance for your Amazon S3 directories is optimized.
    // This is disabled by default.
    //
    // By default, home directory mappings have a TYPE of DIRECTORY. If you enable
    // this option, you would then need to explicitly set the HomeDirectoryMapEntry
    // Type to FILE if you want a mapping to have a file target.
    S3StorageOptions *S3StorageOptions `type:"structure"`

    // Specifies the name of the security policy for the server.
    SecurityPolicyName *string `type:"string"`

    // Specifies the unique system-assigned identifier for a server that you instantiate.
    ServerId *string `min:"19" type:"string"`

    // 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.
    State *string `type:"string" enum:"State"`

    // Specifies the log groups to which your server logs are sent.
    //
    // To specify a log group, you must provide the ARN for an existing log group.
    // In this case, the format of the log group is as follows:
    //
    // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
    //
    // For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
    //
    // If you have previously specified a log group for a server, you can clear
    // it, and in effect turn off structured logging, by providing an empty value
    // for this parameter in an update-server call. For example:
    //
    // update-server --server-id s-1234567890abcdef0 --structured-log-destinations
    StructuredLogDestinations []*string `type:"list"`

    // Specifies the key-value pairs that you can use to search for and group servers
    // that were assigned to the server that was described.
    Tags []*Tag `min:"1" type:"list"`

    // Specifies the number of users that are assigned to a server you specified
    // with the ServerId.
    UserCount *int64 `type:"integer"`

    // Specifies the workflow ID for the workflow to assign and the execution role
    // that's used for executing the workflow.
    //
    // In addition to a workflow to execute when a file is uploaded completely,
    // WorkflowDetails can also contain a workflow ID (and execution role) for a
    // workflow to execute on partial upload. A partial upload occurs when the server
    // session disconnects while the file is still being uploaded.
    WorkflowDetails *WorkflowDetails `type:"structure"`
    // contains filtered or unexported fields
}

Describes the properties of a file transfer protocol-enabled server that was specified.

func (DescribedServer) GoString ¶

func (s DescribedServer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedServer) SetArn ¶

func (s *DescribedServer) SetArn(v string) *DescribedServer

SetArn sets the Arn field's value.

func (*DescribedServer) SetAs2ServiceManagedEgressIpAddresses ¶

func (s *DescribedServer) SetAs2ServiceManagedEgressIpAddresses(v []*string) *DescribedServer

SetAs2ServiceManagedEgressIpAddresses sets the As2ServiceManagedEgressIpAddresses field's value.

func (*DescribedServer) SetCertificate ¶

func (s *DescribedServer) SetCertificate(v string) *DescribedServer

SetCertificate sets the Certificate field's value.

func (*DescribedServer) SetDomain ¶

func (s *DescribedServer) SetDomain(v string) *DescribedServer

SetDomain sets the Domain field's value.

func (*DescribedServer) SetEndpointDetails ¶

func (s *DescribedServer) SetEndpointDetails(v *EndpointDetails) *DescribedServer

SetEndpointDetails sets the EndpointDetails field's value.

func (*DescribedServer) SetEndpointType ¶

func (s *DescribedServer) SetEndpointType(v string) *DescribedServer

SetEndpointType sets the EndpointType field's value.

func (*DescribedServer) SetHostKeyFingerprint ¶

func (s *DescribedServer) SetHostKeyFingerprint(v string) *DescribedServer

SetHostKeyFingerprint sets the HostKeyFingerprint field's value.

func (*DescribedServer) SetIdentityProviderDetails ¶

func (s *DescribedServer) SetIdentityProviderDetails(v *IdentityProviderDetails) *DescribedServer

SetIdentityProviderDetails sets the IdentityProviderDetails field's value.

func (*DescribedServer) SetIdentityProviderType ¶

func (s *DescribedServer) SetIdentityProviderType(v string) *DescribedServer

SetIdentityProviderType sets the IdentityProviderType field's value.

func (*DescribedServer) SetLoggingRole ¶

func (s *DescribedServer) SetLoggingRole(v string) *DescribedServer

SetLoggingRole sets the LoggingRole field's value.

func (*DescribedServer) SetPostAuthenticationLoginBanner ¶

func (s *DescribedServer) SetPostAuthenticationLoginBanner(v string) *DescribedServer

SetPostAuthenticationLoginBanner sets the PostAuthenticationLoginBanner field's value.

func (*DescribedServer) SetPreAuthenticationLoginBanner ¶

func (s *DescribedServer) SetPreAuthenticationLoginBanner(v string) *DescribedServer

SetPreAuthenticationLoginBanner sets the PreAuthenticationLoginBanner field's value.

func (*DescribedServer) SetProtocolDetails ¶

func (s *DescribedServer) SetProtocolDetails(v *ProtocolDetails) *DescribedServer

SetProtocolDetails sets the ProtocolDetails field's value.

func (*DescribedServer) SetProtocols ¶

func (s *DescribedServer) SetProtocols(v []*string) *DescribedServer

SetProtocols sets the Protocols field's value.

func (*DescribedServer) SetS3StorageOptions ¶

func (s *DescribedServer) SetS3StorageOptions(v *S3StorageOptions) *DescribedServer

SetS3StorageOptions sets the S3StorageOptions field's value.

func (*DescribedServer) SetSecurityPolicyName ¶

func (s *DescribedServer) SetSecurityPolicyName(v string) *DescribedServer

SetSecurityPolicyName sets the SecurityPolicyName field's value.

func (*DescribedServer) SetServerId ¶

func (s *DescribedServer) SetServerId(v string) *DescribedServer

SetServerId sets the ServerId field's value.

func (*DescribedServer) SetState ¶

func (s *DescribedServer) SetState(v string) *DescribedServer

SetState sets the State field's value.

func (*DescribedServer) SetStructuredLogDestinations ¶

func (s *DescribedServer) SetStructuredLogDestinations(v []*string) *DescribedServer

SetStructuredLogDestinations sets the StructuredLogDestinations field's value.

func (*DescribedServer) SetTags ¶

func (s *DescribedServer) SetTags(v []*Tag) *DescribedServer

SetTags sets the Tags field's value.

func (*DescribedServer) SetUserCount ¶

func (s *DescribedServer) SetUserCount(v int64) *DescribedServer

SetUserCount sets the UserCount field's value.

func (*DescribedServer) SetWorkflowDetails ¶

func (s *DescribedServer) SetWorkflowDetails(v *WorkflowDetails) *DescribedServer

SetWorkflowDetails sets the WorkflowDetails field's value.

func (DescribedServer) String ¶

func (s DescribedServer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedUser ¶

type DescribedUser struct {

    // Specifies the unique Amazon Resource Name (ARN) for the user that was requested
    // to be described.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // 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.
    //
    // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
    HomeDirectory *string `type:"string"`

    // 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.
    HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"`

    // 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 Amazon EFS path as is in their file
    // transfer protocol clients. If you set it to 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.
    //
    // If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings
    // parameter. If, on the other hand, HomeDirectoryType is PATH, you provide
    // an absolute path using the HomeDirectory parameter. You cannot have both
    // HomeDirectory and HomeDirectoryMappings in your template.
    HomeDirectoryType *string `type:"string" enum:"HomeDirectoryType"`

    // 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}.
    Policy *string `type:"string"`

    // 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.
    PosixProfile *PosixProfile `type:"structure"`

    // 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.
    Role *string `min:"20" type:"string"`

    // Specifies the public key portion of the Secure Shell (SSH) keys stored for
    // the described user.
    SshPublicKeys []*SshPublicKey `type:"list"`

    // Specifies the key-value pairs for the user requested. Tag can be used to
    // search for and group users for a variety of purposes.
    Tags []*Tag `min:"1" type:"list"`

    // 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.
    UserName *string `min:"3" type:"string"`
    // contains filtered or unexported fields
}

Describes the properties of a user that was specified.

func (DescribedUser) GoString ¶

func (s DescribedUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedUser) SetArn ¶

func (s *DescribedUser) SetArn(v string) *DescribedUser

SetArn sets the Arn field's value.

func (*DescribedUser) SetHomeDirectory ¶

func (s *DescribedUser) SetHomeDirectory(v string) *DescribedUser

SetHomeDirectory sets the HomeDirectory field's value.

func (*DescribedUser) SetHomeDirectoryMappings ¶

func (s *DescribedUser) SetHomeDirectoryMappings(v []*HomeDirectoryMapEntry) *DescribedUser

SetHomeDirectoryMappings sets the HomeDirectoryMappings field's value.

func (*DescribedUser) SetHomeDirectoryType ¶

func (s *DescribedUser) SetHomeDirectoryType(v string) *DescribedUser

SetHomeDirectoryType sets the HomeDirectoryType field's value.

func (*DescribedUser) SetPolicy ¶

func (s *DescribedUser) SetPolicy(v string) *DescribedUser

SetPolicy sets the Policy field's value.

func (*DescribedUser) SetPosixProfile ¶

func (s *DescribedUser) SetPosixProfile(v *PosixProfile) *DescribedUser

SetPosixProfile sets the PosixProfile field's value.

func (*DescribedUser) SetRole ¶

func (s *DescribedUser) SetRole(v string) *DescribedUser

SetRole sets the Role field's value.

func (*DescribedUser) SetSshPublicKeys ¶

func (s *DescribedUser) SetSshPublicKeys(v []*SshPublicKey) *DescribedUser

SetSshPublicKeys sets the SshPublicKeys field's value.

func (*DescribedUser) SetTags ¶

func (s *DescribedUser) SetTags(v []*Tag) *DescribedUser

SetTags sets the Tags field's value.

func (*DescribedUser) SetUserName ¶

func (s *DescribedUser) SetUserName(v string) *DescribedUser

SetUserName sets the UserName field's value.

func (DescribedUser) String ¶

func (s DescribedUser) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribedWorkflow ¶

type DescribedWorkflow struct {

    // Specifies the unique Amazon Resource Name (ARN) for the workflow.
    //
    // Arn is a required field
    Arn *string `min:"20" type:"string" required:"true"`

    // Specifies the text description for the workflow.
    Description *string `type:"string"`

    // Specifies the steps (actions) to take if errors are encountered during execution
    // of the workflow.
    OnExceptionSteps []*WorkflowStep `type:"list"`

    // Specifies the details for the steps that are in the specified workflow.
    Steps []*WorkflowStep `type:"list"`

    // Key-value pairs that can be used to group and search for workflows. Tags
    // are metadata attached to workflows for any purpose.
    Tags []*Tag `min:"1" type:"list"`

    // A unique identifier for the workflow.
    WorkflowId *string `min:"19" type:"string"`
    // contains filtered or unexported fields
}

Describes the properties of the specified workflow

func (DescribedWorkflow) GoString ¶

func (s DescribedWorkflow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribedWorkflow) SetArn ¶

func (s *DescribedWorkflow) SetArn(v string) *DescribedWorkflow

SetArn sets the Arn field's value.

func (*DescribedWorkflow) SetDescription ¶

func (s *DescribedWorkflow) SetDescription(v string) *DescribedWorkflow

SetDescription sets the Description field's value.

func (*DescribedWorkflow) SetOnExceptionSteps ¶

func (s *DescribedWorkflow) SetOnExceptionSteps(v []*WorkflowStep) *DescribedWorkflow

SetOnExceptionSteps sets the OnExceptionSteps field's value.

func (*DescribedWorkflow) SetSteps ¶

func (s *DescribedWorkflow) SetSteps(v []*WorkflowStep) *DescribedWorkflow

SetSteps sets the Steps field's value.

func (*DescribedWorkflow) SetTags ¶

func (s *DescribedWorkflow) SetTags(v []*Tag) *DescribedWorkflow

SetTags sets the Tags field's value.

func (*DescribedWorkflow) SetWorkflowId ¶

func (s *DescribedWorkflow) SetWorkflowId(v string) *DescribedWorkflow

SetWorkflowId sets the WorkflowId field's value.

func (DescribedWorkflow) String ¶

func (s DescribedWorkflow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EfsFileLocation ¶

type EfsFileLocation struct {

    // The identifier of the file system, assigned by Amazon EFS.
    FileSystemId *string `type:"string"`

    // The pathname for the folder being used by a workflow.
    Path *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems (Amazon EFS) for storage.

func (EfsFileLocation) GoString ¶

func (s EfsFileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EfsFileLocation) SetFileSystemId ¶

func (s *EfsFileLocation) SetFileSystemId(v string) *EfsFileLocation

SetFileSystemId sets the FileSystemId field's value.

func (*EfsFileLocation) SetPath ¶

func (s *EfsFileLocation) SetPath(v string) *EfsFileLocation

SetPath sets the Path field's value.

func (EfsFileLocation) String ¶

func (s EfsFileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EfsFileLocation) Validate ¶

func (s *EfsFileLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EndpointDetails ¶

type EndpointDetails struct {

    // A list of address allocation IDs that are required to attach an Elastic IP
    // address to your server's endpoint.
    //
    // An address allocation ID corresponds to the allocation ID of an Elastic IP
    // address. This value can be retrieved from the allocationId field from the
    // Amazon EC2 Address (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html)
    // data type. One way to retrieve this value is by calling the EC2 DescribeAddresses
    // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html)
    // API.
    //
    // This parameter is optional. Set this parameter if you want to make your VPC
    // endpoint public-facing. For details, see Create an internet-facing endpoint
    // for your server (https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint).
    //
    // This property can only be set as follows:
    //
    //    * EndpointType must be set to VPC
    //
    //    * The Transfer Family server must be offline.
    //
    //    * You cannot set this parameter for Transfer Family servers that use the
    //    FTP protocol.
    //
    //    * The server must already have SubnetIds populated (SubnetIds and AddressAllocationIds
    //    cannot be updated simultaneously).
    //
    //    * AddressAllocationIds can't contain duplicates, and must be equal in
    //    length to SubnetIds. For example, if you have three subnet IDs, you must
    //    also specify three address allocation IDs.
    //
    //    * Call the UpdateServer API to set or change this parameter.
    AddressAllocationIds []*string `type:"list"`

    // 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 (https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html)
    // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html)
    // API.
    SecurityGroupIds []*string `type:"list"`

    // 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.
    SubnetIds []*string `type:"list"`

    // 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.
    VpcEndpointId *string `min:"22" type:"string"`

    // 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.
    VpcId *string `type:"string"`
    // contains filtered or unexported fields
}

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.

func (EndpointDetails) GoString ¶

func (s EndpointDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointDetails) SetAddressAllocationIds ¶

func (s *EndpointDetails) SetAddressAllocationIds(v []*string) *EndpointDetails

SetAddressAllocationIds sets the AddressAllocationIds field's value.

func (*EndpointDetails) SetSecurityGroupIds ¶

func (s *EndpointDetails) SetSecurityGroupIds(v []*string) *EndpointDetails

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*EndpointDetails) SetSubnetIds ¶

func (s *EndpointDetails) SetSubnetIds(v []*string) *EndpointDetails

SetSubnetIds sets the SubnetIds field's value.

func (*EndpointDetails) SetVpcEndpointId ¶

func (s *EndpointDetails) SetVpcEndpointId(v string) *EndpointDetails

SetVpcEndpointId sets the VpcEndpointId field's value.

func (*EndpointDetails) SetVpcId ¶

func (s *EndpointDetails) SetVpcId(v string) *EndpointDetails

SetVpcId sets the VpcId field's value.

func (EndpointDetails) String ¶

func (s EndpointDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointDetails) Validate ¶

func (s *EndpointDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExecutionError ¶

type ExecutionError struct {

    // Specifies the descriptive message that corresponds to the ErrorType.
    //
    // Message is a required field
    Message *string `type:"string" required:"true"`

    // 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.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"ExecutionErrorType"`
    // contains filtered or unexported fields
}

Specifies the error message and type, for an error that occurs during the execution of the workflow.

func (ExecutionError) GoString ¶

func (s ExecutionError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionError) SetMessage ¶

func (s *ExecutionError) SetMessage(v string) *ExecutionError

SetMessage sets the Message field's value.

func (*ExecutionError) SetType ¶

func (s *ExecutionError) SetType(v string) *ExecutionError

SetType sets the Type field's value.

func (ExecutionError) String ¶

func (s ExecutionError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionResults ¶

type ExecutionResults struct {

    // Specifies the steps (actions) to take if errors are encountered during execution
    // of the workflow.
    OnExceptionSteps []*ExecutionStepResult `min:"1" type:"list"`

    // Specifies the details for the steps that are in the specified workflow.
    Steps []*ExecutionStepResult `min:"1" type:"list"`
    // contains filtered or unexported fields
}

Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.

func (ExecutionResults) GoString ¶

func (s ExecutionResults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionResults) SetOnExceptionSteps ¶

func (s *ExecutionResults) SetOnExceptionSteps(v []*ExecutionStepResult) *ExecutionResults

SetOnExceptionSteps sets the OnExceptionSteps field's value.

func (*ExecutionResults) SetSteps ¶

func (s *ExecutionResults) SetSteps(v []*ExecutionStepResult) *ExecutionResults

SetSteps sets the Steps field's value.

func (ExecutionResults) String ¶

func (s ExecutionResults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecutionStepResult ¶

type ExecutionStepResult struct {

    // Specifies the details for an error, if it occurred during execution of the
    // specified workflow step.
    Error *ExecutionError `type:"structure"`

    // The values for the key/value pair applied as a tag to the file. Only applicable
    // if the step type is TAG.
    Outputs *string `type:"string"`

    // One of the available step types.
    //
    //    * COPY - Copy the file to another location.
    //
    //    * CUSTOM - Perform a custom step with an Lambda function target.
    //
    //    * DECRYPT - Decrypt a file that was encrypted before it was uploaded.
    //
    //    * DELETE - Delete the file.
    //
    //    * TAG - Add a tag to the file.
    StepType *string `type:"string" enum:"WorkflowStepType"`
    // contains filtered or unexported fields
}

Specifies the following details for the step: error (if any), outputs (if any), and the step type.

func (ExecutionStepResult) GoString ¶

func (s ExecutionStepResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecutionStepResult) SetError ¶

func (s *ExecutionStepResult) SetError(v *ExecutionError) *ExecutionStepResult

SetError sets the Error field's value.

func (*ExecutionStepResult) SetOutputs ¶

func (s *ExecutionStepResult) SetOutputs(v string) *ExecutionStepResult

SetOutputs sets the Outputs field's value.

func (*ExecutionStepResult) SetStepType ¶

func (s *ExecutionStepResult) SetStepType(v string) *ExecutionStepResult

SetStepType sets the StepType field's value.

func (ExecutionStepResult) String ¶

func (s ExecutionStepResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileLocation ¶

type FileLocation struct {

    // Specifies the Amazon EFS identifier and the path for the file being used.
    EfsFileLocation *EfsFileLocation `type:"structure"`

    // Specifies the S3 details for the file being used, such as bucket, ETag, and
    // so forth.
    S3FileLocation *S3FileLocation `type:"structure"`
    // contains filtered or unexported fields
}

Specifies the Amazon S3 or EFS file details to be used in the step.

func (FileLocation) GoString ¶

func (s FileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileLocation) SetEfsFileLocation ¶

func (s *FileLocation) SetEfsFileLocation(v *EfsFileLocation) *FileLocation

SetEfsFileLocation sets the EfsFileLocation field's value.

func (*FileLocation) SetS3FileLocation ¶

func (s *FileLocation) SetS3FileLocation(v *S3FileLocation) *FileLocation

SetS3FileLocation sets the S3FileLocation field's value.

func (FileLocation) String ¶

func (s FileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HomeDirectoryMapEntry ¶

type HomeDirectoryMapEntry struct {

    // Represents an entry for HomeDirectoryMappings.
    //
    // Entry is a required field
    Entry *string `type:"string" required:"true"`

    // Represents the map target that is used in a HomeDirectoryMapEntry.
    //
    // Target is a required field
    Target *string `type:"string" required:"true"`

    // Specifies the type of mapping. Set the type to FILE if you want the mapping
    // to point to a file, or DIRECTORY for the directory to point to a directory.
    //
    // By default, home directory mappings have a Type of DIRECTORY when you create
    // a Transfer Family server. You would need to explicitly set Type to FILE if
    // you want a mapping to have a file target.
    Type *string `type:"string" enum:"MapType"`
    // contains filtered or unexported fields
}

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" } ]

func (HomeDirectoryMapEntry) GoString ¶

func (s HomeDirectoryMapEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HomeDirectoryMapEntry) SetEntry ¶

func (s *HomeDirectoryMapEntry) SetEntry(v string) *HomeDirectoryMapEntry

SetEntry sets the Entry field's value.

func (*HomeDirectoryMapEntry) SetTarget ¶

func (s *HomeDirectoryMapEntry) SetTarget(v string) *HomeDirectoryMapEntry

SetTarget sets the Target field's value.

func (*HomeDirectoryMapEntry) SetType ¶

func (s *HomeDirectoryMapEntry) SetType(v string) *HomeDirectoryMapEntry

SetType sets the Type field's value.

func (HomeDirectoryMapEntry) String ¶

func (s HomeDirectoryMapEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HomeDirectoryMapEntry) Validate ¶

func (s *HomeDirectoryMapEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IdentityProviderDetails ¶

type IdentityProviderDetails struct {

    // The identifier of the Directory Service directory that you want to use as
    // your identity provider.
    DirectoryId *string `min:"12" type:"string"`

    // The ARN for a Lambda function to use for the Identity provider.
    Function *string `min:"1" type:"string"`

    // This parameter is only applicable if your IdentityProviderType is API_GATEWAY.
    // Provides the type of InvocationRole used to authenticate the user account.
    InvocationRole *string `min:"20" type:"string"`

    // For SFTP-enabled servers, and for custom identity providers only, you can
    // specify whether to authenticate using a password, SSH key pair, or both.
    //
    //    * PASSWORD - users must provide their password to connect.
    //
    //    * PUBLIC_KEY - users must provide their private key to connect.
    //
    //    * PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password
    //    or their key. This is the default value.
    //
    //    * PUBLIC_KEY_AND_PASSWORD - users must provide both their private key
    //    and their password to connect. The server checks the key first, and then
    //    if the key is valid, the system prompts for a password. If the private
    //    key provided does not match the public key that is stored, authentication
    //    fails.
    SftpAuthenticationMethods *string `type:"string" enum:"SftpAuthenticationMethods"`

    // Provides the location of the service endpoint used to authenticate users.
    Url *string `type:"string"`
    // contains filtered or unexported fields
}

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.

func (IdentityProviderDetails) GoString ¶

func (s IdentityProviderDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityProviderDetails) SetDirectoryId ¶

func (s *IdentityProviderDetails) SetDirectoryId(v string) *IdentityProviderDetails

SetDirectoryId sets the DirectoryId field's value.

func (*IdentityProviderDetails) SetFunction ¶

func (s *IdentityProviderDetails) SetFunction(v string) *IdentityProviderDetails

SetFunction sets the Function field's value.

func (*IdentityProviderDetails) SetInvocationRole ¶

func (s *IdentityProviderDetails) SetInvocationRole(v string) *IdentityProviderDetails

SetInvocationRole sets the InvocationRole field's value.

func (*IdentityProviderDetails) SetSftpAuthenticationMethods ¶

func (s *IdentityProviderDetails) SetSftpAuthenticationMethods(v string) *IdentityProviderDetails

SetSftpAuthenticationMethods sets the SftpAuthenticationMethods field's value.

func (*IdentityProviderDetails) SetUrl ¶

func (s *IdentityProviderDetails) SetUrl(v string) *IdentityProviderDetails

SetUrl sets the Url field's value.

func (IdentityProviderDetails) String ¶

func (s IdentityProviderDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdentityProviderDetails) Validate ¶

func (s *IdentityProviderDetails) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportCertificateInput ¶

type ImportCertificateInput struct {

    // An optional date that specifies when the certificate becomes active.
    ActiveDate *time.Time `type:"timestamp"`

    //    * For the CLI, provide a file path for a certificate in URI format. For
    //    example, --certificate file://encryption-cert.pem. Alternatively, you
    //    can provide the raw content.
    //
    //    * For the SDK, specify the raw content of a certificate file. For example,
    //    --certificate "`cat encryption-cert.pem`".
    //
    // Certificate is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ImportCertificateInput's
    // String and GoString methods.
    //
    // Certificate is a required field
    Certificate *string `min:"1" type:"string" required:"true" sensitive:"true"`

    // An optional list of certificates that make up the chain for the certificate
    // that's being imported.
    //
    // CertificateChain is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ImportCertificateInput's
    // String and GoString methods.
    CertificateChain *string `min:"1" type:"string" sensitive:"true"`

    // A short description that helps identify the certificate.
    Description *string `min:"1" type:"string"`

    // An optional date that specifies when the certificate becomes inactive.
    InactiveDate *time.Time `type:"timestamp"`

    //    * For the CLI, provide a file path for a private key in URI format.For
    //    example, --private-key file://encryption-key.pem. Alternatively, you can
    //    provide the raw content of the private key file.
    //
    //    * For the SDK, specify the raw content of a private key file. For example,
    //    --private-key "`cat encryption-key.pem`"
    //
    // PrivateKey is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ImportCertificateInput's
    // String and GoString methods.
    PrivateKey *string `min:"1" type:"string" sensitive:"true"`

    // Key-value pairs that can be used to group and search for certificates.
    Tags []*Tag `min:"1" type:"list"`

    // Specifies how this certificate is used. It can be used in the following ways:
    //
    //    * SIGNING: For signing AS2 messages
    //
    //    * ENCRYPTION: For encrypting AS2 messages
    //
    //    * TLS: For securing AS2 communications sent over HTTPS
    //
    // Usage is a required field
    Usage *string `type:"string" required:"true" enum:"CertificateUsageType"`
    // contains filtered or unexported fields
}

func (ImportCertificateInput) GoString ¶

func (s ImportCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportCertificateInput) SetActiveDate ¶

func (s *ImportCertificateInput) SetActiveDate(v time.Time) *ImportCertificateInput

SetActiveDate sets the ActiveDate field's value.

func (*ImportCertificateInput) SetCertificate ¶

func (s *ImportCertificateInput) SetCertificate(v string) *ImportCertificateInput

SetCertificate sets the Certificate field's value.

func (*ImportCertificateInput) SetCertificateChain ¶

func (s *ImportCertificateInput) SetCertificateChain(v string) *ImportCertificateInput

SetCertificateChain sets the CertificateChain field's value.

func (*ImportCertificateInput) SetDescription ¶

func (s *ImportCertificateInput) SetDescription(v string) *ImportCertificateInput

SetDescription sets the Description field's value.

func (*ImportCertificateInput) SetInactiveDate ¶

func (s *ImportCertificateInput) SetInactiveDate(v time.Time) *ImportCertificateInput

SetInactiveDate sets the InactiveDate field's value.

func (*ImportCertificateInput) SetPrivateKey ¶

func (s *ImportCertificateInput) SetPrivateKey(v string) *ImportCertificateInput

SetPrivateKey sets the PrivateKey field's value.

func (*ImportCertificateInput) SetTags ¶

func (s *ImportCertificateInput) SetTags(v []*Tag) *ImportCertificateInput

SetTags sets the Tags field's value.

func (*ImportCertificateInput) SetUsage ¶

func (s *ImportCertificateInput) SetUsage(v string) *ImportCertificateInput

SetUsage sets the Usage field's value.

func (ImportCertificateInput) String ¶

func (s ImportCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportCertificateInput) Validate ¶

func (s *ImportCertificateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportCertificateOutput ¶

type ImportCertificateOutput struct {

    // An array of identifiers for the imported certificates. You use this identifier
    // for working with profiles and partner profiles.
    //
    // CertificateId is a required field
    CertificateId *string `min:"22" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ImportCertificateOutput) GoString ¶

func (s ImportCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportCertificateOutput) SetCertificateId ¶

func (s *ImportCertificateOutput) SetCertificateId(v string) *ImportCertificateOutput

SetCertificateId sets the CertificateId field's value.

func (ImportCertificateOutput) String ¶

func (s ImportCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportHostKeyInput ¶

type ImportHostKeyInput struct {

    // The text description that identifies this host key.
    Description *string `type:"string"`

    // The private key portion of an SSH key pair.
    //
    // Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    //
    // HostKeyBody is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ImportHostKeyInput's
    // String and GoString methods.
    //
    // HostKeyBody is a required field
    HostKeyBody *string `type:"string" required:"true" sensitive:"true"`

    // The identifier of the server that contains the host key that you are importing.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // Key-value pairs that can be used to group and search for host keys.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (ImportHostKeyInput) GoString ¶

func (s ImportHostKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportHostKeyInput) SetDescription ¶

func (s *ImportHostKeyInput) SetDescription(v string) *ImportHostKeyInput

SetDescription sets the Description field's value.

func (*ImportHostKeyInput) SetHostKeyBody ¶

func (s *ImportHostKeyInput) SetHostKeyBody(v string) *ImportHostKeyInput

SetHostKeyBody sets the HostKeyBody field's value.

func (*ImportHostKeyInput) SetServerId ¶

func (s *ImportHostKeyInput) SetServerId(v string) *ImportHostKeyInput

SetServerId sets the ServerId field's value.

func (*ImportHostKeyInput) SetTags ¶

func (s *ImportHostKeyInput) SetTags(v []*Tag) *ImportHostKeyInput

SetTags sets the Tags field's value.

func (ImportHostKeyInput) String ¶

func (s ImportHostKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportHostKeyInput) Validate ¶

func (s *ImportHostKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportHostKeyOutput ¶

type ImportHostKeyOutput struct {

    // Returns the host key identifier for the imported key.
    //
    // HostKeyId is a required field
    HostKeyId *string `min:"25" type:"string" required:"true"`

    // Returns the server identifier that contains the imported key.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ImportHostKeyOutput) GoString ¶

func (s ImportHostKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportHostKeyOutput) SetHostKeyId ¶

func (s *ImportHostKeyOutput) SetHostKeyId(v string) *ImportHostKeyOutput

SetHostKeyId sets the HostKeyId field's value.

func (*ImportHostKeyOutput) SetServerId ¶

func (s *ImportHostKeyOutput) SetServerId(v string) *ImportHostKeyOutput

SetServerId sets the ServerId field's value.

func (ImportHostKeyOutput) String ¶

func (s ImportHostKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportSshPublicKeyInput ¶

type ImportSshPublicKeyInput struct {

    // A system-assigned unique identifier for a server.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // The public key portion of an SSH key pair.
    //
    // Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    //
    // SshPublicKeyBody is a required field
    SshPublicKeyBody *string `type:"string" required:"true"`

    // The name of the Transfer Family user that is assigned to one or more servers.
    //
    // UserName is a required field
    UserName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ImportSshPublicKeyInput) GoString ¶

func (s ImportSshPublicKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportSshPublicKeyInput) SetServerId ¶

func (s *ImportSshPublicKeyInput) SetServerId(v string) *ImportSshPublicKeyInput

SetServerId sets the ServerId field's value.

func (*ImportSshPublicKeyInput) SetSshPublicKeyBody ¶

func (s *ImportSshPublicKeyInput) SetSshPublicKeyBody(v string) *ImportSshPublicKeyInput

SetSshPublicKeyBody sets the SshPublicKeyBody field's value.

func (*ImportSshPublicKeyInput) SetUserName ¶

func (s *ImportSshPublicKeyInput) SetUserName(v string) *ImportSshPublicKeyInput

SetUserName sets the UserName field's value.

func (ImportSshPublicKeyInput) String ¶

func (s ImportSshPublicKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportSshPublicKeyInput) Validate ¶

func (s *ImportSshPublicKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportSshPublicKeyOutput ¶

type ImportSshPublicKeyOutput struct {

    // A system-assigned unique identifier for a server.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`

    // The name given to a public key by the system that was imported.
    //
    // SshPublicKeyId is a required field
    SshPublicKeyId *string `min:"21" type:"string" required:"true"`

    // A user name assigned to the ServerID value that you specified.
    //
    // UserName is a required field
    UserName *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

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.

func (ImportSshPublicKeyOutput) GoString ¶

func (s ImportSshPublicKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportSshPublicKeyOutput) SetServerId ¶

func (s *ImportSshPublicKeyOutput) SetServerId(v string) *ImportSshPublicKeyOutput

SetServerId sets the ServerId field's value.

func (*ImportSshPublicKeyOutput) SetSshPublicKeyId ¶

func (s *ImportSshPublicKeyOutput) SetSshPublicKeyId(v string) *ImportSshPublicKeyOutput

SetSshPublicKeyId sets the SshPublicKeyId field's value.

func (*ImportSshPublicKeyOutput) SetUserName ¶

func (s *ImportSshPublicKeyOutput) SetUserName(v string) *ImportSshPublicKeyOutput

SetUserName sets the UserName field's value.

func (ImportSshPublicKeyOutput) String ¶

func (s ImportSshPublicKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputFileLocation ¶

type InputFileLocation struct {

    // Specifies the details for the Amazon Elastic File System (Amazon EFS) file
    // that's being decrypted.
    EfsFileLocation *EfsFileLocation `type:"structure"`

    // Specifies the details for the Amazon S3 file that's being copied or decrypted.
    S3FileLocation *S3InputFileLocation `type:"structure"`
    // contains filtered or unexported fields
}

Specifies the location for the file that's being processed.

func (InputFileLocation) GoString ¶

func (s InputFileLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputFileLocation) SetEfsFileLocation ¶

func (s *InputFileLocation) SetEfsFileLocation(v *EfsFileLocation) *InputFileLocation

SetEfsFileLocation sets the EfsFileLocation field's value.

func (*InputFileLocation) SetS3FileLocation ¶

func (s *InputFileLocation) SetS3FileLocation(v *S3InputFileLocation) *InputFileLocation

SetS3FileLocation sets the S3FileLocation field's value.

func (InputFileLocation) String ¶

func (s InputFileLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputFileLocation) Validate ¶

func (s *InputFileLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServiceError ¶

type InternalServiceError struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

This exception is thrown when an error occurs in the Transfer Family service.

func (*InternalServiceError) Code ¶

func (s *InternalServiceError) Code() string

Code returns the exception type name.

func (*InternalServiceError) Error ¶

func (s *InternalServiceError) Error() string

func (InternalServiceError) GoString ¶

func (s InternalServiceError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServiceError) Message ¶

func (s *InternalServiceError) Message() string

Message returns the exception's message.

func (*InternalServiceError) OrigErr ¶

func (s *InternalServiceError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceError) RequestID ¶

func (s *InternalServiceError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceError) StatusCode ¶

func (s *InternalServiceError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceError) String ¶

func (s InternalServiceError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidNextTokenException ¶

type InvalidNextTokenException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

The NextToken parameter that was passed is invalid.

func (*InvalidNextTokenException) Code ¶

func (s *InvalidNextTokenException) Code() string

Code returns the exception type name.

func (*InvalidNextTokenException) Error ¶

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString ¶

func (s InvalidNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidNextTokenException) Message ¶

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr ¶

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID ¶

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode ¶

func (s *InvalidNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidNextTokenException) String ¶

func (s InvalidNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException ¶

type InvalidRequestException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

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

func (*InvalidRequestException) Code ¶

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error ¶

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString ¶

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message ¶

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr ¶

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID ¶

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode ¶

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String ¶

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAccessesInput ¶

type ListAccessesInput struct {

    // Specifies the maximum number of access SIDs to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // A system-assigned unique identifier for a server that has users assigned
    // to it.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListAccessesInput) GoString ¶

func (s ListAccessesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessesInput) SetMaxResults ¶

func (s *ListAccessesInput) SetMaxResults(v int64) *ListAccessesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAccessesInput) SetNextToken ¶

func (s *ListAccessesInput) SetNextToken(v string) *ListAccessesInput

SetNextToken sets the NextToken field's value.

func (*ListAccessesInput) SetServerId ¶

func (s *ListAccessesInput) SetServerId(v string) *ListAccessesInput

SetServerId sets the ServerId field's value.

func (ListAccessesInput) String ¶

func (s ListAccessesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessesInput) Validate ¶

func (s *ListAccessesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAccessesOutput ¶

type ListAccessesOutput struct {

    // Returns the accesses and their properties for the ServerId value that you
    // specify.
    //
    // Accesses is a required field
    Accesses []*ListedAccess `type:"list" required:"true"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // A system-assigned unique identifier for a server that has users assigned
    // to it.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListAccessesOutput) GoString ¶

func (s ListAccessesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessesOutput) SetAccesses ¶

func (s *ListAccessesOutput) SetAccesses(v []*ListedAccess) *ListAccessesOutput

SetAccesses sets the Accesses field's value.

func (*ListAccessesOutput) SetNextToken ¶

func (s *ListAccessesOutput) SetNextToken(v string) *ListAccessesOutput

SetNextToken sets the NextToken field's value.

func (*ListAccessesOutput) SetServerId ¶

func (s *ListAccessesOutput) SetServerId(v string) *ListAccessesOutput

SetServerId sets the ServerId field's value.

func (ListAccessesOutput) String ¶

func (s ListAccessesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAgreementsInput ¶

type ListAgreementsInput struct {

    // The maximum number of agreements to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // The identifier of the server for which you want a list of agreements.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListAgreementsInput) GoString ¶

func (s ListAgreementsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgreementsInput) SetMaxResults ¶

func (s *ListAgreementsInput) SetMaxResults(v int64) *ListAgreementsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAgreementsInput) SetNextToken ¶

func (s *ListAgreementsInput) SetNextToken(v string) *ListAgreementsInput

SetNextToken sets the NextToken field's value.

func (*ListAgreementsInput) SetServerId ¶

func (s *ListAgreementsInput) SetServerId(v string) *ListAgreementsInput

SetServerId sets the ServerId field's value.

func (ListAgreementsInput) String ¶

func (s ListAgreementsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgreementsInput) Validate ¶

func (s *ListAgreementsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAgreementsOutput ¶

type ListAgreementsOutput struct {

    // Returns an array, where each item contains the details of an agreement.
    //
    // Agreements is a required field
    Agreements []*ListedAgreement `type:"list" required:"true"`

    // Returns a token that you can use to call ListAgreements again and receive
    // additional results, if there are any.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAgreementsOutput) GoString ¶

func (s ListAgreementsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgreementsOutput) SetAgreements ¶

func (s *ListAgreementsOutput) SetAgreements(v []*ListedAgreement) *ListAgreementsOutput

SetAgreements sets the Agreements field's value.

func (*ListAgreementsOutput) SetNextToken ¶

func (s *ListAgreementsOutput) SetNextToken(v string) *ListAgreementsOutput

SetNextToken sets the NextToken field's value.

func (ListAgreementsOutput) String ¶

func (s ListAgreementsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCertificatesInput ¶

type ListCertificatesInput struct {

    // The maximum number of certificates to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListCertificatesInput) GoString ¶

func (s ListCertificatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCertificatesInput) SetMaxResults ¶

func (s *ListCertificatesInput) SetMaxResults(v int64) *ListCertificatesInput

SetMaxResults sets the MaxResults field's value.

func (*ListCertificatesInput) SetNextToken ¶

func (s *ListCertificatesInput) SetNextToken(v string) *ListCertificatesInput

SetNextToken sets the NextToken field's value.

func (ListCertificatesInput) String ¶

func (s ListCertificatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCertificatesInput) Validate ¶

func (s *ListCertificatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCertificatesOutput ¶

type ListCertificatesOutput struct {

    // Returns an array of the certificates that are specified in the ListCertificates
    // call.
    //
    // Certificates is a required field
    Certificates []*ListedCertificate `type:"list" required:"true"`

    // Returns the next token, which you can use to list the next certificate.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListCertificatesOutput) GoString ¶

func (s ListCertificatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCertificatesOutput) SetCertificates ¶

func (s *ListCertificatesOutput) SetCertificates(v []*ListedCertificate) *ListCertificatesOutput

SetCertificates sets the Certificates field's value.

func (*ListCertificatesOutput) SetNextToken ¶

func (s *ListCertificatesOutput) SetNextToken(v string) *ListCertificatesOutput

SetNextToken sets the NextToken field's value.

func (ListCertificatesOutput) String ¶

func (s ListCertificatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListConnectorsInput ¶

type ListConnectorsInput struct {

    // The maximum number of connectors to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListConnectorsInput) GoString ¶

func (s ListConnectorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConnectorsInput) SetMaxResults ¶

func (s *ListConnectorsInput) SetMaxResults(v int64) *ListConnectorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListConnectorsInput) SetNextToken ¶

func (s *ListConnectorsInput) SetNextToken(v string) *ListConnectorsInput

SetNextToken sets the NextToken field's value.

func (ListConnectorsInput) String ¶

func (s ListConnectorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConnectorsInput) Validate ¶

func (s *ListConnectorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListConnectorsOutput ¶

type ListConnectorsOutput struct {

    // Returns an array, where each item contains the details of a connector.
    //
    // Connectors is a required field
    Connectors []*ListedConnector `type:"list" required:"true"`

    // Returns a token that you can use to call ListConnectors again and receive
    // additional results, if there are any.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListConnectorsOutput) GoString ¶

func (s ListConnectorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConnectorsOutput) SetConnectors ¶

func (s *ListConnectorsOutput) SetConnectors(v []*ListedConnector) *ListConnectorsOutput

SetConnectors sets the Connectors field's value.

func (*ListConnectorsOutput) SetNextToken ¶

func (s *ListConnectorsOutput) SetNextToken(v string) *ListConnectorsOutput

SetNextToken sets the NextToken field's value.

func (ListConnectorsOutput) String ¶

func (s ListConnectorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExecutionsInput ¶

type ListExecutionsInput struct {

    // Specifies the maximum number of executions to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // A unique identifier for the workflow.
    //
    // WorkflowId is a required field
    WorkflowId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListExecutionsInput) GoString ¶

func (s ListExecutionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsInput) SetMaxResults ¶

func (s *ListExecutionsInput) SetMaxResults(v int64) *ListExecutionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListExecutionsInput) SetNextToken ¶

func (s *ListExecutionsInput) SetNextToken(v string) *ListExecutionsInput

SetNextToken sets the NextToken field's value.

func (*ListExecutionsInput) SetWorkflowId ¶

func (s *ListExecutionsInput) SetWorkflowId(v string) *ListExecutionsInput

SetWorkflowId sets the WorkflowId field's value.

func (ListExecutionsInput) String ¶

func (s ListExecutionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsInput) Validate ¶

func (s *ListExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListExecutionsOutput ¶

type ListExecutionsOutput struct {

    // Returns the details for each execution, in a ListedExecution array.
    //
    // Executions is a required field
    Executions []*ListedExecution `type:"list" required:"true"`

    // ListExecutions returns the NextToken parameter in the output. You can then
    // pass the NextToken parameter in a subsequent command to continue listing
    // additional executions.
    NextToken *string `min:"1" type:"string"`

    // A unique identifier for the workflow.
    //
    // WorkflowId is a required field
    WorkflowId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListExecutionsOutput) GoString ¶

func (s ListExecutionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExecutionsOutput) SetExecutions ¶

func (s *ListExecutionsOutput) SetExecutions(v []*ListedExecution) *ListExecutionsOutput

SetExecutions sets the Executions field's value.

func (*ListExecutionsOutput) SetNextToken ¶

func (s *ListExecutionsOutput) SetNextToken(v string) *ListExecutionsOutput

SetNextToken sets the NextToken field's value.

func (*ListExecutionsOutput) SetWorkflowId ¶

func (s *ListExecutionsOutput) SetWorkflowId(v string) *ListExecutionsOutput

SetWorkflowId sets the WorkflowId field's value.

func (ListExecutionsOutput) String ¶

func (s ListExecutionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListHostKeysInput ¶

type ListHostKeysInput struct {

    // The maximum number of host keys to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // The identifier of the server that contains the host keys that you want to
    // view.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListHostKeysInput) GoString ¶

func (s ListHostKeysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListHostKeysInput) SetMaxResults ¶

func (s *ListHostKeysInput) SetMaxResults(v int64) *ListHostKeysInput

SetMaxResults sets the MaxResults field's value.

func (*ListHostKeysInput) SetNextToken ¶

func (s *ListHostKeysInput) SetNextToken(v string) *ListHostKeysInput

SetNextToken sets the NextToken field's value.

func (*ListHostKeysInput) SetServerId ¶

func (s *ListHostKeysInput) SetServerId(v string) *ListHostKeysInput

SetServerId sets the ServerId field's value.

func (ListHostKeysInput) String ¶

func (s ListHostKeysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListHostKeysInput) Validate ¶

func (s *ListHostKeysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListHostKeysOutput ¶

type ListHostKeysOutput struct {

    // Returns an array, where each item contains the details of a host key.
    //
    // HostKeys is a required field
    HostKeys []*ListedHostKey `type:"list" required:"true"`

    // Returns a token that you can use to call ListHostKeys again and receive additional
    // results, if there are any.
    NextToken *string `min:"1" type:"string"`

    // Returns the server identifier that contains the listed host keys.
    //
    // ServerId is a required field
    ServerId *string `min:"19" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListHostKeysOutput) GoString ¶

func (s ListHostKeysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListHostKeysOutput) SetHostKeys ¶

func (s *ListHostKeysOutput) SetHostKeys(v []*ListedHostKey) *ListHostKeysOutput

SetHostKeys sets the HostKeys field's value.

func (*ListHostKeysOutput) SetNextToken ¶

func (s *ListHostKeysOutput) SetNextToken(v string) *ListHostKeysOutput

SetNextToken sets the NextToken field's value.

func (*ListHostKeysOutput) SetServerId ¶

func (s *ListHostKeysOutput) SetServerId(v string) *ListHostKeysOutput

SetServerId sets the ServerId field's value.

func (ListHostKeysOutput) String ¶

func (s ListHostKeysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListProfilesInput ¶

type ListProfilesInput struct {

    // The maximum number of profiles to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`

    // 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.
    ProfileType *string `type:"string" enum:"ProfileType"`
    // contains filtered or unexported fields
}

func (ListProfilesInput) GoString ¶

func (s ListProfilesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProfilesInput) SetMaxResults ¶

func (s *ListProfilesInput) SetMaxResults(v int64) *ListProfilesInput

SetMaxResults sets the MaxResults field's value.

func (*ListProfilesInput) SetNextToken ¶

func (s *ListProfilesInput) SetNextToken(v string) *ListProfilesInput

SetNextToken sets the NextToken field's value.

func (*ListProfilesInput) SetProfileType ¶

func (s *ListProfilesInput) SetProfileType(v string) *ListProfilesInput

SetProfileType sets the ProfileType field's value.

func (ListProfilesInput) String ¶

func (s ListProfilesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProfilesInput) Validate ¶

func (s *ListProfilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProfilesOutput ¶

type ListProfilesOutput struct {

    // Returns a token that you can use to call ListProfiles again and receive additional
    // results, if there are any.
    NextToken *string `min:"1" type:"string"`

    // Returns an array, where each item contains the details of a profile.
    //
    // Profiles is a required field
    Profiles []*ListedProfile `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (ListProfilesOutput) GoString ¶

func (s ListProfilesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProfilesOutput) SetNextToken ¶

func (s *ListProfilesOutput) SetNextToken(v string) *ListProfilesOutput

SetNextToken sets the NextToken field's value.

func (*ListProfilesOutput) SetProfiles ¶

func (s *ListProfilesOutput) SetProfiles(v []*ListedProfile) *ListProfilesOutput

SetProfiles sets the Profiles field's value.

func (ListProfilesOutput) String ¶

func (s ListProfilesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSecurityPoliciesInput ¶

type ListSecurityPoliciesInput struct {

    // Specifies the number of security policies to return as a response to the
    // ListSecurityPolicies query.
    MaxResults *int64 `min:"1" type:"integer"`

    // 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.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListSecurityPoliciesInput) GoString ¶

func (s ListSecurityPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSecurityPoliciesInput) SetMaxResults ¶

func (s *ListSecurityPoliciesInput) SetMaxResults(v int64) *ListSecurityPoliciesInput

SetMaxResults sets the MaxResults field's value.

func (*ListSecurityPoliciesInput) SetNextToken ¶