1157 lines
49 KiB
JSON
1157 lines
49 KiB
JSON
|
{
|
|||
|
|
"version":"2.0",
|
|||
|
|
"metadata":{
|
|||
|
|
"apiVersion":"2018-11-05",
|
|||
|
|
"endpointPrefix":"transfer",
|
|||
|
|
"jsonVersion":"1.1",
|
|||
|
|
"protocol":"json",
|
|||
|
|
"serviceAbbreviation":"AWS Transfer",
|
|||
|
|
"serviceFullName":"AWS Transfer for SFTP",
|
|||
|
|
"serviceId":"Transfer",
|
|||
|
|
"signatureVersion":"v4",
|
|||
|
|
"signingName":"transfer",
|
|||
|
|
"targetPrefix":"TransferService",
|
|||
|
|
"uid":"transfer-2018-11-05"
|
|||
|
|
},
|
|||
|
|
"operations":{
|
|||
|
|
"CreateServer":{
|
|||
|
|
"name":"CreateServer",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"CreateServerRequest"},
|
|||
|
|
"output":{"shape":"CreateServerResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the <code>ServerId</code> property assigned by the service to the newly created server. Reference this <code>ServerId</code> property when you make updates to your server, or work with users.</p> <p>The response returns the <code>ServerId</code> value for the newly created server.</p>"
|
|||
|
|
},
|
|||
|
|
"CreateUser":{
|
|||
|
|
"name":"CreateUser",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"CreateUserRequest"},
|
|||
|
|
"output":{"shape":"CreateUserResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceExistsException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.</p> <p>The response returns the <code>UserName</code> and <code>ServerId</code> values of the new user for that server.</p>"
|
|||
|
|
},
|
|||
|
|
"DeleteServer":{
|
|||
|
|
"name":"DeleteServer",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"DeleteServerRequest"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used <code>SERVICE_MANAGED</code> as your <code>IdentityProviderType</code>, you need to delete all users associated with this server before deleting the server itself</p> <p>No response returns from this call.</p>"
|
|||
|
|
},
|
|||
|
|
"DeleteSshPublicKey":{
|
|||
|
|
"name":"DeleteSshPublicKey",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"DeleteSshPublicKeyRequest"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Deletes a user's Secure Shell (SSH) public key.</p> <p>No response is returned from this call.</p>"
|
|||
|
|
},
|
|||
|
|
"DeleteUser":{
|
|||
|
|
"name":"DeleteUser",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"DeleteUserRequest"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Deletes the user belonging to the server you specify.</p> <p>No response returns from this call.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note>"
|
|||
|
|
},
|
|||
|
|
"DescribeServer":{
|
|||
|
|
"name":"DescribeServer",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"DescribeServerRequest"},
|
|||
|
|
"output":{"shape":"DescribeServerResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Describes the server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of the server's properties.</p>"
|
|||
|
|
},
|
|||
|
|
"DescribeUser":{
|
|||
|
|
"name":"DescribeUser",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"DescribeUserRequest"},
|
|||
|
|
"output":{"shape":"DescribeUserResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Describes the user assigned to a specific server, as identified by its <code>ServerId</code> property.</p> <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p>"
|
|||
|
|
},
|
|||
|
|
"ImportSshPublicKey":{
|
|||
|
|
"name":"ImportSshPublicKey",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"ImportSshPublicKeyRequest"},
|
|||
|
|
"output":{"shape":"ImportSshPublicKeyResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceExistsException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Adds a Secure Shell (SSH) public key to a user account identified by a <code>UserName</code> value assigned to a specific server, identified by <code>ServerId</code>.</p> <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and the name of the <code>SshPublicKeyId</code>.</p>"
|
|||
|
|
},
|
|||
|
|
"ListServers":{
|
|||
|
|
"name":"ListServers",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"ListServersRequest"},
|
|||
|
|
"output":{"shape":"ListServersResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidNextTokenException"},
|
|||
|
|
{"shape":"InvalidRequestException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.</p>"
|
|||
|
|
},
|
|||
|
|
"ListTagsForResource":{
|
|||
|
|
"name":"ListTagsForResource",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"ListTagsForResourceRequest"},
|
|||
|
|
"output":{"shape":"ListTagsForResourceResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidNextTokenException"},
|
|||
|
|
{"shape":"InvalidRequestException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.</p>"
|
|||
|
|
},
|
|||
|
|
"ListUsers":{
|
|||
|
|
"name":"ListUsers",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"ListUsersRequest"},
|
|||
|
|
"output":{"shape":"ListUsersResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidNextTokenException"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Lists the users for the server that you specify by passing the <code>ServerId</code> parameter.</p>"
|
|||
|
|
},
|
|||
|
|
"StartServer":{
|
|||
|
|
"name":"StartServer",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"StartServerRequest"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Changes the state of a Secure File Transfer Protocol (SFTP) server from <code>OFFLINE</code> to <code>ONLINE</code>. It has no impact on an SFTP server that is already <code>ONLINE</code>. An <code>ONLINE</code> server can accept and process file transfer jobs.</p> <p>The state of <code>STARTING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of <code>START_FAILED</code> can indicate an error condition. </p> <p>No response is returned from this call.</p>"
|
|||
|
|
},
|
|||
|
|
"StopServer":{
|
|||
|
|
"name":"StopServer",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"StopServerRequest"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Changes the state of an SFTP server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.</p> <p>The states of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>"
|
|||
|
|
},
|
|||
|
|
"TagResource":{
|
|||
|
|
"name":"TagResource",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"TagResourceRequest"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>There is no response returned from this call.</p>"
|
|||
|
|
},
|
|||
|
|
"TestIdentityProvider":{
|
|||
|
|
"name":"TestIdentityProvider",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"TestIdentityProviderRequest"},
|
|||
|
|
"output":{"shape":"TestIdentityProviderResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>If the <code>IdentityProviderType</code> of the server is <code>API_Gateway</code>, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.</p>"
|
|||
|
|
},
|
|||
|
|
"UntagResource":{
|
|||
|
|
"name":"UntagResource",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"UntagResourceRequest"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.</p> <p>No response is returned from this call.</p>"
|
|||
|
|
},
|
|||
|
|
"UpdateServer":{
|
|||
|
|
"name":"UpdateServer",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"UpdateServerRequest"},
|
|||
|
|
"output":{"shape":"UpdateServerResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Updates the server properties after that server has been created.</p> <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the Secure File Transfer Protocol (SFTP) server you updated.</p>"
|
|||
|
|
},
|
|||
|
|
"UpdateUser":{
|
|||
|
|
"name":"UpdateUser",
|
|||
|
|
"http":{
|
|||
|
|
"method":"POST",
|
|||
|
|
"requestUri":"/"
|
|||
|
|
},
|
|||
|
|
"input":{"shape":"UpdateUserRequest"},
|
|||
|
|
"output":{"shape":"UpdateUserResponse"},
|
|||
|
|
"errors":[
|
|||
|
|
{"shape":"ServiceUnavailableException"},
|
|||
|
|
{"shape":"InternalServiceError"},
|
|||
|
|
{"shape":"InvalidRequestException"},
|
|||
|
|
{"shape":"ResourceNotFoundException"}
|
|||
|
|
],
|
|||
|
|
"documentation":"<p>Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code> you specify.</p> <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"shapes":{
|
|||
|
|
"Arn":{
|
|||
|
|
"type":"string",
|
|||
|
|
"max":1600,
|
|||
|
|
"min":20
|
|||
|
|
},
|
|||
|
|
"CreateServerRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"members":{
|
|||
|
|
"IdentityProviderDetails":{
|
|||
|
|
"shape":"IdentityProviderDetails",
|
|||
|
|
"documentation":"<p> An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the <code>IdentityProviderType</code> value of server that is created uses the <code>SERVICE_MANAGED</code> authentication method.</p>"
|
|||
|
|
},
|
|||
|
|
"IdentityProviderType":{
|
|||
|
|
"shape":"IdentityProviderType",
|
|||
|
|
"documentation":"<p>The mode of authentication enabled for this service. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access SFTP user credentials within the service. An <code>IdentityProviderType</code> value of <code>API_GATEWAY</code> indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.</p>"
|
|||
|
|
},
|
|||
|
|
"LoggingRole":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>A value that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.</p>"
|
|||
|
|
},
|
|||
|
|
"Tags":{
|
|||
|
|
"shape":"Tags",
|
|||
|
|
"documentation":"<p>Key-value pairs that can be used to group and search for servers.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"CreateServerResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>The service-assigned ID of the SFTP server that is created.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"CreateUserRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"Role",
|
|||
|
|
"ServerId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"HomeDirectory":{
|
|||
|
|
"shape":"HomeDirectory",
|
|||
|
|
"documentation":"<p>The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <code>/home/<i>username</i> </code>.</p>"
|
|||
|
|
},
|
|||
|
|
"Policy":{
|
|||
|
|
"shape":"Policy",
|
|||
|
|
"documentation":"<p>A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>"
|
|||
|
|
},
|
|||
|
|
"Role":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>The IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user’s transfer requests.</p>"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyBody":{
|
|||
|
|
"shape":"SshPublicKeyBody",
|
|||
|
|
"documentation":"<p>The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.</p>"
|
|||
|
|
},
|
|||
|
|
"Tags":{
|
|||
|
|
"shape":"Tags",
|
|||
|
|
"documentation":"<p>Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"CreateUserResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>The ID of the SFTP server that the user is attached to.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>A unique string that identifies a user account associated with an SFTP server.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DateImported":{"type":"timestamp"},
|
|||
|
|
"DeleteServerRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A unique system-assigned identifier for an SFTP server instance.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DeleteSshPublicKeyRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"SshPublicKeyId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyId":{
|
|||
|
|
"shape":"SshPublicKeyId",
|
|||
|
|
"documentation":"<p>A unique identifier used to reference your user’s specific SSH key.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>A unique string that identifies a user whose public key is being deleted.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DeleteUserRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>A unique string that identifies a user that is being deleted from the server.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DescribeServerRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DescribeServerResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Server"],
|
|||
|
|
"members":{
|
|||
|
|
"Server":{
|
|||
|
|
"shape":"DescribedServer",
|
|||
|
|
"documentation":"<p>An array containing the properties of the server with the <code>ServerID</code> you specified.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DescribeUserRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server that has this user assigned.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer service and perform file transfer tasks.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DescribeUserResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"User"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server that has this user assigned.</p>"
|
|||
|
|
},
|
|||
|
|
"User":{
|
|||
|
|
"shape":"DescribedUser",
|
|||
|
|
"documentation":"<p>An array containing the properties of the user account for the <code>ServerID</code> value that you specified.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"DescribedServer":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Arn"],
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>Specifies the unique Amazon Resource Name (ARN) for the server to be described.</p>"
|
|||
|
|
},
|
|||
|
|
"IdentityProviderDetails":{
|
|||
|
|
"shape":"IdentityProviderDetails",
|
|||
|
|
"documentation":"<p>Specifies information to call a customer-supplied authentication API. This field is not populated when the <code>IdentityProviderType</code> of the server is <code>SERVICE_MANAGED</code>>.</p>"
|
|||
|
|
},
|
|||
|
|
"IdentityProviderType":{
|
|||
|
|
"shape":"IdentityProviderType",
|
|||
|
|
"documentation":"<p>This property defines the mode of authentication method enabled for this service. A value of <code>SERVICE_MANAGED</code>, means that you are using this Server to store and access SFTP user credentials within the service. A value of <code>API_GATEWAY</code> indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.</p>"
|
|||
|
|
},
|
|||
|
|
"LoggingRole":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.</p>"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>This property is a unique system assigned identifier for the SFTP server that you instantiate.</p>"
|
|||
|
|
},
|
|||
|
|
"State":{
|
|||
|
|
"shape":"State",
|
|||
|
|
"documentation":"<p>The condition of the SFTP server for the server that was described. A value of <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>"
|
|||
|
|
},
|
|||
|
|
"Tags":{
|
|||
|
|
"shape":"Tags",
|
|||
|
|
"documentation":"<p>This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.</p>"
|
|||
|
|
},
|
|||
|
|
"UserCount":{
|
|||
|
|
"shape":"UserCount",
|
|||
|
|
"documentation":"<p>The number of users that are assigned to the SFTP server you specified with the <code>ServerId</code>.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>Describe the properties of the server that was specified. Information returned includes: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, server Id and state, and assigned tags or metadata. </p>"
|
|||
|
|
},
|
|||
|
|
"DescribedUser":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Arn"],
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.</p>"
|
|||
|
|
},
|
|||
|
|
"HomeDirectory":{
|
|||
|
|
"shape":"HomeDirectory",
|
|||
|
|
"documentation":"<p>This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: <code>/<i>bucket_name</i>/home/<i>username</i> </code>.</p>"
|
|||
|
|
},
|
|||
|
|
"Policy":{
|
|||
|
|
"shape":"Policy",
|
|||
|
|
"documentation":"<p>Specifies the name of the policy in use for the described user.</p>"
|
|||
|
|
},
|
|||
|
|
"Role":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>This property specifies the IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user’s transfer requests.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeys":{
|
|||
|
|
"shape":"SshPublicKeys",
|
|||
|
|
"documentation":"<p>This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.</p>"
|
|||
|
|
},
|
|||
|
|
"Tags":{
|
|||
|
|
"shape":"Tags",
|
|||
|
|
"documentation":"<p>This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>Returns properties of the user that you wish to describe.</p>"
|
|||
|
|
},
|
|||
|
|
"HomeDirectory":{
|
|||
|
|
"type":"string",
|
|||
|
|
"max":1024,
|
|||
|
|
"pattern":"^$|/.*"
|
|||
|
|
},
|
|||
|
|
"IdentityProviderDetails":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"members":{
|
|||
|
|
"Url":{
|
|||
|
|
"shape":"Url",
|
|||
|
|
"documentation":"<p>The <code>IdentityProviderDetail</code> parameter contains the location of the service endpoint used to authenticate users.</p>"
|
|||
|
|
},
|
|||
|
|
"InvocationRole":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>The <code>Role</code> parameter provides the type of <code>InvocationRole</code> used to authenticate the user account.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>Returns information related to the type of user authentication that is in use for a server's users. A server can only have one method of authentication.</p>"
|
|||
|
|
},
|
|||
|
|
"IdentityProviderType":{
|
|||
|
|
"type":"string",
|
|||
|
|
"documentation":"<p>Returns information related to the type of user authentication that is in use for a server's users. For <code>SERVICE_MANAGED</code> authentication, the Secure Shell (SSH) public keys are stored with a user on an SFTP server instance. For <code>API_GATEWAY</code> authentication, your custom authentication method is implemented by using an API call. A server can only have one method of authentication.</p>",
|
|||
|
|
"enum":[
|
|||
|
|
"SERVICE_MANAGED",
|
|||
|
|
"API_GATEWAY"
|
|||
|
|
]
|
|||
|
|
},
|
|||
|
|
"ImportSshPublicKeyRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"SshPublicKeyBody",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyBody":{
|
|||
|
|
"shape":"SshPublicKeyBody",
|
|||
|
|
"documentation":"<p>The public key portion of an SSH key pair.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>The name of the user account that is assigned to one or more servers.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"ImportSshPublicKeyResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"SshPublicKeyId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyId":{
|
|||
|
|
"shape":"SshPublicKeyId",
|
|||
|
|
"documentation":"<p>This identifier is the name given to a public key by the system that was imported.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>A user name assigned to the <code>ServerID</code> value that you specified.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>This response identifies the user, server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associate with.</p>"
|
|||
|
|
},
|
|||
|
|
"InternalServiceError":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Message"],
|
|||
|
|
"members":{
|
|||
|
|
"Message":{"shape":"Message"}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>This exception is thrown when an error occurs in the AWS Transfer for SFTP service.</p>",
|
|||
|
|
"exception":true,
|
|||
|
|
"fault":true
|
|||
|
|
},
|
|||
|
|
"InvalidNextTokenException":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Message"],
|
|||
|
|
"members":{
|
|||
|
|
"Message":{"shape":"Message"}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>The <code>NextToken</code> parameter that was passed is invalid.</p>",
|
|||
|
|
"exception":true
|
|||
|
|
},
|
|||
|
|
"InvalidRequestException":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Message"],
|
|||
|
|
"members":{
|
|||
|
|
"Message":{"shape":"Message"}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>This exception is thrown when the client submits a malformed request.</p>",
|
|||
|
|
"exception":true
|
|||
|
|
},
|
|||
|
|
"ListServersRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"members":{
|
|||
|
|
"MaxResults":{
|
|||
|
|
"shape":"MaxResults",
|
|||
|
|
"documentation":"<p>Specifies the number of servers to return as a response to the <code>ListServers</code> query.</p>"
|
|||
|
|
},
|
|||
|
|
"NextToken":{
|
|||
|
|
"shape":"NextToken",
|
|||
|
|
"documentation":"<p>When additional results are obtained from the ListServers command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional servers.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"ListServersResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Servers"],
|
|||
|
|
"members":{
|
|||
|
|
"NextToken":{
|
|||
|
|
"shape":"NextToken",
|
|||
|
|
"documentation":"<p>When you can get additional results from the <code>ListServers</code> operation, a <code>NextToken</code> parameter is returned in the output. In a following command, you can pass in the <code>NextToken</code> parameter to continue listing additional servers.</p>"
|
|||
|
|
},
|
|||
|
|
"Servers":{
|
|||
|
|
"shape":"ListedServers",
|
|||
|
|
"documentation":"<p>An array of servers that were listed.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"ListTagsForResourceRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Arn"],
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.</p>"
|
|||
|
|
},
|
|||
|
|
"MaxResults":{"shape":"MaxResults"},
|
|||
|
|
"NextToken":{"shape":"NextToken"}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"ListTagsForResourceResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>This value is the ARN you specified to list the tags of.</p>"
|
|||
|
|
},
|
|||
|
|
"NextToken":{"shape":"NextToken"},
|
|||
|
|
"Tags":{
|
|||
|
|
"shape":"Tags",
|
|||
|
|
"documentation":"<p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define that you can use for any purpose.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"ListUsersRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"MaxResults":{
|
|||
|
|
"shape":"MaxResults",
|
|||
|
|
"documentation":"<p>Specifies the number of users to return as a response to the <code>ListUsers</code> request.</p>"
|
|||
|
|
},
|
|||
|
|
"NextToken":{
|
|||
|
|
"shape":"NextToken",
|
|||
|
|
"documentation":"<p>When you can get additional results from the <code>ListUsers</code>ListUsers call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command the <code>NextToken</code> parameter to continue listing additional users.</p>"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"ListUsersResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"Users"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"NextToken":{
|
|||
|
|
"shape":"NextToken",
|
|||
|
|
"documentation":"<p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command the <code>NextToken</code> parameter to continue listing additional users.</p>"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server that the users are assigned to.</p>"
|
|||
|
|
},
|
|||
|
|
"Users":{
|
|||
|
|
"shape":"ListedUsers",
|
|||
|
|
"documentation":"<p>Returns the user accounts and their properties for the <code>ServerId</code> value that you specify.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"ListedServer":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Arn"],
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>The unique Amazon Resource Name (ARN) for the server to be listed.</p>"
|
|||
|
|
},
|
|||
|
|
"IdentityProviderType":{
|
|||
|
|
"shape":"IdentityProviderType",
|
|||
|
|
"documentation":"<p>The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include <code>SERVICE_MANAGED</code> or <code>API_GATEWAY</code>.</p>"
|
|||
|
|
},
|
|||
|
|
"LoggingRole":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.</p>"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>This value is the unique system assigned identifier for the SFTP servers that were listed.</p>"
|
|||
|
|
},
|
|||
|
|
"State":{
|
|||
|
|
"shape":"State",
|
|||
|
|
"documentation":"<p>This property describes the condition of the SFTP server for the server that was described. A value of <code>ONLINE</code>> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>"
|
|||
|
|
},
|
|||
|
|
"UserCount":{
|
|||
|
|
"shape":"UserCount",
|
|||
|
|
"documentation":"<p>This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the <code>ServerId</code>.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>Returns properties of the server that was specified.</p>"
|
|||
|
|
},
|
|||
|
|
"ListedServers":{
|
|||
|
|
"type":"list",
|
|||
|
|
"member":{"shape":"ListedServer"}
|
|||
|
|
},
|
|||
|
|
"ListedUser":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["Arn"],
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>This property is the unique Amazon Resource Name (ARN) for the user that you wish to learn about.</p>"
|
|||
|
|
},
|
|||
|
|
"HomeDirectory":{
|
|||
|
|
"shape":"HomeDirectory",
|
|||
|
|
"documentation":"<p>This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.</p>"
|
|||
|
|
},
|
|||
|
|
"Role":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>The role in use by this user. A <i>role</i> is an AWS Identity and Access Management (IAM) entity that in this case allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyCount":{
|
|||
|
|
"shape":"SshPublicKeyCount",
|
|||
|
|
"documentation":"<p>This value is the number of SSH public keys stored for the user you specified.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>The name of the user whose ARN was specified. User names are used for authentication purposes.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>Returns properties of the user that you specify.</p>"
|
|||
|
|
},
|
|||
|
|
"ListedUsers":{
|
|||
|
|
"type":"list",
|
|||
|
|
"member":{"shape":"ListedUser"}
|
|||
|
|
},
|
|||
|
|
"MaxResults":{
|
|||
|
|
"type":"integer",
|
|||
|
|
"max":1000,
|
|||
|
|
"min":1
|
|||
|
|
},
|
|||
|
|
"Message":{"type":"string"},
|
|||
|
|
"NextToken":{
|
|||
|
|
"type":"string",
|
|||
|
|
"max":256,
|
|||
|
|
"min":1
|
|||
|
|
},
|
|||
|
|
"NullableRole":{
|
|||
|
|
"type":"string",
|
|||
|
|
"pattern":"^$|arn:.*role/.*"
|
|||
|
|
},
|
|||
|
|
"Policy":{"type":"string"},
|
|||
|
|
"Resource":{"type":"string"},
|
|||
|
|
"ResourceExistsException":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"Message",
|
|||
|
|
"Resource",
|
|||
|
|
"ResourceType"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"Message":{"shape":"Message"},
|
|||
|
|
"Resource":{"shape":"Resource"},
|
|||
|
|
"ResourceType":{"shape":"ResourceType"}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>The requested resource does not exist.</p>",
|
|||
|
|
"exception":true
|
|||
|
|
},
|
|||
|
|
"ResourceNotFoundException":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"Message",
|
|||
|
|
"Resource",
|
|||
|
|
"ResourceType"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"Message":{"shape":"Message"},
|
|||
|
|
"Resource":{"shape":"Resource"},
|
|||
|
|
"ResourceType":{"shape":"ResourceType"}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.</p>",
|
|||
|
|
"exception":true
|
|||
|
|
},
|
|||
|
|
"ResourceType":{"type":"string"},
|
|||
|
|
"Role":{
|
|||
|
|
"type":"string",
|
|||
|
|
"pattern":"arn:.*role/.*"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"type":"string",
|
|||
|
|
"pattern":"^s-([0-9a-f]{17})$"
|
|||
|
|
},
|
|||
|
|
"ServiceErrorMessage":{"type":"string"},
|
|||
|
|
"ServiceUnavailableException":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"members":{
|
|||
|
|
"Message":{"shape":"ServiceErrorMessage"}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>The request has failed because the AWS Transfer for SFTP service is not available.</p>",
|
|||
|
|
"exception":true,
|
|||
|
|
"fault":true,
|
|||
|
|
"synthetic":true
|
|||
|
|
},
|
|||
|
|
"SshPublicKey":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"DateImported",
|
|||
|
|
"SshPublicKeyBody",
|
|||
|
|
"SshPublicKeyId"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"DateImported":{
|
|||
|
|
"shape":"DateImported",
|
|||
|
|
"documentation":"<p>The date that the public key was added to the user account.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyBody":{
|
|||
|
|
"shape":"SshPublicKeyBody",
|
|||
|
|
"documentation":"<p>The content of the SSH public key as specified by the <code>PublicKeyId</code>.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyId":{
|
|||
|
|
"shape":"SshPublicKeyId",
|
|||
|
|
"documentation":"<p>The <code>SshPublicKeyId</code> parameter contains the identifier of the public key.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>Provides information about the public Secure Shell (SSH) key that is associated with a user account for a specific server (as identified by <code>ServerId</code>). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific SFTP server.</p>"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyBody":{
|
|||
|
|
"type":"string",
|
|||
|
|
"max":2048,
|
|||
|
|
"pattern":"^ssh-rsa\\s+[A-Za-z0-9+/]+[=]{0,3}(\\s+.+)?\\s*$"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeyCount":{"type":"integer"},
|
|||
|
|
"SshPublicKeyId":{
|
|||
|
|
"type":"string",
|
|||
|
|
"pattern":"^key-[0-9a-f]{17}$"
|
|||
|
|
},
|
|||
|
|
"SshPublicKeys":{
|
|||
|
|
"type":"list",
|
|||
|
|
"member":{"shape":"SshPublicKey"},
|
|||
|
|
"max":5
|
|||
|
|
},
|
|||
|
|
"StartServerRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server that you start.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"State":{
|
|||
|
|
"type":"string",
|
|||
|
|
"documentation":"<p>Describes the condition of the SFTP server with respect to its ability to perform file operations. There are six possible states: <code>OFFLINE</code>, <code>ONLINE</code>, <code>STARTING</code>, <code>STOPPING</code>, <code>START_FAILED</code>, and <code>STOP_FAILED</code>.</p> <p> <code>OFFLINE</code> indicates that the SFTP server exists, but that it is not available for file operations. <code>ONLINE</code> indicates that the SFTP server is available to perform file operations. <code>STARTING</code> indicates that the SFTP server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for an SFTP server to be completely operational. Both <code>START_FAILED</code> and <code>STOP_FAILED</code> are error conditions.</p>",
|
|||
|
|
"enum":[
|
|||
|
|
"OFFLINE",
|
|||
|
|
"ONLINE",
|
|||
|
|
"STARTING",
|
|||
|
|
"STOPPING",
|
|||
|
|
"START_FAILED",
|
|||
|
|
"STOP_FAILED"
|
|||
|
|
]
|
|||
|
|
},
|
|||
|
|
"StatusCode":{"type":"integer"},
|
|||
|
|
"StopServerRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server that you stopped.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"Tag":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"Key",
|
|||
|
|
"Value"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"Key":{
|
|||
|
|
"shape":"TagKey",
|
|||
|
|
"documentation":"<p>The name assigned to the tag that you create.</p>"
|
|||
|
|
},
|
|||
|
|
"Value":{
|
|||
|
|
"shape":"TagValue",
|
|||
|
|
"documentation":"<p>This property contains one or more values that you assigned to the key name you create.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p>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 <code>Group</code> and assign the values <code>Research</code> and <code>Accounting</code> to that group.</p>"
|
|||
|
|
},
|
|||
|
|
"TagKey":{"type":"string"},
|
|||
|
|
"TagKeys":{
|
|||
|
|
"type":"list",
|
|||
|
|
"member":{"shape":"TagKey"},
|
|||
|
|
"max":50,
|
|||
|
|
"min":1
|
|||
|
|
},
|
|||
|
|
"TagResourceRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"Arn",
|
|||
|
|
"Tags"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.</p>"
|
|||
|
|
},
|
|||
|
|
"Tags":{
|
|||
|
|
"shape":"Tags",
|
|||
|
|
"documentation":"<p>Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"TagValue":{"type":"string"},
|
|||
|
|
"Tags":{
|
|||
|
|
"type":"list",
|
|||
|
|
"member":{"shape":"Tag"},
|
|||
|
|
"max":50,
|
|||
|
|
"min":1
|
|||
|
|
},
|
|||
|
|
"TestIdentityProviderRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>This request parameter is name of the user account to be tested.</p>"
|
|||
|
|
},
|
|||
|
|
"UserPassword":{
|
|||
|
|
"shape":"UserPassword",
|
|||
|
|
"documentation":"<p>The password of the user account to be tested.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"TestIdentityProviderResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"StatusCode",
|
|||
|
|
"Url"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"Message":{
|
|||
|
|
"shape":"Message",
|
|||
|
|
"documentation":"<p>The result of the authorization test as a message. </p>"
|
|||
|
|
},
|
|||
|
|
"StatusCode":{
|
|||
|
|
"shape":"StatusCode",
|
|||
|
|
"documentation":"<p>The HTTP status code that is the response from your API Gateway.</p>"
|
|||
|
|
},
|
|||
|
|
"Url":{
|
|||
|
|
"shape":"Url",
|
|||
|
|
"documentation":"<p>The endpoint of the service used to authenticate a user.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"UntagResourceRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"Arn",
|
|||
|
|
"TagKeys"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"Arn":{
|
|||
|
|
"shape":"Arn",
|
|||
|
|
"documentation":"<p>This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.</p>"
|
|||
|
|
},
|
|||
|
|
"TagKeys":{
|
|||
|
|
"shape":"TagKeys",
|
|||
|
|
"documentation":"<p>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.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"UpdateServerRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"IdentityProviderDetails":{
|
|||
|
|
"shape":"IdentityProviderDetails",
|
|||
|
|
"documentation":"<p>This response parameter is an array containing all of the information required to call a customer's authentication API method.</p>"
|
|||
|
|
},
|
|||
|
|
"LoggingRole":{
|
|||
|
|
"shape":"NullableRole",
|
|||
|
|
"documentation":"<p>Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.</p>"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"UpdateServerResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":["ServerId"],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server that the user account is assigned to.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"UpdateUserRequest":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"HomeDirectory":{
|
|||
|
|
"shape":"HomeDirectory",
|
|||
|
|
"documentation":"<p>The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: <code>/home/<i>username</i> </code>.</p>"
|
|||
|
|
},
|
|||
|
|
"Policy":{
|
|||
|
|
"shape":"Policy",
|
|||
|
|
"documentation":"<p>Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>"
|
|||
|
|
},
|
|||
|
|
"Role":{
|
|||
|
|
"shape":"Role",
|
|||
|
|
"documentation":"<p>The IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user’s transfer requests.</p>"
|
|||
|
|
},
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server.</p>"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"UpdateUserResponse":{
|
|||
|
|
"type":"structure",
|
|||
|
|
"required":[
|
|||
|
|
"ServerId",
|
|||
|
|
"UserName"
|
|||
|
|
],
|
|||
|
|
"members":{
|
|||
|
|
"ServerId":{
|
|||
|
|
"shape":"ServerId",
|
|||
|
|
"documentation":"<p>A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.</p>"
|
|||
|
|
},
|
|||
|
|
"UserName":{
|
|||
|
|
"shape":"UserName",
|
|||
|
|
"documentation":"<p>The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.</p>"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"documentation":"<p> <code>UpdateUserResponse</code> returns the user name and server identifier for the request to update a user's properties.</p>"
|
|||
|
|
},
|
|||
|
|
"Url":{"type":"string"},
|
|||
|
|
"UserCount":{"type":"integer"},
|
|||
|
|
"UserName":{
|
|||
|
|
"type":"string",
|
|||
|
|
"pattern":"^[a-z0-9]{3,32}$"
|
|||
|
|
},
|
|||
|
|
"UserPassword":{"type":"string"}
|
|||
|
|
}
|
|||
|
|
}
|