Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListKeyGroups

Gets a list of key groups.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Request Syntax


GET /2020-05-31/key-group?Marker=Marker&MaxItems=MaxItems HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Marker: Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
MaxItems: The maximum number of key groups that you want in the response.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<KeyGroupList>
   <Items>
      <KeyGroupSummary>
         <KeyGroup>
            <Id>string</Id>
            <KeyGroupConfig>
               <Comment>string</Comment>
               <Items>
                  <PublicKey>string</PublicKey>
               </Items>
               <Name>string</Name>
            </KeyGroupConfig>
            <LastModifiedTime>timestamp</LastModifiedTime>
         </KeyGroup>
      </KeyGroupSummary>
   </Items>
   <MaxItems>integer</MaxItems>
   <NextMarker>string</NextMarker>
   <Quantity>integer</Quantity>
</KeyGroupList>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

KeyGroupList

Root level tag for the KeyGroupList parameters.

Required: Yes

Items

A list of key groups.

Type: Array of KeyGroupSummary objects

MaxItems

The maximum number of key groups requested.

Type: Integer

NextMarker

If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing key groups.

Type: String

Quantity

The number of key groups returned in the response.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidArgument

An argument is invalid.

HTTP Status Code: 400