C# AWS KMS: List Aliases

Back to Index

Gets a list of all aliases in the caller's AWS account and region.

Documentation: https://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html

CURL Command

curl -X POST https://kms.us-west-2.amazonaws.com/ \
  -H "Content-Type: application/x-amz-json-1.1" \
  -H "X-Amz-Target: TrentService.ListAliases" \
  -d '{}'

C# Example

Chilkat.Rest rest = new Chilkat.Rest();
bool success;

Chilkat.AuthAws authAws = new Chilkat.AuthAws();
authAws.AccessKey = "AWS_ACCESS_KEY";
authAws.SecretKey = "AWS_SECRET_KEY";
authAws.Region = "us-west-2";
authAws.ServiceName = "kms";
rest.SetAuthAws(authAws);

//  URL: https://kms.us-west-2.amazonaws.com/
bool bTls = true;
int port = 443;
bool bAutoReconnect = true;
success = rest.Connect("kms.us-west-2.amazonaws.com",port,bTls,bAutoReconnect);
if (success != true) {
    Debug.WriteLine("ConnectFailReason: " + Convert.ToString(rest.ConnectFailReason));
    Debug.WriteLine(rest.LastErrorText);
    return;
}

//  See the Online Tool for Generating JSON Creation Code
Chilkat.JsonObject json = new Chilkat.JsonObject();

rest.AddHeader("Content-Type","application/x-amz-json-1.1");
rest.AddHeader("X-Amz-Target","TrentService.ListAliases");

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

int respStatusCode = rest.ResponseStatusCode;
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(rest.ResponseHeader);
    Debug.WriteLine("Response Body:");
    Debug.WriteLine(sbResponseBody.GetAsString());
    return;
}

Chilkat.JsonObject jsonResponse = new Chilkat.JsonObject();
jsonResponse.LoadSb(sbResponseBody);

//  See the Online Tool for Generating JSON Parse Code
int i;
int count_i;

int AliasCount = jsonResponse.IntOf("AliasCount");
bool Truncated = jsonResponse.BoolOf("Truncated");
i = 0;
count_i = jsonResponse.SizeOfArray("Aliases");
while (i < count_i) {
    jsonResponse.I = i;
    string AliasArn = jsonResponse.StringOf("Aliases[i].AliasArn");
    string AliasName = jsonResponse.StringOf("Aliases[i].AliasName");
    string TargetKeyId = jsonResponse.StringOf("Aliases[i].TargetKeyId");
    i = i + 1;
}

Sample JSON Response Body

{
  "AliasCount": 5,
  "Aliases": [
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/ExampleAlias",
      "AliasName": "alias/ExampleAlias",
      "TargetKeyId": "265e3993-428b-4581-9466-b1030a53062f"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/ExampleAlias2",
      "AliasName": "alias/ExampleAlias2",
      "TargetKeyId": "265e3993-428b-4581-9466-b1030a53062f"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/acm",
      "AliasName": "alias/aws/acm",
      "TargetKeyId": "1b0e5b3c-0675-4510-adb6-a75b40a93da0"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/dynamodb",
      "AliasName": "alias/aws/dynamodb"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/ebs",
      "AliasName": "alias/aws/ebs"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/elasticfilesystem",
      "AliasName": "alias/aws/elasticfilesystem"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/es",
      "AliasName": "alias/aws/es"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/glue",
      "AliasName": "alias/aws/glue"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/kinesisvideo",
      "AliasName": "alias/aws/kinesisvideo"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/rds",
      "AliasName": "alias/aws/rds"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/redshift",
      "AliasName": "alias/aws/redshift"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/s3",
      "AliasName": "alias/aws/s3",
      "TargetKeyId": "657f2cf7-97d6-48eb-b75e-01367b2efd38"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/ssm",
      "AliasName": "alias/aws/ssm"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/workmail",
      "AliasName": "alias/aws/workmail",
      "TargetKeyId": "e5b9bdb0-5e22-4a0b-a443-a90318d7c695"
    },
    {
      "AliasArn": "arn:aws:kms:us-west-2:954491834127:alias/aws/xray",
      "AliasName": "alias/aws/xray"
    }
  ],
  "Truncated": false
}