SSM / Client / update_document_default_version

update_document_default_version#

SSM.Client.update_document_default_version(**kwargs)#

Set the default version of a document.

Note

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

See also: AWS API Documentation

Request Syntax

response = client.update_document_default_version(
    Name='string',
    DocumentVersion='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of a custom document that you want to set as the default version.

  • DocumentVersion (string) –

    [REQUIRED]

    The version of a custom document that you want to set as the default version.

Return type:

dict

Returns:

Response Syntax

{
    'Description': {
        'Name': 'string',
        'DefaultVersion': 'string',
        'DefaultVersionName': 'string'
    }
}

Response Structure

  • (dict) –

    • Description (dict) –

      The description of a custom document that you want to set as the default version.

      • Name (string) –

        The name of the document.

      • DefaultVersion (string) –

        The default version of the document.

      • DefaultVersionName (string) –

        The default version of the artifact associated with the document.

Exceptions