cdk-comprehend-s3olap 2.0.155 → 2.0.156
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/.jsii +3 -3
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +9 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +3 -0
- package/node_modules/aws-sdk/apis/codecatalyst-2022-09-28.min.json +75 -12
- package/node_modules/aws-sdk/apis/codecatalyst-2022-09-28.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kafka-2018-11-14.min.json +6 -2
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +104 -90
- package/node_modules/aws-sdk/apis/rolesanywhere-2018-05-10.min.json +159 -43
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +48 -47
- package/node_modules/aws-sdk/clients/athena.d.ts +4 -0
- package/node_modules/aws-sdk/clients/codecatalyst.d.ts +66 -0
- package/node_modules/aws-sdk/clients/kafka.d.ts +2 -2
- package/node_modules/aws-sdk/clients/rekognition.d.ts +19 -1
- package/node_modules/aws-sdk/clients/rolesanywhere.d.ts +154 -45
- package/node_modules/aws-sdk/clients/transfer.d.ts +52 -44
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +98 -73
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +1950 -1900
- package/node_modules/aws-sdk/dist/aws-sdk.js +111 -93
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +30 -30
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/region_config.js +1 -0
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
@@ -101,11 +101,11 @@ declare class Transfer extends Service {
|
|
101
101
|
*/
|
102
102
|
deleteConnector(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
103
103
|
/**
|
104
|
-
* Deletes the host key that's specified in the
|
104
|
+
* Deletes the host key that's specified in the HostKeyId parameter.
|
105
105
|
*/
|
106
106
|
deleteHostKey(params: Transfer.Types.DeleteHostKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
107
107
|
/**
|
108
|
-
* Deletes the host key that's specified in the
|
108
|
+
* Deletes the host key that's specified in the HostKeyId parameter.
|
109
109
|
*/
|
110
110
|
deleteHostKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
111
111
|
/**
|
@@ -181,11 +181,11 @@ declare class Transfer extends Service {
|
|
181
181
|
*/
|
182
182
|
describeConnector(callback?: (err: AWSError, data: Transfer.Types.DescribeConnectorResponse) => void): Request<Transfer.Types.DescribeConnectorResponse, AWSError>;
|
183
183
|
/**
|
184
|
-
* You can use DescribeExecution to check the details of the execution of the specified workflow.
|
184
|
+
* You can use DescribeExecution to check the details of the execution of the specified workflow. This API call only returns details for in-progress workflows. If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.
|
185
185
|
*/
|
186
186
|
describeExecution(params: Transfer.Types.DescribeExecutionRequest, callback?: (err: AWSError, data: Transfer.Types.DescribeExecutionResponse) => void): Request<Transfer.Types.DescribeExecutionResponse, AWSError>;
|
187
187
|
/**
|
188
|
-
* You can use DescribeExecution to check the details of the execution of the specified workflow.
|
188
|
+
* You can use DescribeExecution to check the details of the execution of the specified workflow. This API call only returns details for in-progress workflows. If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.
|
189
189
|
*/
|
190
190
|
describeExecution(callback?: (err: AWSError, data: Transfer.Types.DescribeExecutionResponse) => void): Request<Transfer.Types.DescribeExecutionResponse, AWSError>;
|
191
191
|
/**
|
@@ -253,11 +253,11 @@ declare class Transfer extends Service {
|
|
253
253
|
*/
|
254
254
|
importHostKey(callback?: (err: AWSError, data: Transfer.Types.ImportHostKeyResponse) => void): Request<Transfer.Types.ImportHostKeyResponse, AWSError>;
|
255
255
|
/**
|
256
|
-
* Adds a Secure Shell (SSH) public key to a user
|
256
|
+
* Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
|
257
257
|
*/
|
258
258
|
importSshPublicKey(params: Transfer.Types.ImportSshPublicKeyRequest, callback?: (err: AWSError, data: Transfer.Types.ImportSshPublicKeyResponse) => void): Request<Transfer.Types.ImportSshPublicKeyResponse, AWSError>;
|
259
259
|
/**
|
260
|
-
* Adds a Secure Shell (SSH) public key to a user
|
260
|
+
* Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId. The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
|
261
261
|
*/
|
262
262
|
importSshPublicKey(callback?: (err: AWSError, data: Transfer.Types.ImportSshPublicKeyResponse) => void): Request<Transfer.Types.ImportSshPublicKeyResponse, AWSError>;
|
263
263
|
/**
|
@@ -293,11 +293,11 @@ declare class Transfer extends Service {
|
|
293
293
|
*/
|
294
294
|
listConnectors(callback?: (err: AWSError, data: Transfer.Types.ListConnectorsResponse) => void): Request<Transfer.Types.ListConnectorsResponse, AWSError>;
|
295
295
|
/**
|
296
|
-
* Lists all executions for the specified workflow.
|
296
|
+
* Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
|
297
297
|
*/
|
298
298
|
listExecutions(params: Transfer.Types.ListExecutionsRequest, callback?: (err: AWSError, data: Transfer.Types.ListExecutionsResponse) => void): Request<Transfer.Types.ListExecutionsResponse, AWSError>;
|
299
299
|
/**
|
300
|
-
* Lists all executions for the specified workflow.
|
300
|
+
* Lists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.
|
301
301
|
*/
|
302
302
|
listExecutions(callback?: (err: AWSError, data: Transfer.Types.ListExecutionsResponse) => void): Request<Transfer.Types.ListExecutionsResponse, AWSError>;
|
303
303
|
/**
|
@@ -349,11 +349,11 @@ declare class Transfer extends Service {
|
|
349
349
|
*/
|
350
350
|
listUsers(callback?: (err: AWSError, data: Transfer.Types.ListUsersResponse) => void): Request<Transfer.Types.ListUsersResponse, AWSError>;
|
351
351
|
/**
|
352
|
-
* Lists all
|
352
|
+
* Lists all workflows associated with your Amazon Web Services account for your current region.
|
353
353
|
*/
|
354
354
|
listWorkflows(params: Transfer.Types.ListWorkflowsRequest, callback?: (err: AWSError, data: Transfer.Types.ListWorkflowsResponse) => void): Request<Transfer.Types.ListWorkflowsResponse, AWSError>;
|
355
355
|
/**
|
356
|
-
* Lists all
|
356
|
+
* Lists all workflows associated with your Amazon Web Services account for your current region.
|
357
357
|
*/
|
358
358
|
listWorkflows(callback?: (err: AWSError, data: Transfer.Types.ListWorkflowsResponse) => void): Request<Transfer.Types.ListWorkflowsResponse, AWSError>;
|
359
359
|
/**
|
@@ -397,11 +397,11 @@ declare class Transfer extends Service {
|
|
397
397
|
*/
|
398
398
|
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
399
399
|
/**
|
400
|
-
* If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service. The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional. You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
|
400
|
+
* If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service. The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional. Note the following: You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED. TestIdentityProvider does not work with keys: it only accepts passwords. TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords. If you provide any incorrect values for any parameters, the Response field is empty. If you provide a server ID for a server that uses service-managed users, you get an error: An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error: An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server. It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).
|
401
401
|
*/
|
402
402
|
testIdentityProvider(params: Transfer.Types.TestIdentityProviderRequest, callback?: (err: AWSError, data: Transfer.Types.TestIdentityProviderResponse) => void): Request<Transfer.Types.TestIdentityProviderResponse, AWSError>;
|
403
403
|
/**
|
404
|
-
* If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service. The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional. You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.
|
404
|
+
* If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service. The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional. Note the following: You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED. TestIdentityProvider does not work with keys: it only accepts passwords. TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords. If you provide any incorrect values for any parameters, the Response field is empty. If you provide a server ID for a server that uses service-managed users, you get an error: An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error: An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server. It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).
|
405
405
|
*/
|
406
406
|
testIdentityProvider(callback?: (err: AWSError, data: Transfer.Types.TestIdentityProviderResponse) => void): Request<Transfer.Types.TestIdentityProviderResponse, AWSError>;
|
407
407
|
/**
|
@@ -555,11 +555,11 @@ declare namespace Transfer {
|
|
555
555
|
*/
|
556
556
|
Name?: WorkflowStepName;
|
557
557
|
/**
|
558
|
-
* Specifies the location for the file being copied. Use ${Transfer:
|
558
|
+
* Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date. Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file. Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload. The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
|
559
559
|
*/
|
560
560
|
DestinationFileLocation?: InputFileLocation;
|
561
561
|
/**
|
562
|
-
* A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
|
562
|
+
* A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE. If the workflow is processing a file that has the same name as an existing file, the behavior is as follows: If OverwriteExisting is TRUE, the existing file is replaced with the file being processed. If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
|
563
563
|
*/
|
564
564
|
OverwriteExisting?: OverwriteExisting;
|
565
565
|
/**
|
@@ -722,11 +722,11 @@ declare namespace Transfer {
|
|
722
722
|
*/
|
723
723
|
HostKey?: HostKey;
|
724
724
|
/**
|
725
|
-
* Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
|
725
|
+
* Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
|
726
726
|
*/
|
727
727
|
IdentityProviderDetails?: IdentityProviderDetails;
|
728
728
|
/**
|
729
|
-
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter
|
729
|
+
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.
|
730
730
|
*/
|
731
731
|
IdentityProviderType?: IdentityProviderType;
|
732
732
|
/**
|
@@ -758,7 +758,7 @@ declare namespace Transfer {
|
|
758
758
|
*/
|
759
759
|
Tags?: Tags;
|
760
760
|
/**
|
761
|
-
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when
|
761
|
+
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.
|
762
762
|
*/
|
763
763
|
WorkflowDetails?: WorkflowDetails;
|
764
764
|
}
|
@@ -816,7 +816,7 @@ declare namespace Transfer {
|
|
816
816
|
*/
|
817
817
|
ServerId: ServerId;
|
818
818
|
/**
|
819
|
-
* A unique string that identifies a
|
819
|
+
* A unique string that identifies a Transfer Family user.
|
820
820
|
*/
|
821
821
|
UserName: UserName;
|
822
822
|
}
|
@@ -830,7 +830,7 @@ declare namespace Transfer {
|
|
830
830
|
*/
|
831
831
|
Steps: WorkflowSteps;
|
832
832
|
/**
|
833
|
-
* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. For custom steps, the
|
833
|
+
* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. For custom steps, the Lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the Lambda does not send SUCCESS before it times out, the exception steps are executed.
|
834
834
|
*/
|
835
835
|
OnExceptionSteps?: WorkflowSteps;
|
836
836
|
/**
|
@@ -850,7 +850,7 @@ declare namespace Transfer {
|
|
850
850
|
*/
|
851
851
|
Name?: WorkflowStepName;
|
852
852
|
/**
|
853
|
-
* The ARN for the
|
853
|
+
* The ARN for the Lambda function that is being called.
|
854
854
|
*/
|
855
855
|
Target?: CustomStepTarget;
|
856
856
|
/**
|
@@ -880,9 +880,12 @@ declare namespace Transfer {
|
|
880
880
|
*/
|
881
881
|
SourceFileLocation?: SourceFileLocation;
|
882
882
|
/**
|
883
|
-
* A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
|
883
|
+
* A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE. If the workflow is processing a file that has the same name as an existing file, the behavior is as follows: If OverwriteExisting is TRUE, the existing file is replaced with the file being processed. If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
|
884
884
|
*/
|
885
885
|
OverwriteExisting?: OverwriteExisting;
|
886
|
+
/**
|
887
|
+
* Specifies the location for the file being decrypted. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date. Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file. Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload. The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
|
888
|
+
*/
|
886
889
|
DestinationFileLocation: InputFileLocation;
|
887
890
|
}
|
888
891
|
export interface DeleteAccessRequest {
|
@@ -1127,7 +1130,7 @@ declare namespace Transfer {
|
|
1127
1130
|
*/
|
1128
1131
|
ServerId: ServerId;
|
1129
1132
|
/**
|
1130
|
-
* An array containing the properties of the user
|
1133
|
+
* An array containing the properties of the Transfer Family user for the ServerID value that you specified.
|
1131
1134
|
*/
|
1132
1135
|
User: DescribedUser;
|
1133
1136
|
}
|
@@ -1447,7 +1450,7 @@ declare namespace Transfer {
|
|
1447
1450
|
*/
|
1448
1451
|
IdentityProviderDetails?: IdentityProviderDetails;
|
1449
1452
|
/**
|
1450
|
-
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter
|
1453
|
+
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.
|
1451
1454
|
*/
|
1452
1455
|
IdentityProviderType?: IdentityProviderType;
|
1453
1456
|
/**
|
@@ -1487,7 +1490,7 @@ declare namespace Transfer {
|
|
1487
1490
|
*/
|
1488
1491
|
UserCount?: UserCount;
|
1489
1492
|
/**
|
1490
|
-
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when
|
1493
|
+
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.
|
1491
1494
|
*/
|
1492
1495
|
WorkflowDetails?: WorkflowDetails;
|
1493
1496
|
}
|
@@ -1677,7 +1680,7 @@ declare namespace Transfer {
|
|
1677
1680
|
*/
|
1678
1681
|
Url?: Url;
|
1679
1682
|
/**
|
1680
|
-
* Provides the type of InvocationRole used to authenticate the user account.
|
1683
|
+
* This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.
|
1681
1684
|
*/
|
1682
1685
|
InvocationRole?: Role;
|
1683
1686
|
/**
|
@@ -1685,9 +1688,13 @@ declare namespace Transfer {
|
|
1685
1688
|
*/
|
1686
1689
|
DirectoryId?: DirectoryId;
|
1687
1690
|
/**
|
1688
|
-
* The ARN for a
|
1691
|
+
* The ARN for a Lambda function to use for the Identity provider.
|
1689
1692
|
*/
|
1690
1693
|
Function?: Function;
|
1694
|
+
/**
|
1695
|
+
* For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both. PASSWORD - users must provide their password to connect. PUBLIC_KEY - users must provide their private key to connect. PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value. PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.
|
1696
|
+
*/
|
1697
|
+
SftpAuthenticationMethods?: SftpAuthenticationMethods;
|
1691
1698
|
}
|
1692
1699
|
export type IdentityProviderType = "SERVICE_MANAGED"|"API_GATEWAY"|"AWS_DIRECTORY_SERVICE"|"AWS_LAMBDA"|string;
|
1693
1700
|
export interface ImportCertificateRequest {
|
@@ -1768,7 +1775,7 @@ declare namespace Transfer {
|
|
1768
1775
|
*/
|
1769
1776
|
SshPublicKeyBody: SshPublicKeyBody;
|
1770
1777
|
/**
|
1771
|
-
* The name of the user
|
1778
|
+
* The name of the Transfer Family user that is assigned to one or more servers.
|
1772
1779
|
*/
|
1773
1780
|
UserName: UserName;
|
1774
1781
|
}
|
@@ -1912,7 +1919,7 @@ declare namespace Transfer {
|
|
1912
1919
|
*/
|
1913
1920
|
WorkflowId: WorkflowId;
|
1914
1921
|
/**
|
1915
|
-
* Returns the details for each execution
|
1922
|
+
* Returns the details for each execution, in a ListedExecution array.
|
1916
1923
|
*/
|
1917
1924
|
Executions: ListedExecutions;
|
1918
1925
|
}
|
@@ -2060,7 +2067,7 @@ declare namespace Transfer {
|
|
2060
2067
|
*/
|
2061
2068
|
ServerId: ServerId;
|
2062
2069
|
/**
|
2063
|
-
* Returns the
|
2070
|
+
* Returns the Transfer Family users and their properties for the ServerId value that you specify.
|
2064
2071
|
*/
|
2065
2072
|
Users: ListedUsers;
|
2066
2073
|
}
|
@@ -2259,7 +2266,7 @@ declare namespace Transfer {
|
|
2259
2266
|
*/
|
2260
2267
|
Domain?: Domain;
|
2261
2268
|
/**
|
2262
|
-
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter
|
2269
|
+
* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.
|
2263
2270
|
*/
|
2264
2271
|
IdentityProviderType?: IdentityProviderType;
|
2265
2272
|
/**
|
@@ -2474,12 +2481,13 @@ declare namespace Transfer {
|
|
2474
2481
|
}
|
2475
2482
|
export type SessionId = string;
|
2476
2483
|
export type SetStatOption = "DEFAULT"|"ENABLE_NO_OP"|string;
|
2484
|
+
export type SftpAuthenticationMethods = "PASSWORD"|"PUBLIC_KEY"|"PUBLIC_KEY_OR_PASSWORD"|"PUBLIC_KEY_AND_PASSWORD"|string;
|
2477
2485
|
export type SigningAlg = "SHA256"|"SHA384"|"SHA512"|"SHA1"|"NONE"|string;
|
2478
2486
|
export type SourceFileLocation = string;
|
2479
2487
|
export type SourceIp = string;
|
2480
2488
|
export interface SshPublicKey {
|
2481
2489
|
/**
|
2482
|
-
* Specifies the date that the public key was added to the user
|
2490
|
+
* Specifies the date that the public key was added to the Transfer Family user.
|
2483
2491
|
*/
|
2484
2492
|
DateImported: DateImported;
|
2485
2493
|
/**
|
@@ -2546,7 +2554,7 @@ declare namespace Transfer {
|
|
2546
2554
|
*/
|
2547
2555
|
Arn: Arn;
|
2548
2556
|
/**
|
2549
|
-
* Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to
|
2557
|
+
* Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (servers, users, workflows, and so on) for any purpose.
|
2550
2558
|
*/
|
2551
2559
|
Tags: Tags;
|
2552
2560
|
}
|
@@ -2572,29 +2580,29 @@ declare namespace Transfer {
|
|
2572
2580
|
*/
|
2573
2581
|
ServerId: ServerId;
|
2574
2582
|
/**
|
2575
|
-
* 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)
|
2583
|
+
* The type of file transfer protocol to be tested. The available protocols are: Secure Shell (SSH) File Transfer Protocol (SFTP) File Transfer Protocol Secure (FTPS) File Transfer Protocol (FTP) Applicability Statement 2 (AS2)
|
2576
2584
|
*/
|
2577
2585
|
ServerProtocol?: Protocol;
|
2578
2586
|
/**
|
2579
|
-
* The source IP address of the
|
2587
|
+
* The source IP address of the account to be tested.
|
2580
2588
|
*/
|
2581
2589
|
SourceIp?: SourceIp;
|
2582
2590
|
/**
|
2583
|
-
* The name of the
|
2591
|
+
* The name of the account to be tested.
|
2584
2592
|
*/
|
2585
2593
|
UserName: UserName;
|
2586
2594
|
/**
|
2587
|
-
* The password of the
|
2595
|
+
* The password of the account to be tested.
|
2588
2596
|
*/
|
2589
2597
|
UserPassword?: UserPassword;
|
2590
2598
|
}
|
2591
2599
|
export interface TestIdentityProviderResponse {
|
2592
2600
|
/**
|
2593
|
-
* The response that is returned from your API Gateway.
|
2601
|
+
* The response that is returned from your API Gateway or your Lambda function.
|
2594
2602
|
*/
|
2595
2603
|
Response?: Response;
|
2596
2604
|
/**
|
2597
|
-
* The HTTP status code that is the response from your API Gateway.
|
2605
|
+
* The HTTP status code that is the response from your API Gateway or your Lambda function.
|
2598
2606
|
*/
|
2599
2607
|
StatusCode: StatusCode;
|
2600
2608
|
/**
|
@@ -2837,17 +2845,17 @@ declare namespace Transfer {
|
|
2837
2845
|
*/
|
2838
2846
|
SecurityPolicyName?: SecurityPolicyName;
|
2839
2847
|
/**
|
2840
|
-
* A system-assigned unique identifier for a server instance that the user
|
2848
|
+
* A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
|
2841
2849
|
*/
|
2842
2850
|
ServerId: ServerId;
|
2843
2851
|
/**
|
2844
|
-
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when
|
2852
|
+
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow. In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded. To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example. aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
|
2845
2853
|
*/
|
2846
2854
|
WorkflowDetails?: WorkflowDetails;
|
2847
2855
|
}
|
2848
2856
|
export interface UpdateServerResponse {
|
2849
2857
|
/**
|
2850
|
-
* A system-assigned unique identifier for a server that the user
|
2858
|
+
* A system-assigned unique identifier for a server that the Transfer Family user is assigned to.
|
2851
2859
|
*/
|
2852
2860
|
ServerId: ServerId;
|
2853
2861
|
}
|
@@ -2877,7 +2885,7 @@ declare namespace Transfer {
|
|
2877
2885
|
*/
|
2878
2886
|
Role?: Role;
|
2879
2887
|
/**
|
2880
|
-
* A system-assigned unique identifier for a server instance that the user
|
2888
|
+
* A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.
|
2881
2889
|
*/
|
2882
2890
|
ServerId: ServerId;
|
2883
2891
|
/**
|
@@ -2887,7 +2895,7 @@ declare namespace Transfer {
|
|
2887
2895
|
}
|
2888
2896
|
export interface UpdateUserResponse {
|
2889
2897
|
/**
|
2890
|
-
* A system-assigned unique identifier for a server instance that the
|
2898
|
+
* A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to.
|
2891
2899
|
*/
|
2892
2900
|
ServerId: ServerId;
|
2893
2901
|
/**
|
@@ -2899,7 +2907,7 @@ declare namespace Transfer {
|
|
2899
2907
|
export type UserCount = number;
|
2900
2908
|
export interface UserDetails {
|
2901
2909
|
/**
|
2902
|
-
* A unique string that identifies a user
|
2910
|
+
* A unique string that identifies a Transfer Family user associated with a server.
|
2903
2911
|
*/
|
2904
2912
|
UserName: UserName;
|
2905
2913
|
/**
|