aws-sdk 2.1502.0 → 2.1503.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 +41 -1
- package/README.md +1 -3
- package/apis/accessanalyzer-2019-11-01.min.json +423 -86
- package/apis/accessanalyzer-2019-11-01.paginators.json +12 -0
- package/apis/amp-2020-08-01.min.json +320 -3
- package/apis/amp-2020-08-01.paginators.json +6 -0
- package/apis/amp-2020-08-01.waiters2.json +33 -0
- package/apis/bcm-data-exports-2023-11-26.examples.json +5 -0
- package/apis/bcm-data-exports-2023-11-26.min.json +470 -0
- package/apis/bcm-data-exports-2023-11-26.paginators.json +22 -0
- package/apis/cloudtrail-2013-11-01.min.json +67 -24
- package/apis/codestar-connections-2019-12-01.min.json +590 -3
- package/apis/codestar-connections-2019-12-01.paginators.json +10 -0
- package/apis/compute-optimizer-2019-11-01.min.json +243 -39
- package/apis/config-2014-11-12.min.json +204 -169
- package/apis/controltower-2018-05-10.min.json +249 -13
- package/apis/controltower-2018-05-10.paginators.json +6 -0
- package/apis/cost-optimization-hub-2022-07-26.examples.json +5 -0
- package/apis/cost-optimization-hub-2022-07-26.min.json +757 -0
- package/apis/cost-optimization-hub-2022-07-26.paginators.json +22 -0
- package/apis/detective-2018-10-26.min.json +294 -0
- package/apis/ecs-2014-11-13.min.json +108 -107
- package/apis/eks-2017-11-01.min.json +211 -4
- package/apis/eks-2017-11-01.paginators.json +12 -0
- package/apis/eks-auth-2023-11-26.examples.json +5 -0
- package/apis/eks-auth-2023-11-26.min.json +104 -0
- package/apis/eks-auth-2023-11-26.paginators.json +4 -0
- package/apis/eks-auth-2023-11-26.waiters2.json +5 -0
- package/apis/elasticfilesystem-2015-02-01.min.json +5 -1
- package/apis/elasticfilesystem-2015-02-01.paginators.json +18 -3
- package/apis/elasticloadbalancingv2-2015-12-01.min.json +403 -75
- package/apis/elasticloadbalancingv2-2015-12-01.paginators.json +15 -0
- package/apis/freetier-2023-09-07.examples.json +5 -0
- package/apis/freetier-2023-09-07.min.json +105 -0
- package/apis/freetier-2023-09-07.paginators.json +10 -0
- package/apis/fsx-2018-03-01.min.json +259 -135
- package/apis/guardduty-2017-11-28.min.json +64 -0
- package/apis/iotfleetwise-2021-06-17.min.json +159 -33
- package/apis/lakeformation-2017-03-31.min.json +126 -35
- package/apis/logs-2014-03-28.min.json +310 -36
- package/apis/logs-2014-03-28.paginators.json +12 -0
- package/apis/managedblockchain-2018-09-24.min.json +58 -50
- package/apis/metadata.json +22 -0
- package/apis/models.lex.v2-2020-08-07.min.json +633 -331
- package/apis/models.lex.v2-2020-08-07.paginators.json +5 -0
- package/apis/personalize-2018-05-22.min.json +85 -52
- package/apis/personalize-events-2018-03-22.min.json +97 -5
- package/apis/personalize-runtime-2018-05-22.min.json +68 -11
- package/apis/quicksight-2018-04-01.min.json +398 -268
- package/apis/redshift-2012-12-01.min.json +14 -2
- package/apis/repostspace-2022-05-13.examples.json +5 -0
- package/apis/repostspace-2022-05-13.min.json +447 -0
- package/apis/repostspace-2022-05-13.paginators.json +10 -0
- package/apis/runtime.lex.v2-2020-08-07.min.json +25 -24
- package/apis/s3-2006-03-01.examples.json +142 -142
- package/apis/s3-2006-03-01.min.json +45 -0
- package/apis/s3control-2018-08-20.min.json +1330 -314
- package/apis/s3control-2018-08-20.paginators.json +15 -0
- package/apis/secretsmanager-2017-10-17.min.json +111 -50
- package/apis/secretsmanager-2017-10-17.paginators.json +5 -0
- package/apis/securityhub-2018-10-26.examples.json +93 -2
- package/apis/securityhub-2018-10-26.min.json +551 -300
- package/apis/states-2016-11-23.min.json +85 -0
- package/apis/transcribe-2017-10-26.min.json +49 -38
- package/apis/workspaces-2015-04-08.min.json +119 -96
- package/apis/workspaces-thin-client-2023-08-22.examples.json +5 -0
- package/apis/workspaces-thin-client-2023-08-22.min.json +777 -0
- package/apis/workspaces-thin-client-2023-08-22.paginators.json +22 -0
- package/clients/accessanalyzer.d.ts +374 -5
- package/clients/all.d.ts +6 -0
- package/clients/all.js +7 -1
- package/clients/amp.d.ts +322 -0
- package/clients/bcmdataexports.d.ts +589 -0
- package/clients/bcmdataexports.js +18 -0
- package/clients/cloudtrail.d.ts +76 -2
- package/clients/cloudwatchlogs.d.ts +413 -1
- package/clients/codestarconnections.d.ts +727 -0
- package/clients/computeoptimizer.d.ts +307 -6
- package/clients/configservice.d.ts +60 -11
- package/clients/controltower.d.ts +258 -20
- package/clients/costoptimizationhub.d.ts +1283 -0
- package/clients/costoptimizationhub.js +18 -0
- package/clients/detective.d.ts +469 -0
- package/clients/ecs.d.ts +10 -5
- package/clients/efs.d.ts +39 -30
- package/clients/eks.d.ts +237 -15
- package/clients/eksauth.d.ts +124 -0
- package/clients/eksauth.js +19 -0
- package/clients/elbv2.d.ts +433 -4
- package/clients/freetier.d.ts +149 -0
- package/clients/freetier.js +18 -0
- package/clients/fsx.d.ts +194 -21
- package/clients/guardduty.d.ts +82 -11
- package/clients/iotfleetwise.d.ts +198 -13
- package/clients/lakeformation.d.ts +118 -2
- package/clients/lexmodelsv2.d.ts +343 -2
- package/clients/lexruntimev2.d.ts +14 -9
- package/clients/managedblockchain.d.ts +26 -5
- package/clients/personalize.d.ts +65 -20
- package/clients/personalizeevents.d.ts +102 -12
- package/clients/personalizeruntime.d.ts +72 -2
- package/clients/quicksight.d.ts +124 -0
- package/clients/redshift.d.ts +16 -0
- package/clients/repostspace.d.ts +458 -0
- package/clients/repostspace.js +18 -0
- package/clients/s3.d.ts +2 -2
- package/clients/s3control.d.ts +841 -13
- package/clients/secretsmanager.d.ts +94 -5
- package/clients/securityhub.d.ts +305 -2
- package/clients/stepfunctions.d.ts +153 -8
- package/clients/transcribeservice.d.ts +11 -1
- package/clients/workspaces.d.ts +43 -1
- package/clients/workspacesthinclient.d.ts +895 -0
- package/clients/workspacesthinclient.js +18 -0
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +277 -48
- package/dist/aws-sdk.js +1976 -565
- package/dist/aws-sdk.min.js +104 -104
- package/lib/config_service_placeholders.d.ts +12 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/ecs.d.ts
CHANGED
@@ -277,11 +277,11 @@ declare class ECS extends Service {
|
|
277
277
|
*/
|
278
278
|
listTasks(callback?: (err: AWSError, data: ECS.Types.ListTasksResponse) => void): Request<ECS.Types.ListTasksResponse, AWSError>;
|
279
279
|
/**
|
280
|
-
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When you specify serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. When you specify awsvpcTrunking, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. When you specify containerInsights, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide. Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.
|
280
|
+
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When you specify serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. When you specify awsvpcTrunking, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. When you specify containerInsights, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide. Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide. The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
|
281
281
|
*/
|
282
282
|
putAccountSetting(params: ECS.Types.PutAccountSettingRequest, callback?: (err: AWSError, data: ECS.Types.PutAccountSettingResponse) => void): Request<ECS.Types.PutAccountSettingResponse, AWSError>;
|
283
283
|
/**
|
284
|
-
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When you specify serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. When you specify awsvpcTrunking, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. When you specify containerInsights, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide. Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.
|
284
|
+
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When you specify serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. When you specify awsvpcTrunking, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. When you specify containerInsights, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide. Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide. The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
|
285
285
|
*/
|
286
286
|
putAccountSetting(callback?: (err: AWSError, data: ECS.Types.PutAccountSettingResponse) => void): Request<ECS.Types.PutAccountSettingResponse, AWSError>;
|
287
287
|
/**
|
@@ -2782,7 +2782,7 @@ declare namespace ECS {
|
|
2782
2782
|
export type ProxyConfigurationType = "APPMESH"|string;
|
2783
2783
|
export interface PutAccountSettingDefaultRequest {
|
2784
2784
|
/**
|
2785
|
-
* The resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the ENI limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required maintenance is affected. When you specify fargateFIPSMode for the name and enabled for the value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information about FIPS-140 compliance with Fargate, see Amazon Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container Service Developer Guide. When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to set the wait time to retire a Fargate task to the default. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.
|
2785
|
+
* The resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the ENI limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required maintenance is affected. When you specify fargateFIPSMode for the name and enabled for the value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information about FIPS-140 compliance with Fargate, see Amazon Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container Service Developer Guide. When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to set the wait time to retire a Fargate task to the default. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide. The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
|
2786
2786
|
*/
|
2787
2787
|
name: SettingName;
|
2788
2788
|
/**
|
@@ -2798,7 +2798,7 @@ declare namespace ECS {
|
|
2798
2798
|
}
|
2799
2799
|
export interface PutAccountSettingRequest {
|
2800
2800
|
/**
|
2801
|
-
* The Amazon ECS resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify fargateFIPSMode, Fargate FIPS 140 compliance is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the wait time to retire a Fargate task is affected.
|
2801
|
+
* The Amazon ECS resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify fargateFIPSMode, Fargate FIPS 140 compliance is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the wait time to retire a Fargate task is affected. The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
|
2802
2802
|
*/
|
2803
2803
|
name: SettingName;
|
2804
2804
|
/**
|
@@ -3387,8 +3387,13 @@ declare namespace ECS {
|
|
3387
3387
|
* The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.
|
3388
3388
|
*/
|
3389
3389
|
principalArn?: String;
|
3390
|
+
/**
|
3391
|
+
* Indicates whether Amazon Web Services manages the account setting, or if the user manages it. aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.
|
3392
|
+
*/
|
3393
|
+
type?: SettingType;
|
3390
3394
|
}
|
3391
|
-
export type SettingName = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights"|"fargateFIPSMode"|"tagResourceAuthorization"|"fargateTaskRetirementWaitPeriod"|string;
|
3395
|
+
export type SettingName = "serviceLongArnFormat"|"taskLongArnFormat"|"containerInstanceLongArnFormat"|"awsvpcTrunking"|"containerInsights"|"fargateFIPSMode"|"tagResourceAuthorization"|"fargateTaskRetirementWaitPeriod"|"guardDutyActivate"|string;
|
3396
|
+
export type SettingType = "user"|"aws_managed"|string;
|
3392
3397
|
export type Settings = Setting[];
|
3393
3398
|
export type SortOrder = "ASC"|"DESC"|string;
|
3394
3399
|
export type StabilityStatus = "STEADY_STATE"|"STABILIZING"|string;
|
package/clients/efs.d.ts
CHANGED
@@ -20,27 +20,27 @@ declare class EFS extends Service {
|
|
20
20
|
*/
|
21
21
|
createAccessPoint(callback?: (err: AWSError, data: EFS.Types.AccessPointDescription) => void): Request<EFS.Types.AccessPointDescription, AWSError>;
|
22
22
|
/**
|
23
|
-
* Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token.
|
23
|
+
* Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token. The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error. For more information, see Creating a file system in the Amazon EFS User Guide. The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state. This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for all file systems. File systems using the maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or file systems that use Elastic throughput. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes. You can set the throughput mode for the file system using the ThroughputMode parameter. After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works. This operation requires permissions for the elasticfilesystem:CreateFileSystem action. File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.
|
24
24
|
*/
|
25
25
|
createFileSystem(params: EFS.Types.CreateFileSystemRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
|
26
26
|
/**
|
27
|
-
* Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token.
|
27
|
+
* Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token. The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error. For more information, see Creating a file system in the Amazon EFS User Guide. The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state. This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for all file systems. File systems using the maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or file systems that use Elastic throughput. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes. You can set the throughput mode for the file system using the ThroughputMode parameter. After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works. This operation requires permissions for the elasticfilesystem:CreateFileSystem action. File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.
|
28
28
|
*/
|
29
29
|
createFileSystem(callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
|
30
30
|
/**
|
31
|
-
* Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. You can create only one mount target for
|
31
|
+
* Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. You can create only one mount target for a One Zone file system. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target. For more information, see Amazon EFS: How it Works. To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems. In the request, provide the following: The file system ID for which you are creating the mount target. A subnet ID, which determines the following: The VPC in which Amazon EFS creates the mount target The Availability Zone in which Amazon EFS creates the mount target The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request) After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview. Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements: Must belong to the same VPC as the subnets of the existing mount targets Must not be in the same Availability Zone as any of the subnets of the existing mount targets If the request satisfies the requirements, Amazon EFS does the following: Creates a new mount target in the specified subnet. Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state. We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:CreateMountTarget This operation also requires permissions for the following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface
|
32
32
|
*/
|
33
33
|
createMountTarget(params: EFS.Types.CreateMountTargetRequest, callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request<EFS.Types.MountTargetDescription, AWSError>;
|
34
34
|
/**
|
35
|
-
* Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. You can create only one mount target for
|
35
|
+
* Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. You can create only one mount target for a One Zone file system. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target. For more information, see Amazon EFS: How it Works. To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems. In the request, provide the following: The file system ID for which you are creating the mount target. A subnet ID, which determines the following: The VPC in which Amazon EFS creates the mount target The Availability Zone in which Amazon EFS creates the mount target The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request) After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview. Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements: Must belong to the same VPC as the subnets of the existing mount targets Must not be in the same Availability Zone as any of the subnets of the existing mount targets If the request satisfies the requirements, Amazon EFS does the following: Creates a new mount target in the specified subnet. Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state. We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:CreateMountTarget This operation also requires permissions for the following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface
|
36
36
|
*/
|
37
37
|
createMountTarget(callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request<EFS.Types.MountTargetDescription, AWSError>;
|
38
38
|
/**
|
39
|
-
* Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following: Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration. Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties: Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. To use EFS replication in a Region that is disabled by default, you must first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide Availability Zone - If you want the destination file system to use EFS One Zone availability
|
39
|
+
* Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following: Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration. Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties: Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. To use EFS replication in a Region that is disabled by default, you must first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide Availability Zone - If you want the destination file system to use EFS One Zone availability, you must specify the Availability Zone to create the file system in. For more information about EFS storage classes, see Amazon EFS storage classes in the Amazon EFS User Guide. Encryption - All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used. After the file system is created, you cannot change the KMS key. The following properties are set by default: Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed. Throughput mode - The destination file system's throughput mode matches that of the source file system. After the file system is created, you can modify the throughput mode. The following properties are turned off by default: Lifecycle management – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable it. Automatic backups – Automatic daily backups are enabled on the destination file system. After the file system is created, you can change this setting. For more information, see Amazon EFS replication in the Amazon EFS User Guide.
|
40
40
|
*/
|
41
41
|
createReplicationConfiguration(params: EFS.Types.CreateReplicationConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.ReplicationConfigurationDescription) => void): Request<EFS.Types.ReplicationConfigurationDescription, AWSError>;
|
42
42
|
/**
|
43
|
-
* Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following: Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration. Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties: Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. To use EFS replication in a Region that is disabled by default, you must first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide Availability Zone - If you want the destination file system to use EFS One Zone availability
|
43
|
+
* Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following: Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration. Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties: Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. To use EFS replication in a Region that is disabled by default, you must first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide Availability Zone - If you want the destination file system to use EFS One Zone availability, you must specify the Availability Zone to create the file system in. For more information about EFS storage classes, see Amazon EFS storage classes in the Amazon EFS User Guide. Encryption - All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used. After the file system is created, you cannot change the KMS key. The following properties are set by default: Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed. Throughput mode - The destination file system's throughput mode matches that of the source file system. After the file system is created, you can modify the throughput mode. The following properties are turned off by default: Lifecycle management – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable it. Automatic backups – Automatic daily backups are enabled on the destination file system. After the file system is created, you can change this setting. For more information, see Amazon EFS replication in the Amazon EFS User Guide.
|
44
44
|
*/
|
45
45
|
createReplicationConfiguration(callback?: (err: AWSError, data: EFS.Types.ReplicationConfigurationDescription) => void): Request<EFS.Types.ReplicationConfigurationDescription, AWSError>;
|
46
46
|
/**
|
@@ -140,11 +140,11 @@ declare class EFS extends Service {
|
|
140
140
|
*/
|
141
141
|
describeFileSystems(callback?: (err: AWSError, data: EFS.Types.DescribeFileSystemsResponse) => void): Request<EFS.Types.DescribeFileSystemsResponse, AWSError>;
|
142
142
|
/**
|
143
|
-
* Returns the current LifecycleConfiguration object for the specified Amazon EFS file system.
|
143
|
+
* Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. Llifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.
|
144
144
|
*/
|
145
145
|
describeLifecycleConfiguration(params: EFS.Types.DescribeLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
|
146
146
|
/**
|
147
|
-
* Returns the current LifecycleConfiguration object for the specified Amazon EFS file system.
|
147
|
+
* Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. Llifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.
|
148
148
|
*/
|
149
149
|
describeLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
|
150
150
|
/**
|
@@ -220,11 +220,11 @@ declare class EFS extends Service {
|
|
220
220
|
*/
|
221
221
|
putFileSystemPolicy(callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
|
222
222
|
/**
|
223
|
-
* Use this action to manage
|
223
|
+
* Use this action to manage storage of your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following: TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage. TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage. File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA. The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode. TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage. For more information, see Managing file system storage. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration for the file system. In the request, specify the following: The ID for the file system for which you are enabling, disabling, or modifying Lifecycle management. A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary storage. Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information. This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.
|
224
224
|
*/
|
225
225
|
putLifecycleConfiguration(params: EFS.Types.PutLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
|
226
226
|
/**
|
227
|
-
* Use this action to manage
|
227
|
+
* Use this action to manage storage of your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following: TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage. TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage. File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA. The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode. TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage. For more information, see Managing file system storage. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration for the file system. In the request, specify the following: The ID for the file system for which you are enabling, disabling, or modifying Lifecycle management. A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary storage. Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information. This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.
|
228
228
|
*/
|
229
229
|
putLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
|
230
230
|
/**
|
@@ -284,7 +284,7 @@ declare namespace EFS {
|
|
284
284
|
*/
|
285
285
|
PosixUser?: PosixUser;
|
286
286
|
/**
|
287
|
-
* The directory on the
|
287
|
+
* The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
|
288
288
|
*/
|
289
289
|
RootDirectory?: RootDirectory;
|
290
290
|
/**
|
@@ -304,7 +304,7 @@ declare namespace EFS {
|
|
304
304
|
export type Backup = boolean;
|
305
305
|
export interface BackupPolicy {
|
306
306
|
/**
|
307
|
-
* Describes the status of the file system's backup policy. ENABLED
|
307
|
+
* Describes the status of the file system's backup policy. ENABLED – EFS is automatically backing up the file system. ENABLING – EFS is turning on automatic backups for the file system. DISABLED – Automatic back ups are turned off for the file system. DISABLING – EFS is turning off automatic backups for the file system.
|
308
308
|
*/
|
309
309
|
Status: Status;
|
310
310
|
}
|
@@ -334,7 +334,7 @@ declare namespace EFS {
|
|
334
334
|
*/
|
335
335
|
PosixUser?: PosixUser;
|
336
336
|
/**
|
337
|
-
* Specifies the directory on the
|
337
|
+
* Specifies the directory on the EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, Amazon EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you must provide the Path, and the CreationInfo. Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.
|
338
338
|
*/
|
339
339
|
RootDirectory?: RootDirectory;
|
340
340
|
}
|
@@ -344,7 +344,7 @@ declare namespace EFS {
|
|
344
344
|
*/
|
345
345
|
CreationToken: CreationToken;
|
346
346
|
/**
|
347
|
-
* The
|
347
|
+
* The Performance mode of the file system. We recommend generalPurpose performance mode for all file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The maxIO mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. Default is generalPurpose.
|
348
348
|
*/
|
349
349
|
PerformanceMode?: PerformanceMode;
|
350
350
|
/**
|
@@ -356,7 +356,7 @@ declare namespace EFS {
|
|
356
356
|
*/
|
357
357
|
KmsKeyId?: KmsKeyId;
|
358
358
|
/**
|
359
|
-
* Specifies the throughput mode for the file system. The mode can be bursting, provisioned, or elastic. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's
|
359
|
+
* Specifies the throughput mode for the file system. The mode can be bursting, provisioned, or elastic. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide. Default is bursting.
|
360
360
|
*/
|
361
361
|
ThroughputMode?: ThroughputMode;
|
362
362
|
/**
|
@@ -364,11 +364,11 @@ declare namespace EFS {
|
|
364
364
|
*/
|
365
365
|
ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
|
366
366
|
/**
|
367
|
-
* Used to create a
|
367
|
+
* Used to create a One Zone file system. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see Using EFS storage classes in the Amazon EFS User Guide. One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
|
368
368
|
*/
|
369
369
|
AvailabilityZoneName?: AvailabilityZoneName;
|
370
370
|
/**
|
371
|
-
* Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to true to enable automatic backups. If you are creating a
|
371
|
+
* Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to true to enable automatic backups. If you are creating a One Zone file system, automatic backups are enabled by default. For more information, see Automatic backups in the Amazon EFS User Guide. Default is false. However, if you specify an AvailabilityZoneName, the default is true. Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
|
372
372
|
*/
|
373
373
|
Backup?: Backup;
|
374
374
|
/**
|
@@ -382,7 +382,7 @@ declare namespace EFS {
|
|
382
382
|
*/
|
383
383
|
FileSystemId: FileSystemId;
|
384
384
|
/**
|
385
|
-
* The ID of the subnet to add the mount target in. For
|
385
|
+
* The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.
|
386
386
|
*/
|
387
387
|
SubnetId: SubnetId;
|
388
388
|
/**
|
@@ -519,7 +519,7 @@ declare namespace EFS {
|
|
519
519
|
}
|
520
520
|
export interface DescribeBackupPolicyRequest {
|
521
521
|
/**
|
522
|
-
* Specifies which EFS file system to retrieve the BackupPolicy
|
522
|
+
* Specifies which EFS file system for which to retrieve the BackupPolicy.
|
523
523
|
*/
|
524
524
|
FileSystemId: FileSystemId;
|
525
525
|
}
|
@@ -669,7 +669,7 @@ declare namespace EFS {
|
|
669
669
|
}
|
670
670
|
export interface Destination {
|
671
671
|
/**
|
672
|
-
* Describes the status of the destination
|
672
|
+
* Describes the status of the destination EFS file system. The Paused state occurs as a result of opting out of the source or destination Region after the replication configuration was created. To resume replication for the file system, you need to again opt in to the Amazon Web Services Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Guide. The Error state occurs when either the source or the destination file system (or both) is in a failed state and is unrecoverable. For more information, see Monitoring replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then restore the most recent backup of the failed file system (either the source or the destination) to a new file system.
|
673
673
|
*/
|
674
674
|
Status: ReplicationStatus;
|
675
675
|
/**
|
@@ -691,7 +691,7 @@ declare namespace EFS {
|
|
691
691
|
*/
|
692
692
|
Region?: RegionName;
|
693
693
|
/**
|
694
|
-
* To create a file system that uses
|
694
|
+
* To create a file system that uses One Zone storage, specify the name of the Availability Zone in which to create the destination file system.
|
695
695
|
*/
|
696
696
|
AvailabilityZoneName?: AvailabilityZoneName;
|
697
697
|
/**
|
@@ -741,7 +741,7 @@ declare namespace EFS {
|
|
741
741
|
*/
|
742
742
|
SizeInBytes: FileSystemSize;
|
743
743
|
/**
|
744
|
-
* The
|
744
|
+
* The Performance mode of the file system.
|
745
745
|
*/
|
746
746
|
PerformanceMode: PerformanceMode;
|
747
747
|
/**
|
@@ -761,11 +761,11 @@ declare namespace EFS {
|
|
761
761
|
*/
|
762
762
|
ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
|
763
763
|
/**
|
764
|
-
* Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for
|
764
|
+
* Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
|
765
765
|
*/
|
766
766
|
AvailabilityZoneName?: AvailabilityZoneName;
|
767
767
|
/**
|
768
|
-
* The unique and consistent identifier of the Availability Zone in which the file system
|
768
|
+
* The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
|
769
769
|
*/
|
770
770
|
AvailabilityZoneId?: AvailabilityZoneId;
|
771
771
|
/**
|
@@ -803,6 +803,10 @@ declare namespace EFS {
|
|
803
803
|
* The latest known metered size (in bytes) of data stored in the Standard storage class.
|
804
804
|
*/
|
805
805
|
ValueInStandard?: FileSystemNullableSizeValue;
|
806
|
+
/**
|
807
|
+
* The latest known metered size (in bytes) of data stored in the Archive storage class.
|
808
|
+
*/
|
809
|
+
ValueInArchive?: FileSystemNullableSizeValue;
|
806
810
|
}
|
807
811
|
export type FileSystemSizeValue = number;
|
808
812
|
export type Gid = number;
|
@@ -818,13 +822,17 @@ declare namespace EFS {
|
|
818
822
|
export type LifecyclePolicies = LifecyclePolicy[];
|
819
823
|
export interface LifecyclePolicy {
|
820
824
|
/**
|
821
|
-
*
|
825
|
+
* The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
|
822
826
|
*/
|
823
827
|
TransitionToIA?: TransitionToIARules;
|
824
828
|
/**
|
825
|
-
*
|
829
|
+
* Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
|
826
830
|
*/
|
827
831
|
TransitionToPrimaryStorageClass?: TransitionToPrimaryStorageClassRules;
|
832
|
+
/**
|
833
|
+
* The number of days after files were last accessed in primary storage (the Standard storage class) files at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
|
834
|
+
*/
|
835
|
+
TransitionToArchive?: TransitionToArchiveRules;
|
828
836
|
}
|
829
837
|
export interface ListTagsForResourceRequest {
|
830
838
|
/**
|
@@ -970,7 +978,7 @@ declare namespace EFS {
|
|
970
978
|
*/
|
971
979
|
FileSystemId: FileSystemId;
|
972
980
|
/**
|
973
|
-
* An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS
|
981
|
+
* An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS Lifecycle management of the following: TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage. TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage. File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA. The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode. TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage. When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.
|
974
982
|
*/
|
975
983
|
LifecyclePolicies: LifecyclePolicies;
|
976
984
|
}
|
@@ -981,7 +989,7 @@ declare namespace EFS {
|
|
981
989
|
*/
|
982
990
|
SourceFileSystemId: FileSystemId;
|
983
991
|
/**
|
984
|
-
* The Amazon Web Services Region in which the source
|
992
|
+
* The Amazon Web Services Region in which the source EFS file system is located.
|
985
993
|
*/
|
986
994
|
SourceFileSystemRegion: RegionName;
|
987
995
|
/**
|
@@ -989,7 +997,7 @@ declare namespace EFS {
|
|
989
997
|
*/
|
990
998
|
SourceFileSystemArn: FileSystemArn;
|
991
999
|
/**
|
992
|
-
* The Amazon Resource Name (ARN) of the original source
|
1000
|
+
* The Amazon Resource Name (ARN) of the original source EFS file system in the replication configuration.
|
993
1001
|
*/
|
994
1002
|
OriginalSourceFileSystemArn: FileSystemArn;
|
995
1003
|
/**
|
@@ -1059,7 +1067,8 @@ declare namespace EFS {
|
|
1059
1067
|
export type ThroughputMode = "bursting"|"provisioned"|"elastic"|string;
|
1060
1068
|
export type Timestamp = Date;
|
1061
1069
|
export type Token = string;
|
1062
|
-
export type
|
1070
|
+
export type TransitionToArchiveRules = "AFTER_1_DAY"|"AFTER_7_DAYS"|"AFTER_14_DAYS"|"AFTER_30_DAYS"|"AFTER_60_DAYS"|"AFTER_90_DAYS"|"AFTER_180_DAYS"|"AFTER_270_DAYS"|"AFTER_365_DAYS"|string;
|
1071
|
+
export type TransitionToIARules = "AFTER_7_DAYS"|"AFTER_14_DAYS"|"AFTER_30_DAYS"|"AFTER_60_DAYS"|"AFTER_90_DAYS"|"AFTER_1_DAY"|"AFTER_180_DAYS"|"AFTER_270_DAYS"|"AFTER_365_DAYS"|string;
|
1063
1072
|
export type TransitionToPrimaryStorageClassRules = "AFTER_1_ACCESS"|string;
|
1064
1073
|
export type Uid = number;
|
1065
1074
|
export interface UntagResourceRequest {
|