diff --git a/clients/client-location/src/commands/DeleteKeyCommand.ts b/clients/client-location/src/commands/DeleteKeyCommand.ts index 26a218c2edac..5c8363a86ebe 100644 --- a/clients/client-location/src/commands/DeleteKeyCommand.ts +++ b/clients/client-location/src/commands/DeleteKeyCommand.ts @@ -38,6 +38,7 @@ export interface DeleteKeyCommandOutput extends DeleteKeyResponse, __MetadataBea * const client = new LocationClient(config); * const input = { // DeleteKeyRequest * KeyName: "STRING_VALUE", // required + * ForceDelete: true || false, * }; * const command = new DeleteKeyCommand(input); * const response = await client.send(command); diff --git a/clients/client-location/src/models/models_0.ts b/clients/client-location/src/models/models_0.ts index 91f3414ee424..8a18f02ec52d 100644 --- a/clients/client-location/src/models/models_0.ts +++ b/clients/client-location/src/models/models_0.ts @@ -159,7 +159,7 @@ export interface ApiKeyRestrictions { *
Other than wildcards, you must include the full ARN, including the
* arn
, partition
, service
,
- * region
, account-id
and resource-id
,
+ * region
, account-id
and resource-id
* delimited by colons (:).
The name of the API key to delete.
*/ KeyName: string | undefined; + + /** + * @public + *ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true
to delete the key or to false
to not preemptively delete the API key.
Valid values: true
, or false
.
Required: No
+ *This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
+ *A list of allowed resource ARNs that a API key bearer can perform actions on.
\nThe ARN must be the correct ARN for a map, place, or route ARN. You may \n include wildcards in the resource-id to match multiple resources of the \n same type.
\nThe resources must be in the same partition
, \n region
, and account-id
as the key that is being \n created.
Other than wildcards, you must include the full ARN, including the \n arn
, partition
, service
,\n region
, account-id
and resource-id
,\n delimited by colons (:).
No spaces allowed, even with wildcards. For example,\n arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names\n (ARNs).
", + "smithy.api#documentation": "A list of allowed resource ARNs that a API key bearer can perform actions on.
\nThe ARN must be the correct ARN for a map, place, or route ARN. You may \n include wildcards in the resource-id to match multiple resources of the \n same type.
\nThe resources must be in the same partition
, \n region
, and account-id
as the key that is being \n created.
Other than wildcards, you must include the full ARN, including the \n arn
, partition
, service
,\n region
, account-id
and resource-id
\n delimited by colons (:).
No spaces allowed, even with wildcards. For example,\n arn:aws:geo:region:account-id:map/ExampleMap*
.
For more information about ARN format, see Amazon Resource Names\n (ARNs).
", "smithy.api#length": { "min": 1, "max": 5 @@ -2331,6 +2331,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "ForceDelete": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true
to delete the key or to false
to not preemptively delete the API key.
Valid values: true
, or false
.
Required: No
\nThis action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
\n