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

Description

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDocuments Source #

See: newListDocuments smart constructor.

Constructors

ListDocuments' 

Fields

  • documentFilterList :: Maybe (NonEmpty DocumentFilter)

    This data type is deprecated. Instead, use Filters.

  • filters :: Maybe [DocumentKeyValuesFilter]

    One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

    This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

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

Instances

Instances details
Eq ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Read ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Show ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Generic ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Associated Types

type Rep ListDocuments :: Type -> Type #

NFData ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Methods

rnf :: ListDocuments -> () #

Hashable ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

ToJSON ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

AWSPager ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

AWSRequest ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Associated Types

type AWSResponse ListDocuments #

ToHeaders ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

ToPath ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

ToQuery ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

type Rep ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

type Rep ListDocuments = D1 ('MetaData "ListDocuments" "Amazonka.SSM.ListDocuments" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListDocuments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentFilterList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentFilter))) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentKeyValuesFilter]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListDocuments Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

newListDocuments :: ListDocuments Source #

Create a value of ListDocuments 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:documentFilterList:ListDocuments', listDocuments_documentFilterList - This data type is deprecated. Instead, use Filters.

$sel:filters:ListDocuments', listDocuments_filters - One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

$sel:nextToken:ListDocuments', listDocuments_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:maxResults:ListDocuments', listDocuments_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.

Request Lenses

listDocuments_documentFilterList :: Lens' ListDocuments (Maybe (NonEmpty DocumentFilter)) Source #

This data type is deprecated. Instead, use Filters.

listDocuments_filters :: Lens' ListDocuments (Maybe [DocumentKeyValuesFilter]) Source #

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

listDocuments_nextToken :: Lens' ListDocuments (Maybe Text) Source #

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

listDocuments_maxResults :: Lens' ListDocuments (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.

Destructuring the Response

data ListDocumentsResponse Source #

See: newListDocumentsResponse smart constructor.

Constructors

ListDocumentsResponse' 

Fields

Instances

Instances details
Eq ListDocumentsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Read ListDocumentsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Show ListDocumentsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Generic ListDocumentsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Associated Types

type Rep ListDocumentsResponse :: Type -> Type #

NFData ListDocumentsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

Methods

rnf :: ListDocumentsResponse -> () #

type Rep ListDocumentsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListDocuments

type Rep ListDocumentsResponse = D1 ('MetaData "ListDocumentsResponse" "Amazonka.SSM.ListDocuments" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListDocumentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentIdentifier])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDocumentsResponse Source #

Create a value of ListDocumentsResponse 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:documentIdentifiers:ListDocumentsResponse', listDocumentsResponse_documentIdentifiers - The names of the SSM documents.

$sel:nextToken:ListDocuments', listDocumentsResponse_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:ListDocumentsResponse', listDocumentsResponse_httpStatus - The response's http status code.

Response Lenses

listDocumentsResponse_nextToken :: Lens' ListDocumentsResponse (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.