Class: Aws::Transfer::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-transfer/client.rb,
sig/client.rbs

Overview

An API client for Transfer. To construct a client, you need to configure a :region and :credentials.

client = Aws::Transfer::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Defined Under Namespace

Modules: _CreateAccessResponseSuccess, _CreateAgreementResponseSuccess, _CreateConnectorResponseSuccess, _CreateProfileResponseSuccess, _CreateServerResponseSuccess, _CreateUserResponseSuccess, _CreateWebAppResponseSuccess, _CreateWorkflowResponseSuccess, _DescribeAccessResponseSuccess, _DescribeAgreementResponseSuccess, _DescribeCertificateResponseSuccess, _DescribeConnectorResponseSuccess, _DescribeExecutionResponseSuccess, _DescribeHostKeyResponseSuccess, _DescribeProfileResponseSuccess, _DescribeSecurityPolicyResponseSuccess, _DescribeServerResponseSuccess, _DescribeUserResponseSuccess, _DescribeWebAppCustomizationResponseSuccess, _DescribeWebAppResponseSuccess, _DescribeWorkflowResponseSuccess, _ImportCertificateResponseSuccess, _ImportHostKeyResponseSuccess, _ImportSshPublicKeyResponseSuccess, _ListAccessesResponseSuccess, _ListAgreementsResponseSuccess, _ListCertificatesResponseSuccess, _ListConnectorsResponseSuccess, _ListExecutionsResponseSuccess, _ListFileTransferResultsResponseSuccess, _ListHostKeysResponseSuccess, _ListProfilesResponseSuccess, _ListSecurityPoliciesResponseSuccess, _ListServersResponseSuccess, _ListTagsForResourceResponseSuccess, _ListUsersResponseSuccess, _ListWebAppsResponseSuccess, _ListWorkflowsResponseSuccess, _SendWorkflowStepStateResponseSuccess, _StartDirectoryListingResponseSuccess, _StartFileTransferResponseSuccess, _StartRemoteDeleteResponseSuccess, _StartRemoteMoveResponseSuccess, _TestConnectionResponseSuccess, _TestIdentityProviderResponseSuccess, _UpdateAccessResponseSuccess, _UpdateAgreementResponseSuccess, _UpdateCertificateResponseSuccess, _UpdateConnectorResponseSuccess, _UpdateHostKeyResponseSuccess, _UpdateProfileResponseSuccess, _UpdateServerResponseSuccess, _UpdateUserResponseSuccess, _UpdateWebAppCustomizationResponseSuccess, _UpdateWebAppResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:workflow_step) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

  
Constructor Details

  
    

  

  
    #initialize(options)  ⇒ Client 
  

  

  




  

    
Returns a new instance of Client.


  





  
  

  

    

  





  
Parameters:


    
  
    
  • 
      
        options
      
      
        (Hash)
      
      
      
    
    • 
  



  
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :plugins
          (Array<Seahorse::Client::Plugin>)
          
            
              — default:
              []]
            
          
          
            — 
    A list of plugins to apply to the client. Each plugin is either a
class name or an instance of a plugin class.
    
          
        
    • 
      
        
  • 
          :credentials
          (required, Aws::CredentialProvider)
          
            
          
          
            — 
    Your AWS credentials used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or instance of any one of the following classes:
    

      

    • 

      Aws::Credentials - Used for configuring static, non-refreshing
credentials.
      

      • 

    • 

      Aws::SharedCredentials - Used for loading static credentials from a
shared file, such as ~/.aws/config.
      

      • 

    • 

      Aws::AssumeRoleCredentials - Used when you need to assume a role.
      

      • 

    • 

      Aws::AssumeRoleWebIdentityCredentials - Used when you need to
assume a role after providing credentials via the web.
      

      • 

    • 

      Aws::SSOCredentials - Used for loading credentials from AWS SSO using an
access token generated from aws login.
      

      • 

    • 

      Aws::ProcessCredentials - Used for loading credentials from a
process that outputs to stdout.
      

      • 

    • 

      Aws::InstanceProfileCredentials - Used for loading credentials
from an EC2 IMDS on an EC2 instance.
      

      • 

    • 

      Aws::ECSCredentials - Used for loading credentials from
instances running in ECS.
      

      • 

    • 

      Aws::CognitoIdentityCredentials - Used for loading credentials
from the Cognito Identity service.
      

      • 

    

    When :credentials are not configured directly, the following locations will be searched for credentials:
    

      

    • 

      Aws.config[:credentials]
      

      • 

    • 

      The :access_key_id, :secret_access_key, :session_token, and
:account_id options.
      

      • 

    • 

      ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
      

      • 

    • 

      ~/.aws/credentials
      

      • 

    • 

      ~/.aws/config
      

      • 

    • 

      EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to
enable retries and extended timeouts. Instance profile credential fetching can be disabled by
setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
      

      • 

    
          
        
    • 
      
        
  • 
          :region
          (required, String)
          
            
          
          
            — 
    The AWS region to connect to.  The configured :region is
used to determine the service :endpoint. When not passed,
a default :region is searched for in the following locations:
    

      

    • Aws.config[:region]
      • 

    • ENV['AWS_REGION']
      • 

    • ENV['AMAZON_REGION']
      • 

    • ENV['AWS_DEFAULT_REGION']
      • 

    • ~/.aws/credentials
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :access_key_id
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :account_id
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :active_endpoint_cache
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to true, a thread polling for endpoints will be running in
the background every 60 secs (default). Defaults to false.
    
          
        
    • 
      
        
  • 
          :adaptive_retry_wait_to_fill
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    Used only in adaptive retry mode.  When true, the request will sleep
until there is sufficent client side capacity to retry the request.
When false, the request will raise a RetryCapacityNotAvailableError and will
not retry instead of sleeping.
    
          
        
    • 
      
        
  • 
          :auth_scheme_preference
          (Array<String>)
          
            
          
          
            — 
    A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in
shared config as auth_scheme_preference, the value should be a comma-separated list.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true, client-side metrics will be collected for all API requests from
this client.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_client_id
          (String)
          
            
              — default:
              ""
            
          
          
            — 
    Allows you to provide an identifier for this client which will be attached to
all generated client side metrics. Defaults to an empty string.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_host
          (String)
          
            
              — default:
              "127.0.0.1"
            
          
          
            — 
    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
side monitoring agent is running on, where client metrics will be published via UDP.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_port
          (Integer)
          
            
              — default:
              31000
            
          
          
            — 
    Required for publishing client metrics. The port that the client side monitoring
agent is running on, where client metrics will be published via UDP.
    
          
        
    • 
      
        
  • 
          :client_side_monitoring_publisher
          (Aws::ClientSideMonitoring::Publisher)
          
            
              — default:
              Aws::ClientSideMonitoring::Publisher
            
          
          
            — 
    Allows you to provide a custom client-side monitoring publisher class. By default,
will use the Client Side Monitoring Agent Publisher.
    
          
        
    • 
      
        
  • 
          :convert_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, an attempt is made to coerce request parameters into
the required types.
    
          
        
    • 
      
        
  • 
          :correct_clock_skew
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    Used only in standard and adaptive retry modes. Specifies whether to apply
a clock skew correction and retry requests with skewed client clocks.
    
          
        
    • 
      
        
  • 
          :defaults_mode
          (String)
          
            
              — default:
              "legacy"
            
          
          
            — 
    See DefaultsModeConfiguration for a list of the
accepted modes and the configuration defaults that are included.
    
          
        
    • 
      
        
  • 
          :disable_host_prefix_injection
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true, the SDK will not prepend the modeled host prefix to the endpoint.
    
          
        
    • 
      
        
  • 
          :disable_request_compression
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to 'true' the request body will not be compressed
for supported operations.
    
          
        
    • 
      
        
  • 
          :endpoint
          (String, URI::HTTPS, URI::HTTP)
          
            
          
          
            — 
    Normally you should not configure the :endpoint option
directly. This is normally constructed from the :region
option. Configuring :endpoint is normally reserved for
connecting to test or custom endpoints. The endpoint should
be a URI formatted like:
    

    'http://example.com'
'https://example.com'
'http://example.com:123'
    
          
        
    • 
      
        
  • 
          :endpoint_cache_max_entries
          (Integer)
          
            
              — default:
              1000
            
          
          
            — 
    Used for the maximum size limit of the LRU cache storing endpoints data
for endpoint discovery enabled operations. Defaults to 1000.
    
          
        
    • 
      
        
  • 
          :endpoint_cache_max_threads
          (Integer)
          
            
              — default:
              10
            
          
          
            — 
    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
    
          
        
    • 
      
        
  • 
          :endpoint_cache_poll_interval
          (Integer)
          
            
              — default:
              60
            
          
          
            — 
    When :endpoint_discovery and :active_endpoint_cache is enabled,
Use this option to config the time interval in seconds for making
requests fetching endpoints information. Defaults to 60 sec.
    
          
        
    • 
      
        
  • 
          :endpoint_discovery
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When set to true, endpoint discovery will be enabled for operations when available.
    
          
        
    • 
      
        
  • 
          :ignore_configured_endpoint_urls
          (Boolean)
          
            
          
          
            — 
    Setting to true disables use of endpoint URLs provided via environment
variables and the shared configuration file.
    
          
        
    • 
      
        
  • 
          :log_formatter
          (Aws::Log::Formatter)
          
            
              — default:
              Aws::Log::Formatter.default
            
          
          
            — 
    The log formatter.
    
          
        
    • 
      
        
  • 
          :log_level
          (Symbol)
          
            
              — default:
              :info
            
          
          
            — 
    The log level to send messages to the :logger at.
    
          
        
    • 
      
        
  • 
          :logger
          (Logger)
          
            
          
          
            — 
    The Logger instance to send log messages to.  If this option
is not set, logging will be disabled.
    
          
        
    • 
      
        
  • 
          :max_attempts
          (Integer)
          
            
              — default:
              3
            
          
          
            — 
    An integer representing the maximum number attempts that will be made for
a single request, including the initial attempt.  For example,
setting this value to 5 will result in a request being retried up to
4 times. Used in standard and adaptive retry modes.
    
          
        
    • 
      
        
  • 
          :profile
          (String)
          
            
              — default:
              "default"
            
          
          
            — 
    Used when loading credentials from the shared credentials file at HOME/.aws/credentials.
When not specified, 'default' is used.
    
          
        
    • 
      
        
  • 
          :request_checksum_calculation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when a checksum will be calculated for request payloads. Values are:
    

      

    • when_supported - (default) When set, a checksum will be
calculated for all request payloads of operations modeled with the
httpChecksum trait where requestChecksumRequired is true and/or a
requestAlgorithmMember is modeled.
      • 

    • when_required - When set, a checksum will only be calculated for
request payloads of operations modeled with the  httpChecksum trait where
requestChecksumRequired is true or where a requestAlgorithmMember
is modeled and supplied.
      • 

    
          
        
    • 
      
        
  • 
          :request_min_compression_size_bytes
          (Integer)
          
            
              — default:
              10240
            
          
          
            — 
    The minimum size in bytes that triggers compression for request
bodies. The value must be non-negative integer value between 0
and 10485780 bytes inclusive.
    
          
        
    • 
      
        
  • 
          :response_checksum_validation
          (String)
          
            
              — default:
              "when_supported"
            
          
          
            — 
    Determines when checksum validation will be performed on response payloads. Values are:
    

      

    • when_supported - (default) When set, checksum validation is performed on all
response payloads of operations modeled with the httpChecksum trait where
responseAlgorithms is modeled, except when no modeled checksum algorithms
are supported.
      • 

    • when_required - When set, checksum validation is not performed on
response payloads of operations unless the checksum algorithm is supported and
the requestValidationModeMember member is set to ENABLED.
      • 

    
          
        
    • 
      
        
  • 
          :retry_backoff
          (Proc)
          
            
          
          
            — 
    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
This option is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_base_delay
          (Float)
          
            
              — default:
              0.3
            
          
          
            — 
    The base delay in seconds used by the default backoff function. This option
is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_jitter
          (Symbol)
          
            
              — default:
              :none
            
          
          
            — 
    A delay randomiser function used by the default backoff function.
Some predefined functions can be referenced by name - :none, :equal, :full,
otherwise a Proc that takes and returns a number. This option is only used
in the legacy retry mode.
    

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html
    
          
        
    • 
      
        
  • 
          :retry_limit
          (Integer)
          
            
              — default:
              3
            
          
          
            — 
    The maximum number of times to retry failed requests.  Only
~ 500 level server errors and certain ~ 400 level client errors
are retried.  Generally, these are throttling errors, data
checksum errors, networking errors, timeout errors, auth errors,
endpoint discovery, and errors from expired credentials.
This option is only used in the legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_max_delay
          (Integer)
          
            
              — default:
              0
            
          
          
            — 
    The maximum number of seconds to delay between retries (0 for no limit)
used by the default backoff function. This option is only used in the
legacy retry mode.
    
          
        
    • 
      
        
  • 
          :retry_mode
          (String)
          
            
              — default:
              "legacy"
            
          
          
            — 
    Specifies which retry algorithm to use. Values are:
    

      

    • 

      legacy - The pre-existing retry behavior. This is the default
value if no retry mode is provided.
      

      • 

    • 

      standard - A standardized set of retry rules across the AWS SDKs.
This includes support for retry quotas, which limit the number of
unsuccessful retries a client can make.
      

      • 

    • 

      adaptive - A retry mode that includes all the functionality of
standard mode along with automatic client side throttling.
      

      • 

    
          
        
    • 
      
        
  • 
          :sdk_ua_app_id
          (String)
          
            
          
          
            — 
    A unique and opaque application ID that is appended to the
User-Agent header as app/sdk_ua_app_id. It should have a
maximum length of 50. This variable is sourced from environment
variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
    
          
        
    • 
      
        
  • 
          :secret_access_key
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :session_token
          (String)
          
            
          
          
        
    • 
      
        
  • 
          :sigv4a_signing_region_set
          (Array)
          
            
          
          
            — 
    A list of regions that should be signed with SigV4a signing. When
not passed, a default :sigv4a_signing_region_set is searched for
in the following locations:
    

      

    • Aws.config[:sigv4a_signing_region_set]
      • 

    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
      • 

    • ~/.aws/config
      • 

    
          
        
    • 
      
        
  • 
          :simple_json
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    Disables request parameter conversion, validation, and formatting.
Also disables response data type conversions. The request parameters
hash must be formatted exactly as the API expects.This option is useful
when you want to ensure the highest level of performance by avoiding
overhead of walking request parameters and response data structures.
    
          
        
    • 
      
        
  • 
          :stub_responses
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    Causes the client to return stubbed responses. By default
fake responses are generated and returned. You can specify
the response data to return or errors to raise by calling
ClientStubs#stub_responses. See ClientStubs for more information.
    

    ** Please note ** When response stubbing is enabled, no HTTP
requests are made, and retries are disabled.
    
          
        
    • 
      
        
  • 
          :telemetry_provider
          (Aws::Telemetry::TelemetryProviderBase)
          
            
              — default:
              Aws::Telemetry::NoOpTelemetryProvider
            
          
          
            — 
    Allows you to provide a telemetry provider, which is used to
emit telemetry data. By default, uses NoOpTelemetryProvider which
will not record or emit any telemetry data. The SDK supports the
following telemetry providers:
    

      

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk gem and then, pass in an instance of a
Aws::Telemetry::OTelProvider for telemetry provider.
      • 

    
          
        
    • 
      
        
  • 
          :token_provider
          (Aws::TokenProvider)
          
            
          
          
            — 
    Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or instance of any one of the following classes:
    

      

    • 

      Aws::StaticTokenProvider - Used for configuring static, non-refreshing
tokens.
      

      • 

    • 

      Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an
access token generated from aws login.
      

      • 

    

    When :token_provider is not configured directly, the Aws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files.
    
          
        
    • 
      
        
  • 
          :use_dualstack_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, dualstack enabled endpoints (with .aws TLD)
will be used if available.
    
          
        
    • 
      
        
  • 
          :use_fips_endpoint
          (Boolean)
          
            
          
          
            — 
    When set to true, fips compatible endpoints will be used if available.
When a fips region is used, the region is normalized and this config
is set to true.
    
          
        
    • 
      
        
  • 
          :validate_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, request parameters are validated before
sending the request.
    
          
        
    • 
      
        
  • 
          :endpoint_provider
          (Aws::Transfer::EndpointProvider)
          
            
          
          
            — 
    The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters) where parameters is a Struct similar to
Aws::Transfer::EndpointParameters.
    
          
        
    • 
      
        
  • 
          :http_continue_timeout
          (Float)
          
            
              — default:
              1
            
          
          
            — 
    The number of seconds to wait for a 100-continue response before sending the
request body.  This option has no effect unless the request has "Expect"
header set to "100-continue".  Defaults to nil which  disables this
behaviour.  This value can safely be set per request on the session.
    
          
        
    • 
      
        
  • 
          :http_idle_timeout
          (Float)
          
            
              — default:
              5
            
          
          
            — 
    The number of seconds a connection is allowed to sit idle before it
is considered stale.  Stale connections are closed and removed from the
pool before making a request.
    
          
        
    • 
      
        
  • 
          :http_open_timeout
          (Float)
          
            
              — default:
              15
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_proxy
          (URI::HTTP, String)
          
            
          
          
            — 
    A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    
          
        
    • 
      
        
  • 
          :http_read_timeout
          (Float)
          
            
              — default:
              60
            
          
          
            — 
    The default number of seconds to wait for response data.
This value can safely be set per-request on the session.
    
          
        
    • 
      
        
  • 
          :http_wire_trace
          (Boolean)
          
            
              — default:
              false
            
          
          
            — 
    When true,  HTTP debug output will be sent to the :logger.
    
          
        
    • 
      
        
  • 
          :on_chunk_received
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the response body is received. It provides three arguments: the chunk,
the number of bytes received, and the total number of
bytes in the response (or nil if the server did not send a content-length).
    
          
        
    • 
      
        
  • 
          :on_chunk_sent
          (Proc)
          
            
          
          
            — 
    When a Proc object is provided, it will be used as callback when each chunk
of the request body is sent. It provides three arguments: the chunk,
the number of bytes read from the body, and the total number of
bytes in the body.
    
          
        
    • 
      
        
  • 
          :raise_response_errors
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, response errors are raised.
    
          
        
    • 
      
        
  • 
          :ssl_ca_bundle
          (String)
          
            
          
          
            — 
    Full path to the SSL certificate authority bundle file that should be used when
verifying peer certificates.  If you do not pass :ssl_ca_bundle or
:ssl_ca_directory the the system default will be used if available.
    
          
        
    • 
      
        
  • 
          :ssl_ca_directory
          (String)
          
            
          
          
            — 
    Full path of the directory that contains the unbundled SSL certificate
authority files for verifying peer certificates.  If you do
not pass :ssl_ca_bundle or :ssl_ca_directory the the system
default will be used if available.
    
          
        
    • 
      
        
  • 
          :ssl_ca_store
          (String)
          
            
          
          
            — 
    Sets the X509::Store to verify peer certificate.
    
          
        
    • 
      
        
  • 
          :ssl_cert
          (OpenSSL::X509::Certificate)
          
            
          
          
            — 
    Sets a client certificate when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_key
          (OpenSSL::PKey)
          
            
          
          
            — 
    Sets a client key when creating http connections.
    
          
        
    • 
      
        
  • 
          :ssl_timeout
          (Float)
          
            
          
          
            — 
    Sets the SSL timeout in seconds
    
          
        
    • 
      
        
  • 
          :ssl_verify_peer
          (Boolean)
          
            
              — default:
              true
            
          
          
            — 
    When true, SSL peer certificates are verified when establishing a connection.
    
          
        
    • 
      
    

  








  

    
      


478
479
480

    		
    
      
# File 'lib/aws-sdk-transfer/client.rb', line 478

def initialize(*args)
  super
end

    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (readonly)
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


5911
5912
5913

    		
    
      
# File 'lib/aws-sdk-transfer/client.rb', line 5911

def identifier
  @identifier
end

    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


5914
5915
5916

    		
    
      
# File 'lib/aws-sdk-transfer/client.rb', line 5914

def errors_module
  Errors
end

    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  




  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (

    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #build_request(operation_name, params = {})  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  
Parameters:


    
  
    
  • 
      
        params
      
      
        ({})
      
      
        (defaults to: {})
      
      
    
    • 
  






  

    
      


5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785

    		
    
      
# File 'lib/aws-sdk-transfer/client.rb', line 5769

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Transfer')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-transfer'
  context[:gem_version] = '1.146.0'
  Seahorse::Client::Request.new(handlers, context)
end

    		
  





    
      

  

  
    #create_access(params = {})  ⇒ Types::CreateAccessResponse 
  

  

  




  

    
Used by administrators to choose which groups in the directory should
have access to upload and download files over the enabled protocols
using Transfer Family. For example, a Microsoft Active Directory might
contain 50,000 users, but only a small fraction might need the ability
to transfer files to the server. An administrator can use
CreateAccess to limit the access to the correct set of users who
need this ability.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_access({
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
      type: "FILE", # accepts FILE, DIRECTORY
    },
  ],
  policy: "Policy",
  posix_profile: {
    uid: 1, # required
    gid: 1, # required
    secondary_gids: [1],
  },
  role: "Role", # required
  server_id: "ServerId", # required
  external_id: "ExternalId", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.external_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :home_directory
          (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.
    

     You can use the HomeDirectory parameter for HomeDirectoryType when
it is set to either PATH or LOGICAL.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_type
          (String)
          
            
          
          
            — 
    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.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_mappings
          (Array<Types::HomeDirectoryMapEntry>)
          
            
          
          
            — 
    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" } ]
    
          
        
    • 
      
        
  • 
          :policy
          (String)
          
            
          
          
            — 
    A session policy for your user so that you can use the same Identity
and Access Management (IAM) role across multiple users. This policy
scopes down a user's access to portions of their Amazon S3 bucket.
Variables that you can use inside this policy include
${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
    

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

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

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

    For more information, see AssumeRole in the Security Token
Service API Reference.
    
 
    
          
        
    • 
      
        
  • 
          :posix_profile
          (Types::PosixProfile)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :role
          (required, String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
    
          
        
    • 
      
        
  • 
          :external_id
          (required, String)
          
            
          
          
            — 
    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: =,.@:/-
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


88

    		
    
      
# File 'sig/client.rbs', line 88

def create_access: (

    		
  





    
      

  

  
    #create_agreement(params = {})  ⇒ Types::CreateAgreementResponse 
  

  

  




  

    
Creates an agreement. An agreement is a bilateral trading partner
agreement, or partnership, between an Transfer Family server and an
AS2 process. The agreement defines the file and message transfer
relationship between the server and the AS2 process. To define an
agreement, Transfer Family combines a server, local profile, partner
profile, certificate, and other attributes.


The partner is identified with the PartnerProfileId, and the AS2
process is identified with the LocalProfileId.


 Specify either BaseDirectory or CustomDirectories, but not both.
Specifying both causes the command to fail.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_agreement({
  description: "Description",
  server_id: "ServerId", # required
  local_profile_id: "ProfileId", # required
  partner_profile_id: "ProfileId", # required
  base_directory: "HomeDirectory",
  access_role: "Role", # required
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  preserve_filename: "ENABLED", # accepts ENABLED, DISABLED
  enforce_message_signing: "ENABLED", # accepts ENABLED, DISABLED
  custom_directories: {
    failed_files_directory: "HomeDirectory", # required
    mdn_files_directory: "HomeDirectory", # required
    payload_files_directory: "HomeDirectory", # required
    status_files_directory: "HomeDirectory", # required
    temporary_files_directory: "HomeDirectory", # required
  },
})

    
      
        
Response structure

      
      

resp.agreement_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A name or short description to identify the agreement.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
    
          
        
    • 
      
        
  • 
          :local_profile_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the AS2 local profile.
    
          
        
    • 
      
        
  • 
          :partner_profile_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the partner profile used in the agreement.
    
          
        
    • 
      
        
  • 
          :base_directory
          (String)
          
            
          
          
            — 
    The landing directory (folder) for files transferred by using the AS2
protocol.
    

    A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.
    
          
        
    • 
      
        
  • 
          :access_role
          (required, String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :status
          (String)
          
            
          
          
            — 
    The status of the agreement. The agreement can be either ACTIVE or
INACTIVE.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for agreements.
    
          
        
    • 
      
        
  • 
          :preserve_filename
          (String)
          
            
          
          
            — 
    Determines whether or not Transfer Family appends a unique string of
characters to the end of the AS2 message payload filename when saving
it.
    

      

    • 

      ENABLED: the filename provided by your trading parter is preserved
when the file is saved.
      

      • 

    • 

      DISABLED (default value): when Transfer Family saves the file, the
filename is adjusted, as described in File names and locations.
      

      • 

    
          
        
    • 
      
        
  • 
          :enforce_message_signing
          (String)
          
            
          
          
            — 
    Determines whether or not unsigned messages from your trading partners
will be accepted.
    

      

    • 

      ENABLED: Transfer Family rejects unsigned messages from your
trading partner.
      

      • 

    • 

      DISABLED (default value): Transfer Family accepts unsigned
messages from your trading partner.
      

      • 

    
          
        
    • 
      
        
  • 
          :custom_directories
          (Types::CustomDirectoriesType)
          
            
          
          
            — 
    A CustomDirectoriesType structure. This structure specifies custom
directories for storing various AS2 message files. You can specify
directories for the following types of files.
    

      

    • 

      Failed files
      

      • 

    • 

      MDN files
      

      • 

    • 

      Payload files
      

      • 

    • 

      Status files
      

      • 

    • 

      Temporary files
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


115

    		
    
      
# File 'sig/client.rbs', line 115

def create_agreement: (

    		
  





    
      

  

  
    #create_connector(params = {})  ⇒ Types::CreateConnectorResponse 
  

  

  




  

    
Creates the connector, which captures the parameters for a connection
for the AS2 or SFTP protocol. For AS2, the connector is required for
sending files to an externally hosted AS2 server. For SFTP, the
connector is required when sending files to an SFTP server or
receiving files from an SFTP server. For more details about
connectors, see Configure AS2 connectors and Create SFTP
connectors.


 You must specify exactly one configuration object: either for AS2
(As2Config) or SFTP (SftpConfig).

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_connector({
  url: "Url",
  as_2_config: {
    local_profile_id: "ProfileId",
    partner_profile_id: "ProfileId",
    message_subject: "MessageSubject",
    compression: "ZLIB", # accepts ZLIB, DISABLED
    encryption_algorithm: "AES128_CBC", # accepts AES128_CBC, AES192_CBC, AES256_CBC, DES_EDE3_CBC, NONE
    signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE
    mdn_signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE, DEFAULT
    mdn_response: "SYNC", # accepts SYNC, NONE, ASYNC
    basic_auth_secret_id: "As2ConnectorSecretId",
    preserve_content_type: "ENABLED", # accepts ENABLED, DISABLED
    async_mdn_config: {
      url: "Url",
      server_ids: ["ServerId"],
    },
  },
  access_role: "Role", # required
  logging_role: "Role",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  sftp_config: {
    user_secret_id: "SecretId",
    trusted_host_keys: ["SftpConnectorTrustedHostKey"],
    max_concurrent_connections: 1,
    ordered_user_secret_version_stages: ["SecretVersionStage"],
  },
  security_policy_name: "ConnectorSecurityPolicyName",
  egress_config: {
    vpc_lattice: {
      resource_configuration_arn: "VpcLatticeResourceConfigurationArn", # required
      port_number: 1,
    },
  },
  ip_address_type: "IPV4", # accepts IPV4, DUALSTACK
})

    
      
        
Response structure

      
      

resp.connector_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :url
          (String)
          
            
          
          
            — 
    The URL of the partner's AS2 or SFTP endpoint.
    

    When creating AS2 connectors or service-managed SFTP connectors
(connectors without egress configuration), you must provide a URL to
specify the remote server endpoint. For VPC Lattice type connectors,
the URL must be null.
    
          
        
    • 
      
        
  • 
          :as_2_config
          (Types::As2ConnectorConfig)
          
            
          
          
            — 
    A structure that contains the parameters for an AS2 connector object.
    
          
        
    • 
      
        
  • 
          :access_role
          (required, String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :logging_role
          (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.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for connectors.
Tags are metadata attached to connectors for any purpose.
    
          
        
    • 
      
        
  • 
          :sftp_config
          (Types::SftpConnectorConfig)
          
            
          
          
            — 
    A structure that contains the parameters for an SFTP connector object.
    
          
        
    • 
      
        
  • 
          :security_policy_name
          (String)
          
            
          
          
            — 
    Specifies the name of the security policy for the connector.
    
          
        
    • 
      
        
  • 
          :egress_config
          (Types::ConnectorEgressConfig)
          
            
          
          
            — 
    Specifies the egress configuration for the connector, which determines
how traffic is routed from the connector to the SFTP server. When set
to VPC, enables routing through customer VPCs using VPC_LATTICE for
private connectivity.
    
          
        
    • 
      
        
  • 
          :ip_address_type
          (String)
          
            
          
          
            — 
    Specifies the IP address type for the connector's network
connections. When set to IPV4, the connector uses IPv4 addresses
only. When set to DUALSTACK, the connector supports both IPv4 and
IPv6 addresses, with IPv6 preferred when available.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


146

    		
    
      
# File 'sig/client.rbs', line 146

def create_connector: (

    		
  





    
      

  

  
    #create_profile(params = {})  ⇒ Types::CreateProfileResponse 
  

  

  




  

    
Creates the local or partner profile to use for AS2 transfers.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_profile({
  as_2_id: "As2Id", # required
  profile_type: "LOCAL", # required, accepts LOCAL, PARTNER
  certificate_ids: ["CertificateId"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.profile_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :as_2_id
          (required, String)
          
            
          
          
            — 
    The As2Id is the AS2-name, as defined in the RFC 4130. For
inbound transfers, this is the AS2-From header for the AS2 messages
sent from the partner. For outbound connectors, this is the AS2-To
header for the AS2 messages sent to the partner using the
StartFileTransfer API operation. This ID cannot include spaces.
    
          
        
    • 
      
        
  • 
          :profile_type
          (required, String)
          
            
          
          
            — 
    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.
      

      • 

    
          
        
    • 
      
        
  • 
          :certificate_ids
          (Array<String>)
          
            
          
          
            — 
    An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for AS2 profiles.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


179

    		
    
      
# File 'sig/client.rbs', line 179

def create_profile: (

    		
  





    
      

  

  
    #create_server(params = {})  ⇒ Types::CreateServerResponse 
  

  

  




  

    
Instantiates an auto-scaling virtual server based on the selected file
transfer protocol in Amazon Web Services. When you make updates to
your file transfer protocol-enabled server or when you work with
users, use the service-generated ServerId property that is assigned
to the newly created server.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_server({
  certificate: "Certificate",
  domain: "S3", # accepts S3, EFS
  endpoint_details: {
    address_allocation_ids: ["AddressAllocationId"],
    subnet_ids: ["SubnetId"],
    vpc_endpoint_id: "VpcEndpointId",
    vpc_id: "VpcId",
    security_group_ids: ["SecurityGroupId"],
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
    directory_id: "DirectoryId",
    function: "Function",
    sftp_authentication_methods: "PASSWORD", # accepts PASSWORD, PUBLIC_KEY, PUBLIC_KEY_OR_PASSWORD, PUBLIC_KEY_AND_PASSWORD
  },
  identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE, AWS_LAMBDA
  logging_role: "NullableRole",
  post_authentication_login_banner: "PostAuthenticationLoginBanner",
  pre_authentication_login_banner: "PreAuthenticationLoginBanner",
  protocols: ["SFTP"], # accepts SFTP, FTP, FTPS, AS2
  protocol_details: {
    passive_ip: "PassiveIp",
    tls_session_resumption_mode: "DISABLED", # accepts DISABLED, ENABLED, ENFORCED
    set_stat_option: "DEFAULT", # accepts DEFAULT, ENABLE_NO_OP
    as_2_transports: ["HTTP"], # accepts HTTP
    proxy_config: {
      sftp_mode: "NONE", # accepts NONE, PROXY_PROTOCOL_V2_ENFORCED
    },
  },
  security_policy_name: "SecurityPolicyName",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  workflow_details: {
    on_upload: [
      {
        workflow_id: "WorkflowId", # required
        execution_role: "Role", # required
      },
    ],
    on_partial_upload: [
      {
        workflow_id: "WorkflowId", # required
        execution_role: "Role", # required
      },
    ],
  },
  structured_log_destinations: ["Arn"],
  s3_storage_options: {
    directory_listing_optimization: "ENABLED", # accepts ENABLED, DISABLED
  },
  ip_address_type: "IPV4", # accepts IPV4, DUALSTACK
})

    
      
        
Response structure

      
      

resp.server_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :certificate
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the Certificate Manager (ACM)
certificate. Required when Protocols is set to FTPS.
    

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

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

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

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

      

    • 

      2048-bit RSA (RSA_2048)
      

      • 

    • 

      4096-bit RSA (RSA_4096)
      

      • 

    • 

      Elliptic Prime Curve 256 bit (EC_prime256v1)
      

      • 

    • 

      Elliptic Prime Curve 384 bit (EC_secp384r1)
      

      • 

    • 

      Elliptic Prime Curve 521 bit (EC_secp521r1)
      

      • 

    

     The certificate must be a valid SSL/TLS X.509 version 3 certificate
with FQDN or IP address specified and information about the issuer.
    
 
    
          
        
    • 
      
        
  • 
          :domain
          (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.
    
 
    
          
        
    • 
      
        
  • 
          :endpoint_details
          (Types::EndpointDetails)
          
            
          
          
            — 
    The virtual private cloud (VPC) endpoint settings that are configured
for your server. When you host your endpoint within your VPC, you can
make your endpoint accessible only to resources within your VPC, or
you can attach Elastic IP addresses and make your endpoint accessible
to clients over the internet. Your VPC's default security groups are
automatically assigned to your endpoint.
    
          
        
    • 
      
        
  • 
          :endpoint_type
          (String)
          
            
          
          
            — 
    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.
    
 
    
          
        
    • 
      
        
  • 
          :host_key
          (String)
          
            
          
          
            — 
    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 in the Transfer Family User Guide.
    
          
        
    • 
      
        
  • 
          :identity_provider_details
          (Types::IdentityProviderDetails)
          
            
          
          
            — 
    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.
Cannot be specified when IdentityProviderType is set to
SERVICE_MANAGED.
    
          
        
    • 
      
        
  • 
          :identity_provider_type
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :logging_role
          (String)
          
            
          
          
            — 
    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 EFS events. When set, you can view user
activity in your CloudWatch logs.
    
          
        
    • 
      
        
  • 
          :post_authentication_login_banner
          (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.
    
 
    
          
        
    • 
      
        
  • 
          :pre_authentication_login_banner
          (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.
    
          
        
    • 
      
        
  • 
          :protocols
          (Array<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:
    

      

    • 

      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.
      

      • 

    
 
    
          
        
    • 
      
        
  • 
          :protocol_details
          (Types::ProtocolDetails)
          
            
          
          
            — 
    The protocol settings that are configured for your server.
    

     Avoid placing Network Load Balancers (NLBs) or NAT gateways in front
of Transfer Family servers, as this increases costs and can cause
performance issues, including reduced connection limits for FTPS. For
more details, see  Avoid placing NLBs and NATs in front of Transfer
Family.
    
 

      

    • 

      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.
      

      • 

    
          
        
    • 
      
        
  • 
          :security_policy_name
          (String)
          
            
          
          
            — 
    Specifies the name of the security policy for the server.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for servers.
    
          
        
    • 
      
        
  • 
          :workflow_details
          (Types::WorkflowDetails)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :structured_log_destinations
          (Array<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
    
          
        
    • 
      
        
  • 
          :s3_storage_options
          (Types::S3StorageOptions)
          
            
          
          
            — 
    Specifies whether or not performance for your Amazon S3 directories is
optimized.
    

      

    • 

      If using the console, this is enabled by default.
      

      • 

    • 

      If using the API or CLI, 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.
    
          
        
    • 
      
        
  • 
          :ip_address_type
          (String)
          
            
          
          
            — 
    Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and
IPv6) for your Transfer Family endpoint. The default value is IPV4.
    

    The IpAddressType parameter has the following limitations:
    

      

    • 

      It cannot be changed while the server is online. You must stop the
server before modifying this parameter.
      

      • 

    • 

      It cannot be updated to DUALSTACK if the server has
AddressAllocationIds specified.
      

      • 

    

     When using DUALSTACK as the IpAddressType, you cannot set the
AddressAllocationIds parameter for the EndpointDetails for the
server.
    
 
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


197

    		
    
      
# File 'sig/client.rbs', line 197

def create_server: (

    		
  





    
      

  

  
    #create_user(params = {})  ⇒ Types::CreateUserResponse 
  

  

  




  

    
Creates a user and associates them with an existing file transfer
protocol-enabled server. You can only create and associate users with
servers that have the IdentityProviderType set to SERVICE_MANAGED.
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 Identity and Access Management (IAM) role. You can also
optionally add a session policy, and assign metadata with tags that
can be used to group and search for users.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_user({
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
      type: "FILE", # accepts FILE, DIRECTORY
    },
  ],
  policy: "Policy",
  posix_profile: {
    uid: 1, # required
    gid: 1, # required
    secondary_gids: [1],
  },
  role: "Role", # required
  server_id: "ServerId", # required
  ssh_public_key_body: "SshPublicKeyBody",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  user_name: "UserName", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.user_name #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :home_directory
          (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.
    

     You can use the HomeDirectory parameter for HomeDirectoryType when
it is set to either PATH or LOGICAL.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_type
          (String)
          
            
          
          
            — 
    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.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_mappings
          (Array<Types::HomeDirectoryMapEntry>)
          
            
          
          
            — 
    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" } ]
    
          
        
    • 
      
        
  • 
          :policy
          (String)
          
            
          
          
            — 
    A session policy for your user so that you can use the same Identity
and Access Management (IAM) role across multiple users. This policy
scopes down a user's access to portions of their Amazon S3 bucket.
Variables that you can use inside this policy include
${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
    

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

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

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

    For more information, see AssumeRole in the Amazon Web Services
Security Token Service API Reference.
    
 
    
          
        
    • 
      
        
  • 
          :posix_profile
          (Types::PosixProfile)
          
            
          
          
            — 
    Specifies the full POSIX identity, including user ID (Uid), group ID
(Gid), and any secondary groups IDs (SecondaryGids), that controls
your users' access to your Amazon EFS file systems. The POSIX
permissions that are set on files and directories in Amazon EFS
determine the level of access your users get when transferring files
into and out of your Amazon EFS file systems.
    
          
        
    • 
      
        
  • 
          :role
          (required, String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
    
          
        
    • 
      
        
  • 
          :ssh_public_key_body
          (String)
          
            
          
          
            — 
    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.
      

      • 

    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for users. Tags
are metadata attached to users for any purpose.
    
          
        
    • 
      
        
  • 
          :user_name
          (required, String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


244

    		
    
      
# File 'sig/client.rbs', line 244

def create_user: (

    		
  





    
      

  

  
    #create_web_app(params = {})  ⇒ Types::CreateWebAppResponse 
  

  

  




  

    
Creates a web app based on specified parameters, and returns the ID
for the new web app. You can configure the web app to be publicly
accessible or hosted within a VPC.


For more information about using VPC endpoints with Transfer Family,
see Create a Transfer Family web app in a VPC.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_web_app({
  identity_provider_details: { # required
    identity_center_config: {
      instance_arn: "IdentityCenterInstanceArn",
      role: "Role",
    },
  },
  access_endpoint: "WebAppAccessEndpoint",
  web_app_units: {
    provisioned: 1,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  web_app_endpoint_policy: "FIPS", # accepts FIPS, STANDARD
  endpoint_details: {
    vpc: {
      subnet_ids: ["SubnetId"],
      vpc_id: "VpcId",
      security_group_ids: ["SecurityGroupId"],
      ip_address_type: "IPV4", # accepts IPV4, DUALSTACK
    },
  },
})

    
      
        
Response structure

      
      

resp.web_app_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :identity_provider_details
          (required, Types::WebAppIdentityProviderDetails)
          
            
          
          
            — 
    You can provide a structure that contains the details for the identity
provider to use with your web app.
    

    For more details about this parameter, see Configure your identity
provider for Transfer Family web apps.
    
          
        
    • 
      
        
  • 
          :access_endpoint
          (String)
          
            
          
          
            — 
    The AccessEndpoint is the URL that you provide to your users for
them to interact with the Transfer Family web app. You can specify a
custom URL or use the default value.
    

    Before you enter a custom URL for this parameter, follow the steps
described in Update your access endpoint with a custom URL.
    
          
        
    • 
      
        
  • 
          :web_app_units
          (Types::WebAppUnits)
          
            
          
          
            — 
    A union that contains the value for number of concurrent connections
or the user sessions on your web app.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for web apps.
    
          
        
    • 
      
        
  • 
          :web_app_endpoint_policy
          (String)
          
            
          
          
            — 
    Setting for the type of endpoint policy for the web app. The default
value is STANDARD.
    

    If you are creating the web app in an Amazon Web Services GovCloud
(US) Region, you can set this parameter to FIPS.
    
          
        
    • 
      
        
  • 
          :endpoint_details
          (Types::WebAppEndpointDetails)
          
            
          
          
            — 
    The endpoint configuration for the web app. You can specify whether
the web app endpoint is publicly accessible or hosted within a VPC.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


278

    		
    
      
# File 'sig/client.rbs', line 278

def create_web_app: (

    		
  





    
      

  

  
    #create_workflow(params = {})  ⇒ Types::CreateWorkflowResponse 
  

  

  




  

    
Allows you to create a workflow with specified steps and step details
the workflow invokes after file transfer completes. After creating a
workflow, you can associate the workflow created with any transfer
servers by specifying the workflow-details field in CreateServer
and UpdateServer operations.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_workflow({
  description: "WorkflowDescription",
  steps: [ # required
    {
      type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE, DECRYPT
      copy_step_details: {
        name: "WorkflowStepName",
        destination_file_location: {
          s3_file_location: {
            bucket: "S3Bucket",
            key: "S3Key",
          },
          efs_file_location: {
            file_system_id: "EfsFileSystemId",
            path: "EfsPath",
          },
        },
        overwrite_existing: "TRUE", # accepts TRUE, FALSE
        source_file_location: "SourceFileLocation",
      },
      custom_step_details: {
        name: "WorkflowStepName",
        target: "CustomStepTarget",
        timeout_seconds: 1,
        source_file_location: "SourceFileLocation",
      },
      delete_step_details: {
        name: "WorkflowStepName",
        source_file_location: "SourceFileLocation",
      },
      tag_step_details: {
        name: "WorkflowStepName",
        tags: [
          {
            key: "S3TagKey", # required
            value: "S3TagValue", # required
          },
        ],
        source_file_location: "SourceFileLocation",
      },
      decrypt_step_details: {
        name: "WorkflowStepName",
        type: "PGP", # required, accepts PGP
        source_file_location: "SourceFileLocation",
        overwrite_existing: "TRUE", # accepts TRUE, FALSE
        destination_file_location: { # required
          s3_file_location: {
            bucket: "S3Bucket",
            key: "S3Key",
          },
          efs_file_location: {
            file_system_id: "EfsFileSystemId",
            path: "EfsPath",
          },
        },
      },
    },
  ],
  on_exception_steps: [
    {
      type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE, DECRYPT
      copy_step_details: {
        name: "WorkflowStepName",
        destination_file_location: {
          s3_file_location: {
            bucket: "S3Bucket",
            key: "S3Key",
          },
          efs_file_location: {
            file_system_id: "EfsFileSystemId",
            path: "EfsPath",
          },
        },
        overwrite_existing: "TRUE", # accepts TRUE, FALSE
        source_file_location: "SourceFileLocation",
      },
      custom_step_details: {
        name: "WorkflowStepName",
        target: "CustomStepTarget",
        timeout_seconds: 1,
        source_file_location: "SourceFileLocation",
      },
      delete_step_details: {
        name: "WorkflowStepName",
        source_file_location: "SourceFileLocation",
      },
      tag_step_details: {
        name: "WorkflowStepName",
        tags: [
          {
            key: "S3TagKey", # required
            value: "S3TagValue", # required
          },
        ],
        source_file_location: "SourceFileLocation",
      },
      decrypt_step_details: {
        name: "WorkflowStepName",
        type: "PGP", # required, accepts PGP
        source_file_location: "SourceFileLocation",
        overwrite_existing: "TRUE", # accepts TRUE, FALSE
        destination_file_location: { # required
          s3_file_location: {
            bucket: "S3Bucket",
            key: "S3Key",
          },
          efs_file_location: {
            file_system_id: "EfsFileSystemId",
            path: "EfsPath",
          },
        },
      },
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.workflow_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A textual description for the workflow.
    
          
        
    • 
      
        
  • 
          :steps
          (required, Array<Types::WorkflowStep>)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :on_exception_steps
          (Array<Types::WorkflowStep>)
          
            
          
          
            — 
    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.
    
 
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for workflows.
Tags are metadata attached to workflows for any purpose.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


312

    		
    
      
# File 'sig/client.rbs', line 312

def create_workflow: (

    		
  





    
      

  

  
    #delete_access(params = {})  ⇒ Struct 
  

  

  




  

    
Allows you to delete the access specified in the ServerID and
ExternalID parameters.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_access({
  server_id: "ServerId", # required
  external_id: "ExternalId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server that has this user
assigned.
    
          
        
    • 
      
        
  • 
          :external_id
          (required, String)
          
            
          
          
            — 
    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: =,.@:/-
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


330

    		
    
      
# File 'sig/client.rbs', line 330

def delete_access: (

    		
  





    
      

  

  
    #delete_agreement(params = {})  ⇒ Struct 
  

  

  




  

    
Delete the agreement that's specified in the provided AgreementId.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_agreement({
  agreement_id: "AgreementId", # required
  server_id: "ServerId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :agreement_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the agreement. This identifier is returned
when you create an agreement.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The server identifier associated with the agreement that you are
deleting.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


337

    		
    
      
# File 'sig/client.rbs', line 337

def delete_agreement: (

    		
  





    
      

  

  
    #delete_certificate(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the certificate that's specified in the CertificateId
parameter.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_certificate({
  certificate_id: "CertificateId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :certificate_id
          (required, String)
          
            
          
          
            — 
    The identifier of the certificate object that you are deleting.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


344

    		
    
      
# File 'sig/client.rbs', line 344

def delete_certificate: (

    		
  





    
      

  

  
    #delete_connector(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the connector that's specified in the provided ConnectorId.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_connector({
  connector_id: "ConnectorId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


350

    		
    
      
# File 'sig/client.rbs', line 350

def delete_connector: (

    		
  





    
      

  

  
    #delete_host_key(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the host key that's specified in the HostKeyId parameter.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_host_key({
  server_id: "ServerId", # required
  host_key_id: "HostKeyId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The identifier of the server that contains the host key that you are
deleting.
    
          
        
    • 
      
        
  • 
          :host_key_id
          (required, String)
          
            
          
          
            — 
    The identifier of the host key that you are deleting.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


356

    		
    
      
# File 'sig/client.rbs', line 356

def delete_host_key: (

    		
  





    
      

  

  
    #delete_profile(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the profile that's specified in the ProfileId parameter.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_profile({
  profile_id: "ProfileId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :profile_id
          (required, String)
          
            
          
          
            — 
    The identifier of the profile that you are deleting.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


363

    		
    
      
# File 'sig/client.rbs', line 363

def delete_profile: (

    		
  





    
      

  

  
    #delete_server(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the file transfer protocol-enabled server that you specify.


No response returns from this operation.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_server({
  server_id: "ServerId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A unique system-assigned identifier for a server instance.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


369

    		
    
      
# File 'sig/client.rbs', line 369

def delete_server: (

    		
  





    
      

  

  
    #delete_ssh_public_key(params = {})  ⇒ Struct 
  

  

  




  

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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_ssh_public_key({
  server_id: "ServerId", # required
  ssh_public_key_id: "SshPublicKeyId", # required
  user_name: "UserName", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a file transfer
protocol-enabled server instance that has the user assigned to it.
    
          
        
    • 
      
        
  • 
          :ssh_public_key_id
          (required, String)
          
            
          
          
            — 
    A unique identifier used to reference your user's specific SSH key.
    
          
        
    • 
      
        
  • 
          :user_name
          (required, String)
          
            
          
          
            — 
    A unique string that identifies a user whose public key is being
deleted.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


375

    		
    
      
# File 'sig/client.rbs', line 375

def delete_ssh_public_key: (

    		
  





    
      

  

  
    #delete_user(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the user belonging to a file transfer protocol-enabled server
you specify.


No response returns from this operation.


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

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_user({
  server_id: "ServerId", # required
  user_name: "UserName", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server instance that has the
user assigned to it.
    
          
        
    • 
      
        
  • 
          :user_name
          (required, String)
          
            
          
          
            — 
    A unique string that identifies a user that is being deleted from a
server.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


383

    		
    
      
# File 'sig/client.rbs', line 383

def delete_user: (

    		
  





    
      

  

  
    #delete_web_app(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the specified web app.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_web_app({
  web_app_id: "WebAppId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :web_app_id
          (required, String)
          
            
          
          
            — 
    Provide the unique identifier for the web app that you are deleting.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


390

    		
    
      
# File 'sig/client.rbs', line 390

def delete_web_app: (

    		
  





    
      

  

  
    #delete_web_app_customization(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the WebAppCustomization object that corresponds to the web
app ID specified.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_web_app_customization({
  web_app_id: "WebAppId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :web_app_id
          (required, String)
          
            
          
          
            — 
    Provide the unique identifier for the web app that contains the
customizations that you are deleting.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


396

    		
    
      
# File 'sig/client.rbs', line 396

def delete_web_app_customization: (

    		
  





    
      

  

  
    #delete_workflow(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes the specified workflow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_workflow({
  workflow_id: "WorkflowId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :workflow_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the workflow.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


402

    		
    
      
# File 'sig/client.rbs', line 402

def delete_workflow: (

    		
  





    
      

  

  
    #describe_access(params = {})  ⇒ Types::DescribeAccessResponse 
  

  

  




  

    
Describes the access that is assigned to the specific file transfer
protocol-enabled server, as identified by its ServerId property and
its ExternalId.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_access({
  server_id: "ServerId", # required
  external_id: "ExternalId", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.access.home_directory #=> String
resp.access.home_directory_mappings #=> Array
resp.access.home_directory_mappings[0].entry #=> String
resp.access.home_directory_mappings[0].target #=> String
resp.access.home_directory_mappings[0].type #=> String, one of "FILE", "DIRECTORY"
resp.access.home_directory_type #=> String, one of "PATH", "LOGICAL"
resp.access.policy #=> String
resp.access.posix_profile.uid #=> Integer
resp.access.posix_profile.gid #=> Integer
resp.access.posix_profile.secondary_gids #=> Array
resp.access.posix_profile.secondary_gids[0] #=> Integer
resp.access.role #=> String
resp.access.external_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server that has this access
assigned.
    
          
        
    • 
      
        
  • 
          :external_id
          (required, String)
          
            
          
          
            — 
    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: =,.@:/-
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


413

    		
    
      
# File 'sig/client.rbs', line 413

def describe_access: (

    		
  





    
      

  

  
    #describe_agreement(params = {})  ⇒ Types::DescribeAgreementResponse 
  

  

  




  

    
Describes the agreement that's identified by the AgreementId.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_agreement({
  agreement_id: "AgreementId", # required
  server_id: "ServerId", # required
})

    
      
        
Response structure

      
      

resp.agreement.arn #=> String
resp.agreement.agreement_id #=> String
resp.agreement.description #=> String
resp.agreement.status #=> String, one of "ACTIVE", "INACTIVE"
resp.agreement.server_id #=> String
resp.agreement.local_profile_id #=> String
resp.agreement.partner_profile_id #=> String
resp.agreement.base_directory #=> String
resp.agreement.access_role #=> String
resp.agreement.tags #=> Array
resp.agreement.tags[0].key #=> String
resp.agreement.tags[0].value #=> String
resp.agreement.preserve_filename #=> String, one of "ENABLED", "DISABLED"
resp.agreement.enforce_message_signing #=> String, one of "ENABLED", "DISABLED"
resp.agreement.custom_directories.failed_files_directory #=> String
resp.agreement.custom_directories.mdn_files_directory #=> String
resp.agreement.custom_directories.payload_files_directory #=> String
resp.agreement.custom_directories.status_files_directory #=> String
resp.agreement.custom_directories.temporary_files_directory #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :agreement_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the agreement. This identifier is returned
when you create an agreement.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The server identifier that's associated with the agreement.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


424

    		
    
      
# File 'sig/client.rbs', line 424

def describe_agreement: (

    		
  





    
      

  

  
    #describe_certificate(params = {})  ⇒ Types::DescribeCertificateResponse 
  

  

  




  

    
Describes the certificate that's identified by the CertificateId.


 Transfer Family automatically publishes a Amazon CloudWatch metric
called DaysUntilExpiry for imported certificates. This metric tracks
the number of days until the certificate expires based on the
InactiveDate. The metric is available in the AWS/Transfer
namespace and includes the CertificateId as a dimension.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_certificate({
  certificate_id: "CertificateId", # required
})

    
      
        
Response structure

      
      

resp.certificate.arn #=> String
resp.certificate.certificate_id #=> String
resp.certificate.usage #=> String, one of "SIGNING", "ENCRYPTION", "TLS"
resp.certificate.status #=> String, one of "ACTIVE", "PENDING_ROTATION", "INACTIVE"
resp.certificate.certificate #=> String
resp.certificate.certificate_chain #=> String
resp.certificate.active_date #=> Time
resp.certificate.inactive_date #=> Time
resp.certificate.serial #=> String
resp.certificate.not_before_date #=> Time
resp.certificate.not_after_date #=> Time
resp.certificate.type #=> String, one of "CERTIFICATE", "CERTIFICATE_WITH_PRIVATE_KEY"
resp.certificate.description #=> String
resp.certificate.tags #=> Array
resp.certificate.tags[0].key #=> String
resp.certificate.tags[0].value #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :certificate_id
          (required, String)
          
            
          
          
            — 
    An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


435

    		
    
      
# File 'sig/client.rbs', line 435

def describe_certificate: (

    		
  





    
      

  

  
    #describe_connector(params = {})  ⇒ Types::DescribeConnectorResponse 
  

  

  




  

    
Describes the connector that's identified by the ConnectorId.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_connector({
  connector_id: "ConnectorId", # required
})

    
      
        
Response structure

      
      

resp.connector.arn #=> String
resp.connector.connector_id #=> String
resp.connector.url #=> String
resp.connector.as_2_config.local_profile_id #=> String
resp.connector.as_2_config.partner_profile_id #=> String
resp.connector.as_2_config.message_subject #=> String
resp.connector.as_2_config.compression #=> String, one of "ZLIB", "DISABLED"
resp.connector.as_2_config.encryption_algorithm #=> String, one of "AES128_CBC", "AES192_CBC", "AES256_CBC", "DES_EDE3_CBC", "NONE"
resp.connector.as_2_config.signing_algorithm #=> String, one of "SHA256", "SHA384", "SHA512", "SHA1", "NONE"
resp.connector.as_2_config.mdn_signing_algorithm #=> String, one of "SHA256", "SHA384", "SHA512", "SHA1", "NONE", "DEFAULT"
resp.connector.as_2_config.mdn_response #=> String, one of "SYNC", "NONE", "ASYNC"
resp.connector.as_2_config.basic_auth_secret_id #=> String
resp.connector.as_2_config.preserve_content_type #=> String, one of "ENABLED", "DISABLED"
resp.connector.as_2_config.async_mdn_config.url #=> String
resp.connector.as_2_config.async_mdn_config.server_ids #=> Array
resp.connector.as_2_config.async_mdn_config.server_ids[0] #=> String
resp.connector.access_role #=> String
resp.connector.logging_role #=> String
resp.connector.tags #=> Array
resp.connector.tags[0].key #=> String
resp.connector.tags[0].value #=> String
resp.connector.sftp_config.user_secret_id #=> String
resp.connector.sftp_config.trusted_host_keys #=> Array
resp.connector.sftp_config.trusted_host_keys[0] #=> String
resp.connector.sftp_config.max_concurrent_connections #=> Integer
resp.connector.sftp_config.ordered_user_secret_version_stages #=> Array
resp.connector.sftp_config.ordered_user_secret_version_stages[0] #=> String
resp.connector.service_managed_egress_ip_addresses #=> Array
resp.connector.service_managed_egress_ip_addresses[0] #=> String
resp.connector.security_policy_name #=> String
resp.connector.egress_config.vpc_lattice.resource_configuration_arn #=> String
resp.connector.egress_config.vpc_lattice.port_number #=> Integer
resp.connector.egress_type #=> String, one of "SERVICE_MANAGED", "VPC_LATTICE"
resp.connector.error_message #=> String
resp.connector.status #=> String, one of "ACTIVE", "ERRORED", "PENDING"
resp.connector.ip_address_type #=> String, one of "IPV4", "DUALSTACK"

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


445

    		
    
      
# File 'sig/client.rbs', line 445

def describe_connector: (

    		
  





    
      

  

  
    #describe_execution(params = {})  ⇒ Types::DescribeExecutionResponse 
  

  

  




  

    
You can use DescribeExecution to check the details of the execution
of the specified workflow.


 This API call only returns details for in-progress workflows.


If you provide an ID for an execution that is not in progress, or if
the execution doesn't match the specified workflow ID, you receive a
ResourceNotFound exception.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_execution({
  execution_id: "ExecutionId", # required
  workflow_id: "WorkflowId", # required
})

    
      
        
Response structure

      
      

resp.workflow_id #=> String
resp.execution.execution_id #=> String
resp.execution.initial_file_location.s3_file_location.bucket #=> String
resp.execution.initial_file_location.s3_file_location.key #=> String
resp.execution.initial_file_location.s3_file_location.version_id #=> String
resp.execution.initial_file_location.s3_file_location.etag #=> String
resp.execution.initial_file_location.efs_file_location.file_system_id #=> String
resp.execution.initial_file_location.efs_file_location.path #=> String
resp.execution.service_metadata.user_details.user_name #=> String
resp.execution.service_metadata.user_details.server_id #=> String
resp.execution.service_metadata.user_details.session_id #=> String
resp.execution.execution_role #=> String
resp.execution.logging_configuration.logging_role #=> String
resp.execution.logging_configuration.log_group_name #=> String
resp.execution.posix_profile.uid #=> Integer
resp.execution.posix_profile.gid #=> Integer
resp.execution.posix_profile.secondary_gids #=> Array
resp.execution.posix_profile.secondary_gids[0] #=> Integer
resp.execution.status #=> String, one of "IN_PROGRESS", "COMPLETED", "EXCEPTION", "HANDLING_EXCEPTION"
resp.execution.results.steps #=> Array
resp.execution.results.steps[0].step_type #=> String, one of "COPY", "CUSTOM", "TAG", "DELETE", "DECRYPT"
resp.execution.results.steps[0].outputs #=> String
resp.execution.results.steps[0].error.type #=> String, one of "PERMISSION_DENIED", "CUSTOM_STEP_FAILED", "THROTTLED", "ALREADY_EXISTS", "NOT_FOUND", "BAD_REQUEST", "TIMEOUT", "INTERNAL_SERVER_ERROR"
resp.execution.results.steps[0].error.message #=> String
resp.execution.results.on_exception_steps #=> Array
resp.execution.results.on_exception_steps[0].step_type #=> String, one of "COPY", "CUSTOM", "TAG", "DELETE", "DECRYPT"
resp.execution.results.on_exception_steps[0].outputs #=> String
resp.execution.results.on_exception_steps[0].error.type #=> String, one of "PERMISSION_DENIED", "CUSTOM_STEP_FAILED", "THROTTLED", "ALREADY_EXISTS", "NOT_FOUND", "BAD_REQUEST", "TIMEOUT", "INTERNAL_SERVER_ERROR"
resp.execution.results.on_exception_steps[0].error.message #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :execution_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the execution of a workflow.
    
          
        
    • 
      
        
  • 
          :workflow_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the workflow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


456

    		
    
      
# File 'sig/client.rbs', line 456

def describe_execution: (

    		
  





    
      

  

  
    #describe_host_key(params = {})  ⇒ Types::DescribeHostKeyResponse 
  

  

  




  

    
Returns the details of the host key that's specified by the
HostKeyId and ServerId.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_host_key({
  server_id: "ServerId", # required
  host_key_id: "HostKeyId", # required
})

    
      
        
Response structure

      
      

resp.host_key.arn #=> String
resp.host_key.host_key_id #=> String
resp.host_key.host_key_fingerprint #=> String
resp.host_key.description #=> String
resp.host_key.type #=> String
resp.host_key.date_imported #=> Time
resp.host_key.tags #=> Array
resp.host_key.tags[0].key #=> String
resp.host_key.tags[0].value #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The identifier of the server that contains the host key that you want
described.
    
          
        
    • 
      
        
  • 
          :host_key_id
          (required, String)
          
            
          
          
            — 
    The identifier of the host key that you want described.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


467

    		
    
      
# File 'sig/client.rbs', line 467

def describe_host_key: (

    		
  





    
      

  

  
    #describe_profile(params = {})  ⇒ Types::DescribeProfileResponse 
  

  

  




  

    
Returns the details of the profile that's specified by the
ProfileId.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_profile({
  profile_id: "ProfileId", # required
})

    
      
        
Response structure

      
      

resp.profile.arn #=> String
resp.profile.profile_id #=> String
resp.profile.profile_type #=> String, one of "LOCAL", "PARTNER"
resp.profile.as_2_id #=> String
resp.profile.certificate_ids #=> Array
resp.profile.certificate_ids[0] #=> String
resp.profile.tags #=> Array
resp.profile.tags[0].key #=> String
resp.profile.tags[0].value #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :profile_id
          (required, String)
          
            
          
          
            — 
    The identifier of the profile that you want described.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


478

    		
    
      
# File 'sig/client.rbs', line 478

def describe_profile: (

    		
  





    
      

  

  
    #describe_security_policy(params = {})  ⇒ Types::DescribeSecurityPolicyResponse 
  

  

  




  

    
Describes the security policy that is attached to your server or SFTP
connector. The response contains a description of the security
policy's properties. For more information about security policies,
see Working with security policies for servers or Working with
security policies for SFTP connectors.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_security_policy({
  security_policy_name: "SecurityPolicyName", # required
})

    
      
        
Response structure

      
      

resp.security_policy.fips #=> Boolean
resp.security_policy.security_policy_name #=> String
resp.security_policy.ssh_ciphers #=> Array
resp.security_policy.ssh_ciphers[0] #=> String
resp.security_policy.ssh_kexs #=> Array
resp.security_policy.ssh_kexs[0] #=> String
resp.security_policy.ssh_macs #=> Array
resp.security_policy.ssh_macs[0] #=> String
resp.security_policy.tls_ciphers #=> Array
resp.security_policy.tls_ciphers[0] #=> String
resp.security_policy.ssh_host_key_algorithms #=> Array
resp.security_policy.ssh_host_key_algorithms[0] #=> String
resp.security_policy.type #=> String, one of "SERVER", "CONNECTOR"
resp.security_policy.protocols #=> Array
resp.security_policy.protocols[0] #=> String, one of "SFTP", "FTPS"

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :security_policy_name
          (required, String)
          
            
          
          
            — 
    Specify the text name of the security policy for which you want the
details.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


488

    		
    
      
# File 'sig/client.rbs', line 488

def describe_security_policy: (

    		
  





    
      

  

  
    #describe_server(params = {})  ⇒ Types::DescribeServerResponse 
  

  

  




  

    
Describes a file transfer protocol-enabled server that you specify by
passing the ServerId parameter.


The response contains a description of a server's properties. When
you set EndpointType to VPC, the response will contain the
EndpointDetails.


The following waiters are defined for this operation (see #wait_until for detailed usage):


* server_offline
* server_online


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_server({
  server_id: "ServerId", # required
})

    
      
        
Response structure

      
      

resp.server.arn #=> String
resp.server.certificate #=> String
resp.server.protocol_details.passive_ip #=> String
resp.server.protocol_details.tls_session_resumption_mode #=> String, one of "DISABLED", "ENABLED", "ENFORCED"
resp.server.protocol_details.set_stat_option #=> String, one of "DEFAULT", "ENABLE_NO_OP"
resp.server.protocol_details.as_2_transports #=> Array
resp.server.protocol_details.as_2_transports[0] #=> String, one of "HTTP"
resp.server.protocol_details.proxy_config.sftp_mode #=> String, one of "NONE", "PROXY_PROTOCOL_V2_ENFORCED"
resp.server.domain #=> String, one of "S3", "EFS"
resp.server.endpoint_details.address_allocation_ids #=> Array
resp.server.endpoint_details.address_allocation_ids[0] #=> String
resp.server.endpoint_details.subnet_ids #=> Array
resp.server.endpoint_details.subnet_ids[0] #=> String
resp.server.endpoint_details.vpc_endpoint_id #=> String
resp.server.endpoint_details.vpc_id #=> String
resp.server.endpoint_details.security_group_ids #=> Array
resp.server.endpoint_details.security_group_ids[0] #=> String
resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
resp.server.host_key_fingerprint #=> String
resp.server.identity_provider_details.url #=> String
resp.server.identity_provider_details.invocation_role #=> String
resp.server.identity_provider_details.directory_id #=> String
resp.server.identity_provider_details.function #=> String
resp.server.identity_provider_details.sftp_authentication_methods #=> String, one of "PASSWORD", "PUBLIC_KEY", "PUBLIC_KEY_OR_PASSWORD", "PUBLIC_KEY_AND_PASSWORD"
resp.server.identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY", "AWS_DIRECTORY_SERVICE", "AWS_LAMBDA"
resp.server.logging_role #=> String
resp.server. #=> String
resp.server. #=> String
resp.server.protocols #=> Array
resp.server.protocols[0] #=> String, one of "SFTP", "FTP", "FTPS", "AS2"
resp.server.security_policy_name #=> String
resp.server.server_id #=> String
resp.server.state #=> String, one of "OFFLINE", "ONLINE", "STARTING", "STOPPING", "START_FAILED", "STOP_FAILED"
resp.server.tags #=> Array
resp.server.tags[0].key #=> String
resp.server.tags[0].value #=> String
resp.server.user_count #=> Integer
resp.server.workflow_details.on_upload #=> Array
resp.server.workflow_details.on_upload[0].workflow_id #=> String
resp.server.workflow_details.on_upload[0].execution_role #=> String
resp.server.workflow_details.on_partial_upload #=> Array
resp.server.workflow_details.on_partial_upload[0].workflow_id #=> String
resp.server.workflow_details.on_partial_upload[0].execution_role #=> String
resp.server.structured_log_destinations #=> Array
resp.server.structured_log_destinations[0] #=> String
resp.server.s3_storage_options.directory_listing_optimization #=> String, one of "ENABLED", "DISABLED"
resp.server.as_2_service_managed_egress_ip_addresses #=> Array
resp.server.as_2_service_managed_egress_ip_addresses[0] #=> String
resp.server.ip_address_type #=> String, one of "IPV4", "DUALSTACK"

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


498

    		
    
      
# File 'sig/client.rbs', line 498

def describe_server: (

    		
  





    
      

  

  
    #describe_user(params = {})  ⇒ Types::DescribeUserResponse 
  

  

  




  

    
Describes the user assigned to the specific file transfer
protocol-enabled 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.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_user({
  server_id: "ServerId", # required
  user_name: "UserName", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.user.arn #=> String
resp.user.home_directory #=> String
resp.user.home_directory_mappings #=> Array
resp.user.home_directory_mappings[0].entry #=> String
resp.user.home_directory_mappings[0].target #=> String
resp.user.home_directory_mappings[0].type #=> String, one of "FILE", "DIRECTORY"
resp.user.home_directory_type #=> String, one of "PATH", "LOGICAL"
resp.user.policy #=> String
resp.user.posix_profile.uid #=> Integer
resp.user.posix_profile.gid #=> Integer
resp.user.posix_profile.secondary_gids #=> Array
resp.user.posix_profile.secondary_gids[0] #=> Integer
resp.user.role #=> String
resp.user.ssh_public_keys #=> Array
resp.user.ssh_public_keys[0].date_imported #=> Time
resp.user.ssh_public_keys[0].ssh_public_key_body #=> String
resp.user.ssh_public_keys[0].ssh_public_key_id #=> String
resp.user.tags #=> Array
resp.user.tags[0].key #=> String
resp.user.tags[0].value #=> String
resp.user.user_name #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server that has this user
assigned.
    
          
        
    • 
      
        
  • 
          :user_name
          (required, String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


509

    		
    
      
# File 'sig/client.rbs', line 509

def describe_user: (

    		
  





    
      

  

  
    #describe_web_app(params = {})  ⇒ Types::DescribeWebAppResponse 
  

  

  




  

    
Describes the web app that's identified by WebAppId. The response
includes endpoint configuration details such as whether the web app is
publicly accessible or VPC hosted.


For more information about using VPC endpoints with Transfer Family,
see Create a Transfer Family web app in a VPC.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_web_app({
  web_app_id: "WebAppId", # required
})

    
      
        
Response structure

      
      

resp.web_app.arn #=> String
resp.web_app.web_app_id #=> String
resp.web_app.described_identity_provider_details.identity_center_config.application_arn #=> String
resp.web_app.described_identity_provider_details.identity_center_config.instance_arn #=> String
resp.web_app.described_identity_provider_details.identity_center_config.role #=> String
resp.web_app.access_endpoint #=> String
resp.web_app.web_app_endpoint #=> String
resp.web_app.web_app_units.provisioned #=> Integer
resp.web_app.tags #=> Array
resp.web_app.tags[0].key #=> String
resp.web_app.tags[0].value #=> String
resp.web_app.web_app_endpoint_policy #=> String, one of "FIPS", "STANDARD"
resp.web_app.endpoint_type #=> String, one of "PUBLIC", "VPC"
resp.web_app.described_endpoint_details.vpc.subnet_ids #=> Array
resp.web_app.described_endpoint_details.vpc.subnet_ids[0] #=> String
resp.web_app.described_endpoint_details.vpc.vpc_id #=> String
resp.web_app.described_endpoint_details.vpc.vpc_endpoint_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :web_app_id
          (required, String)
          
            
          
          
            — 
    Provide the unique identifier for the web app.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


520

    		
    
      
# File 'sig/client.rbs', line 520

def describe_web_app: (

    		
  





    
      

  

  
    #describe_web_app_customization(params = {})  ⇒ Types::DescribeWebAppCustomizationResponse 
  

  

  




  

    
Describes the web app customization object that's identified by
WebAppId.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_web_app_customization({
  web_app_id: "WebAppId", # required
})

    
      
        
Response structure

      
      

resp.web_app_customization.arn #=> String
resp.web_app_customization.web_app_id #=> String
resp.web_app_customization.title #=> String
resp.web_app_customization.logo_file #=> String
resp.web_app_customization.favicon_file #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :web_app_id
          (required, String)
          
            
          
          
            — 
    Provide the unique identifier for the web app.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


530

    		
    
      
# File 'sig/client.rbs', line 530

def describe_web_app_customization: (

    		
  





    
      

  

  
    #describe_workflow(params = {})  ⇒ Types::DescribeWorkflowResponse 
  

  

  




  

    
Describes the specified workflow.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_workflow({
  workflow_id: "WorkflowId", # required
})

    
      
        
Response structure

      
      

resp.workflow.arn #=> String
resp.workflow.description #=> String
resp.workflow.steps #=> Array
resp.workflow.steps[0].type #=> String, one of "COPY", "CUSTOM", "TAG", "DELETE", "DECRYPT"
resp.workflow.steps[0].copy_step_details.name #=> String
resp.workflow.steps[0].copy_step_details.destination_file_location.s3_file_location.bucket #=> String
resp.workflow.steps[0].copy_step_details.destination_file_location.s3_file_location.key #=> String
resp.workflow.steps[0].copy_step_details.destination_file_location.efs_file_location.file_system_id #=> String
resp.workflow.steps[0].copy_step_details.destination_file_location.efs_file_location.path #=> String
resp.workflow.steps[0].copy_step_details.overwrite_existing #=> String, one of "TRUE", "FALSE"
resp.workflow.steps[0].copy_step_details.source_file_location #=> String
resp.workflow.steps[0].custom_step_details.name #=> String
resp.workflow.steps[0].custom_step_details.target #=> String
resp.workflow.steps[0].custom_step_details.timeout_seconds #=> Integer
resp.workflow.steps[0].custom_step_details.source_file_location #=> String
resp.workflow.steps[0].delete_step_details.name #=> String
resp.workflow.steps[0].delete_step_details.source_file_location #=> String
resp.workflow.steps[0].tag_step_details.name #=> String
resp.workflow.steps[0].tag_step_details.tags #=> Array
resp.workflow.steps[0].tag_step_details.tags[0].key #=> String
resp.workflow.steps[0].tag_step_details.tags[0].value #=> String
resp.workflow.steps[0].tag_step_details.source_file_location #=> String
resp.workflow.steps[0].decrypt_step_details.name #=> String
resp.workflow.steps[0].decrypt_step_details.type #=> String, one of "PGP"
resp.workflow.steps[0].decrypt_step_details.source_file_location #=> String
resp.workflow.steps[0].decrypt_step_details.overwrite_existing #=> String, one of "TRUE", "FALSE"
resp.workflow.steps[0].decrypt_step_details.destination_file_location.s3_file_location.bucket #=> String
resp.workflow.steps[0].decrypt_step_details.destination_file_location.s3_file_location.key #=> String
resp.workflow.steps[0].decrypt_step_details.destination_file_location.efs_file_location.file_system_id #=> String
resp.workflow.steps[0].decrypt_step_details.destination_file_location.efs_file_location.path #=> String
resp.workflow.on_exception_steps #=> Array
resp.workflow.on_exception_steps[0].type #=> String, one of "COPY", "CUSTOM", "TAG", "DELETE", "DECRYPT"
resp.workflow.on_exception_steps[0].copy_step_details.name #=> String
resp.workflow.on_exception_steps[0].copy_step_details.destination_file_location.s3_file_location.bucket #=> String
resp.workflow.on_exception_steps[0].copy_step_details.destination_file_location.s3_file_location.key #=> String
resp.workflow.on_exception_steps[0].copy_step_details.destination_file_location.efs_file_location.file_system_id #=> String
resp.workflow.on_exception_steps[0].copy_step_details.destination_file_location.efs_file_location.path #=> String
resp.workflow.on_exception_steps[0].copy_step_details.overwrite_existing #=> String, one of "TRUE", "FALSE"
resp.workflow.on_exception_steps[0].copy_step_details.source_file_location #=> String
resp.workflow.on_exception_steps[0].custom_step_details.name #=> String
resp.workflow.on_exception_steps[0].custom_step_details.target #=> String
resp.workflow.on_exception_steps[0].custom_step_details.timeout_seconds #=> Integer
resp.workflow.on_exception_steps[0].custom_step_details.source_file_location #=> String
resp.workflow.on_exception_steps[0].delete_step_details.name #=> String
resp.workflow.on_exception_steps[0].delete_step_details.source_file_location #=> String
resp.workflow.on_exception_steps[0].tag_step_details.name #=> String
resp.workflow.on_exception_steps[0].tag_step_details.tags #=> Array
resp.workflow.on_exception_steps[0].tag_step_details.tags[0].key #=> String
resp.workflow.on_exception_steps[0].tag_step_details.tags[0].value #=> String
resp.workflow.on_exception_steps[0].tag_step_details.source_file_location #=> String
resp.workflow.on_exception_steps[0].decrypt_step_details.name #=> String
resp.workflow.on_exception_steps[0].decrypt_step_details.type #=> String, one of "PGP"
resp.workflow.on_exception_steps[0].decrypt_step_details.source_file_location #=> String
resp.workflow.on_exception_steps[0].decrypt_step_details.overwrite_existing #=> String, one of "TRUE", "FALSE"
resp.workflow.on_exception_steps[0].decrypt_step_details.destination_file_location.s3_file_location.bucket #=> String
resp.workflow.on_exception_steps[0].decrypt_step_details.destination_file_location.s3_file_location.key #=> String
resp.workflow.on_exception_steps[0].decrypt_step_details.destination_file_location.efs_file_location.file_system_id #=> String
resp.workflow.on_exception_steps[0].decrypt_step_details.destination_file_location.efs_file_location.path #=> String
resp.workflow.workflow_id #=> String
resp.workflow.tags #=> Array
resp.workflow.tags[0].key #=> String
resp.workflow.tags[0].value #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :workflow_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the workflow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


540

    		
    
      
# File 'sig/client.rbs', line 540

def describe_workflow: (

    		
  





    
      

  

  
    #import_certificate(params = {})  ⇒ Types::ImportCertificateResponse 
  

  

  




  

    
Imports the signing and encryption certificates that you need to
create local (AS2) profiles and partner profiles.


You can import both the certificate and its chain in the Certificate
parameter.


After importing a certificate, Transfer Family automatically creates a
Amazon CloudWatch metric called DaysUntilExpiry that tracks the
number of days until the certificate expires. The metric is based on
the InactiveDate parameter and is published daily in the
AWS/Transfer namespace.


It can take up to a full day after importing a certificate for
Transfer Family to emit the DaysUntilExpiry metric to your account.


 If you use the Certificate parameter to upload both the certificate
and its chain, don't use the CertificateChain parameter.

 

CloudWatch monitoring


The DaysUntilExpiry metric includes the following specifications:


    

  • 

    Units: Count (days)
    

    • 

  • 

    Dimensions: CertificateId (always present), Description (if
provided during certificate import)
    

    • 

  • 

    Statistics: Minimum, Maximum, Average
    

    • 

  • 

    Frequency: Published daily
    

    • 



  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.import_certificate({
  usage: "SIGNING", # required, accepts SIGNING, ENCRYPTION, TLS
  certificate: "CertificateBodyType", # required
  certificate_chain: "CertificateChainType",
  private_key: "PrivateKeyType",
  active_date: Time.now,
  inactive_date: Time.now,
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.certificate_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :usage
          (required, String)
          
            
          
          
            — 
    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
      

      • 

    
          
        
    • 
      
        
  • 
          :certificate
          (required, String)
          
            
          
          
            — 
      

    • 

      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`".
      

      • 

    

     You can provide both the certificate and its chain in this parameter,
without needing to use the CertificateChain parameter. If you use
this parameter for both the certificate and its chain, do not use the
CertificateChain parameter.
    
 
    
          
        
    • 
      
        
  • 
          :certificate_chain
          (String)
          
            
          
          
            — 
    An optional list of certificates that make up the chain for the
certificate that's being imported.
    
          
        
    • 
      
        
  • 
          :private_key
          (String)
          
            
          
          
            — 
      

    • 

      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`"
      

      • 

    
          
        
    • 
      
        
  • 
          :active_date
          (Time, DateTime, Date, Integer, String)
          
            
          
          
            — 
    An optional date that specifies when the certificate becomes active.
If you do not specify a value, ActiveDate takes the same value as
NotBeforeDate, which is specified by the CA.
    
          
        
    • 
      
        
  • 
          :inactive_date
          (Time, DateTime, Date, Integer, String)
          
            
          
          
            — 
    An optional date that specifies when the certificate becomes inactive.
If you do not specify a value, InactiveDate takes the same value as
NotAfterDate, which is specified by the CA.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A short description that helps identify the certificate.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for certificates.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


550

    		
    
      
# File 'sig/client.rbs', line 550

def import_certificate: (

    		
  





    
      

  

  
    #import_host_key(params = {})  ⇒ Types::ImportHostKeyResponse 
  

  

  




  

    
Adds a host key to the server that's specified by the ServerId
parameter.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.import_host_key({
  server_id: "ServerId", # required
  host_key_body: "HostKey", # required
  description: "HostKeyDescription",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.host_key_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The identifier of the server that contains the host key that you are
importing.
    
          
        
    • 
      
        
  • 
          :host_key_body
          (required, String)
          
            
          
          
            — 
    The private key portion of an SSH key pair.
    

    Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    The text description that identifies this host key.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs that can be used to group and search for host keys.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


573

    		
    
      
# File 'sig/client.rbs', line 573

def import_host_key: (

    		
  





    
      

  

  
    #import_ssh_public_key(params = {})  ⇒ Types::ImportSshPublicKeyResponse 
  

  

  




  

    
Adds a Secure Shell (SSH) public key to a Transfer Family user
identified by a UserName value assigned to the specific file
transfer protocol-enabled server, identified by ServerId.


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


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.import_ssh_public_key({
  server_id: "ServerId", # required
  ssh_public_key_body: "SshPublicKeyBody", # required
  user_name: "UserName", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.ssh_public_key_id #=> String
resp.user_name #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server.
    
          
        
    • 
      
        
  • 
          :ssh_public_key_body
          (required, String)
          
            
          
          
            — 
    The public key portion of an SSH key pair.
    

    Transfer Family accepts RSA, ECDSA, and ED25519 keys.
    
          
        
    • 
      
        
  • 
          :user_name
          (required, String)
          
            
          
          
            — 
    The name of the Transfer Family user that is assigned to one or more
servers.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


593

    		
    
      
# File 'sig/client.rbs', line 593

def import_ssh_public_key: (

    		
  





    
      

  

  
    #list_accesses(params = {})  ⇒ Types::ListAccessesResponse 
  

  

  




  

    
Lists the details for all the accesses you have on your server.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_accesses({
  max_results: 1,
  next_token: "NextToken",
  server_id: "ServerId", # required
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.server_id #=> String
resp.accesses #=> Array
resp.accesses[0].home_directory #=> String
resp.accesses[0].home_directory_type #=> String, one of "PATH", "LOGICAL"
resp.accesses[0].role #=> String
resp.accesses[0].external_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server that has users
assigned to it.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


607

    		
    
      
# File 'sig/client.rbs', line 607

def list_accesses: (

    		
  





    
      

  

  
    #list_agreements(params = {})  ⇒ Types::ListAgreementsResponse 
  

  

  




  

    
Returns a list of the agreements for the server that's identified by
the ServerId that you supply. If you want to limit the results to a
certain number, supply a value for the MaxResults parameter. If you
ran the command previously and received a value for NextToken, you
can supply that value to continue listing agreements from where you
left off.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_agreements({
  max_results: 1,
  next_token: "NextToken",
  server_id: "ServerId", # required
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.agreements #=> Array
resp.agreements[0].arn #=> String
resp.agreements[0].agreement_id #=> String
resp.agreements[0].description #=> String
resp.agreements[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.agreements[0].server_id #=> String
resp.agreements[0].local_profile_id #=> String
resp.agreements[0].partner_profile_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The identifier of the server for which you want a list of agreements.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


620

    		
    
      
# File 'sig/client.rbs', line 620

def list_agreements: (

    		
  





    
      

  

  
    #list_certificates(params = {})  ⇒ Types::ListCertificatesResponse 
  

  

  




  

    
Returns a list of the current certificates that have been imported
into Transfer Family. If you want to limit the results to a certain
number, supply a value for the MaxResults parameter. If you ran the
command previously and received a value for the NextToken parameter,
you can supply that value to continue listing certificates from where
you left off.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_certificates({
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.certificates #=> Array
resp.certificates[0].arn #=> String
resp.certificates[0].certificate_id #=> String
resp.certificates[0].usage #=> String, one of "SIGNING", "ENCRYPTION", "TLS"
resp.certificates[0].status #=> String, one of "ACTIVE", "PENDING_ROTATION", "INACTIVE"
resp.certificates[0].active_date #=> Time
resp.certificates[0].inactive_date #=> Time
resp.certificates[0].type #=> String, one of "CERTIFICATE", "CERTIFICATE_WITH_PRIVATE_KEY"
resp.certificates[0].description #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


633

    		
    
      
# File 'sig/client.rbs', line 633

def list_certificates: (

    		
  





    
      

  

  
    #list_connectors(params = {})  ⇒ Types::ListConnectorsResponse 
  

  

  




  

    
Lists the connectors for the specified Region.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_connectors({
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.connectors #=> Array
resp.connectors[0].arn #=> String
resp.connectors[0].connector_id #=> String
resp.connectors[0].url #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


645

    		
    
      
# File 'sig/client.rbs', line 645

def list_connectors: (

    		
  





    
      

  

  
    #list_executions(params = {})  ⇒ Types::ListExecutionsResponse 
  

  

  




  

    
Lists all in-progress executions for the specified workflow.


 If the specified workflow ID cannot be found, ListExecutions returns
a ResourceNotFound exception.

 

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_executions({
  max_results: 1,
  next_token: "NextToken",
  workflow_id: "WorkflowId", # required
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.workflow_id #=> String
resp.executions #=> Array
resp.executions[0].execution_id #=> String
resp.executions[0].initial_file_location.s3_file_location.bucket #=> String
resp.executions[0].initial_file_location.s3_file_location.key #=> String
resp.executions[0].initial_file_location.s3_file_location.version_id #=> String
resp.executions[0].initial_file_location.s3_file_location.etag #=> String
resp.executions[0].initial_file_location.efs_file_location.file_system_id #=> String
resp.executions[0].initial_file_location.efs_file_location.path #=> String
resp.executions[0].service_metadata.user_details.user_name #=> String
resp.executions[0].service_metadata.user_details.server_id #=> String
resp.executions[0].service_metadata.user_details.session_id #=> String
resp.executions[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "EXCEPTION", "HANDLING_EXCEPTION"

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :workflow_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the workflow.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


658

    		
    
      
# File 'sig/client.rbs', line 658

def list_executions: (

    		
  





    
      

  

  
    #list_file_transfer_results(params = {})  ⇒ Types::ListFileTransferResultsResponse 
  

  

  




  

    
Returns real-time updates and detailed information on the status of
each individual file being transferred in a specific file transfer
operation. You specify the file transfer by providing its
ConnectorId and its TransferId.


 File transfer results are available up to 7 days after an operation
has been requested.

 

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_file_transfer_results({
  connector_id: "ConnectorId", # required
  transfer_id: "TransferId", # required
  next_token: "NextToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.file_transfer_results #=> Array
resp.file_transfer_results[0].file_path #=> String
resp.file_transfer_results[0].status_code #=> String, one of "QUEUED", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.file_transfer_results[0].failure_code #=> String
resp.file_transfer_results[0].failure_message #=> String
resp.next_token #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for a connector. This value should match the value
supplied to the corresponding StartFileTransfer call.
    
          
        
    • 
      
        
  • 
          :transfer_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for a file transfer. This value should match the
value supplied to the corresponding StartFileTransfer call.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    If there are more file details than returned in this call, use this
value for a subsequent call to ListFileTransferResults to retrieve
them.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of files to return in a single page. Note that
currently you can specify a maximum of 10 file paths in a single
StartFileTransfer operation. Thus, the maximum number of file
transfer results that can be returned in a single page is 10.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


671

    		
    
      
# File 'sig/client.rbs', line 671

def list_file_transfer_results: (

    		
  





    
      

  

  
    #list_host_keys(params = {})  ⇒ Types::ListHostKeysResponse 
  

  

  




  

    
Returns a list of host keys for the server that's specified by the
ServerId parameter.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_host_keys({
  max_results: 1,
  next_token: "NextToken",
  server_id: "ServerId", # required
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.server_id #=> String
resp.host_keys #=> Array
resp.host_keys[0].arn #=> String
resp.host_keys[0].host_key_id #=> String
resp.host_keys[0].fingerprint #=> String
resp.host_keys[0].description #=> String
resp.host_keys[0].type #=> String
resp.host_keys[0].date_imported #=> Time

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The identifier of the server that contains the host keys that you want
to view.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


686

    		
    
      
# File 'sig/client.rbs', line 686

def list_host_keys: (

    		
  





    
      

  

  
    #list_profiles(params = {})  ⇒ Types::ListProfilesResponse 
  

  

  




  

    
Returns a list of the profiles for your system. If you want to limit
the results to a certain number, supply a value for the MaxResults
parameter. If you ran the command previously and received a value for
NextToken, you can supply that value to continue listing profiles
from where you left off.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_profiles({
  max_results: 1,
  next_token: "NextToken",
  profile_type: "LOCAL", # accepts LOCAL, PARTNER
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.profiles #=> Array
resp.profiles[0].arn #=> String
resp.profiles[0].profile_id #=> String
resp.profiles[0].as_2_id #=> String
resp.profiles[0].profile_type #=> String, one of "LOCAL", "PARTNER"

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :profile_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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


699

    		
    
      
# File 'sig/client.rbs', line 699

def list_profiles: (

    		
  





    
      

  

  
    #list_security_policies(params = {})  ⇒ Types::ListSecurityPoliciesResponse 
  

  

  




  

    
Lists the security policies that are attached to your servers and SFTP
connectors. For more information about security policies, see Working
with security policies for servers or Working with security
policies for SFTP connectors.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_security_policies({
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.security_policy_names #=> Array
resp.security_policy_names[0] #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Specifies the number of security policies to return as a response to
the ListSecurityPolicies query.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


712

    		
    
      
# File 'sig/client.rbs', line 712

def list_security_policies: (

    		
  





    
      

  

  
    #list_servers(params = {})  ⇒ Types::ListServersResponse 
  

  

  




  

    
Lists the file transfer protocol-enabled servers that are associated
with your Amazon Web Services account.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_servers({
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.servers #=> Array
resp.servers[0].arn #=> String
resp.servers[0].domain #=> String, one of "S3", "EFS"
resp.servers[0].identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY", "AWS_DIRECTORY_SERVICE", "AWS_LAMBDA"
resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
resp.servers[0].logging_role #=> String
resp.servers[0].server_id #=> String
resp.servers[0].state #=> String, one of "OFFLINE", "ONLINE", "STARTING", "STOPPING", "START_FAILED", "STOP_FAILED"
resp.servers[0].user_count #=> Integer

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Specifies the number of servers to return as a response to the
ListServers query.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    When additional results are obtained from the ListServers command, a
NextToken parameter is returned in the output. You can then pass the
NextToken parameter in a subsequent command to continue listing
additional servers.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


724

    		
    
      
# File 'sig/client.rbs', line 724

def list_servers: (

    		
  





    
      

  

  
    #list_tags_for_resource(params = {})  ⇒ Types::ListTagsForResourceResponse 
  

  

  




  

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


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_tags_for_resource({
  arn: "Arn", # required
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.arn #=> String
resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    Requests the tags associated with a particular Amazon Resource Name
(ARN). An ARN is an identifier for a specific Amazon Web Services
resource, such as a server, user, or role.
    
          
        
    • 
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Specifies the number of tags to return as a response to the
ListTagsForResource request.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    When you request additional results from the ListTagsForResource
operation, a NextToken parameter is returned in the input. You can
then pass in a subsequent command to the NextToken parameter to
continue listing additional tags.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


737

    		
    
      
# File 'sig/client.rbs', line 737

def list_tags_for_resource: (

    		
  





    
      

  

  
    #list_users(params = {})  ⇒ Types::ListUsersResponse 
  

  

  




  

    
Lists the users for a file transfer protocol-enabled server that you
specify by passing the ServerId parameter.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_users({
  max_results: 1,
  next_token: "NextToken",
  server_id: "ServerId", # required
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.server_id #=> String
resp.users #=> Array
resp.users[0].arn #=> String
resp.users[0].home_directory #=> String
resp.users[0].home_directory_type #=> String, one of "PATH", "LOGICAL"
resp.users[0].role #=> String
resp.users[0].ssh_public_key_count #=> Integer
resp.users[0].user_name #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    Specifies the number of users to return as a response to the
ListUsers request.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    If there are additional results from the ListUsers call, a
NextToken parameter is returned in the output. You can then pass the
NextToken to a subsequent ListUsers command, to continue listing
additional users.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server that has users
assigned to it.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


751

    		
    
      
# File 'sig/client.rbs', line 751

def list_users: (

    		
  





    
      

  

  
    #list_web_apps(params = {})  ⇒ Types::ListWebAppsResponse 
  

  

  




  

    
Lists all web apps associated with your Amazon Web Services account
for your current region. The response includes the endpoint type for
each web app, showing whether it is publicly accessible or VPC hosted.


For more information about using VPC endpoints with Transfer Family,
see Create a Transfer Family web app in a VPC.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_web_apps({
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.web_apps #=> Array
resp.web_apps[0].arn #=> String
resp.web_apps[0].web_app_id #=> String
resp.web_apps[0].access_endpoint #=> String
resp.web_apps[0].web_app_endpoint #=> String
resp.web_apps[0].endpoint_type #=> String, one of "PUBLIC", "VPC"

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    Returns the NextToken parameter in the output. You can then pass the
NextToken parameter in a subsequent command to continue listing
additional web apps.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


764

    		
    
      
# File 'sig/client.rbs', line 764

def list_web_apps: (

    		
  





    
      

  

  
    #list_workflows(params = {})  ⇒ Types::ListWorkflowsResponse 
  

  

  




  

    
Lists all workflows associated with your Amazon Web Services account
for your current region.


The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_workflows({
  max_results: 1,
  next_token: "NextToken",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.workflows #=> Array
resp.workflows[0].workflow_id #=> String
resp.workflows[0].description #=> String
resp.workflows[0].arn #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :max_results
          (Integer)
          
            
          
          
            — 
    The maximum number of items to return.
    
          
        
    • 
      
        
  • 
          :next_token
          (String)
          
            
          
          
            — 
    ListWorkflows returns the NextToken parameter in the output. You
can then pass the NextToken parameter in a subsequent command to
continue listing additional workflows.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


776

    		
    
      
# File 'sig/client.rbs', line 776

def list_workflows: (

    		
  





    
      

  

  
    #send_workflow_step_state(params = {})  ⇒ Struct 
  

  

  




  

    
Sends a callback for asynchronous custom steps.


The ExecutionId, WorkflowId, and Token are passed to the target
resource during execution of a custom step of a workflow. You must
include those with their callback as well as providing a status.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.send_workflow_step_state({
  workflow_id: "WorkflowId", # required
  execution_id: "ExecutionId", # required
  token: "CallbackToken", # required
  status: "SUCCESS", # required, accepts SUCCESS, FAILURE
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :workflow_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the workflow.
    
          
        
    • 
      
        
  • 
          :execution_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the execution of a workflow.
    
          
        
    • 
      
        
  • 
          :token
          (required, String)
          
            
          
          
            — 
    Used to distinguish between multiple callbacks for multiple Lambda
steps within the same execution.
    
          
        
    • 
      
        
  • 
          :status
          (required, String)
          
            
          
          
            — 
    Indicates whether the specified step succeeded or failed.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


786

    		
    
      
# File 'sig/client.rbs', line 786

def send_workflow_step_state: (

    		
  





    
      

  

  
    #start_directory_listing(params = {})  ⇒ Types::StartDirectoryListingResponse 
  

  

  




  

    
Retrieves a list of the contents of a directory from a remote SFTP
server. You specify the connector ID, the output path, and the remote
directory path. You can also specify the optional MaxItems value to
control the maximum number of items that are listed from the remote
directory. This API returns a list of all files and directories in the
remote directory (up to the maximum value), but does not return files
or folders in sub-directories. That is, it only returns a list of
files and directories one-level deep.


After you receive the listing file, you can provide the files that you
want to transfer to the RetrieveFilePaths parameter of the
StartFileTransfer API call.


The naming convention for the output file is  connector-ID-listing-ID.json. The output file contains the following
information:


    

  • 

    filePath: the complete path of a remote file, relative to the
directory of the listing request for your SFTP connector on the
remote server.
    

    • 

  • 

    modifiedTimestamp: the last time the file was modified, in UTC
time format. This field is optional. If the remote file attributes
don't contain a timestamp, it is omitted from the file listing.
    

    • 

  • 

    size: the size of the file, in bytes. This field is optional. If
the remote file attributes don't contain a file size, it is omitted
from the file listing.
    

    • 

  • 

    path: the complete path of a remote directory, relative to the
directory of the listing request for your SFTP connector on the
remote server.
    

    • 

  • 

    truncated: a flag indicating whether the list output contains all
of the items contained in the remote directory or not. If your
Truncated output value is true, you can increase the value
provided in the optional max-items input attribute to be able to
list more items (up to the maximum allowed list size of 200,000
items).
    

    • 



  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_directory_listing({
  connector_id: "ConnectorId", # required
  remote_directory_path: "FilePath", # required
  max_items: 1,
  output_directory_path: "FilePath", # required
})

    
      
        
Response structure

      
      

resp.listing_id #=> String
resp.output_file_name #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
        
  • 
          :remote_directory_path
          (required, String)
          
            
          
          
            — 
    Specifies the directory on the remote SFTP server for which you want
to list its contents.
    
          
        
    • 
      
        
  • 
          :max_items
          (Integer)
          
            
          
          
            — 
    An optional parameter where you can specify the maximum number of
file/directory names to retrieve. The default value is 1,000.
    
          
        
    • 
      
        
  • 
          :output_directory_path
          (required, String)
          
            
          
          
            — 
    Specifies the path (bucket and prefix) in Amazon S3 storage to store
the results of the directory listing.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


800

    		
    
      
# File 'sig/client.rbs', line 800

def start_directory_listing: (

    		
  





    
      

  

  
    #start_file_transfer(params = {})  ⇒ Types::StartFileTransferResponse 
  

  

  




  

    
Begins a file transfer between local Amazon Web Services storage and a
remote AS2 or SFTP server.


    

  • 

    For an AS2 connector, you specify the ConnectorId and one or more
SendFilePaths to identify the files you want to transfer.
    

    • 

  • 

    For an SFTP connector, the file transfer can be either outbound or
inbound. In both cases, you specify the ConnectorId. Depending on
the direction of the transfer, you also specify the following items:
    

    • 

  • 

    If you are transferring file from a partner's SFTP server to
Amazon Web Services storage, you specify one or more
RetrieveFilePaths to identify the files you want to transfer,
and a LocalDirectoryPath to specify the destination folder.
    

    • 

  • 

    If you are transferring file to a partner's SFTP server from
Amazon Web Services storage, you specify one or more
SendFilePaths to identify the files you want to transfer, and a
RemoteDirectoryPath to specify the destination folder.
    

    • 



  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_file_transfer({
  connector_id: "ConnectorId", # required
  send_file_paths: ["FilePath"],
  retrieve_file_paths: ["FilePath"],
  local_directory_path: "FilePath",
  remote_directory_path: "FilePath",
  custom_http_headers: [
    {
      key: "CustomHttpHeaderKeyType",
      value: "CustomHttpHeaderValueType",
    },
  ],
})

    
      
        
Response structure

      
      

resp.transfer_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
        
  • 
          :send_file_paths
          (Array<String>)
          
            
          
          
            — 
    One or more source paths for the Amazon S3 storage. Each string
represents a source file path for one outbound file transfer. For
example, amzn-s3-demo-bucket/myfile.txt.
    

     Replace amzn-s3-demo-bucket with one of your actual buckets.
    
 
    
          
        
    • 
      
        
  • 
          :retrieve_file_paths
          (Array<String>)
          
            
          
          
            — 
    One or more source paths for the partner's SFTP server. Each string
represents a source file path for one inbound file transfer.
    
          
        
    • 
      
        
  • 
          :local_directory_path
          (String)
          
            
          
          
            — 
    For an inbound transfer, the LocaDirectoryPath specifies the
destination for one or more files that are transferred from the
partner's SFTP server.
    
          
        
    • 
      
        
  • 
          :remote_directory_path
          (String)
          
            
          
          
            — 
    For an outbound transfer, the RemoteDirectoryPath specifies the
destination for one or more files that are transferred to the
partner's SFTP server. If you don't specify a RemoteDirectoryPath,
the destination for transferred files is the SFTP user's home
directory.
    
          
        
    • 
      
        
  • 
          :custom_http_headers
          (Array<Types::CustomHttpHeader>)
          
            
          
          
            — 
    An array of key-value pairs that represent custom HTTP headers to
include in AS2 messages. These headers are added to the AS2 message
when sending files to your trading partner.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


813

    		
    
      
# File 'sig/client.rbs', line 813

def start_file_transfer: (

    		
  





    
      

  

  
    #start_remote_delete(params = {})  ⇒ Types::StartRemoteDeleteResponse 
  

  

  




  

    
Deletes a file or directory on the remote SFTP server.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_remote_delete({
  connector_id: "ConnectorId", # required
  delete_path: "FilePath", # required
})

    
      
        
Response structure

      
      

resp.delete_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
        
  • 
          :delete_path
          (required, String)
          
            
          
          
            — 
    The absolute path of the file or directory to delete. You can only
specify one path per call to this operation.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


833

    		
    
      
# File 'sig/client.rbs', line 833

def start_remote_delete: (

    		
  





    
      

  

  
    #start_remote_move(params = {})  ⇒ Types::StartRemoteMoveResponse 
  

  

  




  

    
Moves or renames a file or directory on the remote SFTP server.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_remote_move({
  connector_id: "ConnectorId", # required
  source_path: "FilePath", # required
  target_path: "FilePath", # required
})

    
      
        
Response structure

      
      

resp.move_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
        
  • 
          :source_path
          (required, String)
          
            
          
          
            — 
    The absolute path of the file or directory to move or rename. You can
only specify one path per call to this operation.
    
          
        
    • 
      
        
  • 
          :target_path
          (required, String)
          
            
          
          
            — 
    The absolute path for the target of the move/rename operation.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


844

    		
    
      
# File 'sig/client.rbs', line 844

def start_remote_move: (

    		
  





    
      

  

  
    #start_server(params = {})  ⇒ Struct 
  

  

  




  

    
Changes the state of a file transfer protocol-enabled server from
OFFLINE to ONLINE. It has no impact on a 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.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_server({
  server_id: "ServerId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server that you start.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


852

    		
    
      
# File 'sig/client.rbs', line 852

def start_server: (

    		
  





    
      

  

  
    #stop_server(params = {})  ⇒ Struct 
  

  

  




  

    
Changes the state of a file transfer protocol-enabled 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 the server does not reduce or impact your file transfer
protocol endpoint billing; you must delete the server to stop being
billed.

 

The state 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.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.stop_server({
  server_id: "ServerId", # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server that you stopped.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


858

    		
    
      
# File 'sig/client.rbs', line 858

def stop_server: (

    		
  





    
      

  

  
    #tag_resource(params = {})  ⇒ Struct 
  

  

  




  

    
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.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.tag_resource({
  arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    An Amazon Resource Name (ARN) for a specific Amazon Web Services
resource, such as a server, user, or role.
    
          
        
    • 
      
        
  • 
          :tags
          (required, Array<Types::Tag>)
          
            
          
          
            — 
    Key-value pairs assigned to ARNs that you can use to group and search
for resources by type. You can attach this metadata to resources
(servers, users, workflows, and so on) for any purpose.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


864

    		
    
      
# File 'sig/client.rbs', line 864

def tag_resource: (

    		
  





    
      

  

  
    #test_connection(params = {})  ⇒ Types::TestConnectionResponse 
  

  

  




  

    
Tests whether your SFTP connector is set up successfully. We highly
recommend that you call this operation to test your ability to
transfer files between local Amazon Web Services storage and a trading
partner's SFTP server.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.test_connection({
  connector_id: "ConnectorId", # required
})

    
      
        
Response structure

      
      

resp.connector_id #=> String
resp.status #=> String
resp.status_message #=> String
resp.sftp_connection_details.host_key #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


883

    		
    
      
# File 'sig/client.rbs', line 883

def test_connection: (

    		
  





    
      

  

  
    #test_identity_provider(params = {})  ⇒ Types::TestIdentityProviderResponse 
  

  

  




  

    
If the IdentityProviderType of a file transfer protocol-enabled
server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your
identity provider is set up successfully. We highly recommend that you
call this operation to test your authentication method as soon as you
create your server. By doing so, you can troubleshoot issues with the
identity provider integration to ensure that your users can
successfully use the service.


The ServerId and UserName parameters are required. The
ServerProtocol, SourceIp, and UserPassword are all optional.


Note the following:


    

  • 

    You cannot use TestIdentityProvider if the IdentityProviderType
of your server is SERVICE_MANAGED.
    

    • 

  • 

    TestIdentityProvider does not work with keys: it only accepts
passwords.
    

    • 

  • 

    TestIdentityProvider can test the password operation for a custom
Identity Provider that handles keys and passwords.
    

    • 

  • 

    If you provide any incorrect values for any parameters, the
Response field is empty.
    

    • 

  • 

    If you provide a server ID for a server that uses service-managed
users, you get an error:
    

    An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth
    

    • 

  • 

    If you enter a Server ID for the --server-id parameter that does
not identify an actual Transfer server, you receive the following
error:
    

    An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server.
    

    It is possible your sever is in a different region. You can specify
a region by adding the following: --region region-code, such as
--region us-east-2 to specify a server in US East (Ohio).
    

    • 



  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.test_identity_provider({
  server_id: "ServerId", # required
  server_protocol: "SFTP", # accepts SFTP, FTP, FTPS, AS2
  source_ip: "SourceIp",
  user_name: "UserName", # required
  user_password: "UserPassword",
})

    
      
        
Response structure

      
      

resp.response #=> String
resp.status_code #=> Integer
resp.message #=> String
resp.url #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned identifier for a specific server. That server's
user authentication method is tested with a user name and password.
    
          
        
    • 
      
        
  • 
          :server_protocol
          (String)
          
            
          
          
            — 
    The type of file transfer protocol to be tested.
    

    The available protocols are:
    

      

    • 

      Secure Shell (SSH) File Transfer Protocol (SFTP)
      

      • 

    • 

      File Transfer Protocol Secure (FTPS)
      

      • 

    • 

      File Transfer Protocol (FTP)
      

      • 

    • 

      Applicability Statement 2 (AS2)
      

      • 

    
          
        
    • 
      
        
  • 
          :source_ip
          (String)
          
            
          
          
            — 
    The source IP address of the account to be tested.
    
          
        
    • 
      
        
  • 
          :user_name
          (required, String)
          
            
          
          
            — 
    The name of the account to be tested.
    
          
        
    • 
      
        
  • 
          :user_password
          (String)
          
            
          
          
            — 
    The password of the account to be tested.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


896

    		
    
      
# File 'sig/client.rbs', line 896

def test_identity_provider: (

    		
  





    
      

  

  
    #untag_resource(params = {})  ⇒ Struct 
  

  

  




  

    
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.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.untag_resource({
  arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :arn
          (required, String)
          
            
          
          
            — 
    The value of the resource that will have the tag removed. An Amazon
Resource Name (ARN) is an identifier for a specific Amazon Web
Services resource, such as a server, user, or role.
    
          
        
    • 
      
        
  • 
          :tag_keys
          (required, Array<String>)
          
            
          
          
            — 
    TagKeys are key-value pairs assigned to ARNs that can be used to group
and search for resources by type. This metadata can be attached to
resources for any purpose.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


906

    		
    
      
# File 'sig/client.rbs', line 906

def untag_resource: (

    		
  





    
      

  

  
    #update_access(params = {})  ⇒ Types::UpdateAccessResponse 
  

  

  




  

    
Allows you to update parameters for the access specified in the
ServerID and ExternalID parameters.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_access({
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
      type: "FILE", # accepts FILE, DIRECTORY
    },
  ],
  policy: "Policy",
  posix_profile: {
    uid: 1, # required
    gid: 1, # required
    secondary_gids: [1],
  },
  role: "Role",
  server_id: "ServerId", # required
  external_id: "ExternalId", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.external_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :home_directory
          (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.
    

     You can use the HomeDirectory parameter for HomeDirectoryType when
it is set to either PATH or LOGICAL.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_type
          (String)
          
            
          
          
            — 
    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.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_mappings
          (Array<Types::HomeDirectoryMapEntry>)
          
            
          
          
            — 
    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" } ]
    
          
        
    • 
      
        
  • 
          :policy
          (String)
          
            
          
          
            — 
    A session policy for your user so that you can use the same Identity
and Access Management (IAM) role across multiple users. This policy
scopes down a user's access to portions of their Amazon S3 bucket.
Variables that you can use inside this policy include
${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
    

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

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

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

    For more information, see AssumeRole in the Amazon Web
ServicesSecurity Token Service API Reference.
    
 
    
          
        
    • 
      
        
  • 
          :posix_profile
          (Types::PosixProfile)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :role
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
    
          
        
    • 
      
        
  • 
          :external_id
          (required, String)
          
            
          
          
            — 
    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: =,.@:/-
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


918

    		
    
      
# File 'sig/client.rbs', line 918

def update_access: (

    		
  





    
      

  

  
    #update_agreement(params = {})  ⇒ Types::UpdateAgreementResponse 
  

  

  




  

    
Updates some of the parameters for an existing agreement. Provide the
AgreementId and the ServerId for the agreement that you want to
update, along with the new values for the parameters to update.


 Specify either BaseDirectory or CustomDirectories, but not both.
Specifying both causes the command to fail.


If you update an agreement from using base directory to custom
directories, the base directory is no longer used. Similarly, if you
change from custom directories to a base directory, the custom
directories are no longer used.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_agreement({
  agreement_id: "AgreementId", # required
  server_id: "ServerId", # required
  description: "Description",
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  local_profile_id: "ProfileId",
  partner_profile_id: "ProfileId",
  base_directory: "HomeDirectory",
  access_role: "Role",
  preserve_filename: "ENABLED", # accepts ENABLED, DISABLED
  enforce_message_signing: "ENABLED", # accepts ENABLED, DISABLED
  custom_directories: {
    failed_files_directory: "HomeDirectory", # required
    mdn_files_directory: "HomeDirectory", # required
    payload_files_directory: "HomeDirectory", # required
    status_files_directory: "HomeDirectory", # required
    temporary_files_directory: "HomeDirectory", # required
  },
})

    
      
        
Response structure

      
      

resp.agreement_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :agreement_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the agreement. This identifier is returned
when you create an agreement.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    To replace the existing description, provide a short description for
the agreement.
    
          
        
    • 
      
        
  • 
          :status
          (String)
          
            
          
          
            — 
    You can update the status for the agreement, either activating an
inactive agreement or the reverse.
    
          
        
    • 
      
        
  • 
          :local_profile_id
          (String)
          
            
          
          
            — 
    A unique identifier for the AS2 local profile.
    

    To change the local profile identifier, provide a new value here.
    
          
        
    • 
      
        
  • 
          :partner_profile_id
          (String)
          
            
          
          
            — 
    A unique identifier for the partner profile. To change the partner
profile identifier, provide a new value here.
    
          
        
    • 
      
        
  • 
          :base_directory
          (String)
          
            
          
          
            — 
    To change the landing directory (folder) for files that are
transferred, provide the bucket folder that you want to use; for
example, /amzn-s3-demo-bucket/home/mydirectory .
    
          
        
    • 
      
        
  • 
          :access_role
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :preserve_filename
          (String)
          
            
          
          
            — 
    Determines whether or not Transfer Family appends a unique string of
characters to the end of the AS2 message payload filename when saving
it.
    

      

    • 

      ENABLED: the filename provided by your trading parter is preserved
when the file is saved.
      

      • 

    • 

      DISABLED (default value): when Transfer Family saves the file, the
filename is adjusted, as described in File names and locations.
      

      • 

    
          
        
    • 
      
        
  • 
          :enforce_message_signing
          (String)
          
            
          
          
            — 
    Determines whether or not unsigned messages from your trading partners
will be accepted.
    

      

    • 

      ENABLED: Transfer Family rejects unsigned messages from your
trading partner.
      

      • 

    • 

      DISABLED (default value): Transfer Family accepts unsigned
messages from your trading partner.
      

      • 

    
          
        
    • 
      
        
  • 
          :custom_directories
          (Types::CustomDirectoriesType)
          
            
          
          
            — 
    A CustomDirectoriesType structure. This structure specifies custom
directories for storing various AS2 message files. You can specify
directories for the following types of files.
    

      

    • 

      Failed files
      

      • 

    • 

      MDN files
      

      • 

    • 

      Payload files
      

      • 

    • 

      Status files
      

      • 

    • 

      Temporary files
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


945

    		
    
      
# File 'sig/client.rbs', line 945

def update_agreement: (

    		
  





    
      

  

  
    #update_certificate(params = {})  ⇒ Types::UpdateCertificateResponse 
  

  

  




  

    
Updates the active and inactive dates for a certificate.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_certificate({
  certificate_id: "CertificateId", # required
  active_date: Time.now,
  inactive_date: Time.now,
  description: "Description",
})

    
      
        
Response structure

      
      

resp.certificate_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :certificate_id
          (required, String)
          
            
          
          
            — 
    The identifier of the certificate object that you are updating.
    
          
        
    • 
      
        
  • 
          :active_date
          (Time, DateTime, Date, Integer, String)
          
            
          
          
            — 
    An optional date that specifies when the certificate becomes active.
If you do not specify a value, ActiveDate takes the same value as
NotBeforeDate, which is specified by the CA.
    
          
        
    • 
      
        
  • 
          :inactive_date
          (Time, DateTime, Date, Integer, String)
          
            
          
          
            — 
    An optional date that specifies when the certificate becomes inactive.
If you do not specify a value, InactiveDate takes the same value as
NotAfterDate, which is specified by the CA.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A short description to help identify the certificate.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


971

    		
    
      
# File 'sig/client.rbs', line 971

def update_certificate: (

    		
  





    
      

  

  
    #update_connector(params = {})  ⇒ Types::UpdateConnectorResponse 
  

  

  




  

    
Updates some of the parameters for an existing connector. Provide the
ConnectorId for the connector that you want to update, along with
the new values for the parameters to update.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_connector({
  connector_id: "ConnectorId", # required
  url: "Url",
  as_2_config: {
    local_profile_id: "ProfileId",
    partner_profile_id: "ProfileId",
    message_subject: "MessageSubject",
    compression: "ZLIB", # accepts ZLIB, DISABLED
    encryption_algorithm: "AES128_CBC", # accepts AES128_CBC, AES192_CBC, AES256_CBC, DES_EDE3_CBC, NONE
    signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE
    mdn_signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE, DEFAULT
    mdn_response: "SYNC", # accepts SYNC, NONE, ASYNC
    basic_auth_secret_id: "As2ConnectorSecretId",
    preserve_content_type: "ENABLED", # accepts ENABLED, DISABLED
    async_mdn_config: {
      url: "Url",
      server_ids: ["ServerId"],
    },
  },
  access_role: "Role",
  logging_role: "Role",
  sftp_config: {
    user_secret_id: "SecretId",
    trusted_host_keys: ["SftpConnectorTrustedHostKey"],
    max_concurrent_connections: 1,
    ordered_user_secret_version_stages: ["SecretVersionStage"],
  },
  security_policy_name: "ConnectorSecurityPolicyName",
  egress_config: {
    vpc_lattice: {
      resource_configuration_arn: "VpcLatticeResourceConfigurationArn",
      port_number: 1,
    },
  },
  ip_address_type: "IPV4", # accepts IPV4, DUALSTACK
})

    
      
        
Response structure

      
      

resp.connector_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :connector_id
          (required, String)
          
            
          
          
            — 
    The unique identifier for the connector.
    
          
        
    • 
      
        
  • 
          :url
          (String)
          
            
          
          
            — 
    The URL of the partner's AS2 or SFTP endpoint.
    

    When creating AS2 connectors or service-managed SFTP connectors
(connectors without egress configuration), you must provide a URL to
specify the remote server endpoint. For VPC Lattice type connectors,
the URL must be null.
    
          
        
    • 
      
        
  • 
          :as_2_config
          (Types::As2ConnectorConfig)
          
            
          
          
            — 
    A structure that contains the parameters for an AS2 connector object.
    
          
        
    • 
      
        
  • 
          :access_role
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :logging_role
          (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.
    
          
        
    • 
      
        
  • 
          :sftp_config
          (Types::SftpConnectorConfig)
          
            
          
          
            — 
    A structure that contains the parameters for an SFTP connector object.
    
          
        
    • 
      
        
  • 
          :security_policy_name
          (String)
          
            
          
          
            — 
    Specifies the name of the security policy for the connector.
    
          
        
    • 
      
        
  • 
          :egress_config
          (Types::UpdateConnectorEgressConfig)
          
            
          
          
            — 
    Updates the egress configuration for the connector, allowing you to
modify how traffic is routed from the connector to the SFTP server.
Changes to VPC configuration may require connector restart.
    
          
        
    • 
      
        
  • 
          :ip_address_type
          (String)
          
            
          
          
            — 
    Specifies the IP address type for the connector's network
connections. When set to IPV4, the connector uses IPv4 addresses
only. When set to DUALSTACK, the connector supports both IPv4 and
IPv6 addresses, with IPv6 preferred when available.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


984

    		
    
      
# File 'sig/client.rbs', line 984

def update_connector: (

    		
  





    
      

  

  
    #update_host_key(params = {})  ⇒ Types::UpdateHostKeyResponse 
  

  

  




  

    
Updates the description for the host key that's specified by the
ServerId and HostKeyId parameters.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_host_key({
  server_id: "ServerId", # required
  host_key_id: "HostKeyId", # required
  description: "HostKeyDescription", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.host_key_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    The identifier of the server that contains the host key that you are
updating.
    
          
        
    • 
      
        
  • 
          :host_key_id
          (required, String)
          
            
          
          
            — 
    The identifier of the host key that you are updating.
    
          
        
    • 
      
        
  • 
          :description
          (required, String)
          
            
          
          
            — 
    An updated description for the host key.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1013

    		
    
      
# File 'sig/client.rbs', line 1013

def update_host_key: (

    		
  





    
      

  

  
    #update_profile(params = {})  ⇒ Types::UpdateProfileResponse 
  

  

  




  

    
Updates some of the parameters for an existing profile. Provide the
ProfileId for the profile that you want to update, along with the
new values for the parameters to update.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_profile({
  profile_id: "ProfileId", # required
  certificate_ids: ["CertificateId"],
})

    
      
        
Response structure

      
      

resp.profile_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :profile_id
          (required, String)
          
            
          
          
            — 
    The identifier of the profile object that you are updating.
    
          
        
    • 
      
        
  • 
          :certificate_ids
          (Array<String>)
          
            
          
          
            — 
    An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1025

    		
    
      
# File 'sig/client.rbs', line 1025

def update_profile: (

    		
  





    
      

  

  
    #update_server(params = {})  ⇒ Types::UpdateServerResponse 
  

  

  




  

    
Updates the file transfer protocol-enabled server's properties after
that server has been created.


The UpdateServer call returns the ServerId of the server you
updated.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_server({
  certificate: "Certificate",
  protocol_details: {
    passive_ip: "PassiveIp",
    tls_session_resumption_mode: "DISABLED", # accepts DISABLED, ENABLED, ENFORCED
    set_stat_option: "DEFAULT", # accepts DEFAULT, ENABLE_NO_OP
    as_2_transports: ["HTTP"], # accepts HTTP
    proxy_config: {
      sftp_mode: "NONE", # accepts NONE, PROXY_PROTOCOL_V2_ENFORCED
    },
  },
  endpoint_details: {
    address_allocation_ids: ["AddressAllocationId"],
    subnet_ids: ["SubnetId"],
    vpc_endpoint_id: "VpcEndpointId",
    vpc_id: "VpcId",
    security_group_ids: ["SecurityGroupId"],
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
    directory_id: "DirectoryId",
    function: "Function",
    sftp_authentication_methods: "PASSWORD", # accepts PASSWORD, PUBLIC_KEY, PUBLIC_KEY_OR_PASSWORD, PUBLIC_KEY_AND_PASSWORD
  },
  logging_role: "NullableRole",
  post_authentication_login_banner: "PostAuthenticationLoginBanner",
  pre_authentication_login_banner: "PreAuthenticationLoginBanner",
  protocols: ["SFTP"], # accepts SFTP, FTP, FTPS, AS2
  security_policy_name: "SecurityPolicyName",
  server_id: "ServerId", # required
  workflow_details: {
    on_upload: [
      {
        workflow_id: "WorkflowId", # required
        execution_role: "Role", # required
      },
    ],
    on_partial_upload: [
      {
        workflow_id: "WorkflowId", # required
        execution_role: "Role", # required
      },
    ],
  },
  structured_log_destinations: ["Arn"],
  s3_storage_options: {
    directory_listing_optimization: "ENABLED", # accepts ENABLED, DISABLED
  },
  ip_address_type: "IPV4", # accepts IPV4, DUALSTACK
  identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE, AWS_LAMBDA
})

    
      
        
Response structure

      
      

resp.server_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :certificate
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate
Manager (ACM) certificate. Required when Protocols is set to FTPS.
    

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

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

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

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

      

    • 

      2048-bit RSA (RSA_2048)
      

      • 

    • 

      4096-bit RSA (RSA_4096)
      

      • 

    • 

      Elliptic Prime Curve 256 bit (EC_prime256v1)
      

      • 

    • 

      Elliptic Prime Curve 384 bit (EC_secp384r1)
      

      • 

    • 

      Elliptic Prime Curve 521 bit (EC_secp521r1)
      

      • 

    

     The certificate must be a valid SSL/TLS X.509 version 3 certificate
with FQDN or IP address specified and information about the issuer.
    
 
    
          
        
    • 
      
        
  • 
          :protocol_details
          (Types::ProtocolDetails)
          
            
          
          
            — 
    The protocol settings that are configured for your server.
    

     Avoid placing Network Load Balancers (NLBs) or NAT gateways in front
of Transfer Family servers, as this increases costs and can cause
performance issues, including reduced connection limits for FTPS. For
more details, see  Avoid placing NLBs and NATs in front of Transfer
Family.
    
 

      

    • 

      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.
      

      • 

    
          
        
    • 
      
        
  • 
          :endpoint_details
          (Types::EndpointDetails)
          
            
          
          
            — 
    The virtual private cloud (VPC) endpoint settings that are configured
for your server. When you host your endpoint within your VPC, you can
make your endpoint accessible only to resources within your VPC, or
you can attach Elastic IP addresses and make your endpoint accessible
to clients over the internet. Your VPC's default security groups are
automatically assigned to your endpoint.
    
          
        
    • 
      
        
  • 
          :endpoint_type
          (String)
          
            
          
          
            — 
    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.
    
 
    
          
        
    • 
      
        
  • 
          :host_key
          (String)
          
            
          
          
            — 
    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 in the Transfer Family User Guide.
    
          
        
    • 
      
        
  • 
          :identity_provider_details
          (Types::IdentityProviderDetails)
          
            
          
          
            — 
    An array containing all of the information required to call a
customer's authentication API method.
    
          
        
    • 
      
        
  • 
          :logging_role
          (String)
          
            
          
          
            — 
    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 EFS events. When set, you can view user
activity in your CloudWatch logs.
    
          
        
    • 
      
        
  • 
          :post_authentication_login_banner
          (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.
    
 
    
          
        
    • 
      
        
  • 
          :pre_authentication_login_banner
          (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.
    
          
        
    • 
      
        
  • 
          :protocols
          (Array<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:
    

      

    • 

      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.
      

      • 

    
 
    
          
        
    • 
      
        
  • 
          :security_policy_name
          (String)
          
            
          
          
            — 
    Specifies the name of the security policy for the server.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a server instance that the
Transfer Family user is assigned to.
    
          
        
    • 
      
        
  • 
          :workflow_details
          (Types::WorkflowDetails)
          
            
          
          
            — 
    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.
    

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

    aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
    
          
        
    • 
      
        
  • 
          :structured_log_destinations
          (Array<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
    
          
        
    • 
      
        
  • 
          :s3_storage_options
          (Types::S3StorageOptions)
          
            
          
          
            — 
    Specifies whether or not performance for your Amazon S3 directories is
optimized.
    

      

    • 

      If using the console, this is enabled by default.
      

      • 

    • 

      If using the API or CLI, 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.
    
          
        
    • 
      
        
  • 
          :ip_address_type
          (String)
          
            
          
          
            — 
    Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and
IPv6) for your Transfer Family endpoint. The default value is IPV4.
    

    The IpAddressType parameter has the following limitations:
    

      

    • 

      It cannot be changed while the server is online. You must stop the
server before modifying this parameter.
      

      • 

    • 

      It cannot be updated to DUALSTACK if the server has
AddressAllocationIds specified.
      

      • 

    

     When using DUALSTACK as the IpAddressType, you cannot set the
AddressAllocationIds parameter for the EndpointDetails for the
server.
    
 
    
          
        
    • 
      
        
  • 
          :identity_provider_type
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1036

    		
    
      
# File 'sig/client.rbs', line 1036

def update_server: (

    		
  





    
      

  

  
    #update_user(params = {})  ⇒ Types::UpdateUserResponse 
  

  

  




  

    
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.


In the console, you can select Restricted when you create or update
a user. This ensures that the user can't access anything outside of
their home directory. The programmatic way to configure this behavior
is to update the user. Set their HomeDirectoryType to LOGICAL, and
specify HomeDirectoryMappings with Entry as root (/) and
Target as their home directory.


For example, if the user's home directory is /test/admin-user, the
following command updates the user so that their configuration in the
console shows the Restricted flag as selected.


 aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{"Entry":"/", "Target":"/test/admin-user"}]"


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_user({
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
      type: "FILE", # accepts FILE, DIRECTORY
    },
  ],
  policy: "Policy",
  posix_profile: {
    uid: 1, # required
    gid: 1, # required
    secondary_gids: [1],
  },
  role: "Role",
  server_id: "ServerId", # required
  user_name: "UserName", # required
})

    
      
        
Response structure

      
      

resp.server_id #=> String
resp.user_name #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :home_directory
          (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.
    

     You can use the HomeDirectory parameter for HomeDirectoryType when
it is set to either PATH or LOGICAL.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_type
          (String)
          
            
          
          
            — 
    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.
    
 
    
          
        
    • 
      
        
  • 
          :home_directory_mappings
          (Array<Types::HomeDirectoryMapEntry>)
          
            
          
          
            — 
    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" } ]
    
          
        
    • 
      
        
  • 
          :policy
          (String)
          
            
          
          
            — 
    A session policy for your user so that you can use the same Identity
and Access Management (IAM) role across multiple users. This policy
scopes down a user's access to portions of their Amazon S3 bucket.
Variables that you can use inside this policy include
${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
    

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

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

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

    For more information, see AssumeRole in the Amazon Web Services
Security Token Service API Reference.
    
 
    
          
        
    • 
      
        
  • 
          :posix_profile
          (Types::PosixProfile)
          
            
          
          
            — 
    Specifies the full POSIX identity, including user ID (Uid), group ID
(Gid), and any secondary groups IDs (SecondaryGids), that controls
your users' access to your Amazon Elastic File Systems (Amazon EFS).
The POSIX permissions that are set on files and directories in your
file system determines the level of access your users get when
transferring files into and out of your Amazon EFS file systems.
    
          
        
    • 
      
        
  • 
          :role
          (String)
          
            
          
          
            — 
    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.
    
          
        
    • 
      
        
  • 
          :server_id
          (required, String)
          
            
          
          
            — 
    A system-assigned unique identifier for a Transfer Family server
instance that the user is assigned to.
    
          
        
    • 
      
        
  • 
          :user_name
          (required, String)
          
            
          
          
            — 
    A unique string that identifies a user and is associated with a server
as specified by the ServerId. This user name must be a minimum of 3
and a maximum of 100 characters long. The following are valid
characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period
'.', and at sign '@'. The user name can't start with a hyphen,
period, or at sign.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1077

    		
    
      
# File 'sig/client.rbs', line 1077

def update_user: (

    		
  





    
      

  

  
    #update_web_app(params = {})  ⇒ Types::UpdateWebAppResponse 
  

  

  




  

    
Assigns new properties to a web app. You can modify the access point,
identity provider details, endpoint configuration, and the web app
units.


For more information about using VPC endpoints with Transfer Family,
see Create a Transfer Family web app in a VPC.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_web_app({
  web_app_id: "WebAppId", # required
  identity_provider_details: {
    identity_center_config: {
      role: "Role",
    },
  },
  access_endpoint: "WebAppAccessEndpoint",
  web_app_units: {
    provisioned: 1,
  },
  endpoint_details: {
    vpc: {
      subnet_ids: ["SubnetId"],
      ip_address_type: "IPV4", # accepts IPV4, DUALSTACK
    },
  },
})

    
      
        
Response structure

      
      

resp.web_app_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :web_app_id
          (required, String)
          
            
          
          
            — 
    Provide the identifier of the web app that you are updating.
    
          
        
    • 
      
        
  • 
          :identity_provider_details
          (Types::UpdateWebAppIdentityProviderDetails)
          
            
          
          
            — 
    Provide updated identity provider values in a
WebAppIdentityProviderDetails object.
    
          
        
    • 
      
        
  • 
          :access_endpoint
          (String)
          
            
          
          
            — 
    The AccessEndpoint is the URL that you provide to your users for
them to interact with the Transfer Family web app. You can specify a
custom URL or use the default value.
    
          
        
    • 
      
        
  • 
          :web_app_units
          (Types::WebAppUnits)
          
            
          
          
            — 
    A union that contains the value for number of concurrent connections
or the user sessions on your web app.
    
          
        
    • 
      
        
  • 
          :endpoint_details
          (Types::UpdateWebAppEndpointDetails)
          
            
          
          
            — 
    The updated endpoint configuration for the web app. You can modify the
endpoint type and VPC configuration settings.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1104

    		
    
      
# File 'sig/client.rbs', line 1104

def update_web_app: (

    		
  





    
      

  

  
    #update_web_app_customization(params = {})  ⇒ Types::UpdateWebAppCustomizationResponse 
  

  

  




  

    
Assigns new customization properties to a web app. You can modify the
icon file, logo file, and title.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_web_app_customization({
  web_app_id: "WebAppId", # required
  title: "WebAppTitle",
  logo_file: "data",
  favicon_file: "data",
})

    
      
        
Response structure

      
      

resp.web_app_id #=> String

    
  


  

Parameters:


    
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :web_app_id
          (required, String)
          
            
          
          
            — 
    Provide the identifier of the web app that you are updating.
    
          
        
    • 
      
        
  • 
          :title
          (String)
          
            
          
          
            — 
    Provide an updated title.
    
          
        
    • 
      
        
  • 
          :logo_file
          (String, StringIO, File)
          
            
          
          
            — 
    Specify logo file data string (in base64 encoding).
    
          
        
    • 
      
        
  • 
          :favicon_file
          (String, StringIO, File)
          
            
          
          
            — 
    Specify an icon file data string (in base64 encoding).
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1129

    		
    
      
# File 'sig/client.rbs', line 1129

def update_web_app_customization: (

    		
  





    
      

  

  
    #wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean 
  

  

  




  

    
Polls an API operation until a resource enters a desired state.


Basic Usage


A waiter will call an API operation until:


    

  • It is successful
    • 

  • It enters a terminal state
    • 

  • It makes the maximum number of attempts
    • 



In between attempts, the waiter will sleep.


# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)



Configuration


You can configure the maximum number of polling attempts, and the
delay (in seconds) between each polling attempt. You can pass
configuration as the final arguments hash.


# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})



Callbacks


You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.


started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})



Handling Errors


When a waiter is unsuccessful, it will raise an error.
All of the failure errors extend from
Waiters::Errors::WaiterFailed.


begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end



Valid Waiters


The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.






waiter_name
params
:delay
:max_attempts






server_offline
#describe_server
30
120




server_online
#describe_server
30
120






  





  
Parameters:


    
  
    
  • 
      
        waiter_name
      
      
        (Symbol)
      
      
      
    
    • 
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  
    
  • 
      
        options
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
    
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :max_attempts
          (Integer)
          
            
          
          
        
    • 
      
        
  • 
          :delay
          (Integer)
          
            
          
          
        
    • 
      
        
  • 
          :before_attempt
          (Proc)
          
            
          
          
        
    • 
      
        
  • 
          :before_wait
          (Proc)
          
            
          
          
        
    • 
      
    

  


Yields:


    
  
    
  • 
      
      
        (w.waiter)
      
      
      
    
    • 
  



Returns:


    
  
    
  • 
      
      
        (Boolean)
      
      
      
        —
        
    Returns true if the waiter was successful.
    
      
    
    • 
  



Raises:


    
  
    
  • 
      
      
        (Errors::FailureStateError)
      
      
      
        —
        
    Raised when the waiter terminates
because the waiter has entered a state that it will not transition
out of, preventing success.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::TooManyAttemptsError)
      
      
      
        —
        
    Raised when the configured
maximum number of attempts have been made, and the waiter is not
yet successful.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::UnexpectedError)
      
      
      
        —
        
    Raised when an error is encounted
while polling for a resource that is not expected.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::NoSuchWaiterError)
      
      
      
        —
        
    Raised when you request to wait
for an unknown state.
    
      
    
    • 
  





  

    
      


1138

    		
    
      
# File 'sig/client.rbs', line 1138

def wait_until: (:server_offline waiter_name,

    		
  





    
      

  

  
    #waiter_names  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.



Deprecated. 



  





  



  

    
      


5884
5885
5886

    		
    
      
# File 'lib/aws-sdk-transfer/client.rb', line 5884

def waiter_names
  waiters.keys
end