Skip to content

ListDocumentsRequest

Source code in docs_src/capo_ssm/types/list_documents_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class ListDocumentsRequest(TypedDict, closed=True):
    document_filter_list: NotRequired[
        "capo_ssm.types.document_filter_list.DocumentFilterList"
    ]
    """<p>This data type is deprecated. Instead, use <code>Filters</code>.</p>"""
    filters: NotRequired[
        "capo_ssm.types.document_key_values_filter_list.DocumentKeyValuesFilterList"
    ]
    """<p>One or more <code>DocumentKeyValuesFilter</code> 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 <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p> <note> <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code> </p> </note>"""
    max_results: NotRequired["capo_ssm.types.max_results.MaxResults"]
    """<p>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.</p>"""
    next_token: NotRequired["capo_ssm.types.next_token.NextToken"]
    """<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"""

document_filter_list instance-attribute 

document_filter_list: NotRequired[DocumentFilterList]

This data type is deprecated. Instead, use Filters.

filters instance-attribute 

filters: NotRequired[DocumentKeyValuesFilterList]

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

max_results instance-attribute 

max_results: NotRequired[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.

next_token instance-attribute 

next_token: NotRequired[NextToken]

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