libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.DescribeDocumentPermission

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

Synopsis

Creating a Request

data DescribeDocumentPermission Source #

See: newDescribeDocumentPermission smart constructor.

Constructors

DescribeDocumentPermission' 

Fields

  • nextToken :: Maybe Text

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

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

  • 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

Instances details
Eq DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Read DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Show DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Generic DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Associated Types

type Rep DescribeDocumentPermission :: Type -> Type #

NFData DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Hashable DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

ToJSON DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

AWSRequest DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

ToHeaders DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

ToPath DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

ToQuery DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

type Rep DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

type Rep DescribeDocumentPermission = D1 ('MetaData "DescribeDocumentPermission" "Amazonka.SSM.DescribeDocumentPermission" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeDocumentPermission'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "permissionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentPermissionType))))
type AWSResponse DescribeDocumentPermission Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

newDescribeDocumentPermission Source #

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:nextToken:DescribeDocumentPermission', describeDocumentPermission_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

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

$sel:name: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_nextToken :: Lens' DescribeDocumentPermission (Maybe Text) Source #

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

describeDocumentPermission_maxResults :: Lens' DescribeDocumentPermission (Maybe Natural) Source #

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_name :: Lens' DescribeDocumentPermission Text Source #

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

describeDocumentPermission_permissionType :: Lens' DescribeDocumentPermission DocumentPermissionType Source #

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

Destructuring the Response

data DescribeDocumentPermissionResponse Source #

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

Instances details
Eq DescribeDocumentPermissionResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Read DescribeDocumentPermissionResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Show DescribeDocumentPermissionResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Generic DescribeDocumentPermissionResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

Associated Types

type Rep DescribeDocumentPermissionResponse :: Type -> Type #

NFData DescribeDocumentPermissionResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

type Rep DescribeDocumentPermissionResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeDocumentPermission

type Rep DescribeDocumentPermissionResponse = D1 ('MetaData "DescribeDocumentPermissionResponse" "Amazonka.SSM.DescribeDocumentPermission" "libZSservicesZSamazonka-ssmZSamazonka-ssm" '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 Source #

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.

$sel:nextToken: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]) Source #

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]) Source #

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) Source #

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