aws-sdk 2.658.0 → 2.662.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -1
- package/README.md +1 -1
- package/apis/apigatewayv2-2018-11-29.min.json +51 -0
- package/apis/application-autoscaling-2016-02-06.examples.json +6 -169
- package/apis/ce-2017-10-25.min.json +123 -88
- package/apis/ce-2017-10-25.paginators.json +5 -0
- package/apis/codeguru-reviewer-2019-09-19.min.json +341 -3
- package/apis/codeguru-reviewer-2019-09-19.paginators.json +15 -0
- package/apis/elasticmapreduce-2009-03-31.min.json +98 -17
- package/apis/es-2015-01-01.min.json +3 -0
- package/apis/firehose-2015-08-04.min.json +74 -30
- package/apis/guardduty-2017-11-28.min.json +165 -16
- package/apis/guardduty-2017-11-28.paginators.json +6 -0
- package/apis/iotevents-2018-07-27.min.json +102 -20
- package/apis/mediapackage-vod-2018-11-07.min.json +173 -36
- package/apis/metadata.json +3 -0
- package/apis/pinpoint-2016-12-01.min.json +363 -335
- package/apis/ram-2018-01-04.min.json +30 -0
- package/apis/rds-2014-10-31.min.json +2 -0
- package/apis/redshift-2012-12-01.min.json +154 -46
- package/apis/redshift-2012-12-01.paginators.json +6 -0
- package/apis/route53domains-2014-05-15.min.json +97 -24
- package/apis/storagegateway-2013-06-30.min.json +99 -14
- package/apis/synthetics-2017-10-11.examples.json +5 -0
- package/apis/synthetics-2017-10-11.min.json +578 -0
- package/apis/synthetics-2017-10-11.paginators.json +24 -0
- package/apis/transfer-2018-11-05.min.json +41 -24
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/apigatewayv2.d.ts +40 -2
- package/clients/applicationautoscaling.d.ts +83 -83
- package/clients/codegurureviewer.d.ts +417 -10
- package/clients/costexplorer.d.ts +66 -28
- package/clients/emr.d.ts +91 -6
- package/clients/es.d.ts +4 -0
- package/clients/firehose.d.ts +50 -8
- package/clients/fms.d.ts +6 -6
- package/clients/glue.d.ts +4 -4
- package/clients/guardduty.d.ts +340 -224
- package/clients/iotevents.d.ts +106 -0
- package/clients/mediapackagevod.d.ts +55 -0
- package/clients/pinpoint.d.ts +115 -77
- package/clients/ram.d.ts +41 -2
- package/clients/rds.d.ts +13 -5
- package/clients/redshift.d.ts +162 -1
- package/clients/route53domains.d.ts +140 -47
- package/clients/storagegateway.d.ts +137 -60
- package/clients/synthetics.d.ts +656 -0
- package/clients/synthetics.js +18 -0
- package/clients/transfer.d.ts +154 -123
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +61 -24
- package/dist/aws-sdk.js +664 -222
- package/dist/aws-sdk.min.js +74 -74
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/transfer.d.ts
CHANGED
|
@@ -12,27 +12,27 @@ declare class Transfer extends Service {
|
|
|
12
12
|
constructor(options?: Transfer.Types.ClientConfiguration)
|
|
13
13
|
config: Config & Transfer.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
* Instantiates an autoscaling virtual server based on
|
|
15
|
+
* Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. 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.
|
|
16
16
|
*/
|
|
17
17
|
createServer(params: Transfer.Types.CreateServerRequest, callback?: (err: AWSError, data: Transfer.Types.CreateServerResponse) => void): Request<Transfer.Types.CreateServerResponse, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
* Instantiates an autoscaling virtual server based on
|
|
19
|
+
* Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. 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.
|
|
20
20
|
*/
|
|
21
21
|
createServer(callback?: (err: AWSError, data: Transfer.Types.CreateServerResponse) => void): Request<Transfer.Types.CreateServerResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates a user and associates them with an existing
|
|
23
|
+
* 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 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.
|
|
24
24
|
*/
|
|
25
25
|
createUser(params: Transfer.Types.CreateUserRequest, callback?: (err: AWSError, data: Transfer.Types.CreateUserResponse) => void): Request<Transfer.Types.CreateUserResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Creates a user and associates them with an existing
|
|
27
|
+
* 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 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.
|
|
28
28
|
*/
|
|
29
29
|
createUser(callback?: (err: AWSError, data: Transfer.Types.CreateUserResponse) => void): Request<Transfer.Types.CreateUserResponse, AWSError>;
|
|
30
30
|
/**
|
|
31
|
-
* Deletes the
|
|
31
|
+
* Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation.
|
|
32
32
|
*/
|
|
33
33
|
deleteServer(params: Transfer.Types.DeleteServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
34
34
|
/**
|
|
35
|
-
* Deletes the
|
|
35
|
+
* Deletes the file transfer protocol-enabled server that you specify. No response returns from this operation.
|
|
36
36
|
*/
|
|
37
37
|
deleteServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
38
38
|
/**
|
|
@@ -44,43 +44,43 @@ declare class Transfer extends Service {
|
|
|
44
44
|
*/
|
|
45
45
|
deleteSshPublicKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
46
46
|
/**
|
|
47
|
-
* Deletes the user belonging to
|
|
47
|
+
* 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.
|
|
48
48
|
*/
|
|
49
49
|
deleteUser(params: Transfer.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
50
50
|
/**
|
|
51
|
-
* Deletes the user belonging to
|
|
51
|
+
* 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.
|
|
52
52
|
*/
|
|
53
53
|
deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
54
54
|
/**
|
|
55
|
-
* Describes
|
|
55
|
+
* 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.
|
|
56
56
|
*/
|
|
57
57
|
describeServer(params: Transfer.Types.DescribeServerRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeServerResponse) => void): Request<Transfer.Types.DescribeServerResponse, AWSError>;
|
|
58
58
|
/**
|
|
59
|
-
* Describes
|
|
59
|
+
* 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.
|
|
60
60
|
*/
|
|
61
61
|
describeServer(callback?: (err: AWSError, data: Transfer.Types.DescribeServerResponse) => void): Request<Transfer.Types.DescribeServerResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Describes the user assigned to
|
|
63
|
+
* 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.
|
|
64
64
|
*/
|
|
65
65
|
describeUser(params: Transfer.Types.DescribeUserRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeUserResponse) => void): Request<Transfer.Types.DescribeUserResponse, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Describes the user assigned to
|
|
67
|
+
* 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.
|
|
68
68
|
*/
|
|
69
69
|
describeUser(callback?: (err: AWSError, data: Transfer.Types.DescribeUserResponse) => void): Request<Transfer.Types.DescribeUserResponse, AWSError>;
|
|
70
70
|
/**
|
|
71
|
-
* Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to
|
|
71
|
+
* Adds a Secure Shell (SSH) public key to a user account 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.
|
|
72
72
|
*/
|
|
73
73
|
importSshPublicKey(params: Transfer.Types.ImportSshPublicKeyRequest, callback?: (err: AWSError, data: Transfer.Types.ImportSshPublicKeyResponse) => void): Request<Transfer.Types.ImportSshPublicKeyResponse, AWSError>;
|
|
74
74
|
/**
|
|
75
|
-
* Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to
|
|
75
|
+
* Adds a Secure Shell (SSH) public key to a user account 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.
|
|
76
76
|
*/
|
|
77
77
|
importSshPublicKey(callback?: (err: AWSError, data: Transfer.Types.ImportSshPublicKeyResponse) => void): Request<Transfer.Types.ImportSshPublicKeyResponse, AWSError>;
|
|
78
78
|
/**
|
|
79
|
-
* Lists the
|
|
79
|
+
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
|
80
80
|
*/
|
|
81
81
|
listServers(params: Transfer.Types.ListServersRequest, callback?: (err: AWSError, data: Transfer.Types.ListServersResponse) => void): Request<Transfer.Types.ListServersResponse, AWSError>;
|
|
82
82
|
/**
|
|
83
|
-
* Lists the
|
|
83
|
+
* Lists the file transfer protocol-enabled servers that are associated with your AWS account.
|
|
84
84
|
*/
|
|
85
85
|
listServers(callback?: (err: AWSError, data: Transfer.Types.ListServersResponse) => void): Request<Transfer.Types.ListServersResponse, AWSError>;
|
|
86
86
|
/**
|
|
@@ -92,27 +92,27 @@ declare class Transfer extends Service {
|
|
|
92
92
|
*/
|
|
93
93
|
listTagsForResource(callback?: (err: AWSError, data: Transfer.Types.ListTagsForResourceResponse) => void): Request<Transfer.Types.ListTagsForResourceResponse, AWSError>;
|
|
94
94
|
/**
|
|
95
|
-
* Lists the users for
|
|
95
|
+
* Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
|
|
96
96
|
*/
|
|
97
97
|
listUsers(params: Transfer.Types.ListUsersRequest, callback?: (err: AWSError, data: Transfer.Types.ListUsersResponse) => void): Request<Transfer.Types.ListUsersResponse, AWSError>;
|
|
98
98
|
/**
|
|
99
|
-
* Lists the users for
|
|
99
|
+
* Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
|
|
100
100
|
*/
|
|
101
101
|
listUsers(callback?: (err: AWSError, data: Transfer.Types.ListUsersResponse) => void): Request<Transfer.Types.ListUsersResponse, AWSError>;
|
|
102
102
|
/**
|
|
103
|
-
* Changes the state of a
|
|
103
|
+
* 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.
|
|
104
104
|
*/
|
|
105
105
|
startServer(params: Transfer.Types.StartServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
106
106
|
/**
|
|
107
|
-
* Changes the state of a
|
|
107
|
+
* 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.
|
|
108
108
|
*/
|
|
109
109
|
startServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
* Changes the state of
|
|
111
|
+
* 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 will not reduce or impact your file transfer protocol endpoint billing. 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.
|
|
112
112
|
*/
|
|
113
113
|
stopServer(params: Transfer.Types.StopServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
* Changes the state of
|
|
115
|
+
* 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 will not reduce or impact your file transfer protocol endpoint billing. 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.
|
|
116
116
|
*/
|
|
117
117
|
stopServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
118
118
|
/**
|
|
@@ -124,11 +124,11 @@ declare class Transfer extends Service {
|
|
|
124
124
|
*/
|
|
125
125
|
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
126
126
|
/**
|
|
127
|
-
* If the IdentityProviderType of
|
|
127
|
+
* If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway 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 API Gateway integration to ensure that your users can successfully use the service.
|
|
128
128
|
*/
|
|
129
129
|
testIdentityProvider(params: Transfer.Types.TestIdentityProviderRequest, callback?: (err: AWSError, data: Transfer.Types.TestIdentityProviderResponse) => void): Request<Transfer.Types.TestIdentityProviderResponse, AWSError>;
|
|
130
130
|
/**
|
|
131
|
-
* If the IdentityProviderType of
|
|
131
|
+
* If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway 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 API Gateway integration to ensure that your users can successfully use the service.
|
|
132
132
|
*/
|
|
133
133
|
testIdentityProvider(callback?: (err: AWSError, data: Transfer.Types.TestIdentityProviderResponse) => void): Request<Transfer.Types.TestIdentityProviderResponse, AWSError>;
|
|
134
134
|
/**
|
|
@@ -140,11 +140,11 @@ declare class Transfer extends Service {
|
|
|
140
140
|
*/
|
|
141
141
|
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
142
142
|
/**
|
|
143
|
-
* Updates the server properties after that server has been created. The UpdateServer call returns the ServerId of the
|
|
143
|
+
* 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.
|
|
144
144
|
*/
|
|
145
145
|
updateServer(params: Transfer.Types.UpdateServerRequest, callback?: (err: AWSError, data: Transfer.Types.UpdateServerResponse) => void): Request<Transfer.Types.UpdateServerResponse, AWSError>;
|
|
146
146
|
/**
|
|
147
|
-
* Updates the server properties after that server has been created. The UpdateServer call returns the ServerId of the
|
|
147
|
+
* 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.
|
|
148
148
|
*/
|
|
149
149
|
updateServer(callback?: (err: AWSError, data: Transfer.Types.UpdateServerResponse) => void): Request<Transfer.Types.UpdateServerResponse, AWSError>;
|
|
150
150
|
/**
|
|
@@ -160,69 +160,78 @@ declare namespace Transfer {
|
|
|
160
160
|
export type AddressAllocationId = string;
|
|
161
161
|
export type AddressAllocationIds = AddressAllocationId[];
|
|
162
162
|
export type Arn = string;
|
|
163
|
+
export type Certificate = string;
|
|
163
164
|
export interface CreateServerRequest {
|
|
164
165
|
/**
|
|
165
|
-
* The
|
|
166
|
+
* The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
|
|
167
|
+
*/
|
|
168
|
+
Certificate?: Certificate;
|
|
169
|
+
/**
|
|
170
|
+
* The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
|
|
166
171
|
*/
|
|
167
172
|
EndpointDetails?: EndpointDetails;
|
|
168
173
|
/**
|
|
169
|
-
* The type of VPC endpoint that you want your
|
|
174
|
+
* The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
|
|
170
175
|
*/
|
|
171
176
|
EndpointType?: EndpointType;
|
|
172
177
|
/**
|
|
173
|
-
* The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new
|
|
178
|
+
* The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key command. 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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
|
|
174
179
|
*/
|
|
175
180
|
HostKey?: HostKey;
|
|
176
181
|
/**
|
|
177
|
-
*
|
|
182
|
+
* Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
|
|
178
183
|
*/
|
|
179
184
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
180
185
|
/**
|
|
181
|
-
* Specifies the mode of authentication for
|
|
186
|
+
* Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
|
|
182
187
|
*/
|
|
183
188
|
IdentityProviderType?: IdentityProviderType;
|
|
184
189
|
/**
|
|
185
|
-
*
|
|
190
|
+
* Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
|
|
186
191
|
*/
|
|
187
192
|
LoggingRole?: Role;
|
|
188
193
|
/**
|
|
189
|
-
*
|
|
194
|
+
* 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: Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH File Transfer Protocol Secure (FTPS): File transfer with TLS encryption File Transfer Protocol (FTP): Unencrypted file transfer
|
|
195
|
+
*/
|
|
196
|
+
Protocols?: Protocols;
|
|
197
|
+
/**
|
|
198
|
+
* Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
|
|
190
199
|
*/
|
|
191
200
|
Tags?: Tags;
|
|
192
201
|
}
|
|
193
202
|
export interface CreateServerResponse {
|
|
194
203
|
/**
|
|
195
|
-
* The service-assigned ID of the
|
|
204
|
+
* The service-assigned ID of the file transfer protocol-enabled server that is created.
|
|
196
205
|
*/
|
|
197
206
|
ServerId: ServerId;
|
|
198
207
|
}
|
|
199
208
|
export interface CreateUserRequest {
|
|
200
209
|
/**
|
|
201
|
-
* The landing directory (folder) for a user when they log in to the server using
|
|
210
|
+
* The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the client. An example is your-Amazon-S3-bucket-name>/home/username.
|
|
202
211
|
*/
|
|
203
212
|
HomeDirectory?: HomeDirectory;
|
|
204
213
|
/**
|
|
205
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log into the
|
|
214
|
+
* The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
|
|
206
215
|
*/
|
|
207
216
|
HomeDirectoryType?: HomeDirectoryType;
|
|
208
217
|
/**
|
|
209
|
-
* Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]' In most cases, you can use this value instead of the scope
|
|
218
|
+
* Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]' In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value. If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a '/' for it to be considered a folder.
|
|
210
219
|
*/
|
|
211
220
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
|
212
221
|
/**
|
|
213
|
-
* 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 that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer
|
|
222
|
+
* 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 that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS 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 scope-down policy, see Creating a Scope-Down Policy. For more information, see AssumeRole in the AWS Security Token Service API Reference.
|
|
214
223
|
*/
|
|
215
224
|
Policy?: Policy;
|
|
216
225
|
/**
|
|
217
|
-
* The IAM role that controls your
|
|
226
|
+
* The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
|
|
218
227
|
*/
|
|
219
228
|
Role: Role;
|
|
220
229
|
/**
|
|
221
|
-
* A system-assigned unique identifier for
|
|
230
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server instance. This is the specific server that you added your user to.
|
|
222
231
|
*/
|
|
223
232
|
ServerId: ServerId;
|
|
224
233
|
/**
|
|
225
|
-
* The public portion of the Secure Shell (SSH) key used to authenticate the user to the
|
|
234
|
+
* The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.
|
|
226
235
|
*/
|
|
227
236
|
SshPublicKeyBody?: SshPublicKeyBody;
|
|
228
237
|
/**
|
|
@@ -230,30 +239,30 @@ declare namespace Transfer {
|
|
|
230
239
|
*/
|
|
231
240
|
Tags?: Tags;
|
|
232
241
|
/**
|
|
233
|
-
* 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 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
|
|
242
|
+
* A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
|
|
234
243
|
*/
|
|
235
244
|
UserName: UserName;
|
|
236
245
|
}
|
|
237
246
|
export interface CreateUserResponse {
|
|
238
247
|
/**
|
|
239
|
-
* The ID of the
|
|
248
|
+
* The ID of the file transfer protocol-enabled server that the user is attached to.
|
|
240
249
|
*/
|
|
241
250
|
ServerId: ServerId;
|
|
242
251
|
/**
|
|
243
|
-
* A unique string that identifies a user account associated with
|
|
252
|
+
* A unique string that identifies a user account associated with a file transfer protocol-enabled server.
|
|
244
253
|
*/
|
|
245
254
|
UserName: UserName;
|
|
246
255
|
}
|
|
247
256
|
export type DateImported = Date;
|
|
248
257
|
export interface DeleteServerRequest {
|
|
249
258
|
/**
|
|
250
|
-
* A unique system-assigned identifier for
|
|
259
|
+
* A unique system-assigned identifier for a file transfer protocol-enabled server instance.
|
|
251
260
|
*/
|
|
252
261
|
ServerId: ServerId;
|
|
253
262
|
}
|
|
254
263
|
export interface DeleteSshPublicKeyRequest {
|
|
255
264
|
/**
|
|
256
|
-
* A system-assigned unique identifier for a
|
|
265
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.
|
|
257
266
|
*/
|
|
258
267
|
ServerId: ServerId;
|
|
259
268
|
/**
|
|
@@ -267,39 +276,39 @@ declare namespace Transfer {
|
|
|
267
276
|
}
|
|
268
277
|
export interface DeleteUserRequest {
|
|
269
278
|
/**
|
|
270
|
-
* A system-assigned unique identifier for
|
|
279
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.
|
|
271
280
|
*/
|
|
272
281
|
ServerId: ServerId;
|
|
273
282
|
/**
|
|
274
|
-
* A unique string that identifies a user that is being deleted from
|
|
283
|
+
* A unique string that identifies a user that is being deleted from a file transfer protocol-enabled server.
|
|
275
284
|
*/
|
|
276
285
|
UserName: UserName;
|
|
277
286
|
}
|
|
278
287
|
export interface DescribeServerRequest {
|
|
279
288
|
/**
|
|
280
|
-
* A system-assigned unique identifier for
|
|
289
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server.
|
|
281
290
|
*/
|
|
282
291
|
ServerId: ServerId;
|
|
283
292
|
}
|
|
284
293
|
export interface DescribeServerResponse {
|
|
285
294
|
/**
|
|
286
|
-
* An array containing the properties of
|
|
295
|
+
* An array containing the properties of a file transfer protocol-enabled server with the ServerID you specified.
|
|
287
296
|
*/
|
|
288
297
|
Server: DescribedServer;
|
|
289
298
|
}
|
|
290
299
|
export interface DescribeUserRequest {
|
|
291
300
|
/**
|
|
292
|
-
* A system-assigned unique identifier for
|
|
301
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.
|
|
293
302
|
*/
|
|
294
303
|
ServerId: ServerId;
|
|
295
304
|
/**
|
|
296
|
-
* 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
|
|
305
|
+
* The name of the user assigned to one or more file transfer protocol-enabled servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.
|
|
297
306
|
*/
|
|
298
307
|
UserName: UserName;
|
|
299
308
|
}
|
|
300
309
|
export interface DescribeUserResponse {
|
|
301
310
|
/**
|
|
302
|
-
* A system-assigned unique identifier for
|
|
311
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.
|
|
303
312
|
*/
|
|
304
313
|
ServerId: ServerId;
|
|
305
314
|
/**
|
|
@@ -309,65 +318,73 @@ declare namespace Transfer {
|
|
|
309
318
|
}
|
|
310
319
|
export interface DescribedServer {
|
|
311
320
|
/**
|
|
312
|
-
* Specifies the unique Amazon Resource Name (ARN) for
|
|
321
|
+
* Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.
|
|
313
322
|
*/
|
|
314
323
|
Arn: Arn;
|
|
315
324
|
/**
|
|
316
|
-
* The
|
|
325
|
+
* The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
|
|
326
|
+
*/
|
|
327
|
+
Certificate?: Certificate;
|
|
328
|
+
/**
|
|
329
|
+
* The virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.
|
|
317
330
|
*/
|
|
318
331
|
EndpointDetails?: EndpointDetails;
|
|
319
332
|
/**
|
|
320
|
-
* The type of endpoint that your
|
|
333
|
+
* 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.
|
|
321
334
|
*/
|
|
322
335
|
EndpointType?: EndpointType;
|
|
323
336
|
/**
|
|
324
|
-
*
|
|
337
|
+
* Contains the message-digest algorithm (MD5) hash of a file transfer protocol-enabled server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
|
|
325
338
|
*/
|
|
326
339
|
HostKeyFingerprint?: HostKeyFingerprint;
|
|
327
340
|
/**
|
|
328
|
-
* Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of
|
|
341
|
+
* 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.
|
|
329
342
|
*/
|
|
330
343
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
331
344
|
/**
|
|
332
|
-
*
|
|
345
|
+
* Defines 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.
|
|
333
346
|
*/
|
|
334
347
|
IdentityProviderType?: IdentityProviderType;
|
|
335
348
|
/**
|
|
336
|
-
*
|
|
349
|
+
* An AWS Identity and Access Management (IAM) entity 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.
|
|
337
350
|
*/
|
|
338
351
|
LoggingRole?: Role;
|
|
339
352
|
/**
|
|
340
|
-
*
|
|
353
|
+
* 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: Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH File Transfer Protocol Secure (FTPS): File transfer with TLS encryption File Transfer Protocol (FTP): Unencrypted file transfer
|
|
354
|
+
*/
|
|
355
|
+
Protocols?: Protocols;
|
|
356
|
+
/**
|
|
357
|
+
* Unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.
|
|
341
358
|
*/
|
|
342
359
|
ServerId?: ServerId;
|
|
343
360
|
/**
|
|
344
|
-
* The condition of
|
|
361
|
+
* 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.
|
|
345
362
|
*/
|
|
346
363
|
State?: State;
|
|
347
364
|
/**
|
|
348
|
-
*
|
|
365
|
+
* Contains 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.
|
|
349
366
|
*/
|
|
350
367
|
Tags?: Tags;
|
|
351
368
|
/**
|
|
352
|
-
* The number of users that are assigned to
|
|
369
|
+
* The number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.
|
|
353
370
|
*/
|
|
354
371
|
UserCount?: UserCount;
|
|
355
372
|
}
|
|
356
373
|
export interface DescribedUser {
|
|
357
374
|
/**
|
|
358
|
-
*
|
|
375
|
+
* Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
|
|
359
376
|
*/
|
|
360
377
|
Arn: Arn;
|
|
361
378
|
/**
|
|
362
|
-
*
|
|
379
|
+
* Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
|
|
363
380
|
*/
|
|
364
381
|
HomeDirectory?: HomeDirectory;
|
|
365
382
|
/**
|
|
366
|
-
* Logical directory mappings that you specified for what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. In most cases, you can use this value instead of the scope
|
|
383
|
+
* Logical directory mappings that you specified for what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
|
|
367
384
|
*/
|
|
368
385
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
|
369
386
|
/**
|
|
370
|
-
* The type of landing directory (folder) you mapped for your users
|
|
387
|
+
* The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
|
|
371
388
|
*/
|
|
372
389
|
HomeDirectoryType?: HomeDirectoryType;
|
|
373
390
|
/**
|
|
@@ -375,29 +392,29 @@ declare namespace Transfer {
|
|
|
375
392
|
*/
|
|
376
393
|
Policy?: Policy;
|
|
377
394
|
/**
|
|
378
|
-
*
|
|
395
|
+
* Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
|
|
379
396
|
*/
|
|
380
397
|
Role?: Role;
|
|
381
398
|
/**
|
|
382
|
-
*
|
|
399
|
+
* Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
|
383
400
|
*/
|
|
384
401
|
SshPublicKeys?: SshPublicKeys;
|
|
385
402
|
/**
|
|
386
|
-
*
|
|
403
|
+
* Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
|
|
387
404
|
*/
|
|
388
405
|
Tags?: Tags;
|
|
389
406
|
/**
|
|
390
|
-
*
|
|
407
|
+
* The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
|
|
391
408
|
*/
|
|
392
409
|
UserName?: UserName;
|
|
393
410
|
}
|
|
394
411
|
export interface EndpointDetails {
|
|
395
412
|
/**
|
|
396
|
-
* A list of address allocation IDs that are required to attach an Elastic IP address to your
|
|
413
|
+
* 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. This property can only be use when EndpointType is set to VPC.
|
|
397
414
|
*/
|
|
398
415
|
AddressAllocationIds?: AddressAllocationIds;
|
|
399
416
|
/**
|
|
400
|
-
* A list of subnet IDs that are required to host your
|
|
417
|
+
* A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.
|
|
401
418
|
*/
|
|
402
419
|
SubnetIds?: SubnetIds;
|
|
403
420
|
/**
|
|
@@ -405,7 +422,7 @@ declare namespace Transfer {
|
|
|
405
422
|
*/
|
|
406
423
|
VpcEndpointId?: VpcEndpointId;
|
|
407
424
|
/**
|
|
408
|
-
* The VPC ID of the
|
|
425
|
+
* The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.
|
|
409
426
|
*/
|
|
410
427
|
VpcId?: VpcId;
|
|
411
428
|
}
|
|
@@ -427,18 +444,18 @@ declare namespace Transfer {
|
|
|
427
444
|
export type HostKeyFingerprint = string;
|
|
428
445
|
export interface IdentityProviderDetails {
|
|
429
446
|
/**
|
|
430
|
-
*
|
|
447
|
+
* Contains the location of the service endpoint used to authenticate users.
|
|
431
448
|
*/
|
|
432
449
|
Url?: Url;
|
|
433
450
|
/**
|
|
434
|
-
*
|
|
451
|
+
* Provides the type of InvocationRole used to authenticate the user account.
|
|
435
452
|
*/
|
|
436
453
|
InvocationRole?: Role;
|
|
437
454
|
}
|
|
438
455
|
export type IdentityProviderType = "SERVICE_MANAGED"|"API_GATEWAY"|string;
|
|
439
456
|
export interface ImportSshPublicKeyRequest {
|
|
440
457
|
/**
|
|
441
|
-
* A system-assigned unique identifier for
|
|
458
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server.
|
|
442
459
|
*/
|
|
443
460
|
ServerId: ServerId;
|
|
444
461
|
/**
|
|
@@ -446,17 +463,17 @@ declare namespace Transfer {
|
|
|
446
463
|
*/
|
|
447
464
|
SshPublicKeyBody: SshPublicKeyBody;
|
|
448
465
|
/**
|
|
449
|
-
* The name of the user account that is assigned to one or more servers.
|
|
466
|
+
* The name of the user account that is assigned to one or more file transfer protocol-enabled servers.
|
|
450
467
|
*/
|
|
451
468
|
UserName: UserName;
|
|
452
469
|
}
|
|
453
470
|
export interface ImportSshPublicKeyResponse {
|
|
454
471
|
/**
|
|
455
|
-
* A system-assigned unique identifier for
|
|
472
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server.
|
|
456
473
|
*/
|
|
457
474
|
ServerId: ServerId;
|
|
458
475
|
/**
|
|
459
|
-
*
|
|
476
|
+
* The name given to a public key by the system that was imported.
|
|
460
477
|
*/
|
|
461
478
|
SshPublicKeyId: SshPublicKeyId;
|
|
462
479
|
/**
|
|
@@ -466,21 +483,21 @@ declare namespace Transfer {
|
|
|
466
483
|
}
|
|
467
484
|
export interface ListServersRequest {
|
|
468
485
|
/**
|
|
469
|
-
* Specifies the number of servers to return as a response to the ListServers query.
|
|
486
|
+
* Specifies the number of file transfer protocol-enabled servers to return as a response to the ListServers query.
|
|
470
487
|
*/
|
|
471
488
|
MaxResults?: MaxResults;
|
|
472
489
|
/**
|
|
473
|
-
* When additional results are obtained from
|
|
490
|
+
* When additional results are obtained from theListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional file transfer protocol-enabled servers.
|
|
474
491
|
*/
|
|
475
492
|
NextToken?: NextToken;
|
|
476
493
|
}
|
|
477
494
|
export interface ListServersResponse {
|
|
478
495
|
/**
|
|
479
|
-
* When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.
|
|
496
|
+
* When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional file transfer protocol-enabled servers.
|
|
480
497
|
*/
|
|
481
498
|
NextToken?: NextToken;
|
|
482
499
|
/**
|
|
483
|
-
* An array of servers that were listed.
|
|
500
|
+
* An array of file transfer protocol-enabled servers that were listed.
|
|
484
501
|
*/
|
|
485
502
|
Servers: ListedServers;
|
|
486
503
|
}
|
|
@@ -500,7 +517,7 @@ declare namespace Transfer {
|
|
|
500
517
|
}
|
|
501
518
|
export interface ListTagsForResourceResponse {
|
|
502
519
|
/**
|
|
503
|
-
*
|
|
520
|
+
* The ARN you specified to list the tags of.
|
|
504
521
|
*/
|
|
505
522
|
Arn?: Arn;
|
|
506
523
|
/**
|
|
@@ -522,7 +539,7 @@ declare namespace Transfer {
|
|
|
522
539
|
*/
|
|
523
540
|
NextToken?: NextToken;
|
|
524
541
|
/**
|
|
525
|
-
* A system-assigned unique identifier for a
|
|
542
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server that has users assigned to it.
|
|
526
543
|
*/
|
|
527
544
|
ServerId: ServerId;
|
|
528
545
|
}
|
|
@@ -532,7 +549,7 @@ declare namespace Transfer {
|
|
|
532
549
|
*/
|
|
533
550
|
NextToken?: NextToken;
|
|
534
551
|
/**
|
|
535
|
-
* A system-assigned unique identifier for
|
|
552
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server that the users are assigned to.
|
|
536
553
|
*/
|
|
537
554
|
ServerId: ServerId;
|
|
538
555
|
/**
|
|
@@ -542,54 +559,54 @@ declare namespace Transfer {
|
|
|
542
559
|
}
|
|
543
560
|
export interface ListedServer {
|
|
544
561
|
/**
|
|
545
|
-
* The unique Amazon Resource Name (ARN) for
|
|
562
|
+
* The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be listed.
|
|
546
563
|
*/
|
|
547
564
|
Arn: Arn;
|
|
548
565
|
/**
|
|
549
|
-
* The authentication method used to validate a user for
|
|
566
|
+
* The authentication method used to validate a user for a file transfer protocol-enabled server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.
|
|
550
567
|
*/
|
|
551
568
|
IdentityProviderType?: IdentityProviderType;
|
|
552
569
|
/**
|
|
553
|
-
* The type of VPC endpoint that your
|
|
570
|
+
* The type of VPC endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
|
|
554
571
|
*/
|
|
555
572
|
EndpointType?: EndpointType;
|
|
556
573
|
/**
|
|
557
|
-
* The AWS Identity and Access Management entity that allows
|
|
574
|
+
* The AWS Identity and Access Management (IAM) entity that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging.
|
|
558
575
|
*/
|
|
559
576
|
LoggingRole?: Role;
|
|
560
577
|
/**
|
|
561
|
-
*
|
|
578
|
+
* The unique system assigned identifier for a file transfer protocol-enabled servers that were listed.
|
|
562
579
|
*/
|
|
563
580
|
ServerId?: ServerId;
|
|
564
581
|
/**
|
|
565
|
-
*
|
|
582
|
+
* Describes 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.
|
|
566
583
|
*/
|
|
567
584
|
State?: State;
|
|
568
585
|
/**
|
|
569
|
-
*
|
|
586
|
+
* A numeric value that indicates the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.
|
|
570
587
|
*/
|
|
571
588
|
UserCount?: UserCount;
|
|
572
589
|
}
|
|
573
590
|
export type ListedServers = ListedServer[];
|
|
574
591
|
export interface ListedUser {
|
|
575
592
|
/**
|
|
576
|
-
*
|
|
593
|
+
* The unique Amazon Resource Name (ARN) for the user that you want to learn about.
|
|
577
594
|
*/
|
|
578
595
|
Arn: Arn;
|
|
579
596
|
/**
|
|
580
|
-
*
|
|
597
|
+
* Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
|
|
581
598
|
*/
|
|
582
599
|
HomeDirectory?: HomeDirectory;
|
|
583
600
|
/**
|
|
584
|
-
* The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their
|
|
601
|
+
* The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
|
|
585
602
|
*/
|
|
586
603
|
HomeDirectoryType?: HomeDirectoryType;
|
|
587
604
|
/**
|
|
588
|
-
* The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows
|
|
605
|
+
* The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
|
|
589
606
|
*/
|
|
590
607
|
Role?: Role;
|
|
591
608
|
/**
|
|
592
|
-
*
|
|
609
|
+
* The number of SSH public keys stored for the user you specified.
|
|
593
610
|
*/
|
|
594
611
|
SshPublicKeyCount?: SshPublicKeyCount;
|
|
595
612
|
/**
|
|
@@ -605,6 +622,8 @@ declare namespace Transfer {
|
|
|
605
622
|
export type NextToken = string;
|
|
606
623
|
export type NullableRole = string;
|
|
607
624
|
export type Policy = string;
|
|
625
|
+
export type Protocol = "SFTP"|"FTP"|"FTPS"|string;
|
|
626
|
+
export type Protocols = Protocol[];
|
|
608
627
|
export type Response = string;
|
|
609
628
|
export type Role = string;
|
|
610
629
|
export type ServerId = string;
|
|
@@ -628,7 +647,7 @@ declare namespace Transfer {
|
|
|
628
647
|
export type SshPublicKeys = SshPublicKey[];
|
|
629
648
|
export interface StartServerRequest {
|
|
630
649
|
/**
|
|
631
|
-
* A system-assigned unique identifier for
|
|
650
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server that you start.
|
|
632
651
|
*/
|
|
633
652
|
ServerId: ServerId;
|
|
634
653
|
}
|
|
@@ -636,7 +655,7 @@ declare namespace Transfer {
|
|
|
636
655
|
export type StatusCode = number;
|
|
637
656
|
export interface StopServerRequest {
|
|
638
657
|
/**
|
|
639
|
-
* A system-assigned unique identifier for
|
|
658
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server that you stopped.
|
|
640
659
|
*/
|
|
641
660
|
ServerId: ServerId;
|
|
642
661
|
}
|
|
@@ -648,7 +667,7 @@ declare namespace Transfer {
|
|
|
648
667
|
*/
|
|
649
668
|
Key: TagKey;
|
|
650
669
|
/**
|
|
651
|
-
*
|
|
670
|
+
* Contains one or more values that you assigned to the key name you create.
|
|
652
671
|
*/
|
|
653
672
|
Value: TagValue;
|
|
654
673
|
}
|
|
@@ -668,17 +687,21 @@ declare namespace Transfer {
|
|
|
668
687
|
export type Tags = Tag[];
|
|
669
688
|
export interface TestIdentityProviderRequest {
|
|
670
689
|
/**
|
|
671
|
-
* A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
|
|
690
|
+
* A system-assigned identifier for a specific file transfer protocol-enabled server. That server's user authentication method is tested with a user name and password.
|
|
672
691
|
*/
|
|
673
692
|
ServerId: ServerId;
|
|
674
693
|
/**
|
|
675
|
-
*
|
|
694
|
+
* The name of the user account to be tested.
|
|
676
695
|
*/
|
|
677
696
|
UserName: UserName;
|
|
678
697
|
/**
|
|
679
698
|
* The password of the user account to be tested.
|
|
680
699
|
*/
|
|
681
700
|
UserPassword?: UserPassword;
|
|
701
|
+
/**
|
|
702
|
+
* 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)
|
|
703
|
+
*/
|
|
704
|
+
ServerProtocol?: Protocol;
|
|
682
705
|
}
|
|
683
706
|
export interface TestIdentityProviderResponse {
|
|
684
707
|
/**
|
|
@@ -690,7 +713,7 @@ declare namespace Transfer {
|
|
|
690
713
|
*/
|
|
691
714
|
StatusCode: StatusCode;
|
|
692
715
|
/**
|
|
693
|
-
* A message that indicates whether the test was successful or not.
|
|
716
|
+
* A message that indicates whether the test was successful or not.
|
|
694
717
|
*/
|
|
695
718
|
Message?: Message;
|
|
696
719
|
/**
|
|
@@ -700,7 +723,7 @@ declare namespace Transfer {
|
|
|
700
723
|
}
|
|
701
724
|
export interface UntagResourceRequest {
|
|
702
725
|
/**
|
|
703
|
-
*
|
|
726
|
+
* 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.
|
|
704
727
|
*/
|
|
705
728
|
Arn: Arn;
|
|
706
729
|
/**
|
|
@@ -710,73 +733,81 @@ declare namespace Transfer {
|
|
|
710
733
|
}
|
|
711
734
|
export interface UpdateServerRequest {
|
|
712
735
|
/**
|
|
713
|
-
* The
|
|
736
|
+
* The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
|
|
737
|
+
*/
|
|
738
|
+
Certificate?: Certificate;
|
|
739
|
+
/**
|
|
740
|
+
* The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.
|
|
714
741
|
*/
|
|
715
742
|
EndpointDetails?: EndpointDetails;
|
|
716
743
|
/**
|
|
717
|
-
* The type of endpoint that you want your
|
|
744
|
+
* The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, your server isn't accessible over the public internet.
|
|
718
745
|
*/
|
|
719
746
|
EndpointType?: EndpointType;
|
|
720
747
|
/**
|
|
721
|
-
* The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key. If you aren't planning to migrate existing users from an existing
|
|
748
|
+
* The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key. If you aren't planning to migrate existing users from an existing file transfer protocol-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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
|
|
722
749
|
*/
|
|
723
750
|
HostKey?: HostKey;
|
|
724
751
|
/**
|
|
725
|
-
*
|
|
752
|
+
* An array containing all of the information required to call a customer's authentication API method.
|
|
726
753
|
*/
|
|
727
754
|
IdentityProviderDetails?: IdentityProviderDetails;
|
|
728
755
|
/**
|
|
729
|
-
*
|
|
756
|
+
* 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.
|
|
730
757
|
*/
|
|
731
758
|
LoggingRole?: NullableRole;
|
|
732
759
|
/**
|
|
733
|
-
*
|
|
760
|
+
* 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: Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH File Transfer Protocol Secure (FTPS): File transfer with TLS encryption File Transfer Protocol (FTP): Unencrypted file transfer
|
|
761
|
+
*/
|
|
762
|
+
Protocols?: Protocols;
|
|
763
|
+
/**
|
|
764
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.
|
|
734
765
|
*/
|
|
735
766
|
ServerId: ServerId;
|
|
736
767
|
}
|
|
737
768
|
export interface UpdateServerResponse {
|
|
738
769
|
/**
|
|
739
|
-
* A system-assigned unique identifier for
|
|
770
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server that the user account is assigned to.
|
|
740
771
|
*/
|
|
741
772
|
ServerId: ServerId;
|
|
742
773
|
}
|
|
743
774
|
export interface UpdateUserRequest {
|
|
744
775
|
/**
|
|
745
|
-
*
|
|
776
|
+
* Specifies the landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using their file transfer protocol client. An example is your-Amazon-S3-bucket-name>/home/username.
|
|
746
777
|
*/
|
|
747
778
|
HomeDirectory?: HomeDirectory;
|
|
748
779
|
/**
|
|
749
|
-
* The type of landing directory (folder) you want your users' home directory to be when they log into the
|
|
780
|
+
* The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
|
|
750
781
|
*/
|
|
751
782
|
HomeDirectoryType?: HomeDirectoryType;
|
|
752
783
|
/**
|
|
753
|
-
* Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]' In most cases, you can use this value instead of the scope
|
|
784
|
+
* Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]' In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value. If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
|
|
754
785
|
*/
|
|
755
786
|
HomeDirectoryMappings?: HomeDirectoryMappings;
|
|
756
787
|
/**
|
|
757
|
-
* 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 user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer
|
|
788
|
+
* 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 user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS 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 scope-down policy, see Creating a Scope-Down Policy. For more information, see AssumeRole in the AWS Security Token Service API Reference.
|
|
758
789
|
*/
|
|
759
790
|
Policy?: Policy;
|
|
760
791
|
/**
|
|
761
|
-
* The IAM role that controls your
|
|
792
|
+
* The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
|
|
762
793
|
*/
|
|
763
794
|
Role?: Role;
|
|
764
795
|
/**
|
|
765
|
-
* A system-assigned unique identifier for
|
|
796
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.
|
|
766
797
|
*/
|
|
767
798
|
ServerId: ServerId;
|
|
768
799
|
/**
|
|
769
|
-
* 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
|
|
800
|
+
* A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This is the string that will be used by your user when they log in to your server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
|
|
770
801
|
*/
|
|
771
802
|
UserName: UserName;
|
|
772
803
|
}
|
|
773
804
|
export interface UpdateUserResponse {
|
|
774
805
|
/**
|
|
775
|
-
* A system-assigned unique identifier for
|
|
806
|
+
* A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.
|
|
776
807
|
*/
|
|
777
808
|
ServerId: ServerId;
|
|
778
809
|
/**
|
|
779
|
-
* The unique identifier for a user that is assigned to
|
|
810
|
+
* The unique identifier for a user that is assigned to a file transfer protocol-enabled server instance that was specified in the request.
|
|
780
811
|
*/
|
|
781
812
|
UserName: UserName;
|
|
782
813
|
}
|