Network.AWS.SSM.DescribeDocumentPermission

Describes the permissions for an 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 AWS account ID) or publicly (All).

Creating a Request

describeDocumentPermission

Arguments

:: Text

ddpName

-> DocumentPermissionType

ddpPermissionType

-> DescribeDocumentPermission

Creates a value of DescribeDocumentPermission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddpName
• ddpPermissionType

data DescribeDocumentPermission

See: describeDocumentPermission smart constructor.

Instances

Eq DescribeDocumentPermission

Methods

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

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

Data DescribeDocumentPermission

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDocumentPermission -> c DescribeDocumentPermission

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDocumentPermission

toConstr :: DescribeDocumentPermission -> Constr

dataTypeOf :: DescribeDocumentPermission -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDocumentPermission)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDocumentPermission)

gmapT :: (forall b. Data b => b -> b) -> DescribeDocumentPermission -> DescribeDocumentPermission

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDocumentPermission -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDocumentPermission -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDocumentPermission -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDocumentPermission -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDocumentPermission -> m DescribeDocumentPermission

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDocumentPermission -> m DescribeDocumentPermission

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDocumentPermission -> m DescribeDocumentPermission

Read DescribeDocumentPermission

Methods

readsPrec :: Int -> ReadS DescribeDocumentPermission

readList :: ReadS [DescribeDocumentPermission]

readPrec :: ReadPrec DescribeDocumentPermission

readListPrec :: ReadPrec [DescribeDocumentPermission]

Show DescribeDocumentPermission

Methods

showsPrec :: Int -> DescribeDocumentPermission -> ShowS

show :: DescribeDocumentPermission -> String

showList :: [DescribeDocumentPermission] -> ShowS

Generic DescribeDocumentPermission

Associated Types

type Rep DescribeDocumentPermission :: * -> *

Methods

from :: DescribeDocumentPermission -> Rep DescribeDocumentPermission x

to :: Rep DescribeDocumentPermission x -> DescribeDocumentPermission

Hashable DescribeDocumentPermission

Methods

hashWithSalt :: Int -> DescribeDocumentPermission -> Int

hash :: DescribeDocumentPermission -> Int

NFData DescribeDocumentPermission

Methods

rnf :: DescribeDocumentPermission -> ()

AWSRequest DescribeDocumentPermission

Associated Types

type Rs DescribeDocumentPermission :: *

Methods

request :: DescribeDocumentPermission -> Request DescribeDocumentPermission

response :: MonadResource m => Logger -> Service -> Proxy * DescribeDocumentPermission -> ClientResponse -> m (Response DescribeDocumentPermission)

ToPath DescribeDocumentPermission

Methods

toPath :: DescribeDocumentPermission -> ByteString

ToHeaders DescribeDocumentPermission

Methods

toHeaders :: DescribeDocumentPermission -> [Header]

ToQuery DescribeDocumentPermission

Methods

toQuery :: DescribeDocumentPermission -> QueryString

ToJSON DescribeDocumentPermission

Methods

toJSON :: DescribeDocumentPermission -> Value

toEncoding :: DescribeDocumentPermission -> Encoding

type Rep DescribeDocumentPermission

type Rep DescribeDocumentPermission = D1 (MetaData "DescribeDocumentPermission" "Network.AWS.SSM.DescribeDocumentPermission" "amazonka-ssm-1.4.4-4im17iL5NtDAOTBFqgVH72" False) (C1 (MetaCons "DescribeDocumentPermission'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ddpPermissionType") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 DocumentPermissionType))))

type Rs DescribeDocumentPermission

type Rs DescribeDocumentPermission = DescribeDocumentPermissionResponse

Request Lenses

ddpName :: Lens' DescribeDocumentPermission Text

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

ddpPermissionType :: Lens' DescribeDocumentPermission DocumentPermissionType

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

Destructuring the Response

describeDocumentPermissionResponse

Arguments

:: Int

ddprsResponseStatus

-> DescribeDocumentPermissionResponse

Creates a value of DescribeDocumentPermissionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddprsAccountIds
• ddprsResponseStatus

data DescribeDocumentPermissionResponse

See: describeDocumentPermissionResponse smart constructor.

Instances

Eq DescribeDocumentPermissionResponse

Methods

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

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

Data DescribeDocumentPermissionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDocumentPermissionResponse -> c DescribeDocumentPermissionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDocumentPermissionResponse

toConstr :: DescribeDocumentPermissionResponse -> Constr

dataTypeOf :: DescribeDocumentPermissionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDocumentPermissionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDocumentPermissionResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeDocumentPermissionResponse -> DescribeDocumentPermissionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDocumentPermissionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDocumentPermissionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDocumentPermissionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDocumentPermissionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDocumentPermissionResponse -> m DescribeDocumentPermissionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDocumentPermissionResponse -> m DescribeDocumentPermissionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDocumentPermissionResponse -> m DescribeDocumentPermissionResponse

Read DescribeDocumentPermissionResponse

Methods

readsPrec :: Int -> ReadS DescribeDocumentPermissionResponse

readList :: ReadS [DescribeDocumentPermissionResponse]

readPrec :: ReadPrec DescribeDocumentPermissionResponse

readListPrec :: ReadPrec [DescribeDocumentPermissionResponse]

Show DescribeDocumentPermissionResponse

Methods

showsPrec :: Int -> DescribeDocumentPermissionResponse -> ShowS

show :: DescribeDocumentPermissionResponse -> String

showList :: [DescribeDocumentPermissionResponse] -> ShowS

Generic DescribeDocumentPermissionResponse

Associated Types

type Rep DescribeDocumentPermissionResponse :: * -> *

Methods

from :: DescribeDocumentPermissionResponse -> Rep DescribeDocumentPermissionResponse x

to :: Rep DescribeDocumentPermissionResponse x -> DescribeDocumentPermissionResponse

NFData DescribeDocumentPermissionResponse

Methods

rnf :: DescribeDocumentPermissionResponse -> ()

type Rep DescribeDocumentPermissionResponse

type Rep DescribeDocumentPermissionResponse = D1 (MetaData "DescribeDocumentPermissionResponse" "Network.AWS.SSM.DescribeDocumentPermission" "amazonka-ssm-1.4.4-4im17iL5NtDAOTBFqgVH72" False) (C1 (MetaCons "DescribeDocumentPermissionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddprsAccountIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_ddprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

ddprsAccountIds :: Lens' DescribeDocumentPermissionResponse [Text]

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

ddprsResponseStatus :: Lens' DescribeDocumentPermissionResponse Int

The response status code.