Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.ListDocumentVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List all versions for a document.

This operation returns paginated results.

Synopsis

data ListDocumentVersions = ListDocumentVersions' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- name :: Text
}
newListDocumentVersions :: Text -> ListDocumentVersions
listDocumentVersions_nextToken :: Lens' ListDocumentVersions (Maybe Text)
listDocumentVersions_maxResults :: Lens' ListDocumentVersions (Maybe Natural)
listDocumentVersions_name :: Lens' ListDocumentVersions Text
data ListDocumentVersionsResponse = ListDocumentVersionsResponse' {
- documentVersions :: Maybe (NonEmpty DocumentVersionInfo)
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListDocumentVersionsResponse :: Int -> ListDocumentVersionsResponse
listDocumentVersionsResponse_documentVersions :: Lens' ListDocumentVersionsResponse (Maybe (NonEmpty DocumentVersionInfo))
listDocumentVersionsResponse_nextToken :: Lens' ListDocumentVersionsResponse (Maybe Text)
listDocumentVersionsResponse_httpStatus :: Lens' ListDocumentVersionsResponse Int

Creating a Request

data ListDocumentVersions Source #

See: newListDocumentVersions smart constructor.

Constructors

ListDocumentVersions'
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. You can specify an Amazon Resource Name (ARN).

Instances

Instances details

Eq ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods (==) :: ListDocumentVersions -> ListDocumentVersions -> Bool # (/=) :: ListDocumentVersions -> ListDocumentVersions -> Bool #
Read ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods readsPrec :: Int -> ReadS ListDocumentVersions # readList :: ReadS [ListDocumentVersions] # readPrec :: ReadPrec ListDocumentVersions # readListPrec :: ReadPrec [ListDocumentVersions] #
Show ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods showsPrec :: Int -> ListDocumentVersions -> ShowS # show :: ListDocumentVersions -> String # showList :: [ListDocumentVersions] -> ShowS #
Generic ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Associated Types type Rep ListDocumentVersions :: Type -> Type # Methods from :: ListDocumentVersions -> Rep ListDocumentVersions x # to :: Rep ListDocumentVersions x -> ListDocumentVersions #
NFData ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods rnf :: ListDocumentVersions -> () #
Hashable ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods hashWithSalt :: Int -> ListDocumentVersions -> Int # hash :: ListDocumentVersions -> Int #
ToJSON ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods toJSON :: ListDocumentVersions -> Value # toEncoding :: ListDocumentVersions -> Encoding # toJSONList :: [ListDocumentVersions] -> Value # toEncodingList :: [ListDocumentVersions] -> Encoding #
AWSPager ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods page :: ListDocumentVersions -> AWSResponse ListDocumentVersions -> Maybe ListDocumentVersions #
AWSRequest ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Associated Types type AWSResponse ListDocumentVersions # Methods request :: ListDocumentVersions -> Request ListDocumentVersions # response :: MonadResource m => Logger -> Service -> Proxy ListDocumentVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDocumentVersions))) #
ToHeaders ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods toHeaders :: ListDocumentVersions -> [Header] #
ToPath ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods toPath :: ListDocumentVersions -> ByteString #
ToQuery ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods toQuery :: ListDocumentVersions -> QueryString #
type Rep ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions type Rep ListDocumentVersions = D1 ('MetaData "ListDocumentVersions" "Amazonka.SSM.ListDocumentVersions" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListDocumentVersions'" '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))))
type AWSResponse ListDocumentVersions Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions type AWSResponse ListDocumentVersions = ListDocumentVersionsResponse

newListDocumentVersions Source #

Arguments

:: Text	`$sel:name:ListDocumentVersions'`
-> ListDocumentVersions

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

$sel:maxResults:ListDocumentVersions', listDocumentVersions_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:ListDocumentVersions', listDocumentVersions_name - The name of the document. You can specify an Amazon Resource Name (ARN).

Request Lenses

listDocumentVersions_nextToken :: Lens' ListDocumentVersions (Maybe Text) Source #

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

listDocumentVersions_maxResults :: Lens' ListDocumentVersions (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.

listDocumentVersions_name :: Lens' ListDocumentVersions Text Source #

The name of the document. You can specify an Amazon Resource Name (ARN).

Destructuring the Response

data ListDocumentVersionsResponse Source #

See: newListDocumentVersionsResponse smart constructor.

Constructors

ListDocumentVersionsResponse'
Fields documentVersions :: Maybe (NonEmpty DocumentVersionInfo) The document versions. nextToken :: Maybe Text The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListDocumentVersionsResponse Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods (==) :: ListDocumentVersionsResponse -> ListDocumentVersionsResponse -> Bool # (/=) :: ListDocumentVersionsResponse -> ListDocumentVersionsResponse -> Bool #
Read ListDocumentVersionsResponse Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods readsPrec :: Int -> ReadS ListDocumentVersionsResponse # readList :: ReadS [ListDocumentVersionsResponse] # readPrec :: ReadPrec ListDocumentVersionsResponse # readListPrec :: ReadPrec [ListDocumentVersionsResponse] #
Show ListDocumentVersionsResponse Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods showsPrec :: Int -> ListDocumentVersionsResponse -> ShowS # show :: ListDocumentVersionsResponse -> String # showList :: [ListDocumentVersionsResponse] -> ShowS #
Generic ListDocumentVersionsResponse Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Associated Types type Rep ListDocumentVersionsResponse :: Type -> Type # Methods from :: ListDocumentVersionsResponse -> Rep ListDocumentVersionsResponse x # to :: Rep ListDocumentVersionsResponse x -> ListDocumentVersionsResponse #
NFData ListDocumentVersionsResponse Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions Methods rnf :: ListDocumentVersionsResponse -> () #
type Rep ListDocumentVersionsResponse Source #
Instance details Defined in Amazonka.SSM.ListDocumentVersions type Rep ListDocumentVersionsResponse = D1 ('MetaData "ListDocumentVersionsResponse" "Amazonka.SSM.ListDocumentVersions" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListDocumentVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentVersionInfo))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDocumentVersionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDocumentVersionsResponse'`
-> ListDocumentVersionsResponse

Create a value of ListDocumentVersionsResponse 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:documentVersions:ListDocumentVersionsResponse', listDocumentVersionsResponse_documentVersions - The document versions.

$sel:nextToken:ListDocumentVersions', listDocumentVersionsResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

$sel:httpStatus:ListDocumentVersionsResponse', listDocumentVersionsResponse_httpStatus - The response's http status code.

Response Lenses

listDocumentVersionsResponse_documentVersions :: Lens' ListDocumentVersionsResponse (Maybe (NonEmpty DocumentVersionInfo)) Source #

The document versions.

listDocumentVersionsResponse_nextToken :: Lens' ListDocumentVersionsResponse (Maybe Text) Source #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

listDocumentVersionsResponse_httpStatus :: Lens' ListDocumentVersionsResponse Int Source #

The response's http status code.