Struct: kms.ListRetirableGrantsInput

import "../ibm-cos-sdk-go/service/kms"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary

• Limit *int64

  Use this parameter to specify the maximum number of items to return.

• Marker *string

  Use this parameter in a subsequent request after you receive a response with truncated results.

• RetiringPrincipal *string

  The retiring principal for which to list grants.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetLimit(int64) *ListRetirableGrantsInput operation

  SetLimit sets the Limit field's value.

• SetMarker(string) *ListRetirableGrantsInput operation

  SetMarker sets the Marker field's value.

• SetRetiringPrincipal(string) *ListRetirableGrantsInput operation

  SetRetiringPrincipal sets the RetiringPrincipal field's value.

• String() string operation

  String returns the string representation.

• Validate() error operation

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

Structure Field Details

Limit *int64 `min:"1" type:"integer"`

Use this parameter to specify the maximum number of items to return. When this value is present, 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 *string `min:"1" 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 *string `min:"1" type:"string" required:"true"`

The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

To specify the retiring principal, use the Amazon Resource Name (ARN) (docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs (docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) in the Identity and Access Management User Guide .

RetiringPrincipal is a required field

_ struct{} `type:"structure"`

Method Details

func (s ListRetirableGrantsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 15341

func (s ListRetirableGrantsInput) GoString() string {
	return s.String()
}

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

SetLimit sets the Limit field's value.

// File 'service/kms/api.go', line 15368

func (s *ListRetirableGrantsInput) SetLimit(v int64) *ListRetirableGrantsInput {
	s.Limit = &v
	return s
}

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

SetMarker sets the Marker field's value.

// File 'service/kms/api.go', line 15374

func (s *ListRetirableGrantsInput) SetMarker(v string) *ListRetirableGrantsInput {
	s.Marker = &v
	return s
}

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

SetRetiringPrincipal sets the RetiringPrincipal field's value.

// File 'service/kms/api.go', line 15380

func (s *ListRetirableGrantsInput) SetRetiringPrincipal(v string) *ListRetirableGrantsInput {
	s.RetiringPrincipal = &v
	return s
}

func (s ListRetirableGrantsInput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 15332

func (s ListRetirableGrantsInput) String() string {
	return awsutil.Prettify(s)
}

func (s *ListRetirableGrantsInput) Validate() error

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

// File 'service/kms/api.go', line 15346

func (s *ListRetirableGrantsInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ListRetirableGrantsInput"}
	if s.Limit != nil && *s.Limit < 1 {
		invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
	}
	if s.Marker != nil && len(*s.Marker) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("Marker", 1))
	}
	if s.RetiringPrincipal == nil {
		invalidParams.Add(request.NewErrParamRequired("RetiringPrincipal"))
	}
	if s.RetiringPrincipal != nil && len(*s.RetiringPrincipal) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("RetiringPrincipal", 1))
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}