SSM / Client / describe_document

describe_document#

SSM.Client.describe_document(**kwargs)#

Describes the specified Amazon Web Services Systems Manager document (SSM document).

Request Syntax

response = client.describe_document(
    Name='string',
    DocumentVersion='string',
    VersionName='string'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the SSM document.
DocumentVersion (string) – The document version for which you want information. Can be a specific version or the default version.
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.

Return type:

dict

Returns:

Response Syntax

{
    'Document': {
        'Sha1': 'string',
        'Hash': 'string',
        'HashType': 'Sha256'|'Sha1',
        'Name': 'string',
        'DisplayName': 'string',
        'VersionName': 'string',
        'Owner': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'Status': 'Creating'|'Active'|'Updating'|'Deleting'|'Failed',
        'StatusInformation': 'string',
        'DocumentVersion': 'string',
        'Description': 'string',
        'Parameters': [
            {
                'Name': 'string',
                'Type': 'String'|'StringList',
                'Description': 'string',
                'DefaultValue': 'string'
            },
        ],
        'PlatformTypes': [
            'Windows'|'Linux'|'MacOS',
        ],
        'DocumentType': 'Command'|'Policy'|'Automation'|'Session'|'Package'|'ApplicationConfiguration'|'ApplicationConfigurationSchema'|'DeploymentStrategy'|'ChangeCalendar'|'Automation.ChangeTemplate'|'ProblemAnalysis'|'ProblemAnalysisTemplate'|'CloudFormation'|'ConformancePackTemplate'|'QuickSetup',
        'SchemaVersion': 'string',
        'LatestVersion': 'string',
        'DefaultVersion': 'string',
        'DocumentFormat': 'YAML'|'JSON'|'TEXT',
        'TargetType': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'AttachmentsInformation': [
            {
                'Name': 'string'
            },
        ],
        'Requires': [
            {
                'Name': 'string',
                'Version': 'string',
                'RequireType': 'string',
                'VersionName': 'string'
            },
        ],
        'Author': 'string',
        'ReviewInformation': [
            {
                'ReviewedTime': datetime(2015, 1, 1),
                'Status': 'APPROVED'|'NOT_REVIEWED'|'PENDING'|'REJECTED',
                'Reviewer': 'string'
            },
        ],
        'ApprovedVersion': 'string',
        'PendingReviewVersion': 'string',
        'ReviewStatus': 'APPROVED'|'NOT_REVIEWED'|'PENDING'|'REJECTED',
        'Category': [
            'string',
        ],
        'CategoryEnum': [
            'string',
        ]
    }
}

Response Structure

(dict) –
- Document (dict) –
  
  Information about the SSM document.
  - Sha1 (string) –
    
    The SHA1 hash of the document, which you can use for verification.
  - Hash (string) –
    
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Note
    Sha1 hashes have been deprecated.
  - HashType (string) –
    
    The hash type of the document. Valid values include Sha256 or Sha1.
    
    Note
    Sha1 hashes have been deprecated.
  - Name (string) –
    
    The name of the SSM document.
  - DisplayName (string) –
    
    The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
  - VersionName (string) –
    
    The version of the artifact associated with the document.
  - Owner (string) –
    
    The Amazon Web Services user that created the document.
  - CreatedDate (datetime) –
    
    The date when the document was created.
  - Status (string) –
    
    The status of the SSM document.
  - StatusInformation (string) –
    
    A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, “The specified S3 bucket doesn’t exist. Verify that the URL of the S3 bucket is correct.”
  - DocumentVersion (string) –
    
    The document version.
  - Description (string) –
    
    A description of the document.
  - Parameters (list) –
    
    A description of the parameters for a document.
    - (dict) –
      
      Parameters specified in a Systems Manager document that run on the server when the command is run.
      - Name (string) –
        
        The name of the parameter.
      - Type (string) –
        
        The type of parameter. The type can be either String or StringList.
      - Description (string) –
        
        A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
      - DefaultValue (string) –
        
        If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
  - PlatformTypes (list) –
    
    The list of operating system (OS) platforms compatible with this SSM document.
    - (string) –
  - DocumentType (string) –
    
    The type of document.
  - SchemaVersion (string) –
    
    The schema version.
  - LatestVersion (string) –
    
    The latest version of the document.
  - DefaultVersion (string) –
    
    The default 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.
  - AttachmentsInformation (list) –
    
    Details about the document attachments, including names, locations, sizes, and so on.
    - (dict) –
      
      An attribute of an attachment, such as the attachment name.
      - Name (string) –
        
        The name of the attachment.
  - 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.
  - Author (string) –
    
    The user in your organization who created the document.
  - ReviewInformation (list) –
    
    Details about the review of a document.
    - (dict) –
      
      Information about the result of a document review request.
      - ReviewedTime (datetime) –
        
        The time that the reviewer took action on the document review request.
      - Status (string) –
        
        The current status of the document review request.
      - Reviewer (string) –
        
        The reviewer assigned to take action on the document review request.
  - ApprovedVersion (string) –
    
    The version of the document currently approved for use in the organization.
  - PendingReviewVersion (string) –
    
    The version of the document that is currently under review.
  - ReviewStatus (string) –
    
    The current status of the review.
  - Category (list) –
    
    The classification of a document to help you identify and categorize its use.
    - (string) –
  - CategoryEnum (list) –
    
    The value that identifies a document’s category.
    - (string) –

describe_document#

Request Syntax

Response Syntax

Response Structure

Note

Note

Exceptions