ssm:DescribeDocument

Read

ssm:DescribeDocument is a Read access-level action in the ssm service. Grants permission to view details about a specified SSM document

Resource types

ARNs that ssm:DescribeDocument can be scoped to in an IAM policy.

arn:${Partition}:ssm:${Region}:${Account}:document/${DocumentName}
document

Condition keys

Keys you can use in the Condition block of a policy that grants ssm:DescribeDocument.

aws:ResourceTag/${TagKey} String

Filters access by based on a tag key-value pair assigned to the AWS resource

ssm:DocumentCategories ArrayOfString

Filters access by verifying that a user has permission to access a document belonging to a specific category enum

ssm:DocumentType String

Filters access by verifying that a user has permission to access a document belonging to a specific document type. Only available in "aws", "aws-cn", and "aws-us-gov" partitions

ssm:resourceTag/${TagKey} String

Filters access by a tag key-value pair assigned to the Systems Manager resource

Example IAM policy

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

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowSsmDescribeDocument",
      "Effect": "Allow",
      "Action": "ssm:DescribeDocument",
      "Resource": "*"
    }
  ]
}

Related actions in ssm

View all ssm actions →