DescribeImagePermissions
Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
Request Syntax
{
"MaxResults": number,
"Name": "string",
"NextToken": "string",
"SharedAwsAccountIds": [ "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.
- MaxResults
-
The maximum size of each page of results.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 500.
Required: No
- Name
-
The name of the private image for which to describe permissions. The image must be one that you own.
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$Required: Yes
- NextToken
-
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Type: String
Length Constraints: Minimum length of 1.
Required: No
-
The 12-digit identifier of one or more AWS accounts with which the image is shared.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Pattern:
^\d+$Required: No
Response Syntax
{
"Name": "string",
"NextToken": "string",
"SharedImagePermissionsList": [
{
"imagePermissions": {
"allowFleet": boolean,
"allowImageBuilder": boolean
},
"sharedAccountId": "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.
- Name
-
The name of the private image.
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$ - NextToken
-
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Type: String
Length Constraints: Minimum length of 1.
-
The permissions for a private image that you own.
Type: Array of SharedImagePermissions objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
