Package software.amazon.awssdk.services.kms.model

Interface ListGrantsRequest.Builder

    • Method Detail

      • limit

        ListGrantsRequest.Builder limit​(Integer limit)

        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.

        Parameters:
        limit - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • marker

        ListGrantsRequest.Builder marker​(String marker)

        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.

        Parameters:
        marker - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyId

        ListGrantsRequest.Builder keyId​(String keyId)

        Returns only grants for the specified KMS key. This parameter is required.

        Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

        Parameters:
        keyId - Returns only grants for the specified KMS key. This parameter is required.

        Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • grantId

        ListGrantsRequest.Builder grantId​(String grantId)

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

        Parameters:
        grantId - Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • granteePrincipal

        ListGrantsRequest.Builder granteePrincipal​(String granteePrincipal)

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

        Parameters:
        granteePrincipal - Returns only grants where the specified principal is the grantee principal for the grant.
        Returns:
        Returns a reference to this object so that method calls can be chained together.