Skip to content
AWS for Query.Farm

aws.ssm.describe_document_permission

Example SQL Queries

SELECT * FROM
aws.ssm.describe_document_permission
WHERE
"name" = 'VALUE'
AND "permission_type" = 'VALUE';

Description

Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the document for which you are the owner.

VARCHAR
permission_type Required Input Column

The permission type for the document. The permission type can be Share.

VARCHAR
max_results Input Column

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

BIGINT
next_token Input Column

The token for the next set of items to return. Use this token to get the next set of results.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
account_ids

The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.

VARCHAR[]
Show child fields
account_ids[]
account_sharing_info_list

A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

STRUCT(
    "account_id" VARCHAR,
    "shared_document_version" VARCHAR
)[]
Show child fields
account_sharing_info_list[]
Show child fields
account_sharing_info_list[].account_id

The Amazon Web Services account ID where the current document is shared.

account_sharing_info_list[].shared_document_version

The version of the current document shared with the account.