list_grants¶
Operation¶
list_grants
async
¶
list_grants(request: ListGrantsInput | ListGrantsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListGrantsOutput
list_grants(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGrantsInputDict]) -> ListGrantsOutput
Gets a list of all grants for the specified KMS key.
You must specify the KMS key in all requests. You can filter the grant list by grant ID, grantee principal, or grantee service principal.
For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI.
Note
When a grant is created with the GranteePrincipal field, the
ListGrants response usually contains the user or role designated as
the grantee principal in the grant. However, if the grantee principal is
an Amazon Web Services service, the GranteePrincipal field contains an
Amazon Web Services service
principal,
which might correspond to several different grantee principals, such as
an IAM user, IAM role, or Amazon Web Services account.
When a grant is created with the GranteeServicePrincipal field, the
ListGrants response always includes a GranteeServicePrincipal that
indicates the grantee is actually an Amazon Web Services service
principal.
Cross-account use: Yes. To perform this operation on a KMS key in a
different Amazon Web Services account, specify the key ARN in the value
of the KeyId parameter.
Required permissions: kms:ListGrants (key policy)
Related operations:
-
CreateGrant
-
ListRetirableGrants
-
RetireGrant
-
RevokeGrant
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListGrantsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
ListGrantsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGrantsInput structure.
Attributes¶
grant_id
class-attribute
instance-attribute
¶
grant_id: str | None = ...
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
grantee_principal
class-attribute
instance-attribute
¶
grantee_principal: str | None = ...
Returns only grants where the specified principal is the grantee principal for the grant.
You can specify either GranteePrincipal or GranteeServicePrincipal,
but not both.
grantee_service_principal
class-attribute
instance-attribute
¶
grantee_service_principal: str | None = ...
Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.
You can specify either GranteePrincipal or GranteeServicePrincipal,
but not both.
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
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.
limit
class-attribute
instance-attribute
¶
limit: int | None = ...
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.
Dictionaries¶
ListGrantsInputDict
¶
Bases: TypedDict
Dictionary form of ListGrantsInput.
Attributes¶
grant_id
instance-attribute
¶
grant_id: str | None
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
grantee_principal
instance-attribute
¶
grantee_principal: str | None
Returns only grants where the specified principal is the grantee principal for the grant.
You can specify either GranteePrincipal or GranteeServicePrincipal,
but not both.
grantee_service_principal
instance-attribute
¶
grantee_service_principal: str | None
Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.
You can specify either GranteePrincipal or GranteeServicePrincipal,
but not both.
key_id
instance-attribute
¶
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.
limit
instance-attribute
¶
limit: int | None
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.
Output¶
ListGrantsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGrantsOutput structure.
Attributes¶
grants
class-attribute
instance-attribute
¶
grants: list[GrantListEntry] | None = ...
A list of grants.
next_marker
class-attribute
instance-attribute
¶
next_marker: str | None = ...
When Truncated is true, this element is present and contains the value
to use for the Marker parameter in a subsequent request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
truncated
class-attribute
instance-attribute
¶
truncated: bool = ...
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker element in this response to
the Marker parameter in a subsequent request.