package types

import "github.com/aws/aws-sdk-go-v2/service/transfer/types"

Index

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

func (*AccessDeniedException) GetMessage

func (e *AccessDeniedException) GetMessage() string

func (*AccessDeniedException) HasMessage

func (e *AccessDeniedException) HasMessage() bool

type ConflictException

type ConflictException struct {
	Message *string
}

This exception is thrown when the UpdatServer 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) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

func (*ConflictException) GetMessage

func (e *ConflictException) GetMessage() string

func (*ConflictException) HasMessage

func (e *ConflictException) HasMessage() bool

type DescribedServer

type DescribedServer struct {
	// Defines the type of endpoint that your file transfer protocol-enabled server is
	// connected to. If your server is connected to a VPC endpoint, your server isn't
	// accessible over the public internet.
	EndpointType EndpointType
	// Specifies the unique Amazon Resource Name (ARN) for a file transfer
	// protocol-enabled server to be described.
	Arn *string
	// Specifies information to call a customer-supplied authentication API. This field
	// is not populated when the IdentityProviderType of a file transfer
	// protocol-enabled server is SERVICE_MANAGED.
	IdentityProviderDetails *IdentityProviderDetails
	// Specifies the AWS Identity and Access Management (IAM) role that allows a file
	// transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon
	// S3 events. When set, user activity can be viewed in your CloudWatch logs.
	LoggingRole *string
	// Specifies the key-value pairs that you can use to search for and group file
	// transfer protocol-enabled servers that were assigned to the server that was
	// described.
	Tags []*Tag
	// Specifies the number of users that are assigned to a file transfer
	// protocol-enabled server you specified with the ServerId.
	UserCount *int32
	// Specifies the mode of authentication method enabled for this service. A value of
	// SERVICE_MANAGED means that you are using this file transfer protocol-enabled
	// server to store and access user credentials within the service. A value of
	// API_GATEWAY indicates that you have integrated an API Gateway endpoint that will
	// be invoked for authenticating your user into the service.
	IdentityProviderType IdentityProviderType
	// Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
	// when Protocols is set to FTPS.
	Certificate *string
	// Specifies the virtual private cloud (VPC) endpoint settings that you configured
	// for your file transfer protocol-enabled server.
	EndpointDetails *EndpointDetails
	// Specifies the condition of a file transfer protocol-enabled server for the
	// server that was described. A value of ONLINE indicates that the server can
	// accept jobs and transfer files. A State value of OFFLINE means that the server
	// cannot perform file transfer operations.  <p>The states of <code>STARTING</code>
	// and <code>STOPPING</code> indicate that the server is in an intermediate state,
	// either not fully able to respond, or not fully offline. The values of
	// <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error
	// condition.</p>
	State State
	// 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
	// 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:  <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer
	// Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File
	// Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p>
	// <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li>
	// </ul>
	Protocols []Protocol
	// Specifies the unique system-assigned identifier for a file transfer
	// protocol-enabled server that you instantiate.
	ServerId *string
}

Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the certificate ARN (if the FTPS protocol was selected), the endpoint type and details, the authentication configuration and type, the logging role, the file transfer protocol or protocols, the server ID and state, and assigned tags or metadata.

type DescribedUser

type DescribedUser struct {
	// Specifies the logical directory mappings that specify what Amazon S3 paths and
	// keys should be visible to your user and how you want to make them visible. You
	// will need to specify the "Entry" and "Target" pair, where Entry shows how the
	// path is made visible and Target is the actual Amazon S3 path. If you only
	// specify a target, it will be displayed as is. You will need to also make sure
	// that your AWS Identity and Access Management (IAM) role provides access to paths
	// in Target.  <p>In most cases, you can use this value instead of the scope-down
	// policy to lock your user down to the designated home directory ("chroot"). To do
	// this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the
	// HomeDirectory parameter value.</p>
	HomeDirectoryMappings []*HomeDirectoryMapEntry
	// Specifies the type of landing directory (folder) you mapped for your users to
	// see when they log into the file transfer protocol-enabled server. If you set it
	// to PATH, the user will see the absolute Amazon S3 bucket paths as is in their
	// file transfer protocol clients. If you set it LOGICAL, you will need to provide
	// mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths
	// visible to your users.
	HomeDirectoryType HomeDirectoryType
	// Specifies the name of the policy in use for the described user.
	Policy *string
	// Specifies the public key portion of the Secure Shell (SSH) keys stored for the
	// described user.
	SshPublicKeys []*SshPublicKey
	// Specifies the landing directory (or folder), which is the location that files
	// are written to or read from in an Amazon S3 bucket, for the described user. An
	// example is your-Amazon-S3-bucket-name>/home/username .
	HomeDirectory *string
	// 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 file transfer protocol-enabled server.
	UserName *string
	// 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
	// Specifies the IAM role that controls your users' access to your Amazon S3
	// bucket. The policies attached to this role will determine the level of access
	// you want to provide your users when transferring files into and out of your
	// Amazon S3 bucket or buckets. The IAM role should also contain a trust
	// relationship that allows a file transfer protocol-enabled server to access your
	// resources when servicing your users' transfer requests.
	Role *string
	// Specifies the unique Amazon Resource Name (ARN) for the user that was requested
	// to be described.
	Arn *string
}

Returns properties of the user that you want to describe.

type EndpointDetails

type EndpointDetails struct {
	// A list of subnet IDs that are required to host your file transfer
	// protocol-enabled server endpoint in your VPC.  <note> <p>This property can only
	// be used when <code>EndpointType</code> is set to <code>VPC</code>.</p> </note>
	SubnetIds []*string
	// The ID of the VPC endpoint.  <note> <p>This property can only be used when
	// <code>EndpointType</code> is set to <code>VPC_ENDPOINT</code>.</p> </note>
	VpcEndpointId *string
	// A list of address allocation IDs that are required to attach an Elastic IP
	// address to your file transfer protocol-enabled server's endpoint. This is only
	// valid in the UpdateServer API.  <note> <p>This property can only be use when
	// <code>EndpointType</code> is set to <code>VPC</code>.</p> </note>
	AddressAllocationIds []*string
	// The VPC ID of the VPC in which a file transfer protocol-enabled server's
	// endpoint will be hosted.  <note> <p>This property can only be used when
	// <code>EndpointType</code> is set to <code>VPC</code>.</p> </note>
	VpcId *string
}

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 to your server's endpoint.

type EndpointType

type EndpointType string
const (
	EndpointTypePublic       EndpointType = "PUBLIC"
	EndpointTypeVpc          EndpointType = "VPC"
	EndpointTypeVpc_endpoint EndpointType = "VPC_ENDPOINT"
)

Enum values for EndpointType

type HomeDirectoryMapEntry

type HomeDirectoryMapEntry struct {
	// Represents the map target that is used in a HomeDirectorymapEntry.
	Target *string
	// Represents an entry and a target for HomeDirectoryMappings.
	Entry *string
}

Represents an object that contains entries and a targets for HomeDirectoryMappings.

type HomeDirectoryType

type HomeDirectoryType string
const (
	HomeDirectoryTypePath    HomeDirectoryType = "PATH"
	HomeDirectoryTypeLogical HomeDirectoryType = "LOGICAL"
)

Enum values for HomeDirectoryType

type IdentityProviderDetails

type IdentityProviderDetails struct {
	// Provides the location of the service endpoint used to authenticate users.
	Url *string
	// Provides the type of InvocationRole used to authenticate the user account.
	InvocationRole *string
}

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.

type IdentityProviderType

type IdentityProviderType string
const (
	IdentityProviderTypeService_managed IdentityProviderType = "SERVICE_MANAGED"
	IdentityProviderTypeApi_gateway     IdentityProviderType = "API_GATEWAY"
)

Enum values for IdentityProviderType

type InternalServiceError

type InternalServiceError struct {
	Message *string
}

This exception is thrown when an error occurs in the AWS Transfer Family service.

func (*InternalServiceError) Error

func (e *InternalServiceError) Error() string

func (*InternalServiceError) ErrorCode

func (e *InternalServiceError) ErrorCode() string

func (*InternalServiceError) ErrorFault

func (e *InternalServiceError) ErrorFault() smithy.ErrorFault

func (*InternalServiceError) ErrorMessage

func (e *InternalServiceError) ErrorMessage() string

func (*InternalServiceError) GetMessage

func (e *InternalServiceError) GetMessage() string

func (*InternalServiceError) HasMessage

func (e *InternalServiceError) HasMessage() bool

type InvalidNextTokenException

type InvalidNextTokenException struct {
	Message *string
}

The NextToken parameter that was passed is invalid.

func (*InvalidNextTokenException) Error

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault

func (*InvalidNextTokenException) ErrorMessage

func (e *InvalidNextTokenException) ErrorMessage() string

func (*InvalidNextTokenException) GetMessage

func (e *InvalidNextTokenException) GetMessage() string

func (*InvalidNextTokenException) HasMessage

func (e *InvalidNextTokenException) HasMessage() bool

type InvalidRequestException

type InvalidRequestException struct {
	Message *string
}

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

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

func (*InvalidRequestException) GetMessage

func (e *InvalidRequestException) GetMessage() string

func (*InvalidRequestException) HasMessage

func (e *InvalidRequestException) HasMessage() bool

type ListedServer

type ListedServer struct {
	// Specifies the number of users that are assigned to a file transfer
	// protocol-enabled server you specified with the ServerId.
	UserCount *int32
	// Specifies the condition of a file transfer protocol-enabled server for the
	// server that was described. A value of ONLINE indicates that the server can
	// accept jobs and transfer files. A State value of OFFLINE means that the server
	// cannot perform file transfer operations.  <p>The states of <code>STARTING</code>
	// and <code>STOPPING</code> indicate that the server is in an intermediate state,
	// either not fully able to respond, or not fully offline. The values of
	// <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error
	// condition.</p>
	State State
	// Specifies the type of VPC endpoint that your file transfer protocol-enabled
	// server is connected to. If your server is connected to a VPC endpoint, your
	// server isn't accessible over the public internet.
	EndpointType EndpointType
	// Specifies the AWS Identity and Access Management (IAM) role that allows a file
	// transfer protocol-enabled server to turn on Amazon CloudWatch logging.
	LoggingRole *string
	// Specifies the unique system assigned identifier for a file transfer
	// protocol-enabled servers that were listed.
	ServerId *string
	// Specifies the authentication method used to validate a user for a file transfer
	// protocol-enabled server that was specified. This can include Secure Shell (SSH),
	// user name and password combinations, or your own custom authentication method.
	// Valid values include SERVICE_MANAGED or API_GATEWAY.
	IdentityProviderType IdentityProviderType
	// Specifies the unique Amazon Resource Name (ARN) for a file transfer
	// protocol-enabled server to be listed.
	Arn *string
}

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

type ListedUser

type ListedUser struct {
	// Specifies the type of landing directory (folder) you mapped for your users' home
	// directory. If you set it to PATH, the user will see the absolute Amazon S3
	// bucket paths as is in their file transfer protocol clients. If you set it
	// LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how
	// you want to make Amazon S3 paths visible to your users.
	HomeDirectoryType HomeDirectoryType
	// Specifies the name of the user whose ARN was specified. User names are used for
	// authentication purposes.
	UserName *string
	// Specifies the role that is in use by this user. A role is an AWS Identity and
	// Access Management (IAM) entity that, in this case, allows a file transfer
	// protocol-enabled server to act on a user's behalf. It allows the server to
	// inherit the trust relationship that enables that user to perform file operations
	// to their Amazon S3 bucket.
	Role *string
	// Specifies the number of SSH public keys stored for the user you specified.
	SshPublicKeyCount *int32
	// Provides the unique Amazon Resource Name (ARN) for the user that you want to
	// learn about.
	Arn *string
	// Specifies the location that files are written to or read from an Amazon S3
	// bucket for the user you specify by their ARN.
	HomeDirectory *string
}

Returns properties of the user that you specify.

type Protocol

type Protocol string
const (
	ProtocolSftp Protocol = "SFTP"
	ProtocolFtp  Protocol = "FTP"
	ProtocolFtps Protocol = "FTPS"
)

Enum values for Protocol

type ResourceExistsException

type ResourceExistsException struct {
	Message *string

	Resource     *string
	ResourceType *string
}

The requested resource does not exist.

func (*ResourceExistsException) Error

func (e *ResourceExistsException) Error() string

func (*ResourceExistsException) ErrorCode

func (e *ResourceExistsException) ErrorCode() string

func (*ResourceExistsException) ErrorFault

func (e *ResourceExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceExistsException) ErrorMessage

func (e *ResourceExistsException) ErrorMessage() string

func (*ResourceExistsException) GetMessage

func (e *ResourceExistsException) GetMessage() string

func (*ResourceExistsException) GetResource

func (e *ResourceExistsException) GetResource() string

func (*ResourceExistsException) GetResourceType

func (e *ResourceExistsException) GetResourceType() string

func (*ResourceExistsException) HasMessage

func (e *ResourceExistsException) HasMessage() bool

func (*ResourceExistsException) HasResource

func (e *ResourceExistsException) HasResource() bool

func (*ResourceExistsException) HasResourceType

func (e *ResourceExistsException) HasResourceType() bool

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	Resource     *string
	ResourceType *string
}

This exception is thrown when a resource is not found by the AWS Transfer Family service.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

func (*ResourceNotFoundException) GetMessage

func (e *ResourceNotFoundException) GetMessage() string

func (*ResourceNotFoundException) GetResource

func (e *ResourceNotFoundException) GetResource() string

func (*ResourceNotFoundException) GetResourceType

func (e *ResourceNotFoundException) GetResourceType() string

func (*ResourceNotFoundException) HasMessage

func (e *ResourceNotFoundException) HasMessage() bool

func (*ResourceNotFoundException) HasResource

func (e *ResourceNotFoundException) HasResource() bool

func (*ResourceNotFoundException) HasResourceType

func (e *ResourceNotFoundException) HasResourceType() bool

type ServiceUnavailableException

type ServiceUnavailableException struct {
	Message *string
}

The request has failed because the AWS Transfer Family service is not available.

func (*ServiceUnavailableException) Error

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

func (*ServiceUnavailableException) GetMessage

func (e *ServiceUnavailableException) GetMessage() string

func (*ServiceUnavailableException) HasMessage

func (e *ServiceUnavailableException) HasMessage() bool

type SshPublicKey

type SshPublicKey struct {
	// Specifies the SshPublicKeyId parameter contains the identifier of the public
	// key.
	SshPublicKeyId *string
	// Specifies the date that the public key was added to the user account.
	DateImported *time.Time
	// Specifies the content of the SSH public key as specified by the PublicKeyId.
	SshPublicKeyBody *string
}

Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

type State

type State string
const (
	StateOffline      State = "OFFLINE"
	StateOnline       State = "ONLINE"
	StateStarting     State = "STARTING"
	StateStopping     State = "STOPPING"
	StateStart_failed State = "START_FAILED"
	StateStop_failed  State = "STOP_FAILED"
)

Enum values for State

type Tag

type Tag struct {
	// The name assigned to the tag that you create.
	Key *string
	// Contains one or more values that you assigned to the key name you create.
	Value *string
}

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	RetryAfterSeconds *string
}

The request was denied due to request throttling. <p> HTTP Status Code: 400</p>

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

func (*ThrottlingException) GetRetryAfterSeconds

func (e *ThrottlingException) GetRetryAfterSeconds() string

func (*ThrottlingException) HasRetryAfterSeconds

func (e *ThrottlingException) HasRetryAfterSeconds() bool

Source Files

enums.go errors.go types.go

Version
v0.1.0
Published
Sep 29, 2020
Platform
windows/amd64
Imports
4 packages
Last checked
2 weeks ago

Tools for package owners.