[ aws . ssm ]

update-document-default-version

Description

Set the default version of a document.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-document-default-version
--name <value>
--document-version <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

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

--document-version (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To update the default version of a document

The following update-document-default-version example updates the default version of a Systems Manager document.

aws ssm update-document-default-version \
    --name "Example" \
    --document-version "2"

Output:

{
    "Description": {
        "Name": "Example",
        "DefaultVersion": "2"
    }
}

For more information, see Writing SSM Document Content in the AWS Systems Manager User Guide.

Output

Description -> (structure)

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.