SSM / Paginator / ListDocuments

ListDocuments#

class SSM.Paginator.ListDocuments#

paginator = client.get_paginator('list_documents')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from SSM.Client.list_documents().

Request Syntax

response_iterator = paginator.paginate(
    DocumentFilterList=[
        {
            'key': 'Name'|'Owner'|'PlatformTypes'|'DocumentType',
            'value': 'string'
        },
    ],
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

DocumentFilterList (list) –
This data type is deprecated. Instead, use Filters.
- (dict) –
  
  This data type is deprecated. Instead, use DocumentKeyValuesFilter.
  - key (string) – [REQUIRED]
    
    The name of the filter.
  - value (string) – [REQUIRED]
    
    The value of the filter.
Filters (list) –
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.

Note
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
- (dict) –
  
  One or more filters. Use a filter to return a more specific list of documents.
  
  For keys, you can specify one or more tags that have been applied to a document.
  
  You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:
  
  DocumentType
  - ApplicationConfiguration
  - ApplicationConfigurationSchema
  - Automation
  - ChangeCalendar
  - Command
  - Package
  - Policy
  - Session
    
    Owner
  Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.
  - Amazon
  - Private
  - Public
  - Self
  - ThirdParty
    
    PlatformTypes
  - Linux
  - Windows
  Name is another Amazon Web Services-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with Te, run the following command:
  
  aws ssm list-documents --filters Key=Name,Values=Te
  
  You can also use the TargetType Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
  
  If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.
  
  To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
  
  For example, if you created a key called region and are using the Amazon Web Services CLI to call the list-documents command:
  
  aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self
  - Key (string) –
    
    The name of the filter key.
  - Values (list) –
    
    The value for the filter key.
    - (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'DocumentIdentifiers': [
        {
            'Name': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'DisplayName': 'string',
            'Owner': 'string',
            'VersionName': 'string',
            'PlatformTypes': [
                'Windows'|'Linux'|'MacOS',
            ],
            'DocumentVersion': 'string',
            'DocumentType': 'Command'|'Policy'|'Automation'|'Session'|'Package'|'ApplicationConfiguration'|'ApplicationConfigurationSchema'|'DeploymentStrategy'|'ChangeCalendar'|'Automation.ChangeTemplate'|'ProblemAnalysis'|'ProblemAnalysisTemplate'|'CloudFormation'|'ConformancePackTemplate'|'QuickSetup',
            'SchemaVersion': 'string',
            'DocumentFormat': 'YAML'|'JSON'|'TEXT',
            'TargetType': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Requires': [
                {
                    'Name': 'string',
                    'Version': 'string',
                    'RequireType': 'string',
                    'VersionName': 'string'
                },
            ],
            'ReviewStatus': 'APPROVED'|'NOT_REVIEWED'|'PENDING'|'REJECTED',
            'Author': 'string'
        },
    ],

}

Response Structure

(dict) –
- DocumentIdentifiers (list) –
  
  The names of the SSM documents.
  - (dict) –
    
    Describes the name of a SSM document.
    - Name (string) –
      
      The name of the SSM document.
    - CreatedDate (datetime) –
      
      The date the SSM document was created.
    - DisplayName (string) –
      
      An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
    - Owner (string) –
      
      The Amazon Web Services user that created the document.
    - VersionName (string) –
      
      An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.
    - PlatformTypes (list) –
      
      The operating system platform.
      - (string) –
    - DocumentVersion (string) –
      
      The document version.
    - DocumentType (string) –
      
      The document type.
    - SchemaVersion (string) –
      
      The schema version.
    - DocumentFormat (string) –
      
      The document format, either JSON or YAML.
    - TargetType (string) –
      
      The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    - Tags (list) –
      
      The tags, or metadata, that have been applied to the document.
      - (dict) –
        
        Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
        
        Key (string) –
        
        The name of the tag.
        
        Value (string) –
        
        The value of the tag.
    - Requires (list) –
      
      A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
      - (dict) –
        
        An SSM document required by the current document.
        
        Name (string) –
        
        The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
        
        Version (string) –
        
        The document version required by the current document.
        
        RequireType (string) –
        
        The document type of the required SSM document.
        
        VersionName (string) –
        
        An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.
    - ReviewStatus (string) –
      
      The current status of a document review.
    - Author (string) –
      
      The user in your organization who created the document.