[ aws . transfer ]

describe-server

Description

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-server
--server-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--server-id (string)

A system-assigned unique identifier for a file transfer protocol-enabled server.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Server -> (structure)

An array containing the properties of a file transfer protocol-enabled server with the ServerID you specified.

Arn -> (string)

Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.

Certificate -> (string)

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS .

EndpointDetails -> (structure)

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

AddressAllocationIds -> (list)

A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server’s endpoint. This is only valid in the UpdateServer API.

Note

This property can only be use when EndpointType is set to VPC .

(string)

SubnetIds -> (list)

A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

Note

This property can only be used when EndpointType is set to VPC .

(string)

VpcEndpointId -> (string)

The ID of the VPC endpoint.

Note

This property can only be used when EndpointType is set to VPC_ENDPOINT .

VpcId -> (string)

The VPC ID of the VPC in which a file transfer protocol-enabled server’s endpoint will be hosted.

Note

This property can only be used when EndpointType is set to VPC .

EndpointType -> (string)

Defines the type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn’t accessible over the public internet.

HostKeyFingerprint -> (string)

Specifies the Base64-encoded SHA256 fingerprint of the server’s host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

IdentityProviderDetails -> (structure)

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED .

Url -> (string)

Provides the location of the service endpoint used to authenticate users.

InvocationRole -> (string)

Provides the type of InvocationRole used to authenticate the user account.

IdentityProviderType -> (string)

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

LoggingRole -> (string)

Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Protocols -> (list)

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

(string)

ServerId -> (string)

Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

State -> (string)

Specifies the condition of a file transfer protocol-enabled server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

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

Tags -> (list)

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

(structure)

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

Key -> (string)

The name assigned to the tag that you create.

Value -> (string)

Contains one or more values that you assigned to the key name you create.

UserCount -> (integer)

Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId .