aws-sdk 2.1404.0 → 2.1406.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 +19 -1
- package/README.md +1 -1
- package/apis/appfabric-2023-05-19.examples.json +5 -0
- package/apis/appfabric-2023-05-19.min.json +1254 -0
- package/apis/appfabric-2023-05-19.paginators.json +28 -0
- package/apis/appfabric-2023-05-19.waiters2.json +5 -0
- package/apis/appflow-2020-08-23.min.json +3 -0
- package/apis/connect-2017-08-08.min.json +79 -27
- package/apis/connect-2017-08-08.paginators.json +6 -0
- package/apis/emr-serverless-2021-07-13.min.json +2 -1
- package/apis/glue-2017-03-31.min.json +358 -348
- package/apis/guardduty-2017-11-28.min.json +54 -49
- package/apis/iam-2010-05-08.min.json +85 -54
- package/apis/iam-2010-05-08.paginators.json +49 -0
- package/apis/ivs-2020-07-14.min.json +99 -23
- package/apis/kinesisvideo-2017-09-30.min.json +117 -25
- package/apis/kinesisvideo-2017-09-30.paginators.json +6 -0
- package/apis/metadata.json +3 -0
- package/apis/pinpoint-2016-12-01.min.json +202 -192
- package/apis/privatenetworks-2021-12-03.min.json +127 -69
- package/apis/sagemaker-2017-07-24.min.json +667 -647
- package/apis/sagemaker-featurestore-runtime-2020-07-01.min.json +30 -10
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/appfabric.d.ts +1127 -0
- package/clients/appfabric.js +19 -0
- package/clients/appflow.d.ts +4 -0
- package/clients/connect.d.ts +82 -4
- package/clients/emrserverless.d.ts +10 -6
- package/clients/glue.d.ts +11 -2
- package/clients/guardduty.d.ts +7 -2
- package/clients/iam.d.ts +51 -12
- package/clients/ivs.d.ts +80 -0
- package/clients/kinesisvideo.d.ts +144 -10
- package/clients/macie2.d.ts +18 -18
- package/clients/pinpoint.d.ts +10 -0
- package/clients/privatenetworks.d.ts +67 -5
- package/clients/sagemaker.d.ts +27 -1
- package/clients/sagemakerfeaturestoreruntime.d.ts +36 -2
- package/clients/ssm.d.ts +16 -16
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +63 -19
- package/dist/aws-sdk.js +348 -109
- package/dist/aws-sdk.min.js +78 -78
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/package.json +1 -1
@@ -27,6 +27,14 @@ declare class KinesisVideo extends Service {
|
|
27
27
|
* Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream action.
|
28
28
|
*/
|
29
29
|
createStream(callback?: (err: AWSError, data: KinesisVideo.Types.CreateStreamOutput) => void): Request<KinesisVideo.Types.CreateStreamOutput, AWSError>;
|
30
|
+
/**
|
31
|
+
* An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent. When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion. When the deletion process has completed successfully, the edge configuration is no longer accessible.
|
32
|
+
*/
|
33
|
+
deleteEdgeConfiguration(params: KinesisVideo.Types.DeleteEdgeConfigurationInput, callback?: (err: AWSError, data: KinesisVideo.Types.DeleteEdgeConfigurationOutput) => void): Request<KinesisVideo.Types.DeleteEdgeConfigurationOutput, AWSError>;
|
34
|
+
/**
|
35
|
+
* An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent. When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion. When the deletion process has completed successfully, the edge configuration is no longer accessible.
|
36
|
+
*/
|
37
|
+
deleteEdgeConfiguration(callback?: (err: AWSError, data: KinesisVideo.Types.DeleteEdgeConfigurationOutput) => void): Request<KinesisVideo.Types.DeleteEdgeConfigurationOutput, AWSError>;
|
30
38
|
/**
|
31
39
|
* Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.
|
32
40
|
*/
|
@@ -44,11 +52,11 @@ declare class KinesisVideo extends Service {
|
|
44
52
|
*/
|
45
53
|
deleteStream(callback?: (err: AWSError, data: KinesisVideo.Types.DeleteStreamOutput) => void): Request<KinesisVideo.Types.DeleteStreamOutput, AWSError>;
|
46
54
|
/**
|
47
|
-
* Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.
|
55
|
+
* Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.
|
48
56
|
*/
|
49
57
|
describeEdgeConfiguration(params: KinesisVideo.Types.DescribeEdgeConfigurationInput, callback?: (err: AWSError, data: KinesisVideo.Types.DescribeEdgeConfigurationOutput) => void): Request<KinesisVideo.Types.DescribeEdgeConfigurationOutput, AWSError>;
|
50
58
|
/**
|
51
|
-
* Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.
|
59
|
+
* Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.
|
52
60
|
*/
|
53
61
|
describeEdgeConfiguration(callback?: (err: AWSError, data: KinesisVideo.Types.DescribeEdgeConfigurationOutput) => void): Request<KinesisVideo.Types.DescribeEdgeConfigurationOutput, AWSError>;
|
54
62
|
/**
|
@@ -60,11 +68,11 @@ declare class KinesisVideo extends Service {
|
|
60
68
|
*/
|
61
69
|
describeImageGenerationConfiguration(callback?: (err: AWSError, data: KinesisVideo.Types.DescribeImageGenerationConfigurationOutput) => void): Request<KinesisVideo.Types.DescribeImageGenerationConfigurationOutput, AWSError>;
|
62
70
|
/**
|
63
|
-
* Returns the most current information about the stream.
|
71
|
+
* Returns the most current information about the stream. The streamName or streamARN should be provided in the input.
|
64
72
|
*/
|
65
73
|
describeMappedResourceConfiguration(params: KinesisVideo.Types.DescribeMappedResourceConfigurationInput, callback?: (err: AWSError, data: KinesisVideo.Types.DescribeMappedResourceConfigurationOutput) => void): Request<KinesisVideo.Types.DescribeMappedResourceConfigurationOutput, AWSError>;
|
66
74
|
/**
|
67
|
-
* Returns the most current information about the stream.
|
75
|
+
* Returns the most current information about the stream. The streamName or streamARN should be provided in the input.
|
68
76
|
*/
|
69
77
|
describeMappedResourceConfiguration(callback?: (err: AWSError, data: KinesisVideo.Types.DescribeMappedResourceConfigurationOutput) => void): Request<KinesisVideo.Types.DescribeMappedResourceConfigurationOutput, AWSError>;
|
70
78
|
/**
|
@@ -115,6 +123,14 @@ declare class KinesisVideo extends Service {
|
|
115
123
|
* Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties. Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint. Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.
|
116
124
|
*/
|
117
125
|
getSignalingChannelEndpoint(callback?: (err: AWSError, data: KinesisVideo.Types.GetSignalingChannelEndpointOutput) => void): Request<KinesisVideo.Types.GetSignalingChannelEndpointOutput, AWSError>;
|
126
|
+
/**
|
127
|
+
* Returns an array of edge configurations associated with the specified Edge Agent. In the request, you must specify the Edge Agent HubDeviceArn.
|
128
|
+
*/
|
129
|
+
listEdgeAgentConfigurations(params: KinesisVideo.Types.ListEdgeAgentConfigurationsInput, callback?: (err: AWSError, data: KinesisVideo.Types.ListEdgeAgentConfigurationsOutput) => void): Request<KinesisVideo.Types.ListEdgeAgentConfigurationsOutput, AWSError>;
|
130
|
+
/**
|
131
|
+
* Returns an array of edge configurations associated with the specified Edge Agent. In the request, you must specify the Edge Agent HubDeviceArn.
|
132
|
+
*/
|
133
|
+
listEdgeAgentConfigurations(callback?: (err: AWSError, data: KinesisVideo.Types.ListEdgeAgentConfigurationsOutput) => void): Request<KinesisVideo.Types.ListEdgeAgentConfigurationsOutput, AWSError>;
|
118
134
|
/**
|
119
135
|
* Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
|
120
136
|
*/
|
@@ -323,7 +339,7 @@ declare namespace KinesisVideo {
|
|
323
339
|
*/
|
324
340
|
MediaType?: MediaType;
|
325
341
|
/**
|
326
|
-
* The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (
|
342
|
+
* The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (Amazon Web Services/kinesisvideo) is used. For more information, see DescribeKey.
|
327
343
|
*/
|
328
344
|
KmsKeyId?: KmsKeyId;
|
329
345
|
/**
|
@@ -345,6 +361,18 @@ declare namespace KinesisVideo {
|
|
345
361
|
export type DataRetentionChangeInHours = number;
|
346
362
|
export type DataRetentionInHours = number;
|
347
363
|
export type DeleteAfterUpload = boolean;
|
364
|
+
export interface DeleteEdgeConfigurationInput {
|
365
|
+
/**
|
366
|
+
* The name of the stream from which to delete the edge configuration. Specify either the StreamName or the StreamARN.
|
367
|
+
*/
|
368
|
+
StreamName?: StreamName;
|
369
|
+
/**
|
370
|
+
* The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.
|
371
|
+
*/
|
372
|
+
StreamARN?: ResourceARN;
|
373
|
+
}
|
374
|
+
export interface DeleteEdgeConfigurationOutput {
|
375
|
+
}
|
348
376
|
export interface DeleteSignalingChannelInput {
|
349
377
|
/**
|
350
378
|
* The Amazon Resource Name (ARN) of the signaling channel that you want to delete.
|
@@ -379,7 +407,7 @@ declare namespace KinesisVideo {
|
|
379
407
|
*/
|
380
408
|
LocalSizeConfig?: LocalSizeConfig;
|
381
409
|
/**
|
382
|
-
* The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached. Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to
|
410
|
+
* The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to true, such as when the limit for the EdgeRetentionInHours, or the MaxLocalMediaSizeInMB, has been reached. Since the default value is set to true, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.
|
383
411
|
*/
|
384
412
|
DeleteAfterUpload?: DeleteAfterUpload;
|
385
413
|
}
|
@@ -422,6 +450,10 @@ declare namespace KinesisVideo {
|
|
422
450
|
* A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.
|
423
451
|
*/
|
424
452
|
EdgeConfig?: EdgeConfig;
|
453
|
+
/**
|
454
|
+
* An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.
|
455
|
+
*/
|
456
|
+
EdgeAgentStatus?: EdgeAgentStatus;
|
425
457
|
}
|
426
458
|
export interface DescribeImageGenerationConfigurationInput {
|
427
459
|
/**
|
@@ -535,6 +567,16 @@ declare namespace KinesisVideo {
|
|
535
567
|
export type DestinationUri = string;
|
536
568
|
export type DeviceName = string;
|
537
569
|
export type DurationInSeconds = number;
|
570
|
+
export interface EdgeAgentStatus {
|
571
|
+
/**
|
572
|
+
* The latest status of a stream’s edge recording job.
|
573
|
+
*/
|
574
|
+
LastRecorderStatus?: LastRecorderStatus;
|
575
|
+
/**
|
576
|
+
* The latest status of a stream’s edge to cloud uploader job.
|
577
|
+
*/
|
578
|
+
LastUploaderStatus?: LastUploaderStatus;
|
579
|
+
}
|
538
580
|
export interface EdgeConfig {
|
539
581
|
/**
|
540
582
|
* The "Internet of Things (IoT) Thing" Arn of the stream.
|
@@ -637,12 +679,102 @@ declare namespace KinesisVideo {
|
|
637
679
|
*/
|
638
680
|
Uri: DestinationUri;
|
639
681
|
/**
|
640
|
-
* The
|
682
|
+
* The Amazon Web Services Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.
|
641
683
|
*/
|
642
684
|
DestinationRegion: DestinationRegion;
|
643
685
|
}
|
644
686
|
export type ImageSelectorType = "SERVER_TIMESTAMP"|"PRODUCER_TIMESTAMP"|string;
|
687
|
+
export type JobStatusDetails = string;
|
645
688
|
export type KmsKeyId = string;
|
689
|
+
export interface LastRecorderStatus {
|
690
|
+
/**
|
691
|
+
* A description of a recorder job’s latest status.
|
692
|
+
*/
|
693
|
+
JobStatusDetails?: JobStatusDetails;
|
694
|
+
/**
|
695
|
+
* The timestamp at which the recorder job was last executed and media stored to local disk.
|
696
|
+
*/
|
697
|
+
LastCollectedTime?: Timestamp;
|
698
|
+
/**
|
699
|
+
* The timestamp at which the recorder status was last updated.
|
700
|
+
*/
|
701
|
+
LastUpdatedTime?: Timestamp;
|
702
|
+
/**
|
703
|
+
* The status of the latest recorder job.
|
704
|
+
*/
|
705
|
+
RecorderStatus?: RecorderStatus;
|
706
|
+
}
|
707
|
+
export interface LastUploaderStatus {
|
708
|
+
/**
|
709
|
+
* A description of an uploader job’s latest status.
|
710
|
+
*/
|
711
|
+
JobStatusDetails?: JobStatusDetails;
|
712
|
+
/**
|
713
|
+
* The timestamp at which the uploader job was last executed and media collected to the cloud.
|
714
|
+
*/
|
715
|
+
LastCollectedTime?: Timestamp;
|
716
|
+
/**
|
717
|
+
* The timestamp at which the uploader status was last updated.
|
718
|
+
*/
|
719
|
+
LastUpdatedTime?: Timestamp;
|
720
|
+
/**
|
721
|
+
* The status of the latest uploader job.
|
722
|
+
*/
|
723
|
+
UploaderStatus?: UploaderStatus;
|
724
|
+
}
|
725
|
+
export interface ListEdgeAgentConfigurationsEdgeConfig {
|
726
|
+
/**
|
727
|
+
* The name of the stream.
|
728
|
+
*/
|
729
|
+
StreamName?: StreamName;
|
730
|
+
/**
|
731
|
+
* The Amazon Resource Name (ARN) of the stream.
|
732
|
+
*/
|
733
|
+
StreamARN?: ResourceARN;
|
734
|
+
/**
|
735
|
+
* The timestamp when the stream first created the edge config.
|
736
|
+
*/
|
737
|
+
CreationTime?: Timestamp;
|
738
|
+
/**
|
739
|
+
* The timestamp when the stream last updated the edge config.
|
740
|
+
*/
|
741
|
+
LastUpdatedTime?: Timestamp;
|
742
|
+
/**
|
743
|
+
* The current sync status of the stream's edge configuration.
|
744
|
+
*/
|
745
|
+
SyncStatus?: SyncStatus;
|
746
|
+
/**
|
747
|
+
* A description of the generated failure status.
|
748
|
+
*/
|
749
|
+
FailedStatusDetails?: FailedStatusDetails;
|
750
|
+
EdgeConfig?: EdgeConfig;
|
751
|
+
}
|
752
|
+
export type ListEdgeAgentConfigurationsEdgeConfigList = ListEdgeAgentConfigurationsEdgeConfig[];
|
753
|
+
export interface ListEdgeAgentConfigurationsInput {
|
754
|
+
/**
|
755
|
+
* The "Internet of Things (IoT) Thing" Arn of the edge agent.
|
756
|
+
*/
|
757
|
+
HubDeviceArn: HubDeviceArn;
|
758
|
+
/**
|
759
|
+
* The maximum number of edge configurations to return in the response. The default is 5.
|
760
|
+
*/
|
761
|
+
MaxResults?: ListEdgeAgentConfigurationsInputLimit;
|
762
|
+
/**
|
763
|
+
* If you specify this parameter, when the result of a ListEdgeAgentConfigurations operation is truncated, the call returns the NextToken in the response. To get another batch of edge configurations, provide this token in your next request.
|
764
|
+
*/
|
765
|
+
NextToken?: NextToken;
|
766
|
+
}
|
767
|
+
export type ListEdgeAgentConfigurationsInputLimit = number;
|
768
|
+
export interface ListEdgeAgentConfigurationsOutput {
|
769
|
+
/**
|
770
|
+
* A description of a single stream's edge configuration.
|
771
|
+
*/
|
772
|
+
EdgeConfigs?: ListEdgeAgentConfigurationsEdgeConfigList;
|
773
|
+
/**
|
774
|
+
* If the response is truncated, the call returns this element with a given token. To get the next batch of edge configurations, use this token in your next request.
|
775
|
+
*/
|
776
|
+
NextToken?: NextToken;
|
777
|
+
}
|
646
778
|
export type ListOfProtocols = ChannelProtocol[];
|
647
779
|
export interface ListSignalingChannelsInput {
|
648
780
|
/**
|
@@ -762,7 +894,7 @@ declare namespace KinesisVideo {
|
|
762
894
|
export type MaxLocalMediaSizeInMB = number;
|
763
895
|
export interface MediaSourceConfig {
|
764
896
|
/**
|
765
|
-
* The
|
897
|
+
* The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.
|
766
898
|
*/
|
767
899
|
MediaUriSecretArn: MediaUriSecretArn;
|
768
900
|
/**
|
@@ -812,6 +944,7 @@ declare namespace KinesisVideo {
|
|
812
944
|
*/
|
813
945
|
ScheduleConfig?: ScheduleConfig;
|
814
946
|
}
|
947
|
+
export type RecorderStatus = "SUCCESS"|"USER_ERROR"|"SYSTEM_ERROR"|string;
|
815
948
|
export type ResourceARN = string;
|
816
949
|
export type ResourceEndpoint = string;
|
817
950
|
export type ResourceEndpointList = ResourceEndpointListItem[];
|
@@ -950,7 +1083,7 @@ declare namespace KinesisVideo {
|
|
950
1083
|
*/
|
951
1084
|
ComparisonValue?: StreamName;
|
952
1085
|
}
|
953
|
-
export type SyncStatus = "SYNCING"|"ACKNOWLEDGED"|"IN_SYNC"|"SYNC_FAILED"|"DELETING"|"DELETE_FAILED"|string;
|
1086
|
+
export type SyncStatus = "SYNCING"|"ACKNOWLEDGED"|"IN_SYNC"|"SYNC_FAILED"|"DELETING"|"DELETE_FAILED"|"DELETING_ACKNOWLEDGED"|string;
|
954
1087
|
export interface Tag {
|
955
1088
|
/**
|
956
1089
|
* The key of the tag that is associated with the specified signaling channel.
|
@@ -1135,10 +1268,11 @@ declare namespace KinesisVideo {
|
|
1135
1268
|
}
|
1136
1269
|
export interface UploaderConfig {
|
1137
1270
|
/**
|
1138
|
-
* The configuration that consists of the ScheduleExpression and the
|
1271
|
+
* The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in this UploaderConfig, then the Edge Agent will upload at regular intervals (every 1 hour).
|
1139
1272
|
*/
|
1140
1273
|
ScheduleConfig: ScheduleConfig;
|
1141
1274
|
}
|
1275
|
+
export type UploaderStatus = "SUCCESS"|"USER_ERROR"|"SYSTEM_ERROR"|string;
|
1142
1276
|
export type Version = string;
|
1143
1277
|
export type WidthPixels = number;
|
1144
1278
|
/**
|
package/clients/macie2.d.ts
CHANGED
@@ -269,11 +269,11 @@ declare class Macie2 extends Service {
|
|
269
269
|
*/
|
270
270
|
getCustomDataIdentifier(callback?: (err: AWSError, data: Macie2.Types.GetCustomDataIdentifierResponse) => void): Request<Macie2.Types.GetCustomDataIdentifierResponse, AWSError>;
|
271
271
|
/**
|
272
|
-
*
|
272
|
+
* Retrieves (queries) aggregated statistical data about findings.
|
273
273
|
*/
|
274
274
|
getFindingStatistics(params: Macie2.Types.GetFindingStatisticsRequest, callback?: (err: AWSError, data: Macie2.Types.GetFindingStatisticsResponse) => void): Request<Macie2.Types.GetFindingStatisticsResponse, AWSError>;
|
275
275
|
/**
|
276
|
-
*
|
276
|
+
* Retrieves (queries) aggregated statistical data about findings.
|
277
277
|
*/
|
278
278
|
getFindingStatistics(callback?: (err: AWSError, data: Macie2.Types.GetFindingStatisticsResponse) => void): Request<Macie2.Types.GetFindingStatisticsResponse, AWSError>;
|
279
279
|
/**
|
@@ -1210,7 +1210,7 @@ declare namespace Macie2 {
|
|
1210
1210
|
}
|
1211
1211
|
export interface ClassificationResult {
|
1212
1212
|
/**
|
1213
|
-
* Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data. This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (
|
1213
|
+
* Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data. This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).
|
1214
1214
|
*/
|
1215
1215
|
additionalOccurrences?: __boolean;
|
1216
1216
|
/**
|
@@ -1240,7 +1240,7 @@ declare namespace Macie2 {
|
|
1240
1240
|
*/
|
1241
1241
|
code?: __string;
|
1242
1242
|
/**
|
1243
|
-
* A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are: ARCHIVE_CONTAINS_UNPROCESSED_FILES - The object is an archive file and Macie extracted and analyzed only some or none of the files in the archive. To determine which files Macie analyzed, if any, refer to the corresponding sensitive data discovery result for the finding (
|
1243
|
+
* A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are: ARCHIVE_CONTAINS_UNPROCESSED_FILES - The object is an archive file and Macie extracted and analyzed only some or none of the files in the archive. To determine which files Macie analyzed, if any, refer to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation). ARCHIVE_EXCEEDS_SIZE_LIMIT - The object is an archive file whose total storage size exceeds the size quota for this type of archive. ARCHIVE_NESTING_LEVEL_OVER_LIMIT - The object is an archive file whose nested depth exceeds the quota for the maximum number of nested levels that Macie analyzes for this type of archive. ARCHIVE_TOTAL_BYTES_EXTRACTED_OVER_LIMIT - The object is an archive file that exceeds the quota for the maximum amount of data that Macie extracts and analyzes for this type of archive. ARCHIVE_TOTAL_DOCUMENTS_PROCESSED_OVER_LIMIT - The object is an archive file that contains more than the maximum number of files that Macie extracts and analyzes for this type of archive. FILE_EXCEEDS_SIZE_LIMIT - The storage size of the object exceeds the size quota for this type of file. INVALID_ENCRYPTION - The object is encrypted using server-side encryption but Macie isn't allowed to use the key. Macie can't decrypt and analyze the object. INVALID_KMS_KEY - The object is encrypted with an KMS key that was disabled or is being deleted. Macie can't decrypt and analyze the object. INVALID_OBJECT_STATE - The object doesn't use a supported Amazon S3 storage class. JSON_NESTING_LEVEL_OVER_LIMIT - The object contains JSON data and the nested depth of the data exceeds the quota for the number of nested levels that Macie analyzes for this type of file. MALFORMED_FILE - The object is a malformed or corrupted file. An error occurred when Macie attempted to detect the file's type or extract data from the file. MALFORMED_OR_FILE_SIZE_EXCEEDS_LIMIT - The object is a Microsoft Office file that is malformed or exceeds the size quota for this type of file. If the file is malformed, an error occurred when Macie attempted to extract data from the file. NO_SUCH_BUCKET_AVAILABLE - The object was in a bucket that was deleted shortly before or when Macie attempted to analyze the object. OBJECT_VERSION_MISMATCH - The object was changed while Macie was analyzing it. OOXML_UNCOMPRESSED_RATIO_EXCEEDS_LIMIT - The object is an Office Open XML file whose compression ratio exceeds the compression quota for this type of file. OOXML_UNCOMPRESSED_SIZE_EXCEEDS_LIMIT - The object is an Office Open XML file that exceeds the size quota for this type of file. PERMISSION_DENIED - Macie isn't allowed to access the object. The object's permissions settings prevent Macie from analyzing the object. SOURCE_OBJECT_NO_LONGER_AVAILABLE - The object was deleted shortly before or when Macie attempted to analyze it. TIME_CUT_OFF_REACHED - Macie started analyzing the object but additional analysis would exceed the time quota for analyzing an object. UNABLE_TO_PARSE_FILE - The object is a file that contains structured data and an error occurred when Macie attempted to parse the data. UNSUPPORTED_FILE_TYPE_EXCEPTION - The object is a file that uses an unsupported file or storage format. For information about quotas, supported storage classes, and supported file and storage formats, see Quotas and Supported storage classes and formats in the Amazon Macie User Guide.
|
1244
1244
|
*/
|
1245
1245
|
reason?: __string;
|
1246
1246
|
}
|
@@ -1319,7 +1319,7 @@ declare namespace Macie2 {
|
|
1319
1319
|
*/
|
1320
1320
|
managedDataIdentifierIds?: __listOf__string;
|
1321
1321
|
/**
|
1322
|
-
* The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are: ALL - Use all
|
1322
|
+
* The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are: ALL (default) - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property. EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property. INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property. NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property. RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. If you specify this value, don't specify any values for the managedDataIdentifierIds property. If you don't specify a value for this property, the job uses all managed data identifiers. If the job is a recurring job and you don't specify a value for this property or you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the job starts to run. For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
|
1323
1323
|
*/
|
1324
1324
|
managedDataIdentifierSelector?: ManagedDataIdentifierSelector;
|
1325
1325
|
/**
|
@@ -1383,7 +1383,7 @@ declare namespace Macie2 {
|
|
1383
1383
|
*/
|
1384
1384
|
regex: __string;
|
1385
1385
|
/**
|
1386
|
-
* The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that
|
1386
|
+
* The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding. If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.
|
1387
1387
|
*/
|
1388
1388
|
severityLevels?: SeverityLevelList;
|
1389
1389
|
/**
|
@@ -1744,11 +1744,11 @@ declare namespace Macie2 {
|
|
1744
1744
|
*/
|
1745
1745
|
lastRunTime?: __timestampIso8601;
|
1746
1746
|
/**
|
1747
|
-
* An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).
|
1747
|
+
* An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
|
1748
1748
|
*/
|
1749
1749
|
managedDataIdentifierIds?: __listOf__string;
|
1750
1750
|
/**
|
1751
|
-
* The selection type that determines which managed data identifiers the job uses
|
1751
|
+
* The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are: ALL (default) - Use all managed data identifiers. EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property. INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property. NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds). RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. If this value is null, the job uses all managed data identifiers. If the job is a recurring job and this value is null, ALL, or EXCLUDE, each job run automatically uses new managed data identifiers that are released after the job was created or the preceding run ended. If this value is RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts. For information about individual managed data identifiers or to determine which ones are in the recommended set, see Using managed data identifiers and Recommended managed data identifiers in the Amazon Macie User Guide.
|
1752
1752
|
*/
|
1753
1753
|
managedDataIdentifierSelector?: ManagedDataIdentifierSelector;
|
1754
1754
|
/**
|
@@ -2273,7 +2273,7 @@ declare namespace Macie2 {
|
|
2273
2273
|
*/
|
2274
2274
|
regex?: __string;
|
2275
2275
|
/**
|
2276
|
-
* Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that
|
2276
|
+
* Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.
|
2277
2277
|
*/
|
2278
2278
|
severityLevels?: SeverityLevelList;
|
2279
2279
|
/**
|
@@ -2497,7 +2497,7 @@ declare namespace Macie2 {
|
|
2497
2497
|
*/
|
2498
2498
|
code?: AvailabilityCode;
|
2499
2499
|
/**
|
2500
|
-
* Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are: INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the
|
2500
|
+
* Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are: INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the classificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format. OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data. OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding. UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding. UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data. This value is null if sensitive data can be retrieved for the finding.
|
2501
2501
|
*/
|
2502
2502
|
reasons?: __listOfUnavailabilityReasonCode;
|
2503
2503
|
}
|
@@ -3152,7 +3152,7 @@ declare namespace Macie2 {
|
|
3152
3152
|
tags?: TagMap;
|
3153
3153
|
}
|
3154
3154
|
export type MacieStatus = "PAUSED"|"ENABLED"|string;
|
3155
|
-
export type ManagedDataIdentifierSelector = "ALL"|"EXCLUDE"|"INCLUDE"|"NONE"|string;
|
3155
|
+
export type ManagedDataIdentifierSelector = "ALL"|"EXCLUDE"|"INCLUDE"|"NONE"|"RECOMMENDED"|string;
|
3156
3156
|
export interface ManagedDataIdentifierSummary {
|
3157
3157
|
/**
|
3158
3158
|
* The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.
|
@@ -3463,19 +3463,19 @@ declare namespace Macie2 {
|
|
3463
3463
|
*/
|
3464
3464
|
totalItemsSensitive?: __long;
|
3465
3465
|
/**
|
3466
|
-
* The total number of objects that Amazon Macie
|
3466
|
+
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.
|
3467
3467
|
*/
|
3468
3468
|
totalItemsSkipped?: __long;
|
3469
3469
|
/**
|
3470
|
-
* The total number of objects that Amazon Macie
|
3470
|
+
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys (SSE-C).
|
3471
3471
|
*/
|
3472
3472
|
totalItemsSkippedInvalidEncryption?: __long;
|
3473
3473
|
/**
|
3474
|
-
* The total number of objects that Amazon Macie
|
3474
|
+
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
|
3475
3475
|
*/
|
3476
3476
|
totalItemsSkippedInvalidKms?: __long;
|
3477
3477
|
/**
|
3478
|
-
* The total number of objects that Amazon Macie
|
3478
|
+
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
|
3479
3479
|
*/
|
3480
3480
|
totalItemsSkippedPermissionDenied?: __long;
|
3481
3481
|
}
|
@@ -3636,7 +3636,7 @@ declare namespace Macie2 {
|
|
3636
3636
|
*/
|
3637
3637
|
extension?: __string;
|
3638
3638
|
/**
|
3639
|
-
* The full
|
3639
|
+
* The full name (key) of the object, including the object's prefix if applicable.
|
3640
3640
|
*/
|
3641
3641
|
key?: __string;
|
3642
3642
|
/**
|
@@ -3644,7 +3644,7 @@ declare namespace Macie2 {
|
|
3644
3644
|
*/
|
3645
3645
|
lastModified?: __timestampIso8601;
|
3646
3646
|
/**
|
3647
|
-
* The path to the object, including the
|
3647
|
+
* The full path to the affected object, including the name of the affected bucket and the object's name (key).
|
3648
3648
|
*/
|
3649
3649
|
path?: __string;
|
3650
3650
|
/**
|
@@ -3990,7 +3990,7 @@ declare namespace Macie2 {
|
|
3990
3990
|
}
|
3991
3991
|
export interface SortCriteria {
|
3992
3992
|
/**
|
3993
|
-
* The name of the property to sort the results by.
|
3993
|
+
* The name of the property to sort the results by. Valid values are: count, createdAt, policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected, severity.score, type, and updatedAt.
|
3994
3994
|
*/
|
3995
3995
|
attributeName?: __string;
|
3996
3996
|
/**
|
package/clients/pinpoint.d.ts
CHANGED
@@ -5112,6 +5112,10 @@ declare namespace Pinpoint {
|
|
5112
5112
|
* The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.
|
5113
5113
|
*/
|
5114
5114
|
ClosedDays?: ClosedDays;
|
5115
|
+
/**
|
5116
|
+
* An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute. PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country. POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country. POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.
|
5117
|
+
*/
|
5118
|
+
TimezoneEstimationMethods?: ListOf__TimezoneEstimationMethodsElement;
|
5115
5119
|
}
|
5116
5120
|
export interface JourneyRunExecutionActivityMetricsResponse {
|
5117
5121
|
/**
|
@@ -7476,6 +7480,10 @@ declare namespace Pinpoint {
|
|
7476
7480
|
* The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
|
7477
7481
|
*/
|
7478
7482
|
ClosedDays?: ClosedDays;
|
7483
|
+
/**
|
7484
|
+
* An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute. PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country. POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country. POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.
|
7485
|
+
*/
|
7486
|
+
TimezoneEstimationMethods?: ListOf__TimezoneEstimationMethodsElement;
|
7479
7487
|
}
|
7480
7488
|
export interface WriteSegmentRequest {
|
7481
7489
|
/**
|
@@ -7526,6 +7534,7 @@ declare namespace Pinpoint {
|
|
7526
7534
|
TreatmentName?: __string;
|
7527
7535
|
}
|
7528
7536
|
export type __EndpointTypesElement = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP"|string;
|
7537
|
+
export type __TimezoneEstimationMethodsElement = "PHONE_NUMBER"|"POSTAL_CODE"|string;
|
7529
7538
|
export type __boolean = boolean;
|
7530
7539
|
export type __double = number;
|
7531
7540
|
export type __integer = number;
|
@@ -7555,6 +7564,7 @@ declare namespace Pinpoint {
|
|
7555
7564
|
export type ListOfTreatmentResource = TreatmentResource[];
|
7556
7565
|
export type ListOfWriteTreatmentResource = WriteTreatmentResource[];
|
7557
7566
|
export type ListOf__EndpointTypesElement = __EndpointTypesElement[];
|
7567
|
+
export type ListOf__TimezoneEstimationMethodsElement = __TimezoneEstimationMethodsElement[];
|
7558
7568
|
export type ListOf__string = __string[];
|
7559
7569
|
export type MapOfActivity = {[key: string]: Activity};
|
7560
7570
|
export type MapOfAddressConfiguration = {[key: string]: AddressConfiguration};
|
@@ -176,11 +176,11 @@ declare class PrivateNetworks extends Service {
|
|
176
176
|
*/
|
177
177
|
ping(callback?: (err: AWSError, data: PrivateNetworks.Types.PingResponse) => void): Request<PrivateNetworks.Types.PingResponse, AWSError>;
|
178
178
|
/**
|
179
|
-
*
|
179
|
+
* Use this action to do the following tasks: Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately. Request a replacement for a network resource. Request that you return a network resource. After you submit a request to replace or return a network resource, the status of the network resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network resource is PENDING_RETURN. After the network resource is successfully returned, its status changes to DELETED. For more information, see Return a radio unit.
|
180
180
|
*/
|
181
181
|
startNetworkResourceUpdate(params: PrivateNetworks.Types.StartNetworkResourceUpdateRequest, callback?: (err: AWSError, data: PrivateNetworks.Types.StartNetworkResourceUpdateResponse) => void): Request<PrivateNetworks.Types.StartNetworkResourceUpdateResponse, AWSError>;
|
182
182
|
/**
|
183
|
-
*
|
183
|
+
* Use this action to do the following tasks: Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately. Request a replacement for a network resource. Request that you return a network resource. After you submit a request to replace or return a network resource, the status of the network resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network resource is PENDING_RETURN. After the network resource is successfully returned, its status changes to DELETED. For more information, see Return a radio unit.
|
184
184
|
*/
|
185
185
|
startNetworkResourceUpdate(callback?: (err: AWSError, data: PrivateNetworks.Types.StartNetworkResourceUpdateResponse) => void): Request<PrivateNetworks.Types.StartNetworkResourceUpdateResponse, AWSError>;
|
186
186
|
/**
|
@@ -255,6 +255,10 @@ declare namespace PrivateNetworks {
|
|
255
255
|
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
|
256
256
|
*/
|
257
257
|
clientToken?: ClientToken;
|
258
|
+
/**
|
259
|
+
* Determines the duration and renewal status of the commitment period for all pending radio units. If you include commitmentConfiguration in the ActivateNetworkSiteRequest action, you must specify the following: The commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period. Whether you want your commitment period to automatically renew for one more year after your current commitment period expires. For pricing, see Amazon Web Services Private 5G Pricing. If you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the commitment period is set to 60-days.
|
260
|
+
*/
|
261
|
+
commitmentConfiguration?: CommitmentConfiguration;
|
258
262
|
/**
|
259
263
|
* The Amazon Resource Name (ARN) of the network site.
|
260
264
|
*/
|
@@ -283,12 +287,16 @@ declare namespace PrivateNetworks {
|
|
283
287
|
* The country for this address.
|
284
288
|
*/
|
285
289
|
country: AddressContent;
|
290
|
+
/**
|
291
|
+
* The recipient's email address.
|
292
|
+
*/
|
293
|
+
emailAddress?: AddressContent;
|
286
294
|
/**
|
287
295
|
* The recipient's name for this address.
|
288
296
|
*/
|
289
297
|
name: AddressContent;
|
290
298
|
/**
|
291
|
-
* The phone number
|
299
|
+
* The recipient's phone number.
|
292
300
|
*/
|
293
301
|
phoneNumber?: AddressContent;
|
294
302
|
/**
|
@@ -314,7 +322,33 @@ declare namespace PrivateNetworks {
|
|
314
322
|
}
|
315
323
|
export type AddressContent = string;
|
316
324
|
export type Arn = string;
|
325
|
+
export type Boolean = boolean;
|
317
326
|
export type ClientToken = string;
|
327
|
+
export interface CommitmentConfiguration {
|
328
|
+
/**
|
329
|
+
* Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires. Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew. You can do the following: Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate. Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate. Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment.
|
330
|
+
*/
|
331
|
+
automaticRenewal: Boolean;
|
332
|
+
/**
|
333
|
+
* The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
|
334
|
+
*/
|
335
|
+
commitmentLength: CommitmentLength;
|
336
|
+
}
|
337
|
+
export interface CommitmentInformation {
|
338
|
+
/**
|
339
|
+
* The duration and renewal status of the commitment period for the radio unit.
|
340
|
+
*/
|
341
|
+
commitmentConfiguration: CommitmentConfiguration;
|
342
|
+
/**
|
343
|
+
* The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
|
344
|
+
*/
|
345
|
+
expiresOn?: Timestamp;
|
346
|
+
/**
|
347
|
+
* The date and time that the commitment period started.
|
348
|
+
*/
|
349
|
+
startAt?: Timestamp;
|
350
|
+
}
|
351
|
+
export type CommitmentLength = "SIXTY_DAYS"|"ONE_YEAR"|"THREE_YEARS"|string;
|
318
352
|
export interface ConfigureAccessPointRequest {
|
319
353
|
/**
|
320
354
|
* The Amazon Resource Name (ARN) of the network resource.
|
@@ -800,6 +834,10 @@ declare namespace PrivateNetworks {
|
|
800
834
|
* The attributes of the network resource.
|
801
835
|
*/
|
802
836
|
attributes?: NameValuePairs;
|
837
|
+
/**
|
838
|
+
* Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
|
839
|
+
*/
|
840
|
+
commitmentInformation?: CommitmentInformation;
|
803
841
|
/**
|
804
842
|
* The creation time of the network resource.
|
805
843
|
*/
|
@@ -958,6 +996,10 @@ declare namespace PrivateNetworks {
|
|
958
996
|
* The Amazon Resource Name (ARN) of the order.
|
959
997
|
*/
|
960
998
|
orderArn?: Arn;
|
999
|
+
/**
|
1000
|
+
* A list of the network resources placed in the order.
|
1001
|
+
*/
|
1002
|
+
orderedResources?: OrderedResourceDefinitions;
|
961
1003
|
/**
|
962
1004
|
* The shipping address of the order.
|
963
1005
|
*/
|
@@ -971,6 +1013,22 @@ declare namespace PrivateNetworks {
|
|
971
1013
|
export type OrderFilterValues = String[];
|
972
1014
|
export type OrderFilters = {[key: string]: OrderFilterValues};
|
973
1015
|
export type OrderList = Order[];
|
1016
|
+
export interface OrderedResourceDefinition {
|
1017
|
+
/**
|
1018
|
+
* The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.
|
1019
|
+
*/
|
1020
|
+
commitmentConfiguration?: CommitmentConfiguration;
|
1021
|
+
/**
|
1022
|
+
* The number of network resources in the order.
|
1023
|
+
*/
|
1024
|
+
count: OrderedResourceDefinitionCountInteger;
|
1025
|
+
/**
|
1026
|
+
* The type of network resource in the order.
|
1027
|
+
*/
|
1028
|
+
type: NetworkResourceDefinitionType;
|
1029
|
+
}
|
1030
|
+
export type OrderedResourceDefinitionCountInteger = number;
|
1031
|
+
export type OrderedResourceDefinitions = OrderedResourceDefinition[];
|
974
1032
|
export type PaginationToken = string;
|
975
1033
|
export interface PingResponse {
|
976
1034
|
/**
|
@@ -1029,6 +1087,10 @@ declare namespace PrivateNetworks {
|
|
1029
1087
|
resourceDefinitions?: NetworkResourceDefinitions;
|
1030
1088
|
}
|
1031
1089
|
export interface StartNetworkResourceUpdateRequest {
|
1090
|
+
/**
|
1091
|
+
* Use this action to extend and automatically renew the commitment period for the radio unit. You can do the following: Change a 60-day commitment to a 1-year or 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the new commitment period. Change a 1-year commitment to a 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the 3-year commitment period. Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate. Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate. Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment. For pricing, see Amazon Web Services Private 5G Pricing.
|
1092
|
+
*/
|
1093
|
+
commitmentConfiguration?: CommitmentConfiguration;
|
1032
1094
|
/**
|
1033
1095
|
* The Amazon Resource Name (ARN) of the network resource.
|
1034
1096
|
*/
|
@@ -1042,7 +1104,7 @@ declare namespace PrivateNetworks {
|
|
1042
1104
|
*/
|
1043
1105
|
shippingAddress?: Address;
|
1044
1106
|
/**
|
1045
|
-
* The update type. REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you. RETURN - Submits a request to
|
1107
|
+
* The update type. REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you. RETURN - Submits a request to return a radio unit that you no longer need. We provide a shipping label that you can use for the return process. COMMITMENT - Submits a request to change or renew the commitment period. If you choose this value, then you must set commitmentConfiguration .
|
1046
1108
|
*/
|
1047
1109
|
updateType: UpdateType;
|
1048
1110
|
}
|
@@ -1128,7 +1190,7 @@ declare namespace PrivateNetworks {
|
|
1128
1190
|
*/
|
1129
1191
|
tags?: TagMap;
|
1130
1192
|
}
|
1131
|
-
export type UpdateType = "REPLACE"|"RETURN"|string;
|
1193
|
+
export type UpdateType = "REPLACE"|"RETURN"|"COMMITMENT"|string;
|
1132
1194
|
/**
|
1133
1195
|
* 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.
|
1134
1196
|
*/
|