ListReceivedGrants
Lists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit (OU) to which this member account belongs.
Request Syntax
{
"Filters": [
{
"Name": "string
",
"Values": [ "string
" ]
}
],
"GrantArns": [ "string
" ],
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
Filters to scope the results. The following filters are supported:
-
ProductSKU
-
LicenseIssuerName
-
LicenseArn
-
GrantStatus
-
GranterAccountId
Type: Array of Filter objects
Required: No
-
- GrantArns
-
Amazon Resource Names (ARNs) of the grants.
Type: Array of strings
Length Constraints: Maximum length of 2048.
Pattern:
^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$
Required: No
- MaxResults
-
Maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
Token for the next set of results.
Type: String
Required: No
Response Syntax
{
"Grants": [
{
"GrantArn": "string",
"GrantedOperations": [ "string" ],
"GranteePrincipalArn": "string",
"GrantName": "string",
"GrantStatus": "string",
"HomeRegion": "string",
"LicenseArn": "string",
"Options": {
"ActivationOverrideBehavior": "string"
},
"ParentArn": "string",
"StatusReason": "string",
"Version": "string"
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to resource denied.
HTTP Status Code: 400
- AuthorizationException
-
The Amazon user account does not have permission to perform the action. Check the IAM policy associated with this account.
HTTP Status Code: 400
- InvalidParameterValueException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- RateLimitExceededException
-
Too many requests have been submitted. Try again after a brief wait.
HTTP Status Code: 400
- ResourceLimitExceededException
-
Your resource limits have been exceeded.
HTTP Status Code: 400
- ServerInternalException
-
The server experienced an internal error. Try again.
HTTP Status Code: 500
- ValidationException
-
The provided input is not valid. Try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: