cdk-docker-image-deployment 0.0.197 → 0.0.198
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/destination.js +1 -1
- package/lib/docker-image-deployment.js +1 -1
- package/lib/source.js +1 -1
- package/node_modules/aws-sdk/CHANGELOG.md +7 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.examples.json +155 -0
- package/node_modules/aws-sdk/apis/application-autoscaling-2016-02-06.min.json +70 -1
- package/node_modules/aws-sdk/apis/neptune-2014-10-31.min.json +130 -103
- package/node_modules/aws-sdk/apis/s3outposts-2017-07-25.min.json +8 -1
- package/node_modules/aws-sdk/apis/workdocs-2016-05-01.min.json +234 -32
- package/node_modules/aws-sdk/apis/workdocs-2016-05-01.paginators.json +42 -0
- package/node_modules/aws-sdk/clients/applicationautoscaling.d.ts +88 -11
- package/node_modules/aws-sdk/clients/neptune.d.ts +39 -1
- package/node_modules/aws-sdk/clients/s3outposts.d.ts +17 -1
- package/node_modules/aws-sdk/clients/workdocs.d.ts +196 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +6 -6
- package/node_modules/aws-sdk/dist/aws-sdk.js +349 -36
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +98 -98
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +4 -4
|
@@ -68,29 +68,53 @@ declare class ApplicationAutoScaling extends Service {
|
|
|
68
68
|
*/
|
|
69
69
|
describeScheduledActions(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScheduledActionsResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScheduledActionsResponse, AWSError>;
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
71
|
+
* Returns all the tags on the specified Application Auto Scaling scalable target. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
|
|
72
|
+
*/
|
|
73
|
+
listTagsForResource(params: ApplicationAutoScaling.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.ListTagsForResourceResponse) => void): Request<ApplicationAutoScaling.Types.ListTagsForResourceResponse, AWSError>;
|
|
74
|
+
/**
|
|
75
|
+
* Returns all the tags on the specified Application Auto Scaling scalable target. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
|
|
76
|
+
*/
|
|
77
|
+
listTagsForResource(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.ListTagsForResourceResponse) => void): Request<ApplicationAutoScaling.Types.ListTagsForResourceResponse, AWSError>;
|
|
78
|
+
/**
|
|
79
|
+
* Creates or updates a scaling policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
|
|
72
80
|
*/
|
|
73
81
|
putScalingPolicy(params: ApplicationAutoScaling.Types.PutScalingPolicyRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.PutScalingPolicyResponse, AWSError>;
|
|
74
82
|
/**
|
|
75
|
-
* Creates or updates a scaling policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to
|
|
83
|
+
* Creates or updates a scaling policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
|
|
76
84
|
*/
|
|
77
85
|
putScalingPolicy(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.PutScalingPolicyResponse, AWSError>;
|
|
78
86
|
/**
|
|
79
|
-
* Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When start and end times
|
|
87
|
+
* Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops. To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted. For more information, see Scheduled scaling in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
|
|
80
88
|
*/
|
|
81
89
|
putScheduledAction(params: ApplicationAutoScaling.Types.PutScheduledActionRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScheduledActionResponse) => void): Request<ApplicationAutoScaling.Types.PutScheduledActionResponse, AWSError>;
|
|
82
90
|
/**
|
|
83
|
-
* Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When start and end times
|
|
91
|
+
* Creates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops. To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted. For more information, see Scheduled scaling in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
|
|
84
92
|
*/
|
|
85
93
|
putScheduledAction(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScheduledActionResponse) => void): Request<ApplicationAutoScaling.Types.PutScheduledActionResponse, AWSError>;
|
|
86
94
|
/**
|
|
87
|
-
* Registers or updates a scalable target, the resource that you want to scale. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service. When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. If you
|
|
95
|
+
* Registers or updates a scalable target, which is the resource that you want to scale. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service. When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range. After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget. To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request. If you call the RegisterScalableTarget API operation to create a scalable target, there might be a brief delay until the operation achieves eventual consistency. You might become aware of this brief delay if you get unexpected errors when performing sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include automatic backoff and retry logic. If you call the RegisterScalableTarget API operation to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.
|
|
88
96
|
*/
|
|
89
97
|
registerScalableTarget(params: ApplicationAutoScaling.Types.RegisterScalableTargetRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.RegisterScalableTargetResponse, AWSError>;
|
|
90
98
|
/**
|
|
91
|
-
* Registers or updates a scalable target, the resource that you want to scale. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service. When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. If you
|
|
99
|
+
* Registers or updates a scalable target, which is the resource that you want to scale. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service. When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range. After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget. To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request. If you call the RegisterScalableTarget API operation to create a scalable target, there might be a brief delay until the operation achieves eventual consistency. You might become aware of this brief delay if you get unexpected errors when performing sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include automatic backoff and retry logic. If you call the RegisterScalableTarget API operation to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.
|
|
92
100
|
*/
|
|
93
101
|
registerScalableTarget(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.RegisterScalableTargetResponse, AWSError>;
|
|
102
|
+
/**
|
|
103
|
+
* Adds or edits tags on an Application Auto Scaling scalable target. Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action. You can also add tags to an Application Auto Scaling scalable target while creating it (RegisterScalableTarget). For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
|
|
104
|
+
*/
|
|
105
|
+
tagResource(params: ApplicationAutoScaling.Types.TagResourceRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.TagResourceResponse) => void): Request<ApplicationAutoScaling.Types.TagResourceResponse, AWSError>;
|
|
106
|
+
/**
|
|
107
|
+
* Adds or edits tags on an Application Auto Scaling scalable target. Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action. You can also add tags to an Application Auto Scaling scalable target while creating it (RegisterScalableTarget). For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
|
|
108
|
+
*/
|
|
109
|
+
tagResource(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.TagResourceResponse) => void): Request<ApplicationAutoScaling.Types.TagResourceResponse, AWSError>;
|
|
110
|
+
/**
|
|
111
|
+
* Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.
|
|
112
|
+
*/
|
|
113
|
+
untagResource(params: ApplicationAutoScaling.Types.UntagResourceRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.UntagResourceResponse) => void): Request<ApplicationAutoScaling.Types.UntagResourceResponse, AWSError>;
|
|
114
|
+
/**
|
|
115
|
+
* Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.
|
|
116
|
+
*/
|
|
117
|
+
untagResource(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.UntagResourceResponse) => void): Request<ApplicationAutoScaling.Types.UntagResourceResponse, AWSError>;
|
|
94
118
|
}
|
|
95
119
|
declare namespace ApplicationAutoScaling {
|
|
96
120
|
export type AdjustmentType = "ChangeInCapacity"|"PercentChangeInCapacity"|"ExactCapacity"|string;
|
|
@@ -105,10 +129,11 @@ declare namespace ApplicationAutoScaling {
|
|
|
105
129
|
AlarmARN: ResourceId;
|
|
106
130
|
}
|
|
107
131
|
export type Alarms = Alarm[];
|
|
132
|
+
export type AmazonResourceName = string;
|
|
108
133
|
export type Cooldown = number;
|
|
109
134
|
export interface CustomizedMetricSpecification {
|
|
110
135
|
/**
|
|
111
|
-
* The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that
|
|
136
|
+
* The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
|
|
112
137
|
*/
|
|
113
138
|
MetricName?: MetricName;
|
|
114
139
|
/**
|
|
@@ -332,6 +357,18 @@ declare namespace ApplicationAutoScaling {
|
|
|
332
357
|
export type Expression = string;
|
|
333
358
|
export type Id = string;
|
|
334
359
|
export type IncludeNotScaledActivities = boolean;
|
|
360
|
+
export interface ListTagsForResourceRequest {
|
|
361
|
+
/**
|
|
362
|
+
* Specify the ARN of the scalable target. For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 To get the ARN for a scalable target, use DescribeScalableTargets.
|
|
363
|
+
*/
|
|
364
|
+
ResourceARN: AmazonResourceName;
|
|
365
|
+
}
|
|
366
|
+
export interface ListTagsForResourceResponse {
|
|
367
|
+
/**
|
|
368
|
+
* A list of tags. Each tag consists of a tag key and a tag value.
|
|
369
|
+
*/
|
|
370
|
+
Tags?: TagMap;
|
|
371
|
+
}
|
|
335
372
|
export type MaxResults = number;
|
|
336
373
|
export type MetricAggregationType = "Average"|"Minimum"|"Maximum"|string;
|
|
337
374
|
export interface MetricDimension {
|
|
@@ -483,7 +520,7 @@ declare namespace ApplicationAutoScaling {
|
|
|
483
520
|
*/
|
|
484
521
|
MinCapacity?: ResourceCapacity;
|
|
485
522
|
/**
|
|
486
|
-
* The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target. Although you can specify a large maximum capacity, note that service quotas
|
|
523
|
+
* The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target. Although you can specify a large maximum capacity, note that service quotas might impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.
|
|
487
524
|
*/
|
|
488
525
|
MaxCapacity?: ResourceCapacity;
|
|
489
526
|
/**
|
|
@@ -494,8 +531,16 @@ declare namespace ApplicationAutoScaling {
|
|
|
494
531
|
* An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide.
|
|
495
532
|
*/
|
|
496
533
|
SuspendedState?: SuspendedState;
|
|
534
|
+
/**
|
|
535
|
+
* Assigns one or more tags to the scalable target. Use this parameter to tag the scalable target when it is created. To tag an existing scalable target, use the TagResource operation. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have more than one tag on a scalable target with the same tag key. Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
|
|
536
|
+
*/
|
|
537
|
+
Tags?: TagMap;
|
|
497
538
|
}
|
|
498
539
|
export interface RegisterScalableTargetResponse {
|
|
540
|
+
/**
|
|
541
|
+
* The ARN of the scalable target.
|
|
542
|
+
*/
|
|
543
|
+
ScalableTargetARN?: XmlString;
|
|
499
544
|
}
|
|
500
545
|
export type ResourceCapacity = number;
|
|
501
546
|
export type ResourceId = string;
|
|
@@ -537,6 +582,10 @@ declare namespace ApplicationAutoScaling {
|
|
|
537
582
|
* Specifies whether the scaling activities for a scalable target are in a suspended state.
|
|
538
583
|
*/
|
|
539
584
|
SuspendedState?: SuspendedState;
|
|
585
|
+
/**
|
|
586
|
+
* The ARN of the scalable target.
|
|
587
|
+
*/
|
|
588
|
+
ScalableTargetARN?: XmlString;
|
|
540
589
|
}
|
|
541
590
|
export interface ScalableTargetAction {
|
|
542
591
|
/**
|
|
@@ -697,11 +746,11 @@ declare namespace ApplicationAutoScaling {
|
|
|
697
746
|
export type ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|"appstream"|"dynamodb"|"rds"|"sagemaker"|"custom-resource"|"comprehend"|"lambda"|"cassandra"|"kafka"|"elasticache"|"neptune"|string;
|
|
698
747
|
export interface StepAdjustment {
|
|
699
748
|
/**
|
|
700
|
-
* The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it
|
|
749
|
+
* The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it's exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
|
|
701
750
|
*/
|
|
702
751
|
MetricIntervalLowerBound?: MetricScale;
|
|
703
752
|
/**
|
|
704
|
-
* The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it
|
|
753
|
+
* The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound.
|
|
705
754
|
*/
|
|
706
755
|
MetricIntervalUpperBound?: MetricScale;
|
|
707
756
|
/**
|
|
@@ -746,6 +795,22 @@ declare namespace ApplicationAutoScaling {
|
|
|
746
795
|
*/
|
|
747
796
|
ScheduledScalingSuspended?: ScalingSuspended;
|
|
748
797
|
}
|
|
798
|
+
export type TagKey = string;
|
|
799
|
+
export type TagKeyList = TagKey[];
|
|
800
|
+
export type TagMap = {[key: string]: TagValue};
|
|
801
|
+
export interface TagResourceRequest {
|
|
802
|
+
/**
|
|
803
|
+
* Identifies the Application Auto Scaling scalable target that you want to apply tags to. For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 To get the ARN for a scalable target, use DescribeScalableTargets.
|
|
804
|
+
*/
|
|
805
|
+
ResourceARN: AmazonResourceName;
|
|
806
|
+
/**
|
|
807
|
+
* The tags assigned to the resource. A tag is a label that you assign to an AWS resource. Each tag consists of a tag key and a tag value. You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key. If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the current tag value with the specified one. For information about the rules that apply to tag keys and tag values, see User-defined tag restrictions in the Amazon Web Services Billing and Cost Management User Guide.
|
|
808
|
+
*/
|
|
809
|
+
Tags: TagMap;
|
|
810
|
+
}
|
|
811
|
+
export interface TagResourceResponse {
|
|
812
|
+
}
|
|
813
|
+
export type TagValue = string;
|
|
749
814
|
export interface TargetTrackingMetric {
|
|
750
815
|
/**
|
|
751
816
|
* The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
|
|
@@ -804,7 +869,7 @@ declare namespace ApplicationAutoScaling {
|
|
|
804
869
|
*/
|
|
805
870
|
Metric: TargetTrackingMetric;
|
|
806
871
|
/**
|
|
807
|
-
* The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used
|
|
872
|
+
* The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
|
|
808
873
|
*/
|
|
809
874
|
Stat: XmlString;
|
|
810
875
|
/**
|
|
@@ -840,6 +905,18 @@ declare namespace ApplicationAutoScaling {
|
|
|
840
905
|
DisableScaleIn?: DisableScaleIn;
|
|
841
906
|
}
|
|
842
907
|
export type TimestampType = Date;
|
|
908
|
+
export interface UntagResourceRequest {
|
|
909
|
+
/**
|
|
910
|
+
* Identifies the Application Auto Scaling scalable target from which to remove tags. For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 To get the ARN for a scalable target, use DescribeScalableTargets.
|
|
911
|
+
*/
|
|
912
|
+
ResourceARN: AmazonResourceName;
|
|
913
|
+
/**
|
|
914
|
+
* One or more tag keys. Specify only the tag keys, not the tag values.
|
|
915
|
+
*/
|
|
916
|
+
TagKeys: TagKeyList;
|
|
917
|
+
}
|
|
918
|
+
export interface UntagResourceResponse {
|
|
919
|
+
}
|
|
843
920
|
export type XmlString = string;
|
|
844
921
|
/**
|
|
845
922
|
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
|
@@ -668,6 +668,36 @@ declare namespace Neptune {
|
|
|
668
668
|
*/
|
|
669
669
|
DisableLogTypes?: LogTypeList;
|
|
670
670
|
}
|
|
671
|
+
export interface ClusterPendingModifiedValues {
|
|
672
|
+
/**
|
|
673
|
+
* This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.
|
|
674
|
+
*/
|
|
675
|
+
PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports;
|
|
676
|
+
/**
|
|
677
|
+
* The DBClusterIdentifier value for the DB cluster.
|
|
678
|
+
*/
|
|
679
|
+
DBClusterIdentifier?: String;
|
|
680
|
+
/**
|
|
681
|
+
* A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
|
|
682
|
+
*/
|
|
683
|
+
IAMDatabaseAuthenticationEnabled?: BooleanOptional;
|
|
684
|
+
/**
|
|
685
|
+
* The database engine version.
|
|
686
|
+
*/
|
|
687
|
+
EngineVersion?: String;
|
|
688
|
+
/**
|
|
689
|
+
* The number of days for which automatic DB snapshots are retained.
|
|
690
|
+
*/
|
|
691
|
+
BackupRetentionPeriod?: IntegerOptional;
|
|
692
|
+
/**
|
|
693
|
+
* The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
|
|
694
|
+
*/
|
|
695
|
+
AllocatedStorage?: IntegerOptional;
|
|
696
|
+
/**
|
|
697
|
+
* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
698
|
+
*/
|
|
699
|
+
Iops?: IntegerOptional;
|
|
700
|
+
}
|
|
671
701
|
export interface CopyDBClusterParameterGroupMessage {
|
|
672
702
|
/**
|
|
673
703
|
* The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same Amazon Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different Amazon Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
|
|
@@ -1059,7 +1089,7 @@ declare namespace Neptune {
|
|
|
1059
1089
|
/**
|
|
1060
1090
|
* The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String
|
|
1061
1091
|
*/
|
|
1062
|
-
DBClusterIdentifier
|
|
1092
|
+
DBClusterIdentifier: String;
|
|
1063
1093
|
/**
|
|
1064
1094
|
* Specifies the storage type to be associated with the DB instance. Not applicable. Storage is managed by the DB Cluster.
|
|
1065
1095
|
*/
|
|
@@ -1385,6 +1415,10 @@ declare namespace Neptune {
|
|
|
1385
1415
|
* A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
|
1386
1416
|
*/
|
|
1387
1417
|
EnabledCloudwatchLogsExports?: LogTypeList;
|
|
1418
|
+
/**
|
|
1419
|
+
* This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.
|
|
1420
|
+
*/
|
|
1421
|
+
PendingModifiedValues?: ClusterPendingModifiedValues;
|
|
1388
1422
|
/**
|
|
1389
1423
|
* Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
|
|
1390
1424
|
*/
|
|
@@ -1398,6 +1432,10 @@ declare namespace Neptune {
|
|
|
1398
1432
|
*/
|
|
1399
1433
|
AutomaticRestartTime?: TStamp;
|
|
1400
1434
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfigurationInfo;
|
|
1435
|
+
/**
|
|
1436
|
+
* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
|
|
1437
|
+
*/
|
|
1438
|
+
GlobalClusterIdentifier?: GlobalClusterIdentifier;
|
|
1401
1439
|
}
|
|
1402
1440
|
export interface DBClusterEndpoint {
|
|
1403
1441
|
/**
|
|
@@ -141,12 +141,27 @@ declare namespace S3Outposts {
|
|
|
141
141
|
* The ID of the customer-owned IPv4 address pool used for the endpoint.
|
|
142
142
|
*/
|
|
143
143
|
CustomerOwnedIpv4Pool?: CustomerOwnedIpv4Pool;
|
|
144
|
+
/**
|
|
145
|
+
* The failure reason, if any, for a create or delete endpoint operation.
|
|
146
|
+
*/
|
|
147
|
+
FailedReason?: FailedReason;
|
|
144
148
|
}
|
|
145
149
|
export type EndpointAccessType = "Private"|"CustomerOwnedIp"|string;
|
|
146
150
|
export type EndpointArn = string;
|
|
147
151
|
export type EndpointId = string;
|
|
148
|
-
export type EndpointStatus = "Pending"|"Available"|"Deleting"|string;
|
|
152
|
+
export type EndpointStatus = "Pending"|"Available"|"Deleting"|"Create_Failed"|"Delete_Failed"|string;
|
|
149
153
|
export type Endpoints = Endpoint[];
|
|
154
|
+
export type ErrorCode = string;
|
|
155
|
+
export interface FailedReason {
|
|
156
|
+
/**
|
|
157
|
+
* The failure code, if any, for a create or delete endpoint operation.
|
|
158
|
+
*/
|
|
159
|
+
ErrorCode?: ErrorCode;
|
|
160
|
+
/**
|
|
161
|
+
* Additional error details describing the endpoint failure and recommended action.
|
|
162
|
+
*/
|
|
163
|
+
Message?: Message;
|
|
164
|
+
}
|
|
150
165
|
export interface ListEndpointsRequest {
|
|
151
166
|
/**
|
|
152
167
|
* If a previous response from this operation included a NextToken value, provide that value here to retrieve the next page of results.
|
|
@@ -212,6 +227,7 @@ declare namespace S3Outposts {
|
|
|
212
227
|
NextToken?: NextToken;
|
|
213
228
|
}
|
|
214
229
|
export type MaxResults = number;
|
|
230
|
+
export type Message = string;
|
|
215
231
|
export interface NetworkInterface {
|
|
216
232
|
/**
|
|
217
233
|
* The ID for the network interface.
|
|
@@ -323,6 +323,14 @@ declare class WorkDocs extends Service {
|
|
|
323
323
|
* Recovers a deleted version of an Amazon WorkDocs document.
|
|
324
324
|
*/
|
|
325
325
|
restoreDocumentVersions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
326
|
+
/**
|
|
327
|
+
* Searches metadata and the content of folders, documents, document versions, and comments.
|
|
328
|
+
*/
|
|
329
|
+
searchResources(params: WorkDocs.Types.SearchResourcesRequest, callback?: (err: AWSError, data: WorkDocs.Types.SearchResourcesResponse) => void): Request<WorkDocs.Types.SearchResourcesResponse, AWSError>;
|
|
330
|
+
/**
|
|
331
|
+
* Searches metadata and the content of folders, documents, document versions, and comments.
|
|
332
|
+
*/
|
|
333
|
+
searchResources(callback?: (err: AWSError, data: WorkDocs.Types.SearchResourcesResponse) => void): Request<WorkDocs.Types.SearchResourcesResponse, AWSError>;
|
|
326
334
|
/**
|
|
327
335
|
* Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
|
|
328
336
|
*/
|
|
@@ -451,6 +459,8 @@ declare namespace WorkDocs {
|
|
|
451
459
|
*/
|
|
452
460
|
ShareResults?: ShareResultsList;
|
|
453
461
|
}
|
|
462
|
+
export type AdditionalResponseFieldType = "WEBURL"|string;
|
|
463
|
+
export type AdditionalResponseFieldsList = AdditionalResponseFieldType[];
|
|
454
464
|
export type AuthenticationHeaderType = string;
|
|
455
465
|
export type BooleanEnumType = "TRUE"|"FALSE"|string;
|
|
456
466
|
export type BooleanType = boolean;
|
|
@@ -515,10 +525,15 @@ declare namespace WorkDocs {
|
|
|
515
525
|
* The ID of the user being replied to.
|
|
516
526
|
*/
|
|
517
527
|
RecipientId?: IdType;
|
|
528
|
+
/**
|
|
529
|
+
* The ID of the user who made the comment.
|
|
530
|
+
*/
|
|
531
|
+
ContributorId?: IdType;
|
|
518
532
|
}
|
|
519
533
|
export type CommentStatusType = "DRAFT"|"PUBLISHED"|"DELETED"|string;
|
|
520
534
|
export type CommentTextType = string;
|
|
521
535
|
export type CommentVisibilityType = "PUBLIC"|"PRIVATE"|string;
|
|
536
|
+
export type ContentCategoryType = "IMAGE"|"DOCUMENT"|"PDF"|"SPREADSHEET"|"PRESENTATION"|"AUDIO"|"VIDEO"|"SOURCE_CODE"|"OTHER"|string;
|
|
522
537
|
export interface CreateCommentRequest {
|
|
523
538
|
/**
|
|
524
539
|
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
|
|
@@ -687,6 +702,16 @@ declare namespace WorkDocs {
|
|
|
687
702
|
export type CustomMetadataKeyType = string;
|
|
688
703
|
export type CustomMetadataMap = {[key: string]: CustomMetadataValueType};
|
|
689
704
|
export type CustomMetadataValueType = string;
|
|
705
|
+
export interface DateRangeType {
|
|
706
|
+
/**
|
|
707
|
+
* Timestamp range start value (in epochs)
|
|
708
|
+
*/
|
|
709
|
+
StartValue?: TimestampType;
|
|
710
|
+
/**
|
|
711
|
+
* Timestamp range end value (in epochs).
|
|
712
|
+
*/
|
|
713
|
+
EndValue?: TimestampType;
|
|
714
|
+
}
|
|
690
715
|
export interface DeactivateUserRequest {
|
|
691
716
|
/**
|
|
692
717
|
* The ID of the user.
|
|
@@ -1263,6 +1288,48 @@ declare namespace WorkDocs {
|
|
|
1263
1288
|
export type DocumentVersionStatus = "ACTIVE"|string;
|
|
1264
1289
|
export type EmailAddressType = string;
|
|
1265
1290
|
export type FieldNamesType = string;
|
|
1291
|
+
export interface Filters {
|
|
1292
|
+
/**
|
|
1293
|
+
* Filters by the locale of the content or comment.
|
|
1294
|
+
*/
|
|
1295
|
+
TextLocales?: TextLocaleTypeList;
|
|
1296
|
+
/**
|
|
1297
|
+
* Filters by content category.
|
|
1298
|
+
*/
|
|
1299
|
+
ContentCategories?: SearchContentCategoryTypeList;
|
|
1300
|
+
/**
|
|
1301
|
+
* Filters based on entity type.
|
|
1302
|
+
*/
|
|
1303
|
+
ResourceTypes?: SearchResourceTypeList;
|
|
1304
|
+
/**
|
|
1305
|
+
* Filter by labels using exact match.
|
|
1306
|
+
*/
|
|
1307
|
+
Labels?: SearchLabelList;
|
|
1308
|
+
/**
|
|
1309
|
+
* Filter based on UserIds or GroupIds.
|
|
1310
|
+
*/
|
|
1311
|
+
Principals?: SearchPrincipalTypeList;
|
|
1312
|
+
/**
|
|
1313
|
+
* Filter based on resource’s path.
|
|
1314
|
+
*/
|
|
1315
|
+
AncestorIds?: SearchAncestorIdList;
|
|
1316
|
+
/**
|
|
1317
|
+
* Filter based on file groupings.
|
|
1318
|
+
*/
|
|
1319
|
+
SearchCollectionTypes?: SearchCollectionTypeList;
|
|
1320
|
+
/**
|
|
1321
|
+
* Filter based on size (in bytes).
|
|
1322
|
+
*/
|
|
1323
|
+
SizeRange?: LongRangeType;
|
|
1324
|
+
/**
|
|
1325
|
+
* Filter based on resource’s creation timestamp.
|
|
1326
|
+
*/
|
|
1327
|
+
CreatedRange?: DateRangeType;
|
|
1328
|
+
/**
|
|
1329
|
+
* Filter based on resource’s modified timestamp.
|
|
1330
|
+
*/
|
|
1331
|
+
ModifiedRange?: DateRangeType;
|
|
1332
|
+
}
|
|
1266
1333
|
export type FolderContentType = "ALL"|"DOCUMENT"|"FOLDER"|string;
|
|
1267
1334
|
export interface FolderMetadata {
|
|
1268
1335
|
/**
|
|
@@ -1555,10 +1622,23 @@ declare namespace WorkDocs {
|
|
|
1555
1622
|
*/
|
|
1556
1623
|
UploadMetadata?: UploadMetadata;
|
|
1557
1624
|
}
|
|
1625
|
+
export type LanguageCodeType = "AR"|"BG"|"BN"|"DA"|"DE"|"CS"|"EL"|"EN"|"ES"|"FA"|"FI"|"FR"|"HI"|"HU"|"ID"|"IT"|"JA"|"KO"|"LT"|"LV"|"NL"|"NO"|"PT"|"RO"|"RU"|"SV"|"SW"|"TH"|"TR"|"ZH"|"DEFAULT"|string;
|
|
1558
1626
|
export type LimitType = number;
|
|
1559
1627
|
export type LocaleType = "en"|"fr"|"ko"|"de"|"es"|"ja"|"ru"|"zh_CN"|"zh_TW"|"pt_BR"|"default"|string;
|
|
1628
|
+
export interface LongRangeType {
|
|
1629
|
+
/**
|
|
1630
|
+
* The size start range (in bytes).
|
|
1631
|
+
*/
|
|
1632
|
+
StartValue?: LongType;
|
|
1633
|
+
/**
|
|
1634
|
+
* The size end range (in bytes).
|
|
1635
|
+
*/
|
|
1636
|
+
EndValue?: LongType;
|
|
1637
|
+
}
|
|
1638
|
+
export type LongType = number;
|
|
1560
1639
|
export type MarkerType = string;
|
|
1561
1640
|
export type MessageType = string;
|
|
1641
|
+
export type NextMarkerType = string;
|
|
1562
1642
|
export interface NotificationOptions {
|
|
1563
1643
|
/**
|
|
1564
1644
|
* Boolean value to indicate an email notification should be sent to the recipients.
|
|
@@ -1569,6 +1649,7 @@ declare namespace WorkDocs {
|
|
|
1569
1649
|
*/
|
|
1570
1650
|
EmailMessage?: MessageType;
|
|
1571
1651
|
}
|
|
1652
|
+
export type OrderByFieldType = "RELEVANCE"|"NAME"|"SIZE"|"CREATED_TIMESTAMP"|"MODIFIED_TIMESTAMP"|string;
|
|
1572
1653
|
export type OrderType = "ASCENDING"|"DESCENDING"|string;
|
|
1573
1654
|
export type OrganizationUserList = User[];
|
|
1574
1655
|
export type PageMarkerType = string;
|
|
@@ -1611,6 +1692,7 @@ declare namespace WorkDocs {
|
|
|
1611
1692
|
Roles?: PermissionInfoList;
|
|
1612
1693
|
}
|
|
1613
1694
|
export type PrincipalList = Principal[];
|
|
1695
|
+
export type PrincipalRoleType = "VIEWER"|"CONTRIBUTOR"|"OWNER"|"COOWNER"|string;
|
|
1614
1696
|
export type PrincipalType = "USER"|"GROUP"|"INVITE"|"ANONYMOUS"|"ORGANIZATION"|string;
|
|
1615
1697
|
export interface RemoveAllResourcePermissionsRequest {
|
|
1616
1698
|
/**
|
|
@@ -1693,6 +1775,35 @@ declare namespace WorkDocs {
|
|
|
1693
1775
|
export type ResourceSortType = "DATE"|"NAME"|string;
|
|
1694
1776
|
export type ResourceStateType = "ACTIVE"|"RESTORING"|"RECYCLING"|"RECYCLED"|string;
|
|
1695
1777
|
export type ResourceType = "FOLDER"|"DOCUMENT"|string;
|
|
1778
|
+
export interface ResponseItem {
|
|
1779
|
+
/**
|
|
1780
|
+
* The type of item being returned.
|
|
1781
|
+
*/
|
|
1782
|
+
ResourceType?: ResponseItemType;
|
|
1783
|
+
/**
|
|
1784
|
+
* The webUrl of the item being returned.
|
|
1785
|
+
*/
|
|
1786
|
+
WebUrl?: ResponseItemWebUrl;
|
|
1787
|
+
/**
|
|
1788
|
+
* The document that matches the query.
|
|
1789
|
+
*/
|
|
1790
|
+
DocumentMetadata?: DocumentMetadata;
|
|
1791
|
+
/**
|
|
1792
|
+
* The folder that matches the query.
|
|
1793
|
+
*/
|
|
1794
|
+
FolderMetadata?: FolderMetadata;
|
|
1795
|
+
/**
|
|
1796
|
+
* The comment that matches the query.
|
|
1797
|
+
*/
|
|
1798
|
+
CommentMetadata?: CommentMetadata;
|
|
1799
|
+
/**
|
|
1800
|
+
* The document version that matches the metadata.
|
|
1801
|
+
*/
|
|
1802
|
+
DocumentVersionMetadata?: DocumentVersionMetadata;
|
|
1803
|
+
}
|
|
1804
|
+
export type ResponseItemType = "DOCUMENT"|"FOLDER"|"COMMENT"|"DOCUMENT_VERSION"|string;
|
|
1805
|
+
export type ResponseItemWebUrl = string;
|
|
1806
|
+
export type ResponseItemsList = ResponseItem[];
|
|
1696
1807
|
export interface RestoreDocumentVersionsRequest {
|
|
1697
1808
|
/**
|
|
1698
1809
|
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
|
|
@@ -1705,8 +1816,91 @@ declare namespace WorkDocs {
|
|
|
1705
1816
|
}
|
|
1706
1817
|
export type RolePermissionType = "DIRECT"|"INHERITED"|string;
|
|
1707
1818
|
export type RoleType = "VIEWER"|"CONTRIBUTOR"|"OWNER"|"COOWNER"|string;
|
|
1819
|
+
export type SearchAncestorId = string;
|
|
1820
|
+
export type SearchAncestorIdList = SearchAncestorId[];
|
|
1821
|
+
export type SearchCollectionType = "OWNED"|"SHARED_WITH_ME"|string;
|
|
1822
|
+
export type SearchCollectionTypeList = SearchCollectionType[];
|
|
1823
|
+
export type SearchContentCategoryTypeList = ContentCategoryType[];
|
|
1824
|
+
export type SearchLabel = string;
|
|
1825
|
+
export type SearchLabelList = SearchLabel[];
|
|
1708
1826
|
export type SearchMarkerType = string;
|
|
1827
|
+
export type SearchPrincipalRoleList = PrincipalRoleType[];
|
|
1828
|
+
export interface SearchPrincipalType {
|
|
1829
|
+
/**
|
|
1830
|
+
* UserIds or GroupIds.
|
|
1831
|
+
*/
|
|
1832
|
+
Id: IdType;
|
|
1833
|
+
/**
|
|
1834
|
+
* The Role of a User or Group.
|
|
1835
|
+
*/
|
|
1836
|
+
Roles?: SearchPrincipalRoleList;
|
|
1837
|
+
}
|
|
1838
|
+
export type SearchPrincipalTypeList = SearchPrincipalType[];
|
|
1839
|
+
export type SearchQueryScopeType = "NAME"|"CONTENT"|string;
|
|
1840
|
+
export type SearchQueryScopeTypeList = SearchQueryScopeType[];
|
|
1709
1841
|
export type SearchQueryType = string;
|
|
1842
|
+
export type SearchResourceType = "FOLDER"|"DOCUMENT"|"COMMENT"|"DOCUMENT_VERSION"|string;
|
|
1843
|
+
export type SearchResourceTypeList = SearchResourceType[];
|
|
1844
|
+
export interface SearchResourcesRequest {
|
|
1845
|
+
/**
|
|
1846
|
+
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
|
|
1847
|
+
*/
|
|
1848
|
+
AuthenticationToken?: AuthenticationHeaderType;
|
|
1849
|
+
/**
|
|
1850
|
+
* The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
|
|
1851
|
+
*/
|
|
1852
|
+
QueryText?: SearchQueryType;
|
|
1853
|
+
/**
|
|
1854
|
+
* Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
|
|
1855
|
+
*/
|
|
1856
|
+
QueryScopes?: SearchQueryScopeTypeList;
|
|
1857
|
+
/**
|
|
1858
|
+
* Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
|
|
1859
|
+
*/
|
|
1860
|
+
OrganizationId?: IdType;
|
|
1861
|
+
/**
|
|
1862
|
+
* A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
|
|
1863
|
+
*/
|
|
1864
|
+
AdditionalResponseFields?: AdditionalResponseFieldsList;
|
|
1865
|
+
/**
|
|
1866
|
+
* Filters results based on entity metadata.
|
|
1867
|
+
*/
|
|
1868
|
+
Filters?: Filters;
|
|
1869
|
+
/**
|
|
1870
|
+
* Order by results in one or more categories.
|
|
1871
|
+
*/
|
|
1872
|
+
OrderBy?: SearchResultSortList;
|
|
1873
|
+
/**
|
|
1874
|
+
* Max results count per page.
|
|
1875
|
+
*/
|
|
1876
|
+
Limit?: SearchResultsLimitType;
|
|
1877
|
+
/**
|
|
1878
|
+
* The marker for the next set of results.
|
|
1879
|
+
*/
|
|
1880
|
+
Marker?: NextMarkerType;
|
|
1881
|
+
}
|
|
1882
|
+
export interface SearchResourcesResponse {
|
|
1883
|
+
/**
|
|
1884
|
+
* List of Documents, Folders, Comments, and Document Versions matching the query.
|
|
1885
|
+
*/
|
|
1886
|
+
Items?: ResponseItemsList;
|
|
1887
|
+
/**
|
|
1888
|
+
* The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
|
|
1889
|
+
*/
|
|
1890
|
+
Marker?: NextMarkerType;
|
|
1891
|
+
}
|
|
1892
|
+
export type SearchResultSortList = SearchSortResult[];
|
|
1893
|
+
export type SearchResultsLimitType = number;
|
|
1894
|
+
export interface SearchSortResult {
|
|
1895
|
+
/**
|
|
1896
|
+
* Sort search results based on this field name.
|
|
1897
|
+
*/
|
|
1898
|
+
Field?: OrderByFieldType;
|
|
1899
|
+
/**
|
|
1900
|
+
* Sort direction.
|
|
1901
|
+
*/
|
|
1902
|
+
Order?: SortOrder;
|
|
1903
|
+
}
|
|
1710
1904
|
export interface SharePrincipal {
|
|
1711
1905
|
/**
|
|
1712
1906
|
* The ID of the recipient.
|
|
@@ -1754,6 +1948,7 @@ declare namespace WorkDocs {
|
|
|
1754
1948
|
export type SharedLabels = SharedLabel[];
|
|
1755
1949
|
export type SignedHeaderMap = {[key: string]: HeaderValueType};
|
|
1756
1950
|
export type SizeType = number;
|
|
1951
|
+
export type SortOrder = "ASC"|"DESC"|string;
|
|
1757
1952
|
export interface StorageRuleType {
|
|
1758
1953
|
/**
|
|
1759
1954
|
* The amount of storage allocated, in bytes.
|
|
@@ -1783,6 +1978,7 @@ declare namespace WorkDocs {
|
|
|
1783
1978
|
export type SubscriptionList = Subscription[];
|
|
1784
1979
|
export type SubscriptionProtocolType = "HTTPS"|"SQS"|string;
|
|
1785
1980
|
export type SubscriptionType = "ALL"|string;
|
|
1981
|
+
export type TextLocaleTypeList = LanguageCodeType[];
|
|
1786
1982
|
export type TimeZoneIdType = string;
|
|
1787
1983
|
export type TimestampType = Date;
|
|
1788
1984
|
export interface UpdateDocumentRequest {
|