Actions, resources, and condition keys for Amazon Rekognition - Service Authorization Reference

# Actions, resources, and condition keys for Amazon Rekognition

Amazon Rekognition (service prefix: `rekognition` ) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

- Learn how to configure this service .

- View a list of the API operations available for this service .

- Learn how to secure this service and its resources by using IAM permission policies.

Topics

- Actions defined by Amazon Rekognition
- Resource types defined by Amazon Rekognition
- Condition keys for Amazon Rekognition

## Actions defined by Amazon Rekognition

You can specify the following actions in the `Action` element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") in the `Resource` element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The actions table .

Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions
--- | --- | --- | --- | --- | ---
CompareFaces | Compares a face in source input image with each face detected in the target input image. | Read |  |  |
CreateCollection | Creates a collection in an AWS region. You can then add faces to the collection using the IndexFaces API. | Write | collection* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
CreateProject | Creates a new Amazon Rekognition Custom Labels project. | Write | project* |  |
CreateProjectVersion | Creates a new version of a model and begins training. | Write | project* |  |
projectversion* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
CreateStreamProcessor | Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video. | Write | collection* |  |
streamprocessor* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
DeleteCollection | Deletes the specified collection. Note that this operation removes all faces in the collection. | Write | collection* |  |
DeleteFaces | Deletes faces from a collection. | Write | collection* |  |
DeleteProject | Deletes a project. | Write | project* |  |
DeleteProjectVersion | Deletes a model. | Write | projectversion* |  |
DeleteStreamProcessor | Deletes the stream processor identified by Name. | Write | streamprocessor* |  |
DescribeCollection | Describes the specified collection. | Read | collection* |  |
DescribeProjectVersions | Lists and describes the model versions in an Amazon Rekognition Custom Labels project. | Read | project* |  |
DescribeProjects | Lists and gets information about your Amazon Rekognition Custom Labels projects. | Read |  |  |
DescribeStreamProcessor | Provides information about a stream processor created by CreateStreamProcessor. | Read | streamprocessor* |  |
DetectCustomLabels | Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model version. | Read | projectversion* |  |
DetectFaces | Detects human faces within an image (JPEG or PNG) provided as input. | Read |  |  |
DetectLabels | Detects instances of real-world labels within an image (JPEG or PNG) provided as input. | Read |  |  |
DetectModerationLabels | Detects moderation labels within input image. | Read |  |  |
DetectProtectiveEquipment | Detects Protective Equipment in the input image. | Read |  |  |
DetectText | Detects text in the input image and converts it into machine-readable text. | Read |  |  |
GetCelebrityInfo | Gets the name and additional information about a celebrity based on his or her Rekognition ID. | Read |  |  |
GetCelebrityRecognition | Gets the celebrity recognition results for a Rekognition Video analysis started by StartCelebrityRecognition. | Read |  |  |
GetContentModeration | Gets the content moderation analysis results for a Rekognition Video analysis started by StartContentModeration. | Read |  |  |
GetFaceDetection | Gets face detection results for a Rekognition Video analysis started by StartFaceDetection. | Read |  |  |
GetFaceSearch | Gets the face search results for Rekognition Video face search started by StartFaceSearch. | Read |  |  |
GetLabelDetection | Gets the label detection results of a Rekognition Video analysis started by StartLabelDetection. | Read |  |  |
GetPersonTracking | Gets information about people detected within a video. | Read |  |  |
GetSegmentDetection | Gets segment detection results for a Rekognition Video analysis started by StartSegmentDetection. | Read |  |  |
GetTextDetection | Gets text detection results for a Rekognition Video analysis started by StartTextDetection. | Read |  |  |
IndexFaces | Detects faces in the input image and adds them to the specified collection. | Write | collection* |  |
ListCollections | Returns a list of collection IDs in your account. | Read | collection* |  |
ListFaces | Returns metadata for faces in the specified collection. | Read | collection* |  |
ListStreamProcessors | Gets a list of stream processors that you have created with CreateStreamProcessor. | List | streamprocessor* |  |
ListTagsForResource | Returns a list of tags associated with a resource. | Read | projectversion* |  |
RecognizeCelebrities | Returns an array of celebrities recognized in the input image. | Read |  |  |
SearchFaces | For a given input face ID, searches the specified collection for matching faces. | Read | collection* |  |
SearchFacesByImage | For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. | Read | collection* |  |
StartCelebrityRecognition | Starts asynchronous recognition of celebrities in a video. | Write |  |  |
StartContentModeration | Starts asynchronous detection of explicit or suggestive adult content in a video. | Write |  |  |
StartFaceDetection | Starts asynchronous detection of faces in a video. | Write |  |  |
StartFaceSearch | Starts the asynchronous search for faces in a collection that match the faces of persons detected in a video. | Write | collection* |  |
StartLabelDetection | Starts asynchronous detection of labels in a video. | Write |  |  |
StartPersonTracking | Starts the asynchronous tracking of persons in a video. | Write |  |  |
StartProjectVersion | Starts the deployment of a model version. | Write | projectversion* |  |
StartSegmentDetection | Starts asynchronous detection of segments in a video. | Write |  |  |
StartStreamProcessor | Starts processing a stream processor. | Write | streamprocessor* |  |
StartTextDetection | Starts asynchronous detection of text in a video. | Write |  |  |
StopProjectVersion | Stops a deployed model version. | Write | projectversion* |  |
StopStreamProcessor | Stops a running stream processor that was created by CreateStreamProcessor. | Write | streamprocessor* |  |
TagResource | Adds one or more tags to a resource. | Tagging | projectversion* |  |
| aws:RequestTag/${TagKey} aws:TagKeys |
UntagResource | Removes one or more tags from a resource. | Tagging | projectversion* |  |
| aws:TagKeys |

## Resource types defined by Amazon Rekognition

The following resource types are defined by this service and can be used in the `Resource` element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the table. For details about the columns in the following table, see The resource types table .

Resource types | ARN | Condition keys
--- | --- | ---
collection | `arn:$ { Partition}:rekognition:$ { Region}:$ { Account}:collection/$ { CollectionId}` |
streamprocessor | `arn:$ { Partition}:rekognition:$ { Region}:$ { Account}:streamprocessor/$ { StreamprocessorId}` |
project | `arn:$ { Partition}:rekognition:$ { Region}:$ { Account}:project/$ { ProjectName}/$ { CreationTimestamp}` |
projectversion | `arn:$ { Partition}:rekognition:$ { Region}:$ { Account}:project/$ { ProjectName}/version/$ { VersionName}/$ { CreationTimestamp}` |

## Condition keys for Amazon Rekognition

Amazon Rekognition defines the following condition keys that can be used in the `Condition` element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see The condition keys table .

To view the global condition keys that are available to all services, see Available global condition keys .

Condition keys | Description | Type
--- | --- | ---
aws:RequestTag/${TagKey} | Filters access based on the tags that are passed in the request | String
aws:ResourceTag/${TagKey} | Filters access based on the tags associated with the resource | String
aws:TagKeys | Filters access based on the tag keys that are passed in the request | String

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.