AWSKMSListGrantsRequest

Objective-C

@interface AWSKMSListGrantsRequest

Swift

class AWSKMSListGrantsRequest

  • Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable grantId;

    Swift

    var grantId: String? { get set }

  • Returns only grants where the specified principal is the grantee principal for the grant.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable granteePrincipal;

    Swift

    var granteePrincipal: String? { get set }

  • Returns only grants for the specified customer master key (CMK). This parameter is required.

    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyId;

    Swift

    var keyId: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable limit;

    Swift

    var limit: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable marker;

    Swift

    var marker: String? { get set }