comprehend:DescribeEndpoint

Read

comprehend:DescribeEndpoint is a Read access-level action in the comprehend service. Grants permission to get the properties associated with a specific endpoint. Use this operation to get the status of an endpoint

Resource types

ARNs that comprehend:DescribeEndpoint can be scoped to in an IAM policy.

arn:${Partition}:comprehend:${Region}:${Account}:document-classifier-endpoint/${DocumentClassifierEndpointName}
document-classifier-endpoint
arn:${Partition}:comprehend:${Region}:${Account}:entity-recognizer-endpoint/${EntityRecognizerEndpointName}
entity-recognizer-endpoint

Condition keys

Keys you can use in the Condition block of a policy that grants comprehend:DescribeEndpoint.

aws:ResourceTag/${TagKey} String

Filters access by requiring tag value associated with the resource

Example IAM policy

A minimal policy that allows comprehend:DescribeEndpoint. Replace "Resource": "*" with a specific ARN to follow least privilege.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowComprehendDescribeEndpoint",
      "Effect": "Allow",
      "Action": "comprehend:DescribeEndpoint",
      "Resource": "*"
    }
  ]
}

Related actions in comprehend

comprehend:BatchDetectDominantLanguage Read comprehend:BatchDetectEntities Read comprehend:BatchDetectKeyPhrases Read comprehend:BatchDetectSentiment Read comprehend:BatchDetectSyntax Read comprehend:BatchDetectTargetedSentiment Read comprehend:ClassifyDocument Read comprehend:ContainsPiiEntities Read comprehend:CreateDataset Write comprehend:CreateDocumentClassifier Write comprehend:CreateEndpoint Write comprehend:CreateEntityRecognizer Write

View all comprehend actions →