ListRetirableGrantsRequest Class | AWS SDK for .NET V2

Container for the parameters to the ListRetirableGrants operation. Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
      Amazon.KeyManagementService.Model.ListRetirableGrantsRequest

Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

public class ListRetirableGrantsRequest : AmazonKeyManagementServiceRequest
         IRequestEvents

The ListRetirableGrantsRequest type exposes the following members

Constructors

	Name	Description
	ListRetirableGrantsRequest()

Properties

Name Type Description

Name	Type	Description
Limit	System.Int32	Gets and sets the property Limit. When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the `Truncated` element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
Marker	System.String	Gets and sets the property Marker. Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of `NextMarker` from the response you just received.
RetiringPrincipal	System.String	Gets and sets the property RetiringPrincipal. The retiring principal for which to list grants. To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Limit

System.Int32

Gets and sets the property Limit.

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

Marker

System.String

Gets and sets the property Marker.

Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of NextMarker from the response you just received.

RetiringPrincipal

System.String

Gets and sets the property RetiringPrincipal.

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8