aws-sdk 2.1410.0 → 2.1412.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 +12 -1
- package/README.md +1 -1
- package/apis/ec2-2016-11-15.min.json +281 -278
- package/apis/kms-2014-11-01.min.json +57 -15
- package/apis/location-2020-11-19.min.json +79 -40
- package/apis/mgn-2020-02-26.min.json +274 -130
- package/apis/mgn-2020-02-26.paginators.json +6 -0
- package/apis/outposts-2019-12-03.paginators.json +12 -6
- package/apis/quicksight-2018-04-01.min.json +561 -528
- package/clients/comprehendmedical.d.ts +46 -46
- package/clients/connect.d.ts +11 -11
- package/clients/ec2.d.ts +10 -5
- package/clients/kms.d.ts +58 -2
- package/clients/location.d.ts +50 -14
- package/clients/mgn.d.ts +275 -7
- package/clients/outposts.d.ts +4 -4
- package/clients/quicksight.d.ts +53 -7
- package/clients/rds.d.ts +35 -35
- package/clients/securityhub.d.ts +19 -19
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +8 -8
- package/dist/aws-sdk.js +420 -336
- package/dist/aws-sdk.min.js +70 -70
- package/lib/core.js +1 -1
- package/lib/credentials/shared_ini_file_credentials.js +2 -0
- package/package.json +1 -1
package/clients/kms.d.ts
CHANGED
@@ -332,11 +332,11 @@ declare class KMS extends Service {
|
|
332
332
|
*/
|
333
333
|
revokeGrant(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
334
334
|
/**
|
335
|
-
* Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it. Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key, or an asymmetric or HMAC KMS key with imported key material
|
335
|
+
* Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it. Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key, or an asymmetric or HMAC KMS key with imported key material.) To prevent the use of a KMS key without deleting it, use DisableKey. You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to PendingReplicaDeletion and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion and its waiting period (PendingWindowInDays) begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide. When KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. Deleting a KMS key from an external key store has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material. For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:ScheduleKeyDeletion (key policy) Related operations CancelKeyDeletion DisableKey
|
336
336
|
*/
|
337
337
|
scheduleKeyDeletion(params: KMS.Types.ScheduleKeyDeletionRequest, callback?: (err: AWSError, data: KMS.Types.ScheduleKeyDeletionResponse) => void): Request<KMS.Types.ScheduleKeyDeletionResponse, AWSError>;
|
338
338
|
/**
|
339
|
-
* Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it. Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key, or an asymmetric or HMAC KMS key with imported key material
|
339
|
+
* Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it. Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key, or an asymmetric or HMAC KMS key with imported key material.) To prevent the use of a KMS key without deleting it, use DisableKey. You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to PendingReplicaDeletion and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion and its waiting period (PendingWindowInDays) begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide. When KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. Deleting a KMS key from an external key store has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material. For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:ScheduleKeyDeletion (key policy) Related operations CancelKeyDeletion DisableKey
|
340
340
|
*/
|
341
341
|
scheduleKeyDeletion(callback?: (err: AWSError, data: KMS.Types.ScheduleKeyDeletionResponse) => void): Request<KMS.Types.ScheduleKeyDeletionResponse, AWSError>;
|
342
342
|
/**
|
@@ -553,6 +553,10 @@ declare namespace KMS {
|
|
553
553
|
* A friendly name for the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request. When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens for the same grant ID can be used interchangeably.
|
554
554
|
*/
|
555
555
|
Name?: GrantNameType;
|
556
|
+
/**
|
557
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
558
|
+
*/
|
559
|
+
DryRun?: NullableBooleanType;
|
556
560
|
}
|
557
561
|
export interface CreateGrantResponse {
|
558
562
|
/**
|
@@ -687,6 +691,10 @@ declare namespace KMS {
|
|
687
691
|
* A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
|
688
692
|
*/
|
689
693
|
Recipient?: RecipientInfo;
|
694
|
+
/**
|
695
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
696
|
+
*/
|
697
|
+
DryRun?: NullableBooleanType;
|
690
698
|
}
|
691
699
|
export interface DecryptResponse {
|
692
700
|
/**
|
@@ -828,6 +836,10 @@ declare namespace KMS {
|
|
828
836
|
* Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify. This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. The SM2PKE algorithm is only available in China Regions.
|
829
837
|
*/
|
830
838
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec;
|
839
|
+
/**
|
840
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
841
|
+
*/
|
842
|
+
DryRun?: NullableBooleanType;
|
831
843
|
}
|
832
844
|
export interface EncryptResponse {
|
833
845
|
/**
|
@@ -870,6 +882,10 @@ declare namespace KMS {
|
|
870
882
|
* A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. When you use this parameter, instead of returning a plaintext copy of the private data key, KMS encrypts the plaintext private data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob field in the response contains a copy of the private data key encrypted under the KMS key specified by the KeyId parameter. The PrivateKeyPlaintext field in the response is null or empty. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
|
871
883
|
*/
|
872
884
|
Recipient?: RecipientInfo;
|
885
|
+
/**
|
886
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
887
|
+
*/
|
888
|
+
DryRun?: NullableBooleanType;
|
873
889
|
}
|
874
890
|
export interface GenerateDataKeyPairResponse {
|
875
891
|
/**
|
@@ -914,6 +930,10 @@ declare namespace KMS {
|
|
914
930
|
* A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
|
915
931
|
*/
|
916
932
|
GrantTokens?: GrantTokenList;
|
933
|
+
/**
|
934
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
935
|
+
*/
|
936
|
+
DryRun?: NullableBooleanType;
|
917
937
|
}
|
918
938
|
export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
919
939
|
/**
|
@@ -958,6 +978,10 @@ declare namespace KMS {
|
|
958
978
|
* A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256. This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob field in the response contains a copy of the data key encrypted under the KMS key specified by the KeyId parameter. The Plaintext field in the response is null or empty. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.
|
959
979
|
*/
|
960
980
|
Recipient?: RecipientInfo;
|
981
|
+
/**
|
982
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
983
|
+
*/
|
984
|
+
DryRun?: NullableBooleanType;
|
961
985
|
}
|
962
986
|
export interface GenerateDataKeyResponse {
|
963
987
|
/**
|
@@ -998,6 +1022,10 @@ declare namespace KMS {
|
|
998
1022
|
* A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
|
999
1023
|
*/
|
1000
1024
|
GrantTokens?: GrantTokenList;
|
1025
|
+
/**
|
1026
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1027
|
+
*/
|
1028
|
+
DryRun?: NullableBooleanType;
|
1001
1029
|
}
|
1002
1030
|
export interface GenerateDataKeyWithoutPlaintextResponse {
|
1003
1031
|
/**
|
@@ -1026,6 +1054,10 @@ declare namespace KMS {
|
|
1026
1054
|
* A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
|
1027
1055
|
*/
|
1028
1056
|
GrantTokens?: GrantTokenList;
|
1057
|
+
/**
|
1058
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1059
|
+
*/
|
1060
|
+
DryRun?: NullableBooleanType;
|
1029
1061
|
}
|
1030
1062
|
export interface GenerateMacResponse {
|
1031
1063
|
/**
|
@@ -1610,6 +1642,10 @@ declare namespace KMS {
|
|
1610
1642
|
* A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
|
1611
1643
|
*/
|
1612
1644
|
GrantTokens?: GrantTokenList;
|
1645
|
+
/**
|
1646
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1647
|
+
*/
|
1648
|
+
DryRun?: NullableBooleanType;
|
1613
1649
|
}
|
1614
1650
|
export interface ReEncryptResponse {
|
1615
1651
|
/**
|
@@ -1697,6 +1733,10 @@ declare namespace KMS {
|
|
1697
1733
|
* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants. Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
|
1698
1734
|
*/
|
1699
1735
|
GrantId?: GrantIdType;
|
1736
|
+
/**
|
1737
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1738
|
+
*/
|
1739
|
+
DryRun?: NullableBooleanType;
|
1700
1740
|
}
|
1701
1741
|
export interface RevokeGrantRequest {
|
1702
1742
|
/**
|
@@ -1707,6 +1747,10 @@ declare namespace KMS {
|
|
1707
1747
|
* Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
|
1708
1748
|
*/
|
1709
1749
|
GrantId: GrantIdType;
|
1750
|
+
/**
|
1751
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1752
|
+
*/
|
1753
|
+
DryRun?: NullableBooleanType;
|
1710
1754
|
}
|
1711
1755
|
export interface ScheduleKeyDeletionRequest {
|
1712
1756
|
/**
|
@@ -1757,6 +1801,10 @@ declare namespace KMS {
|
|
1757
1801
|
* Specifies the signing algorithm to use when signing the message. Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.
|
1758
1802
|
*/
|
1759
1803
|
SigningAlgorithm: SigningAlgorithmSpec;
|
1804
|
+
/**
|
1805
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1806
|
+
*/
|
1807
|
+
DryRun?: NullableBooleanType;
|
1760
1808
|
}
|
1761
1809
|
export interface SignResponse {
|
1762
1810
|
/**
|
@@ -1900,6 +1948,10 @@ declare namespace KMS {
|
|
1900
1948
|
* A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
|
1901
1949
|
*/
|
1902
1950
|
GrantTokens?: GrantTokenList;
|
1951
|
+
/**
|
1952
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1953
|
+
*/
|
1954
|
+
DryRun?: NullableBooleanType;
|
1903
1955
|
}
|
1904
1956
|
export interface VerifyMacResponse {
|
1905
1957
|
/**
|
@@ -1940,6 +1992,10 @@ declare namespace KMS {
|
|
1940
1992
|
* A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
|
1941
1993
|
*/
|
1942
1994
|
GrantTokens?: GrantTokenList;
|
1995
|
+
/**
|
1996
|
+
* Checks if your request will succeed. DryRun is an optional parameter. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
|
1997
|
+
*/
|
1998
|
+
DryRun?: NullableBooleanType;
|
1943
1999
|
}
|
1944
2000
|
export interface VerifyResponse {
|
1945
2001
|
/**
|
package/clients/location.d.ts
CHANGED
@@ -92,11 +92,11 @@ declare class Location extends Service {
|
|
92
92
|
*/
|
93
93
|
createGeofenceCollection(callback?: (err: AWSError, data: Location.Types.CreateGeofenceCollectionResponse) => void): Request<Location.Types.CreateGeofenceCollectionResponse, AWSError>;
|
94
94
|
/**
|
95
|
-
* Creates an API key resource in your Amazon Web Services account, which lets you grant
|
95
|
+
* Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer. For more information, see Using API keys.
|
96
96
|
*/
|
97
97
|
createKey(params: Location.Types.CreateKeyRequest, callback?: (err: AWSError, data: Location.Types.CreateKeyResponse) => void): Request<Location.Types.CreateKeyResponse, AWSError>;
|
98
98
|
/**
|
99
|
-
* Creates an API key resource in your Amazon Web Services account, which lets you grant
|
99
|
+
* Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer. For more information, see Using API keys.
|
100
100
|
*/
|
101
101
|
createKey(callback?: (err: AWSError, data: Location.Types.CreateKeyResponse) => void): Request<Location.Types.CreateKeyResponse, AWSError>;
|
102
102
|
/**
|
@@ -188,11 +188,11 @@ declare class Location extends Service {
|
|
188
188
|
*/
|
189
189
|
describeGeofenceCollection(callback?: (err: AWSError, data: Location.Types.DescribeGeofenceCollectionResponse) => void): Request<Location.Types.DescribeGeofenceCollectionResponse, AWSError>;
|
190
190
|
/**
|
191
|
-
* Retrieves the API key resource details.
|
191
|
+
* Retrieves the API key resource details.
|
192
192
|
*/
|
193
193
|
describeKey(params: Location.Types.DescribeKeyRequest, callback?: (err: AWSError, data: Location.Types.DescribeKeyResponse) => void): Request<Location.Types.DescribeKeyResponse, AWSError>;
|
194
194
|
/**
|
195
|
-
* Retrieves the API key resource details.
|
195
|
+
* Retrieves the API key resource details.
|
196
196
|
*/
|
197
197
|
describeKey(callback?: (err: AWSError, data: Location.Types.DescribeKeyResponse) => void): Request<Location.Types.DescribeKeyResponse, AWSError>;
|
198
198
|
/**
|
@@ -324,11 +324,11 @@ declare class Location extends Service {
|
|
324
324
|
*/
|
325
325
|
listGeofences(callback?: (err: AWSError, data: Location.Types.ListGeofencesResponse) => void): Request<Location.Types.ListGeofencesResponse, AWSError>;
|
326
326
|
/**
|
327
|
-
* Lists API key resources in your Amazon Web Services account.
|
327
|
+
* Lists API key resources in your Amazon Web Services account.
|
328
328
|
*/
|
329
329
|
listKeys(params: Location.Types.ListKeysRequest, callback?: (err: AWSError, data: Location.Types.ListKeysResponse) => void): Request<Location.Types.ListKeysResponse, AWSError>;
|
330
330
|
/**
|
331
|
-
* Lists API key resources in your Amazon Web Services account.
|
331
|
+
* Lists API key resources in your Amazon Web Services account.
|
332
332
|
*/
|
333
333
|
listKeys(callback?: (err: AWSError, data: Location.Types.ListKeysResponse) => void): Request<Location.Types.ListKeysResponse, AWSError>;
|
334
334
|
/**
|
@@ -436,11 +436,11 @@ declare class Location extends Service {
|
|
436
436
|
*/
|
437
437
|
updateGeofenceCollection(callback?: (err: AWSError, data: Location.Types.UpdateGeofenceCollectionResponse) => void): Request<Location.Types.UpdateGeofenceCollectionResponse, AWSError>;
|
438
438
|
/**
|
439
|
-
* Updates the specified properties of a given API key resource.
|
439
|
+
* Updates the specified properties of a given API key resource.
|
440
440
|
*/
|
441
441
|
updateKey(params: Location.Types.UpdateKeyRequest, callback?: (err: AWSError, data: Location.Types.UpdateKeyResponse) => void): Request<Location.Types.UpdateKeyResponse, AWSError>;
|
442
442
|
/**
|
443
|
-
* Updates the specified properties of a given API key resource.
|
443
|
+
* Updates the specified properties of a given API key resource.
|
444
444
|
*/
|
445
445
|
updateKey(callback?: (err: AWSError, data: Location.Types.UpdateKeyResponse) => void): Request<Location.Types.UpdateKeyResponse, AWSError>;
|
446
446
|
/**
|
@@ -487,7 +487,7 @@ declare namespace Location {
|
|
487
487
|
}
|
488
488
|
export interface ApiKeyRestrictions {
|
489
489
|
/**
|
490
|
-
* A list of allowed actions that an API key resource grants permissions to perform
|
490
|
+
* A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action. The following are valid values for the actions. Map actions geo:GetMap* - Allows all actions needed for map rendering. Place actions geo:SearchPlaceIndexForText - Allows geocoding. geo:SearchPlaceIndexForPosition - Allows reverse geocoding. geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text. GetPlace - Allows finding a place by place ID. Route actions geo:CalculateRoute - Allows point to point routing. geo:CalculateRouteMatrix - Allows calculating a matrix of routes. You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.
|
491
491
|
*/
|
492
492
|
AllowActions: ApiKeyRestrictionsAllowActionsList;
|
493
493
|
/**
|
@@ -495,7 +495,7 @@ declare namespace Location {
|
|
495
495
|
*/
|
496
496
|
AllowReferers?: ApiKeyRestrictionsAllowReferersList;
|
497
497
|
/**
|
498
|
-
* A list of allowed resource ARNs that a API key bearer can perform actions on
|
498
|
+
* A list of allowed resource ARNs that a API key bearer can perform actions on. The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type. The resources must be in the same partition, region, and account-id as the key that is being created. Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id, delimited by colons (:). No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*. For more information about ARN format, see Amazon Resource Names (ARNs).
|
499
499
|
*/
|
500
500
|
AllowResources: ApiKeyRestrictionsAllowResourcesList;
|
501
501
|
}
|
@@ -673,7 +673,7 @@ declare namespace Location {
|
|
673
673
|
*/
|
674
674
|
GeofenceId: Id;
|
675
675
|
/**
|
676
|
-
*
|
676
|
+
* Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: "key" : "value"
|
677
677
|
*/
|
678
678
|
GeofenceProperties?: PropertyMap;
|
679
679
|
/**
|
@@ -780,6 +780,10 @@ declare namespace Location {
|
|
780
780
|
* Set the unit system to specify the distance. Default Value: Kilometers
|
781
781
|
*/
|
782
782
|
DistanceUnit?: DistanceUnit;
|
783
|
+
/**
|
784
|
+
* The optional API key to authorize the request.
|
785
|
+
*/
|
786
|
+
Key?: ApiKey;
|
783
787
|
/**
|
784
788
|
* Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. The TravelMode you specify also determines how you specify route preferences: If traveling by Car use the CarModeOptions parameter. If traveling by Truck use the TruckModeOptions parameter. Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia. Truck is not available for Grab. For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide. Default Value: Car
|
785
789
|
*/
|
@@ -864,6 +868,10 @@ declare namespace Location {
|
|
864
868
|
* Set to include the geometry details in the result for each path between a pair of positions. Default Value: false Valid Values: false | true
|
865
869
|
*/
|
866
870
|
IncludeLegGeometry?: Boolean;
|
871
|
+
/**
|
872
|
+
* The optional API key to authorize the request.
|
873
|
+
*/
|
874
|
+
Key?: ApiKey;
|
867
875
|
/**
|
868
876
|
* Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode. Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia. Truck is not available for Grab. For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide. The TravelMode you specify also determines how you specify route preferences: If traveling by Car use the CarModeOptions parameter. If traveling by Truck use the TruckModeOptions parameter. Default Value: Car
|
869
877
|
*/
|
@@ -1145,6 +1153,10 @@ declare namespace Location {
|
|
1145
1153
|
* An optional description for the tracker resource.
|
1146
1154
|
*/
|
1147
1155
|
Description?: ResourceDescription;
|
1156
|
+
/**
|
1157
|
+
* Whether to enable position UPDATE events from this tracker to be sent to EventBridge. You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.
|
1158
|
+
*/
|
1159
|
+
EventBridgeEnabled?: Boolean;
|
1148
1160
|
/**
|
1149
1161
|
* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
|
1150
1162
|
*/
|
@@ -1466,6 +1478,10 @@ declare namespace Location {
|
|
1466
1478
|
* The optional description for the tracker resource.
|
1467
1479
|
*/
|
1468
1480
|
Description: ResourceDescription;
|
1481
|
+
/**
|
1482
|
+
* Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.
|
1483
|
+
*/
|
1484
|
+
EventBridgeEnabled?: Boolean;
|
1469
1485
|
/**
|
1470
1486
|
* A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.
|
1471
1487
|
*/
|
@@ -1668,7 +1684,7 @@ declare namespace Location {
|
|
1668
1684
|
*/
|
1669
1685
|
GeofenceId: Id;
|
1670
1686
|
/**
|
1671
|
-
*
|
1687
|
+
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: "key" : "value"
|
1672
1688
|
*/
|
1673
1689
|
GeofenceProperties?: PropertyMap;
|
1674
1690
|
/**
|
@@ -1814,6 +1830,10 @@ declare namespace Location {
|
|
1814
1830
|
* The name of the place index resource that you want to use for the search.
|
1815
1831
|
*/
|
1816
1832
|
IndexName: ResourceName;
|
1833
|
+
/**
|
1834
|
+
* The optional API key to authorize the request.
|
1835
|
+
*/
|
1836
|
+
Key?: ApiKey;
|
1817
1837
|
/**
|
1818
1838
|
* The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English. This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens. If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
|
1819
1839
|
*/
|
@@ -1978,7 +1998,7 @@ declare namespace Location {
|
|
1978
1998
|
*/
|
1979
1999
|
GeofenceId: Id;
|
1980
2000
|
/**
|
1981
|
-
*
|
2001
|
+
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: "key" : "value"
|
1982
2002
|
*/
|
1983
2003
|
GeofenceProperties?: PropertyMap;
|
1984
2004
|
/**
|
@@ -2413,7 +2433,7 @@ declare namespace Location {
|
|
2413
2433
|
*/
|
2414
2434
|
GeofenceId: Id;
|
2415
2435
|
/**
|
2416
|
-
*
|
2436
|
+
* Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence. Format: "key" : "value"
|
2417
2437
|
*/
|
2418
2438
|
GeofenceProperties?: PropertyMap;
|
2419
2439
|
/**
|
@@ -2528,6 +2548,10 @@ declare namespace Location {
|
|
2528
2548
|
* The name of the place index resource you want to use for the search.
|
2529
2549
|
*/
|
2530
2550
|
IndexName: ResourceName;
|
2551
|
+
/**
|
2552
|
+
* The optional API key to authorize the request.
|
2553
|
+
*/
|
2554
|
+
Key?: ApiKey;
|
2531
2555
|
/**
|
2532
2556
|
* The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English. This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens. If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
|
2533
2557
|
*/
|
@@ -2590,6 +2614,10 @@ declare namespace Location {
|
|
2590
2614
|
* The name of the place index resource you want to use for the search.
|
2591
2615
|
*/
|
2592
2616
|
IndexName: ResourceName;
|
2617
|
+
/**
|
2618
|
+
* The optional API key to authorize the request.
|
2619
|
+
*/
|
2620
|
+
Key?: ApiKey;
|
2593
2621
|
/**
|
2594
2622
|
* The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English. This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece. If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
|
2595
2623
|
*/
|
@@ -2670,6 +2698,10 @@ declare namespace Location {
|
|
2670
2698
|
* The name of the place index resource you want to use for the search.
|
2671
2699
|
*/
|
2672
2700
|
IndexName: ResourceName;
|
2701
|
+
/**
|
2702
|
+
* The optional API key to authorize the request.
|
2703
|
+
*/
|
2704
|
+
Key?: ApiKey;
|
2673
2705
|
/**
|
2674
2706
|
* The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English. This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens. If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
|
2675
2707
|
*/
|
@@ -3003,6 +3035,10 @@ declare namespace Location {
|
|
3003
3035
|
* Updates the description for the tracker resource.
|
3004
3036
|
*/
|
3005
3037
|
Description?: ResourceDescription;
|
3038
|
+
/**
|
3039
|
+
* Whether to enable position UPDATE events from this tracker to be sent to EventBridge. You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.
|
3040
|
+
*/
|
3041
|
+
EventBridgeEnabled?: Boolean;
|
3006
3042
|
/**
|
3007
3043
|
* Updates the position filtering for the tracker resource. Valid values: TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.
|
3008
3044
|
*/
|