AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ListRetirableGrantsInput

import "github.com/aws/aws-sdk-go/service/kms"

type ListRetirableGrantsInput struct { Limit *int64 `min:"1" type:"integer"` Marker *string `min:"1" type:"string"` RetiringPrincipal *string `min:"1" type:"string" required:"true"` }

Limit

Type: *int64

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

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

Type: *string

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

RetiringPrincipal

Type: *string

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) 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, see AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) in the Example ARNs section of the Amazon Web Services General Reference.

RetiringPrincipal is a required field

Method

GoString

func (s ListRetirableGrantsInput) GoString() string

GoString returns the string representation

SetLimit

func (s *ListRetirableGrantsInput) SetLimit(v int64) *ListRetirableGrantsInput

SetLimit sets the Limit field's value.

SetMarker

func (s *ListRetirableGrantsInput) SetMarker(v string) *ListRetirableGrantsInput

SetMarker sets the Marker field's value.

SetRetiringPrincipal

func (s *ListRetirableGrantsInput) SetRetiringPrincipal(v string) *ListRetirableGrantsInput

SetRetiringPrincipal sets the RetiringPrincipal field's value.

String

func (s ListRetirableGrantsInput) String() string

String returns the string representation

Validate

func (s *ListRetirableGrantsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: