ListAliases#

Description#

Returns a list of aliases.

Request Parameters#

  • KeyId — The ID of the KMS key.

    • Type: String

    • Required: No

  • Limit — The maximum number of items that will be returned in the response.

    • Type: String

    • Required: No

    • Default value: 50

    • Valid range: from 1 to 100

  • Marker — NextMarker from the previous call (see Response Elements).

    • Type: String

    • Required: No

Response Elements#

  • Aliases — The list of aliases.

  • NextMarker — Contains the value to pass in the Marker parameter in a subsequent request to continue listing data. Returned when Truncated is true.

    • Type: String

  • Truncated — Indicates that the response could not return all list items.

    • Type: Boolean

Examples#

Sample Request#

POST / HTTP/1.1
Host: kms.<region>.<domain>
Content-Length: <PayloadSizeBytes>
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
X-Amz-Date: <Date>
X-Amz-Target: TrentService.ListAliases

{
    "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
}

Sample Response#

HTTP/1.1 200 OK
Content-Type: application/x-amz-json-1.1

{
    "Aliases": [
        {
          "AliasName": "alias/example1",
          "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "CreationDate": 1774439912.925000,
          "LastUpdatedDate": 1774439912.925000
        },
        {
          "AliasName": "alias/example2",
          "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "CreationDate": 1774439916.473000,
          "LastUpdatedDate": 1774439916.473000
        },
        {
          "AliasName": "alias/example3",
          "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
          "CreationDate": 1774439918.935000,
          "LastUpdatedDate": 1774440029.749000
        }
    ],
    "Truncated": false
}