The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

","Requires",{"_6952":6961},[6962,6964],{"_6955":6963},"#/definitions/397476",{"_23":6965},"A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.","Attachments",{"_6952":6968},[6969,6971],{"_6955":6970},"#/definitions/397360",{"_23":6972},"A list of key-value pairs that describe attachments to a version of a document.",{"_6952":6974},[6975,6977],{"_6955":6976},"#/definitions/397366",{"_23":6978},"

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

aws
amazon
amzn

","DisplayName",{"_6952":6981},[6982,6984],{"_6955":6983},"#/definitions/397478",{"_23":6985},"An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.","VersionName",{"_6952":6988},[6989,6991],{"_6955":6990},"#/definitions/397490",{"_23":6992},"An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.",{"_6952":6994},[6995,6997],{"_6955":6996},"#/definitions/397480",{"_23":6998},"

The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

",{"_6952":7000},[7001,7003],{"_6955":7002},"#/definitions/397483",{"_23":7004},"Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.",{"_6952":7006},[7007,7009],{"_6955":7008},"#/definitions/397482",{"_23":7010},"Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide. ","Tags",{"_6952":7013},[7014,7016],{"_6955":7015},"#/definitions/397275",{"_23":7017},"

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

Key=OS,Value=Windows
Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource operation.

","x--orders",[6947,6959,6966,6948,6979,6986,4093,4098,4103,7011],"definitions",{"_7022":7023,"_7024":7025,"_7032":7033,"_7037":7038,"_7040":7041,"_7043":7044,"_7050":7051,"_7056":7057,"_7081":7082,"_7086":7087,"_7091":7092,"_7093":7094,"_7097":7098,"_7099":7100,"_7102":7103,"_7117":7118,"_7121":7122,"_7127":7128,"_7130":7131,"_7159":7160,"_7163":7164,"_7166":7167,"_7185":7186},"396902",{"_5":6944,"_6945":6946,"_30":1093,"_6949":6950,"_7018":7019,"_22":1093},"397275",{"_5":7026,"_7027":7028,"_7030":7031,"_30":2998,"_22":2998},"array","items",{"_6955":7029},"#/definitions/398002","maxItems",1000,"397288",{"_5":7034,"_7035":7036,"_30":3078,"_22":3078},"string","pattern","^[a-zA-Z0-9_\\-.:/]{3,128}$","397300",{"_5":7034,"_7035":7039,"_30":3098,"_22":3098},"([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)","397352",{"_5":7034,"_7035":7042,"_30":3428,"_22":3428},"^[a-zA-Z0-9_\\-.]{3,128}$","397354",{"_5":7034,"_7045":7046,"_30":3443,"_22":3443},"enum",[7047,7048,7049],"SourceUrl","S3FileUrl","AttachmentReference","397355",{"_5":7026,"_7027":7052,"_7054":7055,"_7030":7055,"_30":3448,"_22":3448},{"_6955":7053},"#/definitions/397358","minItems",1,"397356",{"_5":6944,"_6949":7058,"_23":7079,"_7018":7080,"_30":3453,"_22":3453},{"_7059":7060,"_7066":7067,"_6948":7073},"Key",{"_6952":7061},[7062,7064],{"_6955":7063},"#/definitions/397354",{"_23":7065},"The key of a key-value pair that identifies the location of an attachment to a document.","Values",{"_6952":7068},[7069,7071],{"_6955":7070},"#/definitions/397355",{"_23":7072},"

The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

For the key SourceUrl, the value is an S3 bucket location. For example:

\"Values\": [ \"s3://doc-example-bucket/my-folder\" ]
For the key S3FileUrl, the value is a file in an S3 bucket. For example:

\"Values\": [ \"s3://doc-example-bucket/my-folder/my-file.py\" ]
For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:

\"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]

However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:

\"Values\": [ \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\" ]

",{"_6952":7074},[7075,7077],{"_6955":7076},"#/definitions/397352",{"_23":7078},"The name of the document attachment file.","Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.",[7059,7066,6948],"397358",{"_5":7034,"_7083":7055,"_7084":7085,"_30":3463,"_22":3463},"minLength","maxLength",1024,"397360",{"_5":7026,"_7027":7088,"_7054":182,"_7030":7090,"_30":3458,"_22":3458},{"_6955":7089},"#/definitions/397356",20,"397366",{"_5":7034,"_7035":7042,"_30":3488,"_22":3488},"397476",{"_5":7026,"_7027":7095,"_7054":7055,"_30":4078,"_22":4078},{"_6955":7096},"#/definitions/397620","397477",{"_5":7034,"_7083":7055,"_30":4073,"_22":4073},"397478",{"_5":7034,"_7035":7101,"_7084":7085,"_30":4083,"_22":4083},"^[\\w\\.\\-\\:\\/ ]*$","397480",{"_5":7034,"_7045":7104,"_30":4093,"_22":4093},[3783,5293,7105,6658,7106,7107,7108,7109,7110,7111,7112,7113,7114,7115,7116],"Automation","Package","ApplicationConfiguration","ApplicationConfigurationSchema","DeploymentStrategy","ChangeCalendar","Automation.ChangeTemplate","ProblemAnalysis","ProblemAnalysisTemplate","CloudFormation","ConformancePackTemplate","QuickSetup","397482",{"_5":7034,"_7035":7119,"_7084":7120,"_30":4103,"_22":4103},"^\\/[\\w\\.\\-\\:\\/]*$",200,"397483",{"_5":7034,"_7045":7123,"_30":4098,"_22":4098},[7124,7125,7126],"YAML","JSON","TEXT","397490",{"_5":7034,"_7035":7129,"_30":4088,"_22":4088},"^[a-zA-Z0-9_\\-.]{1,128}$","397620",{"_5":6944,"_6945":7132,"_6949":7133,"_23":7157,"_7018":7158,"_30":4783,"_22":4783},[6948],{"_6948":7134,"_5168":7140,"_4933":7146,"_6986":7152},{"_6952":7135},[7136,7138],{"_6955":7137},"#/definitions/397288",{"_23":7139},"The name of the required SSM document. The name can be an Amazon Resource Name (ARN).",{"_6952":7141},[7142,7144],{"_6955":7143},"#/definitions/397300",{"_23":7145},"The document version required by the current document.",{"_6952":7147},[7148,7150],{"_6955":7149},"#/definitions/701089",{"_23":7151},"The document type of the required SSM document.",{"_6952":7153},[7154,7155],{"_6955":6990},{"_23":7156},"An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.","An SSM document required by the current document.",[6948,5168,4933,6986],"397756",{"_5":7034,"_7035":7161,"_7083":7055,"_7084":7162,"_30":5543,"_22":5543},"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",128,"397997",{"_5":7034,"_7035":7161,"_7083":182,"_7084":7165,"_30":6763,"_22":6763},256,"398002",{"_5":6944,"_6945":7168,"_6949":7170,"_23":7183,"_7018":7184,"_30":6768,"_22":6768},[7059,7169],"Value",{"_7059":7171,"_7169":7177},{"_6952":7172},[7173,7175],{"_6955":7174},"#/definitions/397756",{"_23":7176},"The name of the tag.",{"_6952":7178},[7179,7181],{"_6955":7180},"#/definitions/397997",{"_23":7182},"The value of the tag.","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.",[7059,7169],"701089",{"_5":7034,"_7035":7129,"_7084":7162,"_30":4933,"_22":4933},"extraData",{"_7189":7190,"_7191":7021,"_7192":7193,"_23":115,"_7194":1093},"apiFieldList",[],"dataSchemaDefinitions","example","{\n \"Content\": \"string\",\n \"Requires\": [],\n \"Attachments\": [],\n \"Name\": \"string\",\n \"DisplayName\": \"string\",\n \"VersionName\": \"string\",\n \"DocumentType\": \"Command\",\n \"DocumentFormat\": \"YAML\",\n \"TargetType\": \"string\",\n \"Tags\": []\n}","displayName","docsIdTypeData",{"_7197":7198,"_7199":7200,"_7201":7200,"_7202":7203,"_7204":7205,"_7206":7207,"_7208":115,"_7209":-7},"onlineType","APIDOC","onlineId",345650,"projectId","teamId",97,"branchId",308784,"visitType","customDomain","subdirectory","specialFileType","notification",[],"footerBanner",[],"projectSetting",{"_7216":7217,"_7218":7219,"_7234":7235,"_7236":7237,"_7238":7239,"_7240":7241},"auth",{},"advancedSettings",{"_7220":154,"_7221":154,"_7222":51,"_7223":7224,"_7225":154,"_7226":154,"_7227":7228},"enableJsonc","enableBigint","responseValidate","isDefaultUrlEncoding",3,"enableTestScenarioSetting","enableYAPICompatScript","publishedDocUrlRules",{"_7229":7230,"_7231":7232,"_7233":51},"defaultRule","RESOURCE_KEY_ONLY","resourceKeyStandard","LEGACY","enableResourceKeyStandard","securityScheme",{},"mockSettings",{},"preProcessors",[],"postProcessors",[],"environments",{"_7244":7245,"_7287":7288,"_7348":7349},"selectedEnvironment",{"_172":7246,"_22":7247,"_7248":7249,"_7250":7251,"_7253":7254,"_7255":7256,"_7257":7258,"_7259":7260,"_7261":7262,"_7271":7272,"_5":7273,"_7274":7275,"_7201":7200,"_7276":7277,"_7278":7279,"_7280":182,"_184":7281,"_7282":7279,"_7283":7284,"_7285":7286},356112,"The Amazon SSM multi-region endpoint","baseUrl","http://ssm.{region}.amazonaws.com","baseUrls",{"_7252":7249},"default","websocketBaseUrls",{},"socketioBaseUrls",{},"requestProxyAgentSettings",{},"variables",[],"parameters",{"_7263":7264,"_7265":7266,"_7267":7268,"_7269":7270},"cookie",[],"query",[],"header",[],"body",[],"registrationCenters",[],"normal","visibility","protected","projectType","HTTP","creatorId",345038,"ordering",[],"editorId","createdAt","2022-09-10T18:21:21.000Z","updatedAt","2022-09-13T02:21:27.000Z","environmentList",[7289,7302,7317,7333],{"_172":7246,"_22":7247,"_7248":7249,"_7250":7290,"_7253":7291,"_7255":7292,"_7257":7293,"_7259":7294,"_7261":7295,"_7271":7300,"_5":7273,"_7274":7275,"_7201":7200,"_7276":7277,"_7278":7279,"_7280":182,"_184":7301,"_7282":7279,"_7283":7284,"_7285":7286},{"_7252":7249},{},{},{},[],{"_7263":7296,"_7265":7297,"_7267":7298,"_7269":7299},[],[],[],[],[],[],{"_172":7303,"_22":7247,"_7248":7304,"_7250":7305,"_7253":7306,"_7255":7307,"_7257":7308,"_7259":7309,"_7261":7310,"_7271":7315,"_5":7273,"_7274":7275,"_7201":7200,"_7276":7277,"_7278":7279,"_7280":182,"_184":7316,"_7282":7279,"_7283":7284,"_7285":7286},356113,"https://ssm.{region}.amazonaws.com",{"_7252":7304},{},{},{},[],{"_7263":7311,"_7265":7312,"_7267":7313,"_7269":7314},[],[],[],[],[],[],{"_172":7318,"_22":7319,"_7248":7320,"_7250":7321,"_7253":7322,"_7255":7323,"_7257":7324,"_7259":7325,"_7261":7326,"_7271":7331,"_5":7273,"_7274":7275,"_7201":7200,"_7276":7277,"_7278":7279,"_7280":182,"_184":7332,"_7282":7279,"_7283":7284,"_7285":7286},356114,"The Amazon SSM endpoint for China (Beijing) and China (Ningxia)","http://ssm.{region}.amazonaws.com.cn",{"_7252":7320},{},{},{},[],{"_7263":7327,"_7265":7328,"_7267":7329,"_7269":7330},[],[],[],[],[],[],{"_172":7334,"_22":7319,"_7248":7335,"_7250":7336,"_7253":7337,"_7255":7338,"_7257":7339,"_7259":7340,"_7261":7341,"_7271":7346,"_5":7273,"_7274":7275,"_7201":7200,"_7276":7277,"_7278":7279,"_7280":182,"_184":7347,"_7282":7279,"_7283":7284,"_7285":7286},356115,"https://ssm.{region}.amazonaws.com.cn",{"_7252":7335},{},{},{},[],{"_7263":7342,"_7265":7343,"_7267":7344,"_7269":7345},[],[],[],[],[],[],"servers",[7350],{"_172":7252,"_22":7351},"Default Server","searchSettings",{},"versionSettings",[7356],{"_7204":7205,"_7357":51,"_22":6938,"_7358":6938,"_7242":7359},"isDefaultVersion","slug",{"_7360":7361,"_7362":7246},"environmentIds",[7246,7303,7318,7334],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_7248":115,"_7367":115,"_7208":115,"_7368":154},"versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_7371":127},"appBrowserExtensionAdapterKey","customCodes",{"_7374":115},"javascript","primaryColorVariable",{"_6846":7377,"_6850":7378},"--ui-primary-color-hover: var(--ui-primary-5);--ui-primary-color-active: var(--ui-primary-7);--ui-picker-basic-cell-hover-with-range-color: #36139c;--ui-picker-date-hover-range-border-color: #4e1be0;--ui-primary-base: #9373EE;--ui-primary-base-p: 147, 115, 238;--ui-primary-color-p: 147, 115, 238;--ui-primary-color: #9373EE;--ui-primary-10: #362b50;--ui-primary-9: #51407e;--ui-primary-8: #634e9b;--ui-primary-7: #7a60c4;--ui-primary-7-p: 122, 96, 196;--ui-primary-6: #9373EE;--ui-primary-6-p: 147, 115, 238;--ui-primary-5: #b499f4;--ui-primary-5-p: 180, 153, 244;--ui-primary-4: #cebaf8;--ui-primary-3: #dfd1fb;--ui-primary-2: #ebe2fc;--ui-primary-1: #f3eefe;--ui-primary-1-p: 243, 238, 254;--ui-primary-a: #f7f3fe;--ui-primary-b: #fbf9ff;--g-color-primary: #9373EE;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #ffffff;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","--ui-primary-color-hover: var(--ui-primary-7);--ui-primary-color-active: var(--ui-primary-5);--ui-picker-basic-cell-hover-with-range-color: #312865;--ui-picker-date-hover-range-border-color: #4b3d9c;--ui-primary-base: #8276C9;--ui-primary-base-p: 130, 118, 201;--ui-primary-color-p: 130, 118, 201;--ui-primary-color: #8276C9;--ui-primary-10: #dcd7f0;--ui-primary-9: #a69bd9;--ui-primary-8: #b0a5dd;--ui-primary-7: #9c90d4;--ui-primary-7-p: 156, 144, 212;--ui-primary-6: #8276C9;--ui-primary-6-p: 130, 118, 201;--ui-primary-5: #635a96;--ui-primary-5-p: 99, 90, 150;--ui-primary-4: #49436c;--ui-primary-3: #393452;--ui-primary-2: #312d46;--ui-primary-1: #252333;--ui-primary-1-p: 37, 35, 51;--ui-primary-a: #21202d;--ui-primary-b: #1e1c28;--g-color-primary: #8276C9;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #1a1922;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","routes/_index/route","actionData","errors"]

CreateDocumentRequest(CreateDocumentRequest)