AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Transfer

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

type Transfer struct { *client.Client }

Transfer provides the API operation methods for making requests to AWS Transfer for SFTP. See this package's package overview docs for details on the service.

Transfer methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

Client

Type: *client.Client

Method

CreateServer

func (c *Transfer) CreateServer(input *CreateServerInput) (*CreateServerOutput, error)

CreateServer API operation for AWS Transfer for SFTP.

Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users.

The response returns the ServerId value for the newly created server.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation CreateServer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServer

CreateServerRequest

func (c *Transfer) CreateServerRequest(input *CreateServerInput) (req *request.Request, output *CreateServerOutput)

CreateServerRequest generates a "aws/request.Request" representing the client's request for the CreateServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateServer for more information on using the CreateServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateServerRequest method. req, resp := client.CreateServerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServer

CreateServerWithContext

func (c *Transfer) CreateServerWithContext(ctx aws.Context, input *CreateServerInput, opts ...request.Option) (*CreateServerOutput, error)

CreateServerWithContext is the same as CreateServer with the addition of the ability to pass a context and additional request options.

See CreateServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateUser

func (c *Transfer) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)

CreateUser API operation for AWS Transfer for SFTP.

Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

The response returns the UserName and ServerId values of the new user for that server.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation CreateUser for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceExistsException "ResourceExistsException" The requested resource does not exist.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser

CreateUserRequest

func (c *Transfer) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)

CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUser for more information on using the CreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateUserRequest method. req, resp := client.CreateUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser

CreateUserWithContext

func (c *Transfer) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)

CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.

See CreateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteServer

func (c *Transfer) DeleteServer(input *DeleteServerInput) (*DeleteServerOutput, error)

DeleteServer API operation for AWS Transfer for SFTP.

Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used SERVICE_MANAGED as your IdentityProviderType, you need to delete all users associated with this server before deleting the server itself

No response returns from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DeleteServer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer

DeleteServerRequest

func (c *Transfer) DeleteServerRequest(input *DeleteServerInput) (req *request.Request, output *DeleteServerOutput)

DeleteServerRequest generates a "aws/request.Request" representing the client's request for the DeleteServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteServer for more information on using the DeleteServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteServerRequest method. req, resp := client.DeleteServerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer

DeleteServerWithContext

func (c *Transfer) DeleteServerWithContext(ctx aws.Context, input *DeleteServerInput, opts ...request.Option) (*DeleteServerOutput, error)

DeleteServerWithContext is the same as DeleteServer with the addition of the ability to pass a context and additional request options.

See DeleteServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteSshPublicKey

func (c *Transfer) DeleteSshPublicKey(input *DeleteSshPublicKeyInput) (*DeleteSshPublicKeyOutput, error)

DeleteSshPublicKey API operation for AWS Transfer for SFTP.

Deletes a user's Secure Shell (SSH) public key.

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DeleteSshPublicKey for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKey

DeleteSshPublicKeyRequest

func (c *Transfer) DeleteSshPublicKeyRequest(input *DeleteSshPublicKeyInput) (req *request.Request, output *DeleteSshPublicKeyOutput)

DeleteSshPublicKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteSshPublicKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSshPublicKey for more information on using the DeleteSshPublicKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSshPublicKeyRequest method. req, resp := client.DeleteSshPublicKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKey

DeleteSshPublicKeyWithContext

func (c *Transfer) DeleteSshPublicKeyWithContext(ctx aws.Context, input *DeleteSshPublicKeyInput, opts ...request.Option) (*DeleteSshPublicKeyOutput, error)

DeleteSshPublicKeyWithContext is the same as DeleteSshPublicKey with the addition of the ability to pass a context and additional request options.

See DeleteSshPublicKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteUser

func (c *Transfer) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for AWS Transfer for SFTP.

Deletes the user belonging to the server you specify.

No response returns from this call.

When you delete a user from a server, the user's information is lost.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DeleteUser for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser

DeleteUserRequest

func (c *Transfer) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteUserRequest method. req, resp := client.DeleteUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser

DeleteUserWithContext

func (c *Transfer) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeServer

func (c *Transfer) DescribeServer(input *DescribeServerInput) (*DescribeServerOutput, error)

DescribeServer API operation for AWS Transfer for SFTP.

Describes the server that you specify by passing the ServerId parameter.

The response contains a description of the server's properties.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DescribeServer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer

DescribeServerRequest

func (c *Transfer) DescribeServerRequest(input *DescribeServerInput) (req *request.Request, output *DescribeServerOutput)

DescribeServerRequest generates a "aws/request.Request" representing the client's request for the DescribeServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeServer for more information on using the DescribeServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeServerRequest method. req, resp := client.DescribeServerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer

DescribeServerWithContext

func (c *Transfer) DescribeServerWithContext(ctx aws.Context, input *DescribeServerInput, opts ...request.Option) (*DescribeServerOutput, error)

DescribeServerWithContext is the same as DescribeServer with the addition of the ability to pass a context and additional request options.

See DescribeServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeUser

func (c *Transfer) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)

DescribeUser API operation for AWS Transfer for SFTP.

Describes the user assigned to a specific server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation DescribeUser for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser

DescribeUserRequest

func (c *Transfer) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)

DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUser for more information on using the DescribeUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeUserRequest method. req, resp := client.DescribeUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser

DescribeUserWithContext

func (c *Transfer) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)

DescribeUserWithContext is the same as DescribeUser with the addition of the ability to pass a context and additional request options.

See DescribeUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ImportSshPublicKey

func (c *Transfer) ImportSshPublicKey(input *ImportSshPublicKeyInput) (*ImportSshPublicKeyOutput, error)

ImportSshPublicKey API operation for AWS Transfer for SFTP.

Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ImportSshPublicKey for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceExistsException "ResourceExistsException" The requested resource does not exist.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKey

ImportSshPublicKeyRequest

func (c *Transfer) ImportSshPublicKeyRequest(input *ImportSshPublicKeyInput) (req *request.Request, output *ImportSshPublicKeyOutput)

ImportSshPublicKeyRequest generates a "aws/request.Request" representing the client's request for the ImportSshPublicKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportSshPublicKey for more information on using the ImportSshPublicKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ImportSshPublicKeyRequest method. req, resp := client.ImportSshPublicKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKey

ImportSshPublicKeyWithContext

func (c *Transfer) ImportSshPublicKeyWithContext(ctx aws.Context, input *ImportSshPublicKeyInput, opts ...request.Option) (*ImportSshPublicKeyOutput, error)

ImportSshPublicKeyWithContext is the same as ImportSshPublicKey with the addition of the ability to pass a context and additional request options.

See ImportSshPublicKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListServers

func (c *Transfer) ListServers(input *ListServersInput) (*ListServersOutput, error)

ListServers API operation for AWS Transfer for SFTP.

Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ListServers for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken parameter that was passed is invalid.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServers

ListServersRequest

func (c *Transfer) ListServersRequest(input *ListServersInput) (req *request.Request, output *ListServersOutput)

ListServersRequest generates a "aws/request.Request" representing the client's request for the ListServers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListServers for more information on using the ListServers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListServersRequest method. req, resp := client.ListServersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServers

ListServersWithContext

func (c *Transfer) ListServersWithContext(ctx aws.Context, input *ListServersInput, opts ...request.Option) (*ListServersOutput, error)

ListServersWithContext is the same as ListServers with the addition of the ability to pass a context and additional request options.

See ListServers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListTagsForResource

func (c *Transfer) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Transfer for SFTP.

Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken parameter that was passed is invalid.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResource

ListTagsForResourceRequest

func (c *Transfer) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResource

ListTagsForResourceWithContext

func (c *Transfer) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListUsers

func (c *Transfer) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for AWS Transfer for SFTP.

Lists the users for the server that you specify by passing the ServerId parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation ListUsers for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken parameter that was passed is invalid.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsers

ListUsersRequest

func (c *Transfer) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)

ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUsers for more information on using the ListUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListUsersRequest method. req, resp := client.ListUsersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsers

ListUsersWithContext

func (c *Transfer) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)

ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.

See ListUsers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

StartServer

func (c *Transfer) StartServer(input *StartServerInput) (*StartServerOutput, error)

StartServer API operation for AWS Transfer for SFTP.

Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation StartServer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServer

StartServerRequest

func (c *Transfer) StartServerRequest(input *StartServerInput) (req *request.Request, output *StartServerOutput)

StartServerRequest generates a "aws/request.Request" representing the client's request for the StartServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartServer for more information on using the StartServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartServerRequest method. req, resp := client.StartServerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServer

StartServerWithContext

func (c *Transfer) StartServerWithContext(ctx aws.Context, input *StartServerInput, opts ...request.Option) (*StartServerOutput, error)

StartServerWithContext is the same as StartServer with the addition of the ability to pass a context and additional request options.

See StartServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

StopServer

func (c *Transfer) StopServer(input *StopServerInput) (*StopServerOutput, error)

StopServer API operation for AWS Transfer for SFTP.

Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

The states of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation StopServer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServer

StopServerRequest

func (c *Transfer) StopServerRequest(input *StopServerInput) (req *request.Request, output *StopServerOutput)

StopServerRequest generates a "aws/request.Request" representing the client's request for the StopServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopServer for more information on using the StopServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopServerRequest method. req, resp := client.StopServerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServer

StopServerWithContext

func (c *Transfer) StopServerWithContext(ctx aws.Context, input *StopServerInput, opts ...request.Option) (*StopServerOutput, error)

StopServerWithContext is the same as StopServer with the addition of the ability to pass a context and additional request options.

See StopServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

TagResource

func (c *Transfer) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Transfer for SFTP.

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResource

TagResourceRequest

func (c *Transfer) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResource

TagResourceWithContext

func (c *Transfer) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

TestIdentityProvider

func (c *Transfer) TestIdentityProvider(input *TestIdentityProviderInput) (*TestIdentityProviderOutput, error)

TestIdentityProvider API operation for AWS Transfer for SFTP.

If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation TestIdentityProvider for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider

TestIdentityProviderRequest

func (c *Transfer) TestIdentityProviderRequest(input *TestIdentityProviderInput) (req *request.Request, output *TestIdentityProviderOutput)

TestIdentityProviderRequest generates a "aws/request.Request" representing the client's request for the TestIdentityProvider operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestIdentityProvider for more information on using the TestIdentityProvider API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TestIdentityProviderRequest method. req, resp := client.TestIdentityProviderRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider

TestIdentityProviderWithContext

func (c *Transfer) TestIdentityProviderWithContext(ctx aws.Context, input *TestIdentityProviderInput, opts ...request.Option) (*TestIdentityProviderOutput, error)

TestIdentityProviderWithContext is the same as TestIdentityProvider with the addition of the ability to pass a context and additional request options.

See TestIdentityProvider for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UntagResource

func (c *Transfer) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Transfer for SFTP.

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResource

UntagResourceRequest

func (c *Transfer) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResource

UntagResourceWithContext

func (c *Transfer) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateServer

func (c *Transfer) UpdateServer(input *UpdateServerInput) (*UpdateServerOutput, error)

UpdateServer API operation for AWS Transfer for SFTP.

Updates the server properties after that server has been created.

The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation UpdateServer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServer

UpdateServerRequest

func (c *Transfer) UpdateServerRequest(input *UpdateServerInput) (req *request.Request, output *UpdateServerOutput)

UpdateServerRequest generates a "aws/request.Request" representing the client's request for the UpdateServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateServer for more information on using the UpdateServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateServerRequest method. req, resp := client.UpdateServerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServer

UpdateServerWithContext

func (c *Transfer) UpdateServerWithContext(ctx aws.Context, input *UpdateServerInput, opts ...request.Option) (*UpdateServerOutput, error)

UpdateServerWithContext is the same as UpdateServer with the addition of the ability to pass a context and additional request options.

See UpdateServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateUser

func (c *Transfer) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser API operation for AWS Transfer for SFTP.

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Transfer for SFTP's API operation UpdateUser for usage and error information.

Returned Error Codes:

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The request has failed because the AWS Transfer for SFTP service is not available.

  • ErrCodeInternalServiceError "InternalServiceError" This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

  • ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUser

UpdateUserRequest

func (c *Transfer) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)

UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUser for more information on using the UpdateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateUserRequest method. req, resp := client.UpdateUserRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUser

UpdateUserWithContext

func (c *Transfer) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)

UpdateUserWithContext is the same as UpdateUser with the addition of the ability to pass a context and additional request options.

See UpdateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

On this page: