Amazonka.SSM.DescribeDocumentPermission

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).

Creating a Request

data DescribeDocumentPermission

See: newDescribeDocumentPermission smart constructor.

Constructors

DescribeDocumentPermission'

Fields

• maxResults :: Maybe Natural

  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.

• nextToken :: Maybe Text

  The token for the next set of items to return. (You received this token from a previous call.)

• name :: Text

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

• permissionType :: DocumentPermissionType

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

Instances

ToJSON DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

toJSON :: DescribeDocumentPermission -> Value

toEncoding :: DescribeDocumentPermission -> Encoding

toJSONList :: [DescribeDocumentPermission] -> Value

toEncodingList :: [DescribeDocumentPermission] -> Encoding

ToHeaders DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

toHeaders :: DescribeDocumentPermission -> [Header]

ToPath DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

toPath :: DescribeDocumentPermission -> ByteString

ToQuery DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

toQuery :: DescribeDocumentPermission -> QueryString

AWSRequest DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Associated Types

type AWSResponse DescribeDocumentPermission

Methods

request :: (Service -> Service) -> DescribeDocumentPermission -> Request DescribeDocumentPermission

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDocumentPermission -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDocumentPermission)))

Generic DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Associated Types

type Rep DescribeDocumentPermission :: Type -> Type

Methods

from :: DescribeDocumentPermission -> Rep DescribeDocumentPermission x

to :: Rep DescribeDocumentPermission x -> DescribeDocumentPermission

Read DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

readsPrec :: Int -> ReadS DescribeDocumentPermission

readList :: ReadS [DescribeDocumentPermission]

readPrec :: ReadPrec DescribeDocumentPermission

readListPrec :: ReadPrec [DescribeDocumentPermission]

Show DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

showsPrec :: Int -> DescribeDocumentPermission -> ShowS

show :: DescribeDocumentPermission -> String

showList :: [DescribeDocumentPermission] -> ShowS

NFData DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

rnf :: DescribeDocumentPermission -> ()

Eq DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

(==) :: DescribeDocumentPermission -> DescribeDocumentPermission -> Bool

(/=) :: DescribeDocumentPermission -> DescribeDocumentPermission -> Bool

Hashable DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

hashWithSalt :: Int -> DescribeDocumentPermission -> Int

hash :: DescribeDocumentPermission -> Int

type AWSResponse DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

type AWSResponse DescribeDocumentPermission = DescribeDocumentPermissionResponse

type Rep DescribeDocumentPermission

Defined in Amazonka.SSM.DescribeDocumentPermission

type Rep DescribeDocumentPermission = D1 ('MetaData "DescribeDocumentPermission" "Amazonka.SSM.DescribeDocumentPermission" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeDocumentPermission'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "permissionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentPermissionType))))

newDescribeDocumentPermission

Arguments

:: Text

DescribeDocumentPermission

-> DocumentPermissionType

$sel:permissionType:DescribeDocumentPermission'

-> DescribeDocumentPermission

Create a value of DescribeDocumentPermission with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxResults:DescribeDocumentPermission', describeDocumentPermission_maxResults - 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.

DescribeDocumentPermission, describeDocumentPermission_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

DescribeDocumentPermission, describeDocumentPermission_name - The name of the document for which you are the owner.

$sel:permissionType:DescribeDocumentPermission', describeDocumentPermission_permissionType - The permission type for the document. The permission type can be Share.

Request Lenses

describeDocumentPermission_maxResults :: Lens' DescribeDocumentPermission (Maybe Natural)

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.

describeDocumentPermission_nextToken :: Lens' DescribeDocumentPermission (Maybe Text)

The token for the next set of items to return. (You received this token from a previous call.)

describeDocumentPermission_name :: Lens' DescribeDocumentPermission Text

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

describeDocumentPermission_permissionType :: Lens' DescribeDocumentPermission DocumentPermissionType

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

Destructuring the Response

data DescribeDocumentPermissionResponse

See: newDescribeDocumentPermissionResponse smart constructor.

Constructors

DescribeDocumentPermissionResponse'

Fields

• accountIds :: Maybe [Text]

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

• accountSharingInfoList :: Maybe [AccountSharingInfo]

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

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeDocumentPermissionResponse

Defined in Amazonka.SSM.DescribeDocumentPermission

Associated Types

type Rep DescribeDocumentPermissionResponse :: Type -> Type

Methods

from :: DescribeDocumentPermissionResponse -> Rep DescribeDocumentPermissionResponse x

to :: Rep DescribeDocumentPermissionResponse x -> DescribeDocumentPermissionResponse

Read DescribeDocumentPermissionResponse

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

readsPrec :: Int -> ReadS DescribeDocumentPermissionResponse

readList :: ReadS [DescribeDocumentPermissionResponse]

readPrec :: ReadPrec DescribeDocumentPermissionResponse

readListPrec :: ReadPrec [DescribeDocumentPermissionResponse]

Show DescribeDocumentPermissionResponse

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

showsPrec :: Int -> DescribeDocumentPermissionResponse -> ShowS

show :: DescribeDocumentPermissionResponse -> String

showList :: [DescribeDocumentPermissionResponse] -> ShowS

NFData DescribeDocumentPermissionResponse

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

rnf :: DescribeDocumentPermissionResponse -> ()

Eq DescribeDocumentPermissionResponse

Defined in Amazonka.SSM.DescribeDocumentPermission

Methods

(==) :: DescribeDocumentPermissionResponse -> DescribeDocumentPermissionResponse -> Bool

(/=) :: DescribeDocumentPermissionResponse -> DescribeDocumentPermissionResponse -> Bool

type Rep DescribeDocumentPermissionResponse

Defined in Amazonka.SSM.DescribeDocumentPermission

type Rep DescribeDocumentPermissionResponse = D1 ('MetaData "DescribeDocumentPermissionResponse" "Amazonka.SSM.DescribeDocumentPermission" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeDocumentPermissionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "accountSharingInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccountSharingInfo]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDocumentPermissionResponse

Arguments

:: Int

$sel:httpStatus:DescribeDocumentPermissionResponse'

-> DescribeDocumentPermissionResponse

Create a value of DescribeDocumentPermissionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountIds:DescribeDocumentPermissionResponse', describeDocumentPermissionResponse_accountIds - The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.

$sel:accountSharingInfoList:DescribeDocumentPermissionResponse', describeDocumentPermissionResponse_accountSharingInfoList - A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

DescribeDocumentPermission, describeDocumentPermissionResponse_nextToken - The token for the next set of items to return. Use this token to get the next set of results.

$sel:httpStatus:DescribeDocumentPermissionResponse', describeDocumentPermissionResponse_httpStatus - The response's http status code.

Response Lenses

describeDocumentPermissionResponse_accountIds :: Lens' DescribeDocumentPermissionResponse (Maybe [Text])

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

describeDocumentPermissionResponse_accountSharingInfoList :: Lens' DescribeDocumentPermissionResponse (Maybe [AccountSharingInfo])

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

describeDocumentPermissionResponse_nextToken :: Lens' DescribeDocumentPermissionResponse (Maybe Text)

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

describeDocumentPermissionResponse_httpStatus :: Lens' DescribeDocumentPermissionResponse Int

The response's http status code.