deleteAlias method

Future<void> deleteAlias({ required String aliasName, })

Deletes the specified alias.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.

Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

Required permissions

• kms:DeleteAlias on the alias (IAM policy).
• kms:DeleteAlias on the CMK (key policy).

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

Related operations:

• CreateAlias
• ListAliases
• UpdateAlias

May throw DependencyTimeoutException. May throw NotFoundException. May throw KMSInternalException. May throw KMSInvalidStateException.

Parameter aliasName : The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

Implementation

Future<void> deleteAlias({
  required String aliasName,
}) async {
  ArgumentError.checkNotNull(aliasName, 'aliasName');
  _s.validateStringLength(
    'aliasName',
    aliasName,
    1,
    256,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'TrentService.DeleteAlias'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AliasName': aliasName,
    },
  );
}