github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/ssm/2014-11-06/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p>Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A <i>managed instance</i> is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.</p> <p>This reference is intended to be used with the <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/\">Amazon Web Services Systems Manager User Guide</a>.</p> <p>To get started, verify prerequisites and configure managed instances. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html\">Setting up Amazon Web Services Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p class=\"title\"> <b>Related resources</b> </p> <ul> <li> <p>For information about how to use a Query API, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/making-api-requests.html\">Making API requests</a>. </p> </li> <li> <p>For information about other API operations you can perform on EC2 instances, see the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/\">Amazon EC2 API Reference</a>.</p> </li> <li> <p>For information about AppConfig, a capability of Systems Manager, see the <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/\">AppConfig User Guide</a> and the <a href=\"https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/\">AppConfig API Reference</a>.</p> </li> <li> <p>For information about Incident Manager, a capability of Systems Manager, see the <a href=\"https://docs.aws.amazon.com/incident-manager/latest/userguide/\">Incident Manager User Guide</a> and the <a href=\"https://docs.aws.amazon.com/incident-manager/latest/APIReference/\">Incident Manager API Reference</a>.</p> </li> </ul>", 4 "operations": { 5 "AddTagsToResource": "<p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example:</p> <ul> <li> <p> <code>Key=Owner,Value=DbAdmin</code> </p> </li> <li> <p> <code>Key=Owner,Value=SysAdmin</code> </p> </li> <li> <p> <code>Key=Owner,Value=Dev</code> </p> </li> <li> <p> <code>Key=Stack,Value=Production</code> </p> </li> <li> <p> <code>Key=Stack,Value=Pre-Production</code> </p> </li> <li> <p> <code>Key=Stack,Value=Test</code> </p> </li> </ul> <p>Each resource can have a maximum of 50 tags.</p> <p>We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. </p> <p>For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging your Amazon EC2 resources</a> in the <i>Amazon EC2 User Guide</i>.</p>", 6 "AssociateOpsItemRelatedItem": "<p>Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.</p>", 7 "CancelCommand": "<p>Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.</p>", 8 "CancelMaintenanceWindowExecution": "<p>Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.</p>", 9 "CreateActivation": "<p>Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html\">Setting up Amazon Web Services Systems Manager for hybrid environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p> <note> <p>On-premises servers or VMs that are registered with Systems Manager and Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage with Systems Manager are all called <i>managed instances</i>.</p> </note>", 10 "CreateAssociation": "<p>A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. </p>", 11 "CreateAssociationBatch": "<p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified instances or targets.</p> <p>When you associate a document with one or more instances using instance IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the instance processes the document and configures the instance as specified.</p> <p>If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.</p>", 12 "CreateDocument": "<p>Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html\">Amazon Web Services Systems Manager Documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 13 "CreateMaintenanceWindow": "<p>Creates a new maintenance window.</p> <note> <p>The value you specify for <code>Duration</code> determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for <code>Cutoff</code>. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for <code>Cutoff</code> is one hour, no maintenance window tasks can start after 5 PM.</p> </note>", 14 "CreateOpsItem": "<p>Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">Amazon Web Services Systems Manager OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 15 "CreateOpsMetadata": "<p>If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.</p>", 16 "CreatePatchBaseline": "<p>Creates a patch baseline.</p> <note> <p>For information about valid key-value pairs in <code>PatchFilters</code> for each supported operating system type, see <a>PatchFilter</a>.</p> </note>", 17 "CreateResourceDataSync": "<p>A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and <code>SyncFromSource</code>.</p> <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html\">Configuring resource data sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or <code>EntireOrganization</code> by using Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html\">Setting up Systems Manager Explorer to display data from multiple accounts and Regions</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the <a>ListResourceDataSync</a>.</p> <note> <p>By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </p> </note>", 18 "DeleteActivation": "<p>Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation doesn't de-register managed instances. You must manually de-register managed instances.</p>", 19 "DeleteAssociation": "<p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance. If you created the association by using the <code>Targets</code> parameter, then you must delete the association by using the association ID.</p> <p>When you disassociate a document from an instance, it doesn't change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.</p>", 20 "DeleteDocument": "<p>Deletes the Amazon Web Services Systems Manager document (SSM document) and all instance associations to the document.</p> <p>Before you delete the document, we recommend that you use <a>DeleteAssociation</a> to disassociate all instances that are associated with the document.</p>", 21 "DeleteInventory": "<p>Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.</p>", 22 "DeleteMaintenanceWindow": "<p>Deletes a maintenance window.</p>", 23 "DeleteOpsMetadata": "<p>Delete OpsMetadata related to an application.</p>", 24 "DeleteParameter": "<p>Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.</p>", 25 "DeleteParameters": "<p>Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.</p>", 26 "DeletePatchBaseline": "<p>Deletes a patch baseline.</p>", 27 "DeleteResourceDataSync": "<p>Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.</p>", 28 "DeregisterManagedInstance": "<p>Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.</p>", 29 "DeregisterPatchBaselineForPatchGroup": "<p>Removes a patch group from a patch baseline.</p>", 30 "DeregisterTargetFromMaintenanceWindow": "<p>Removes a target from a maintenance window.</p>", 31 "DeregisterTaskFromMaintenanceWindow": "<p>Removes a task from a maintenance window.</p>", 32 "DescribeActivations": "<p>Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the instances in the activation, and the number of instances registered by using this activation.</p>", 33 "DescribeAssociation": "<p>Describes the association for the specified target or instance. If you created the association by using the <code>Targets</code> parameter, then you must retrieve the association by using the association ID.</p>", 34 "DescribeAssociationExecutionTargets": "<p>Views information about a specific execution of a specific association.</p>", 35 "DescribeAssociationExecutions": "<p>Views all executions for a specific association ID. </p>", 36 "DescribeAutomationExecutions": "<p>Provides details about all active and terminated Automation executions.</p>", 37 "DescribeAutomationStepExecutions": "<p>Information about all active and terminated step executions in an Automation workflow.</p>", 38 "DescribeAvailablePatches": "<p>Lists all patches eligible to be included in a patch baseline.</p>", 39 "DescribeDocument": "<p>Describes the specified Amazon Web Services Systems Manager document (SSM document).</p>", 40 "DescribeDocumentPermission": "<p>Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (<i>All</i>). </p>", 41 "DescribeEffectiveInstanceAssociations": "<p>All associations for the instance(s).</p>", 42 "DescribeEffectivePatchesForPatchBaseline": "<p>Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.</p>", 43 "DescribeInstanceAssociationsStatus": "<p>The status of the associations for the instance(s).</p>", 44 "DescribeInstanceInformation": "<p>Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.</p> <p>If you specify one or more instance IDs, it returns information for those instances. If you don't specify instance IDs, it returns information for all your instances. If you specify an instance ID that isn't valid or an instance that you don't own, you receive an error.</p> <note> <p>The <code>IamRole</code> field for this API operation is the Identity and Access Management (IAM) role assigned to on-premises instances. This call doesn't return the IAM role for EC2 instances.</p> </note>", 45 "DescribeInstancePatchStates": "<p>Retrieves the high-level patch state of one or more instances.</p>", 46 "DescribeInstancePatchStatesForPatchGroup": "<p>Retrieves the high-level patch state for the instances in the specified patch group.</p>", 47 "DescribeInstancePatches": "<p>Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.</p>", 48 "DescribeInventoryDeletions": "<p>Describes a specific delete inventory operation.</p>", 49 "DescribeMaintenanceWindowExecutionTaskInvocations": "<p>Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.</p>", 50 "DescribeMaintenanceWindowExecutionTasks": "<p>For a given maintenance window execution, lists the tasks that were run.</p>", 51 "DescribeMaintenanceWindowExecutions": "<p>Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.</p>", 52 "DescribeMaintenanceWindowSchedule": "<p>Retrieves information about upcoming executions of a maintenance window.</p>", 53 "DescribeMaintenanceWindowTargets": "<p>Lists the targets registered with the maintenance window.</p>", 54 "DescribeMaintenanceWindowTasks": "<p>Lists the tasks in a maintenance window.</p> <note> <p>For maintenance window tasks without a specified target, you can't supply values for <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.</p> </note>", 55 "DescribeMaintenanceWindows": "<p>Retrieves the maintenance windows in an Amazon Web Services account.</p>", 56 "DescribeMaintenanceWindowsForTarget": "<p>Retrieves information about the maintenance window targets or tasks that an instance is associated with.</p>", 57 "DescribeOpsItems": "<p>Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 58 "DescribeParameters": "<p>Get information about a parameter.</p> <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results.</p> <important> <p>If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, <code>DescribeParameters</code> retrieves whatever the original key alias was referencing.</p> </important>", 59 "DescribePatchBaselines": "<p>Lists the patch baselines in your Amazon Web Services account.</p>", 60 "DescribePatchGroupState": "<p>Returns high-level aggregated patch compliance state information for a patch group.</p>", 61 "DescribePatchGroups": "<p>Lists all patch groups that have been registered with patch baselines.</p>", 62 "DescribePatchProperties": "<p>Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as <a>CreatePatchBaseline</a>, <a>UpdatePatchBaseline</a>, <a>DescribeAvailablePatches</a>, and <a>DescribePatchBaselines</a>.</p> <p>The following section lists the properties that can be used in filters for each major operating system type:</p> <dl> <dt>AMAZON_LINUX</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>CLASSIFICATION</code> | <code>SEVERITY</code> </p> </dd> <dt>AMAZON_LINUX_2</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>CLASSIFICATION</code> | <code>SEVERITY</code> </p> </dd> <dt>CENTOS</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>CLASSIFICATION</code> | <code>SEVERITY</code> </p> </dd> <dt>DEBIAN</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>PRIORITY</code> </p> </dd> <dt>MACOS</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>CLASSIFICATION</code> </p> </dd> <dt>ORACLE_LINUX</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>CLASSIFICATION</code> | <code>SEVERITY</code> </p> </dd> <dt>REDHAT_ENTERPRISE_LINUX</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>CLASSIFICATION</code> | <code>SEVERITY</code> </p> </dd> <dt>SUSE</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>CLASSIFICATION</code> | <code>SEVERITY</code> </p> </dd> <dt>UBUNTU</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>PRIORITY</code> </p> </dd> <dt>WINDOWS</dt> <dd> <p>Valid properties: <code>PRODUCT</code> | <code>PRODUCT_FAMILY</code> | <code>CLASSIFICATION</code> | <code>MSRC_SEVERITY</code> </p> </dd> </dl>", 63 "DescribeSessions": "<p>Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.</p>", 64 "DisassociateOpsItemRelatedItem": "<p>Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.</p>", 65 "GetAutomationExecution": "<p>Get detailed information about a particular Automation execution.</p>", 66 "GetCalendarState": "<p>Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, <code>GetCalendarState</code> returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, <code>GetCalendarState</code> uses the current time. Change Calendar entries have two possible states: <code>OPEN</code> or <code>CLOSED</code>.</p> <p>If you specify more than one calendar in a request, the command returns the status of <code>OPEN</code> only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is <code>CLOSED</code>.</p> <p>For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html\">Amazon Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 67 "GetCommandInvocation": "<p>Returns detailed information about command execution for an invocation or plugin.</p> <p> <code>GetCommandInvocation</code> only gives the execution status of a plugin in a document. To get the command execution status on a specific instance, use <a>ListCommandInvocations</a>. To get the command execution status across instances, use <a>ListCommands</a>.</p>", 68 "GetConnectionStatus": "<p>Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.</p>", 69 "GetDefaultPatchBaseline": "<p>Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.</p> <p>If you don't specify an operating system value, the default patch baseline for Windows is returned.</p>", 70 "GetDeployablePatchSnapshotForInstance": "<p>Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p> <note> <p>If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target an instance with a script or command. For example, run the command using the <code>AWS-RunShellScript</code> document or the <code>AWS-RunPowerShellScript</code> document.</p> </note>", 71 "GetDocument": "<p>Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).</p>", 72 "GetInventory": "<p>Query inventory information. This includes instance status, such as <code>Stopped</code> or <code>Terminated</code>.</p>", 73 "GetInventorySchema": "<p>Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.</p>", 74 "GetMaintenanceWindow": "<p>Retrieves a maintenance window.</p>", 75 "GetMaintenanceWindowExecution": "<p>Retrieves details about a specific a maintenance window execution.</p>", 76 "GetMaintenanceWindowExecutionTask": "<p>Retrieves the details about a specific task run as part of a maintenance window execution.</p>", 77 "GetMaintenanceWindowExecutionTaskInvocation": "<p>Retrieves information about a specific task running on a specific target.</p>", 78 "GetMaintenanceWindowTask": "<p>Lists the tasks in a maintenance window.</p> <note> <p>For maintenance window tasks without a specified target, you can't supply values for <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.</p> </note>", 79 "GetOpsItem": "<p>Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 80 "GetOpsMetadata": "<p>View operational metadata related to an application in Application Manager.</p>", 81 "GetOpsSummary": "<p>View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer. </p>", 82 "GetParameter": "<p>Get information about a single parameter by specifying the parameter name.</p> <note> <p>To get information about more than one parameter at a time, use the <a>GetParameters</a> operation.</p> </note>", 83 "GetParameterHistory": "<p>Retrieves the history of all changes to a parameter.</p> <important> <p>If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, <code>GetParameterHistory</code> retrieves whatever the original key alias was referencing.</p> </important>", 84 "GetParameters": "<p>Get information about one or more parameters by specifying multiple parameter names.</p> <note> <p>To get information about a single parameter, you can use the <a>GetParameter</a> operation instead.</p> </note>", 85 "GetParametersByPath": "<p>Retrieve information about one or more parameters in a specific hierarchy. </p> <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results.</p>", 86 "GetPatchBaseline": "<p>Retrieves information about a patch baseline.</p>", 87 "GetPatchBaselineForPatchGroup": "<p>Retrieves the patch baseline that should be used for the specified patch group.</p>", 88 "GetServiceSetting": "<p> <code>ServiceSetting</code> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of <code>false</code>. This means the user can't use this feature unless they change the setting to <code>true</code> and intentionally opt in for a paid feature.</p> <p>Services map a <code>SettingId</code> object to a setting value. Amazon Web Services services teams define the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>, but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code> permission for the setting. Use the <a>UpdateServiceSetting</a> API operation to change the default setting. Or use the <a>ResetServiceSetting</a> to change the value back to the original value defined by the Amazon Web Services service team.</p> <p>Query the current service setting for the Amazon Web Services account. </p>", 89 "LabelParameterVersion": "<p>A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. </p> <p>Parameter labels have the following requirements and restrictions.</p> <ul> <li> <p>A version of a parameter can have a maximum of 10 labels.</p> </li> <li> <p>You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.</p> </li> <li> <p>You can move a label from one version of a parameter to another.</p> </li> <li> <p>You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.</p> </li> <li> <p>If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.</p> </li> <li> <p>A label can have a maximum of 100 characters.</p> </li> <li> <p>Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).</p> </li> <li> <p>Labels can't begin with a number, \"<code>aws</code>\" or \"<code>ssm</code>\" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels.</p> </li> </ul>", 90 "ListAssociationVersions": "<p>Retrieves all versions of an association for a specific association ID.</p>", 91 "ListAssociations": "<p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or instance by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>", 92 "ListCommandInvocations": "<p>An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs <code>SendCommand</code> against three instances, then a command invocation is created for each requested instance ID. <code>ListCommandInvocations</code> provide status about command execution.</p>", 93 "ListCommands": "<p>Lists the commands requested by users of the Amazon Web Services account.</p>", 94 "ListComplianceItems": "<p>For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.</p>", 95 "ListComplianceSummaries": "<p>Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.</p>", 96 "ListDocumentMetadataHistory": "<p>Information about approval reviews for a version of a change template in Change Manager.</p>", 97 "ListDocumentVersions": "<p>List all versions for a document.</p>", 98 "ListDocuments": "<p>Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.</p>", 99 "ListInventoryEntries": "<p>A list of inventory items returned by the request.</p>", 100 "ListOpsItemEvents": "<p>Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.</p>", 101 "ListOpsItemRelatedItems": "<p>Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.</p>", 102 "ListOpsMetadata": "<p>Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.</p>", 103 "ListResourceComplianceSummaries": "<p>Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.</p>", 104 "ListResourceDataSync": "<p>Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.</p> <p>The number of sync configurations might be too large to return using a single call to <code>ListResourceDataSync</code>. You can limit the number of sync configurations returned by using the <code>MaxResults</code> parameter. To determine whether there are more sync configurations to list, check the value of <code>NextToken</code> in the output. If there are more sync configurations to list, you can request them by specifying the <code>NextToken</code> returned in the call to the parameter of a subsequent call. </p>", 105 "ListTagsForResource": "<p>Returns a list of the tags assigned to the specified resource.</p> <p>For information about the ID format for each supported resource type, see <a>AddTagsToResource</a>.</p>", 106 "ModifyDocumentPermission": "<p>Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user account IDs for those people who can use the document. If you share a document publicly, you must specify <i>All</i> as the account ID.</p>", 107 "PutComplianceItems": "<p>Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.</p> <p>ComplianceType can be one of the following:</p> <ul> <li> <p>ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.</p> </li> <li> <p>ExecutionType: Specify patch, association, or Custom:<code>string</code>.</p> </li> <li> <p>ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.</p> </li> <li> <p>Id: The patch, association, or custom compliance ID.</p> </li> <li> <p>Title: A title.</p> </li> <li> <p>Status: The status of the compliance item. For example, <code>approved</code> for patches, or <code>Failed</code> for associations.</p> </li> <li> <p>Severity: A patch severity. For example, <code>critical</code>.</p> </li> <li> <p>DocumentName: An SSM document name. For example, <code>AWS-RunPatchBaseline</code>.</p> </li> <li> <p>DocumentVersion: An SSM document version number. For example, 4.</p> </li> <li> <p>Classification: A patch classification. For example, <code>security updates</code>.</p> </li> <li> <p>PatchBaselineId: A patch baseline ID.</p> </li> <li> <p>PatchSeverity: A patch severity. For example, <code>Critical</code>.</p> </li> <li> <p>PatchState: A patch state. For example, <code>InstancesWithFailedPatches</code>.</p> </li> <li> <p>PatchGroup: The name of a patch group.</p> </li> <li> <p>InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'</p> </li> </ul>", 108 "PutInventory": "<p>Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.</p>", 109 "PutParameter": "<p>Add a parameter to the system.</p>", 110 "RegisterDefaultPatchBaseline": "<p>Defines the default patch baseline for the relevant operating system.</p> <p>To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify <code>arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed</code> instead of <code>pb-0574b43a65ea646ed</code>.</p>", 111 "RegisterPatchBaselineForPatchGroup": "<p>Registers a patch baseline for a patch group.</p>", 112 "RegisterTargetWithMaintenanceWindow": "<p>Registers a target with a maintenance window.</p>", 113 "RegisterTaskWithMaintenanceWindow": "<p>Adds a new task to a maintenance window.</p>", 114 "RemoveTagsFromResource": "<p>Removes tag keys from the specified resource.</p>", 115 "ResetServiceSetting": "<p> <code>ServiceSetting</code> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.</p> <p>Services map a <code>SettingId</code> object to a setting value. Amazon Web Services services teams define the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>, but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code> permission for the setting. Use the <a>GetServiceSetting</a> API operation to view the current value. Use the <a>UpdateServiceSetting</a> API operation to change the default setting. </p> <p>Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team. </p>", 116 "ResumeSession": "<p>Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.</p> <note> <p>This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.</p> </note>", 117 "SendAutomationSignal": "<p>Sends a signal to an Automation execution to change the current behavior or status of the execution. </p>", 118 "SendCommand": "<p>Runs commands on one or more managed instances.</p>", 119 "StartAssociationsOnce": "<p>Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.</p>", 120 "StartAutomationExecution": "<p>Initiates execution of an Automation runbook.</p>", 121 "StartChangeRequestExecution": "<p>Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.</p>", 122 "StartSession": "<p>Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.</p> <note> <p>Amazon Web Services CLI usage: <code>start-session</code> is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html\">Install the Session Manager plugin for the Amazon Web Services CLI</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.</p> </note>", 123 "StopAutomationExecution": "<p>Stop an Automation that is currently running.</p>", 124 "TerminateSession": "<p>Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session isn't be resumed.</p>", 125 "UnlabelParameterVersion": "<p>Remove a label or labels from a parameter.</p>", 126 "UpdateAssociation": "<p>Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. </p> <p>In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the <a>DescribeAssociation</a> API operation. If you don't have permission to call <code>DescribeAssociation</code>, then you receive the following error: <code>An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn></code> </p> <important> <p>When you update an association, the association immediately runs against the specified targets.</p> </important>", 127 "UpdateAssociationStatus": "<p>Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified instance.</p> <p> <code>UpdateAssociationStatus</code> is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the <code>InstanceId</code> legacy parameter.</p>", 128 "UpdateDocument": "<p>Updates one or more values for an SSM document.</p>", 129 "UpdateDocumentDefaultVersion": "<p>Set the default version of a document. </p>", 130 "UpdateDocumentMetadata": "<p>Updates information related to approval reviews for a specific version of a change template in Change Manager.</p>", 131 "UpdateMaintenanceWindow": "<p>Updates an existing maintenance window. Only specified parameters are modified.</p> <note> <p>The value you specify for <code>Duration</code> determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for <code>Cutoff</code>. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for <code>Cutoff</code> is one hour, no maintenance window tasks can start after 5 PM.</p> </note>", 132 "UpdateMaintenanceWindowTarget": "<p>Modifies the target of an existing maintenance window. You can change the following:</p> <ul> <li> <p>Name</p> </li> <li> <p>Description</p> </li> <li> <p>Owner</p> </li> <li> <p>IDs for an ID target</p> </li> <li> <p>Tags for a Tag target</p> </li> <li> <p>From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see <a>Target</a>.</p> </li> </ul> <note> <p>If a parameter is null, then the corresponding field isn't modified.</p> </note>", 133 "UpdateMaintenanceWindowTask": "<p>Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:</p> <ul> <li> <p> <code>TaskARN</code>. For example, you can change a <code>RUN_COMMAND</code> task from <code>AWS-RunPowerShellScript</code> to <code>AWS-RunShellScript</code>.</p> </li> <li> <p> <code>ServiceRoleArn</code> </p> </li> <li> <p> <code>TaskInvocationParameters</code> </p> </li> <li> <p> <code>Priority</code> </p> </li> <li> <p> <code>MaxConcurrency</code> </p> </li> <li> <p> <code>MaxErrors</code> </p> </li> </ul> <note> <p>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note> <p>If the value for a parameter in <code>UpdateMaintenanceWindowTask</code> is null, then the corresponding field isn't modified. If you set <code>Replace</code> to true, then all fields required by the <a>RegisterTaskWithMaintenanceWindow</a> operation are required for this request. Optional fields that aren't specified are set to null.</p> <important> <p>When you update a maintenance window task that has options specified in <code>TaskInvocationParameters</code>, you must provide again all the <code>TaskInvocationParameters</code> values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified <code>TaskInvocationParameters</code> values for <code>Comment</code>, <code>NotificationConfig</code>, and <code>OutputS3BucketName</code>. If you update the maintenance window task and specify only a different <code>OutputS3BucketName</code> value, the values for <code>Comment</code> and <code>NotificationConfig</code> are removed.</p> </important>", 134 "UpdateManagedInstanceRole": "<p>Changes the Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see <a>CreateActivation</a>.</p>", 135 "UpdateOpsItem": "<p>Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html\">Getting started with OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 136 "UpdateOpsMetadata": "<p>Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.</p>", 137 "UpdatePatchBaseline": "<p>Modifies an existing patch baseline. Fields not specified in the request are left unchanged.</p> <note> <p>For information about valid key-value pairs in <code>PatchFilters</code> for each supported operating system type, see <a>PatchFilter</a>.</p> </note>", 138 "UpdateResourceDataSync": "<p>Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the <code>Include only the current account</code> option, you can't edit that sync later and choose the <code>Include all accounts from my Organizations configuration</code> option. Instead, you must delete the first resource data sync, and create a new one.</p> <note> <p>This API operation only supports a resource data sync that was created with a SyncFromSource <code>SyncType</code>.</p> </note>", 139 "UpdateServiceSetting": "<p> <code>ServiceSetting</code> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.</p> <p>Services map a <code>SettingId</code> object to a setting value. Amazon Web Services services teams define the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>, but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code> permission for the setting. Use the <a>GetServiceSetting</a> API operation to view the current value. Or, use the <a>ResetServiceSetting</a> to change the value back to the original value defined by the Amazon Web Services service team.</p> <p>Update the service setting for the account. </p>" 140 }, 141 "shapes": { 142 "Account": { 143 "base": null, 144 "refs": { 145 "Accounts$member": null 146 } 147 }, 148 "AccountId": { 149 "base": null, 150 "refs": { 151 "AccountIdList$member": null, 152 "AccountSharingInfo$AccountId": "<p>The Amazon Web Services account ID where the current document is shared.</p>" 153 } 154 }, 155 "AccountIdList": { 156 "base": null, 157 "refs": { 158 "DescribeDocumentPermissionResponse$AccountIds": "<p>The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or <i>All</i>.</p>", 159 "ModifyDocumentPermissionRequest$AccountIdsToAdd": "<p>The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>.</p>", 160 "ModifyDocumentPermissionRequest$AccountIdsToRemove": "<p>The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services user account can either be a group of account IDs or <i>All</i>. This action has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID to add and the same ID to remove, the system removes access to the document.</p>" 161 } 162 }, 163 "AccountSharingInfo": { 164 "base": "<p>Information includes the Amazon Web Services account ID where the current document is shared and the version shared with that account.</p>", 165 "refs": { 166 "AccountSharingInfoList$member": null 167 } 168 }, 169 "AccountSharingInfoList": { 170 "base": "<p>A list of of Amazon Web Services accounts where the current document is shared and the version shared with each account.</p>", 171 "refs": { 172 "DescribeDocumentPermissionResponse$AccountSharingInfoList": "<p>A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.</p>" 173 } 174 }, 175 "Accounts": { 176 "base": null, 177 "refs": { 178 "TargetLocation$Accounts": "<p>The Amazon Web Services accounts targeted by the current Automation execution.</p>" 179 } 180 }, 181 "Activation": { 182 "base": "<p>An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with Amazon Web Services Systems Manager is called a managed instance.</p>", 183 "refs": { 184 "ActivationList$member": null 185 } 186 }, 187 "ActivationCode": { 188 "base": null, 189 "refs": { 190 "CreateActivationResult$ActivationCode": "<p>The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID. </p>" 191 } 192 }, 193 "ActivationDescription": { 194 "base": null, 195 "refs": { 196 "Activation$Description": "<p>A user defined description of the activation.</p>", 197 "CreateActivationRequest$Description": "<p>A user-defined description of the resource that you want to register with Systems Manager. </p> <important> <p>Don't enter personally identifiable information in this field.</p> </important>" 198 } 199 }, 200 "ActivationId": { 201 "base": null, 202 "refs": { 203 "Activation$ActivationId": "<p>The ID created by Systems Manager when you submitted the activation.</p>", 204 "CreateActivationResult$ActivationId": "<p>The ID number generated by the system when it processed the activation. The activation ID functions like a user name.</p>", 205 "DeleteActivationRequest$ActivationId": "<p>The ID of the activation that you want to delete.</p>", 206 "InstanceInformation$ActivationId": "<p>The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.</p>" 207 } 208 }, 209 "ActivationList": { 210 "base": null, 211 "refs": { 212 "DescribeActivationsResult$ActivationList": "<p>A list of activations for your Amazon Web Services account.</p>" 213 } 214 }, 215 "AddTagsToResourceRequest": { 216 "base": null, 217 "refs": { 218 } 219 }, 220 "AddTagsToResourceResult": { 221 "base": null, 222 "refs": { 223 } 224 }, 225 "AgentErrorCode": { 226 "base": null, 227 "refs": { 228 "InstanceAssociationStatusInfo$ErrorCode": "<p>An error code returned by the request to create the association.</p>" 229 } 230 }, 231 "AggregatorSchemaOnly": { 232 "base": null, 233 "refs": { 234 "GetInventorySchemaRequest$Aggregator": "<p>Returns inventory schemas that support aggregation. For example, this call returns the <code>AWS:InstanceInformation</code> type, because it supports aggregation based on the <code>PlatformName</code>, <code>PlatformType</code>, and <code>PlatformVersion</code> attributes.</p>" 235 } 236 }, 237 "AllowedPattern": { 238 "base": null, 239 "refs": { 240 "ParameterHistory$AllowedPattern": "<p>Parameter names can include the following letters and symbols.</p> <p>a-zA-Z0-9_.-</p>", 241 "ParameterMetadata$AllowedPattern": "<p>A parameter name can include only the following letters and symbols.</p> <p>a-zA-Z0-9_.-</p>", 242 "PutParameterRequest$AllowedPattern": "<p>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\\d+$ </p>" 243 } 244 }, 245 "AlreadyExistsException": { 246 "base": "<p>Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.</p>", 247 "refs": { 248 } 249 }, 250 "ApplyOnlyAtCronInterval": { 251 "base": null, 252 "refs": { 253 "AssociationDescription$ApplyOnlyAtCronInterval": "<p>By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.</p>", 254 "AssociationVersionInfo$ApplyOnlyAtCronInterval": "<p>By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.</p>", 255 "CreateAssociationBatchRequestEntry$ApplyOnlyAtCronInterval": "<p>By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.</p>", 256 "CreateAssociationRequest$ApplyOnlyAtCronInterval": "<p>By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.</p>", 257 "UpdateAssociationRequest$ApplyOnlyAtCronInterval": "<p>By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.</p> <p>Also, if you specified this option when you created the association, you can reset it. To do so, specify the <code>no-apply-only-at-cron-interval</code> parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.</p>" 258 } 259 }, 260 "ApproveAfterDays": { 261 "base": null, 262 "refs": { 263 "PatchRule$ApproveAfterDays": "<p>The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of <code>7</code> means that patches are approved seven days after they are released. Not supported on Debian Server or Ubuntu Server.</p>" 264 } 265 }, 266 "AssociateOpsItemRelatedItemRequest": { 267 "base": null, 268 "refs": { 269 } 270 }, 271 "AssociateOpsItemRelatedItemResponse": { 272 "base": null, 273 "refs": { 274 } 275 }, 276 "AssociatedInstances": { 277 "base": "<p>You must disassociate a document from all instances before you can delete it.</p>", 278 "refs": { 279 } 280 }, 281 "Association": { 282 "base": "<p>Describes an association of a Amazon Web Services Systems Manager document (SSM document) and an instance.</p>", 283 "refs": { 284 "AssociationList$member": null 285 } 286 }, 287 "AssociationAlreadyExists": { 288 "base": "<p>The specified association already exists.</p>", 289 "refs": { 290 } 291 }, 292 "AssociationComplianceSeverity": { 293 "base": null, 294 "refs": { 295 "AssociationDescription$ComplianceSeverity": "<p>The severity level that is assigned to the association.</p>", 296 "AssociationVersionInfo$ComplianceSeverity": "<p>The severity level that is assigned to the association.</p>", 297 "CreateAssociationBatchRequestEntry$ComplianceSeverity": "<p>The severity level to assign to the association.</p>", 298 "CreateAssociationRequest$ComplianceSeverity": "<p>The severity level to assign to the association.</p>", 299 "UpdateAssociationRequest$ComplianceSeverity": "<p>The severity level to assign to the association.</p>" 300 } 301 }, 302 "AssociationDescription": { 303 "base": "<p>Describes the parameters for a document.</p>", 304 "refs": { 305 "AssociationDescriptionList$member": null, 306 "CreateAssociationResult$AssociationDescription": "<p>Information about the association.</p>", 307 "DescribeAssociationResult$AssociationDescription": "<p>Information about the association.</p>", 308 "UpdateAssociationResult$AssociationDescription": "<p>The description of the association that was updated.</p>", 309 "UpdateAssociationStatusResult$AssociationDescription": "<p>Information about the association.</p>" 310 } 311 }, 312 "AssociationDescriptionList": { 313 "base": null, 314 "refs": { 315 "CreateAssociationBatchResult$Successful": "<p>Information about the associations that succeeded.</p>" 316 } 317 }, 318 "AssociationDoesNotExist": { 319 "base": "<p>The specified association doesn't exist.</p>", 320 "refs": { 321 } 322 }, 323 "AssociationExecution": { 324 "base": "<p>Includes information about the specified association.</p>", 325 "refs": { 326 "AssociationExecutionsList$member": null 327 } 328 }, 329 "AssociationExecutionDoesNotExist": { 330 "base": "<p>The specified execution ID doesn't exist. Verify the ID number and try again.</p>", 331 "refs": { 332 } 333 }, 334 "AssociationExecutionFilter": { 335 "base": "<p>Filters used in the request.</p>", 336 "refs": { 337 "AssociationExecutionFilterList$member": null 338 } 339 }, 340 "AssociationExecutionFilterKey": { 341 "base": null, 342 "refs": { 343 "AssociationExecutionFilter$Key": "<p>The key value used in the request.</p>" 344 } 345 }, 346 "AssociationExecutionFilterList": { 347 "base": null, 348 "refs": { 349 "DescribeAssociationExecutionsRequest$Filters": "<p>Filters for the request. You can specify the following filters and values.</p> <p>ExecutionId (EQUAL)</p> <p>Status (EQUAL)</p> <p>CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)</p>" 350 } 351 }, 352 "AssociationExecutionFilterValue": { 353 "base": null, 354 "refs": { 355 "AssociationExecutionFilter$Value": "<p>The value specified for the key.</p>" 356 } 357 }, 358 "AssociationExecutionId": { 359 "base": null, 360 "refs": { 361 "AssociationExecution$ExecutionId": "<p>The execution ID for the association.</p>", 362 "AssociationExecutionTarget$ExecutionId": "<p>The execution ID.</p>", 363 "DescribeAssociationExecutionTargetsRequest$ExecutionId": "<p>The execution ID for which you want to view details.</p>" 364 } 365 }, 366 "AssociationExecutionTarget": { 367 "base": "<p>Includes information about the specified association execution.</p>", 368 "refs": { 369 "AssociationExecutionTargetsList$member": null 370 } 371 }, 372 "AssociationExecutionTargetsFilter": { 373 "base": "<p>Filters for the association execution.</p>", 374 "refs": { 375 "AssociationExecutionTargetsFilterList$member": null 376 } 377 }, 378 "AssociationExecutionTargetsFilterKey": { 379 "base": null, 380 "refs": { 381 "AssociationExecutionTargetsFilter$Key": "<p>The key value used in the request.</p>" 382 } 383 }, 384 "AssociationExecutionTargetsFilterList": { 385 "base": null, 386 "refs": { 387 "DescribeAssociationExecutionTargetsRequest$Filters": "<p>Filters for the request. You can specify the following filters and values.</p> <p>Status (EQUAL)</p> <p>ResourceId (EQUAL)</p> <p>ResourceType (EQUAL)</p>" 388 } 389 }, 390 "AssociationExecutionTargetsFilterValue": { 391 "base": null, 392 "refs": { 393 "AssociationExecutionTargetsFilter$Value": "<p>The value specified for the key.</p>" 394 } 395 }, 396 "AssociationExecutionTargetsList": { 397 "base": null, 398 "refs": { 399 "DescribeAssociationExecutionTargetsResult$AssociationExecutionTargets": "<p>Information about the execution.</p>" 400 } 401 }, 402 "AssociationExecutionsList": { 403 "base": null, 404 "refs": { 405 "DescribeAssociationExecutionsResult$AssociationExecutions": "<p>A list of the executions for the specified association ID.</p>" 406 } 407 }, 408 "AssociationFilter": { 409 "base": "<p>Describes a filter.</p>", 410 "refs": { 411 "AssociationFilterList$member": null 412 } 413 }, 414 "AssociationFilterKey": { 415 "base": null, 416 "refs": { 417 "AssociationFilter$key": "<p>The name of the filter.</p> <note> <p> <code>InstanceId</code> has been deprecated.</p> </note>" 418 } 419 }, 420 "AssociationFilterList": { 421 "base": null, 422 "refs": { 423 "ListAssociationsRequest$AssociationFilterList": "<p>One or more filters. Use a filter to return a more specific list of results.</p> <note> <p>Filtering associations using the <code>InstanceID</code> attribute only returns legacy associations created using the <code>InstanceID</code> attribute. Associations targeting the instance that are part of the Target Attributes <code>ResourceGroup</code> or <code>Tags</code> aren't returned.</p> </note>" 424 } 425 }, 426 "AssociationFilterOperatorType": { 427 "base": null, 428 "refs": { 429 "AssociationExecutionFilter$Type": "<p>The filter type specified in the request.</p>" 430 } 431 }, 432 "AssociationFilterValue": { 433 "base": null, 434 "refs": { 435 "AssociationFilter$value": "<p>The filter value.</p>" 436 } 437 }, 438 "AssociationId": { 439 "base": null, 440 "refs": { 441 "Association$AssociationId": "<p>The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.</p>", 442 "AssociationDescription$AssociationId": "<p>The association ID.</p>", 443 "AssociationExecution$AssociationId": "<p>The association ID.</p>", 444 "AssociationExecutionTarget$AssociationId": "<p>The association ID.</p>", 445 "AssociationIdList$member": null, 446 "AssociationVersionInfo$AssociationId": "<p>The ID created by the system when the association was created.</p>", 447 "DeleteAssociationRequest$AssociationId": "<p>The association ID that you want to delete.</p>", 448 "DescribeAssociationExecutionTargetsRequest$AssociationId": "<p>The association ID that includes the execution for which you want to view details.</p>", 449 "DescribeAssociationExecutionsRequest$AssociationId": "<p>The association ID for which you want to view execution history details.</p>", 450 "DescribeAssociationRequest$AssociationId": "<p>The association ID for which you want information.</p>", 451 "InstanceAssociation$AssociationId": "<p>The association ID.</p>", 452 "InstanceAssociationStatusInfo$AssociationId": "<p>The association ID.</p>", 453 "ListAssociationVersionsRequest$AssociationId": "<p>The association ID for which you want to view all versions.</p>", 454 "UpdateAssociationRequest$AssociationId": "<p>The ID of the association you want to update. </p>" 455 } 456 }, 457 "AssociationIdList": { 458 "base": null, 459 "refs": { 460 "StartAssociationsOnceRequest$AssociationIds": "<p>The association IDs that you want to run immediately and only one time.</p>" 461 } 462 }, 463 "AssociationLimitExceeded": { 464 "base": "<p>You can have at most 2,000 active associations.</p>", 465 "refs": { 466 } 467 }, 468 "AssociationList": { 469 "base": null, 470 "refs": { 471 "ListAssociationsResult$Associations": "<p>The associations.</p>" 472 } 473 }, 474 "AssociationName": { 475 "base": null, 476 "refs": { 477 "Association$AssociationName": "<p>The association name.</p>", 478 "AssociationDescription$AssociationName": "<p>The association name.</p>", 479 "AssociationVersionInfo$AssociationName": "<p>The name specified for the association version when the association version was created.</p>", 480 "CreateAssociationBatchRequestEntry$AssociationName": "<p>Specify a descriptive name for the association.</p>", 481 "CreateAssociationRequest$AssociationName": "<p>Specify a descriptive name for the association.</p>", 482 "InstanceAssociationStatusInfo$AssociationName": "<p>The name of the association applied to the instance.</p>", 483 "UpdateAssociationRequest$AssociationName": "<p>The name of the association that you want to update.</p>" 484 } 485 }, 486 "AssociationOverview": { 487 "base": "<p>Information about the association.</p>", 488 "refs": { 489 "Association$Overview": "<p>Information about the association.</p>", 490 "AssociationDescription$Overview": "<p>Information about the association.</p>" 491 } 492 }, 493 "AssociationResourceId": { 494 "base": null, 495 "refs": { 496 "AssociationExecutionTarget$ResourceId": "<p>The resource ID, for example, the instance ID where the association ran.</p>" 497 } 498 }, 499 "AssociationResourceType": { 500 "base": null, 501 "refs": { 502 "AssociationExecutionTarget$ResourceType": "<p>The resource type, for example, instance.</p>" 503 } 504 }, 505 "AssociationStatus": { 506 "base": "<p>Describes an association status.</p>", 507 "refs": { 508 "AssociationDescription$Status": "<p>The association status.</p>", 509 "UpdateAssociationStatusRequest$AssociationStatus": "<p>The association status.</p>" 510 } 511 }, 512 "AssociationStatusAggregatedCount": { 513 "base": null, 514 "refs": { 515 "AssociationOverview$AssociationStatusAggregatedCount": "<p>Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.</p>" 516 } 517 }, 518 "AssociationStatusName": { 519 "base": null, 520 "refs": { 521 "AssociationStatus$Name": "<p>The status.</p>" 522 } 523 }, 524 "AssociationSyncCompliance": { 525 "base": null, 526 "refs": { 527 "AssociationDescription$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>", 528 "AssociationVersionInfo$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>", 529 "CreateAssociationBatchRequestEntry$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>. </p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>", 530 "CreateAssociationRequest$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>", 531 "UpdateAssociationRequest$SyncCompliance": "<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" 532 } 533 }, 534 "AssociationVersion": { 535 "base": null, 536 "refs": { 537 "Association$AssociationVersion": "<p>The association version.</p>", 538 "AssociationDescription$AssociationVersion": "<p>The association version.</p>", 539 "AssociationExecution$AssociationVersion": "<p>The association version.</p>", 540 "AssociationExecutionTarget$AssociationVersion": "<p>The association version.</p>", 541 "AssociationVersionInfo$AssociationVersion": "<p>The association version.</p>", 542 "DescribeAssociationRequest$AssociationVersion": "<p>Specify the association version to retrieve. To view the latest version, either specify <code>$LATEST</code> for this parameter, or omit this parameter. To view a list of all associations for an instance, use <a>ListAssociations</a>. To get a list of versions for a specific association, use <a>ListAssociationVersions</a>. </p>", 543 "InstanceAssociation$AssociationVersion": "<p>Version information for the association on the instance.</p>", 544 "InstanceAssociationStatusInfo$AssociationVersion": "<p>The version of the association applied to the instance.</p>", 545 "UpdateAssociationRequest$AssociationVersion": "<p>This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify <code>$LATEST</code>, or omit this parameter.</p>" 546 } 547 }, 548 "AssociationVersionInfo": { 549 "base": "<p>Information about the association version.</p>", 550 "refs": { 551 "AssociationVersionList$member": null 552 } 553 }, 554 "AssociationVersionLimitExceeded": { 555 "base": "<p>You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions. </p>", 556 "refs": { 557 } 558 }, 559 "AssociationVersionList": { 560 "base": null, 561 "refs": { 562 "ListAssociationVersionsResult$AssociationVersions": "<p>Information about all versions of the association for the specified association ID.</p>" 563 } 564 }, 565 "AttachmentContent": { 566 "base": "<p>A structure that includes attributes that describe a document attachment.</p>", 567 "refs": { 568 "AttachmentContentList$member": null 569 } 570 }, 571 "AttachmentContentList": { 572 "base": null, 573 "refs": { 574 "GetDocumentResult$AttachmentsContent": "<p>A description of the document attachments, including names, locations, sizes, and so on.</p>" 575 } 576 }, 577 "AttachmentHash": { 578 "base": null, 579 "refs": { 580 "AttachmentContent$Hash": "<p>The cryptographic hash value of the document content.</p>" 581 } 582 }, 583 "AttachmentHashType": { 584 "base": null, 585 "refs": { 586 "AttachmentContent$HashType": "<p>The hash algorithm used to calculate the hash value.</p>" 587 } 588 }, 589 "AttachmentIdentifier": { 590 "base": null, 591 "refs": { 592 "AttachmentsSource$Name": "<p>The name of the document attachment file.</p>" 593 } 594 }, 595 "AttachmentInformation": { 596 "base": "<p>An attribute of an attachment, such as the attachment name.</p>", 597 "refs": { 598 "AttachmentInformationList$member": null 599 } 600 }, 601 "AttachmentInformationList": { 602 "base": null, 603 "refs": { 604 "DocumentDescription$AttachmentsInformation": "<p>Details about the document attachments, including names, locations, sizes, and so on.</p>" 605 } 606 }, 607 "AttachmentName": { 608 "base": null, 609 "refs": { 610 "AttachmentContent$Name": "<p>The name of an attachment.</p>", 611 "AttachmentInformation$Name": "<p>The name of the attachment.</p>" 612 } 613 }, 614 "AttachmentUrl": { 615 "base": null, 616 "refs": { 617 "AttachmentContent$Url": "<p>The URL location of the attachment content.</p>" 618 } 619 }, 620 "AttachmentsSource": { 621 "base": "<p>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.</p>", 622 "refs": { 623 "AttachmentsSourceList$member": null 624 } 625 }, 626 "AttachmentsSourceKey": { 627 "base": null, 628 "refs": { 629 "AttachmentsSource$Key": "<p>The key of a key-value pair that identifies the location of an attachment to a document.</p>" 630 } 631 }, 632 "AttachmentsSourceList": { 633 "base": null, 634 "refs": { 635 "CreateDocumentRequest$Attachments": "<p>A list of key-value pairs that describe attachments to a version of a document.</p>", 636 "UpdateDocumentRequest$Attachments": "<p>A list of key-value pairs that describe attachments to a version of a document.</p>" 637 } 638 }, 639 "AttachmentsSourceValue": { 640 "base": null, 641 "refs": { 642 "AttachmentsSourceValues$member": null 643 } 644 }, 645 "AttachmentsSourceValues": { 646 "base": null, 647 "refs": { 648 "AttachmentsSource$Values": "<p>The value of a key-value pair that identifies the location of an attachment to a document. The format for <b>Value</b> depends on the type of key you specify.</p> <ul> <li> <p>For the key <i>SourceUrl</i>, the value is an S3 bucket location. For example:</p> <p> <code>\"Values\": [ \"s3://doc-example-bucket/my-folder\" ]</code> </p> </li> <li> <p>For the key <i>S3FileUrl</i>, the value is a file in an S3 bucket. For example:</p> <p> <code>\"Values\": [ \"s3://doc-example-bucket/my-folder/my-file.py\" ]</code> </p> </li> <li> <p>For the key <i>AttachmentReference</i>, 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:</p> <p> <code>\"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]</code> </p> <p>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:</p> <p> <code>\"Values\": [ \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\" ]</code> </p> </li> </ul>" 649 } 650 }, 651 "AttributeName": { 652 "base": null, 653 "refs": { 654 "ComplianceItemDetails$key": null, 655 "InventoryItemContentContext$key": null, 656 "InventoryItemEntry$key": null, 657 "OpsEntityItemEntry$key": null, 658 "PatchPropertyEntry$key": null 659 } 660 }, 661 "AttributeValue": { 662 "base": null, 663 "refs": { 664 "ComplianceItemDetails$value": null, 665 "InventoryItemContentContext$value": null, 666 "InventoryItemEntry$value": null, 667 "OpsEntityItemEntry$value": null, 668 "PatchPropertyEntry$value": null 669 } 670 }, 671 "AutomationActionName": { 672 "base": null, 673 "refs": { 674 "StepExecution$Action": "<p>The action this step performs. The action determines the behavior of the step.</p>" 675 } 676 }, 677 "AutomationDefinitionNotApprovedException": { 678 "base": "<p>Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.</p>", 679 "refs": { 680 } 681 }, 682 "AutomationDefinitionNotFoundException": { 683 "base": "<p>An Automation runbook with the specified name couldn't be found.</p>", 684 "refs": { 685 } 686 }, 687 "AutomationDefinitionVersionNotFoundException": { 688 "base": "<p>An Automation runbook with the specified name and version couldn't be found.</p>", 689 "refs": { 690 } 691 }, 692 "AutomationExecution": { 693 "base": "<p>Detailed information about the current state of an individual Automation execution.</p>", 694 "refs": { 695 "GetAutomationExecutionResult$AutomationExecution": "<p>Detailed information about the current state of an automation execution.</p>" 696 } 697 }, 698 "AutomationExecutionFilter": { 699 "base": "<p>A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.</p>", 700 "refs": { 701 "AutomationExecutionFilterList$member": null 702 } 703 }, 704 "AutomationExecutionFilterKey": { 705 "base": null, 706 "refs": { 707 "AutomationExecutionFilter$Key": "<p>One or more keys to limit the results.</p>" 708 } 709 }, 710 "AutomationExecutionFilterList": { 711 "base": null, 712 "refs": { 713 "DescribeAutomationExecutionsRequest$Filters": "<p>Filters used to limit the scope of executions that are requested.</p>" 714 } 715 }, 716 "AutomationExecutionFilterValue": { 717 "base": null, 718 "refs": { 719 "AutomationExecutionFilterValueList$member": null 720 } 721 }, 722 "AutomationExecutionFilterValueList": { 723 "base": null, 724 "refs": { 725 "AutomationExecutionFilter$Values": "<p>The values used to limit the execution information associated with the filter's key.</p>" 726 } 727 }, 728 "AutomationExecutionId": { 729 "base": null, 730 "refs": { 731 "AutomationExecution$AutomationExecutionId": "<p>The execution ID.</p>", 732 "AutomationExecution$ParentAutomationExecutionId": "<p>The AutomationExecutionId of the parent automation.</p>", 733 "AutomationExecutionMetadata$AutomationExecutionId": "<p>The execution ID.</p>", 734 "AutomationExecutionMetadata$ParentAutomationExecutionId": "<p>The execution ID of the parent automation.</p>", 735 "DescribeAutomationStepExecutionsRequest$AutomationExecutionId": "<p>The Automation execution ID for which you want step execution descriptions.</p>", 736 "GetAutomationExecutionRequest$AutomationExecutionId": "<p>The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.</p>", 737 "SendAutomationSignalRequest$AutomationExecutionId": "<p>The unique identifier for an existing Automation execution that you want to send the signal to.</p>", 738 "StartAutomationExecutionResult$AutomationExecutionId": "<p>The unique ID of a newly scheduled automation execution.</p>", 739 "StartChangeRequestExecutionResult$AutomationExecutionId": "<p>The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.) </p>", 740 "StopAutomationExecutionRequest$AutomationExecutionId": "<p>The execution ID of the Automation to stop.</p>" 741 } 742 }, 743 "AutomationExecutionLimitExceededException": { 744 "base": "<p>The number of simultaneously running Automation executions exceeded the allowable limit.</p>", 745 "refs": { 746 } 747 }, 748 "AutomationExecutionMetadata": { 749 "base": "<p>Details about a specific Automation execution.</p>", 750 "refs": { 751 "AutomationExecutionMetadataList$member": null 752 } 753 }, 754 "AutomationExecutionMetadataList": { 755 "base": null, 756 "refs": { 757 "DescribeAutomationExecutionsResult$AutomationExecutionMetadataList": "<p>The list of details about each automation execution which has occurred which matches the filter specification, if any.</p>" 758 } 759 }, 760 "AutomationExecutionNotFoundException": { 761 "base": "<p>There is no automation execution information for the requested automation execution ID.</p>", 762 "refs": { 763 } 764 }, 765 "AutomationExecutionStatus": { 766 "base": null, 767 "refs": { 768 "AutomationExecution$AutomationExecutionStatus": "<p>The execution status of the Automation.</p>", 769 "AutomationExecutionMetadata$AutomationExecutionStatus": "<p>The status of the execution.</p>", 770 "StepExecution$StepStatus": "<p>The execution status for this step.</p>" 771 } 772 }, 773 "AutomationParameterKey": { 774 "base": null, 775 "refs": { 776 "AutomationExecution$TargetParameterName": "<p>The parameter name.</p>", 777 "AutomationExecutionMetadata$TargetParameterName": "<p>The list of execution outputs as defined in the Automation runbook.</p>", 778 "AutomationParameterMap$key": null, 779 "Runbook$TargetParameterName": "<p>The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify <code>Targets</code>. </p>", 780 "StartAutomationExecutionRequest$TargetParameterName": "<p>The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.</p>" 781 } 782 }, 783 "AutomationParameterMap": { 784 "base": null, 785 "refs": { 786 "AutomationExecution$Parameters": "<p>The key-value map of execution parameters, which were supplied when calling <a>StartAutomationExecution</a>.</p>", 787 "AutomationExecution$Outputs": "<p>The list of execution outputs as defined in the Automation runbook.</p>", 788 "AutomationExecutionMetadata$Outputs": "<p>The list of execution outputs as defined in the Automation runbook.</p>", 789 "FailureDetails$Details": "<p>Detailed information about the Automation step failure.</p>", 790 "MaintenanceWindowAutomationParameters$Parameters": "<p>The parameters for the <code>AUTOMATION</code> task.</p> <p>For information about specifying and updating task parameters, see <a>RegisterTaskWithMaintenanceWindow</a> and <a>UpdateMaintenanceWindowTask</a>.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p>For <code>AUTOMATION</code> task types, Amazon Web Services Systems Manager ignores any values specified for these parameters.</p> </note>", 791 "Runbook$Parameters": "<p>The key-value map of execution parameters, which were supplied when calling <code>StartChangeRequestExecution</code>.</p>", 792 "SendAutomationSignalRequest$Payload": "<p>The data sent with the signal. The data schema depends on the type of signal used in the request.</p> <p>For <code>Approve</code> and <code>Reject</code> signal types, the payload is an optional comment that you can send with the signal type. For example:</p> <p> <code>Comment=\"Looks good\"</code> </p> <p>For <code>StartStep</code> and <code>Resume</code> signal types, you must send the name of the Automation step to start or resume as the payload. For example:</p> <p> <code>StepName=\"step1\"</code> </p> <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the payload. For example:</p> <p> <code>StepExecutionId=\"97fff367-fc5a-4299-aed8-0123456789ab\"</code> </p>", 793 "StartAutomationExecutionRequest$Parameters": "<p>A key-value map of execution parameters, which match the declared parameters in the Automation runbook.</p>", 794 "StartChangeRequestExecutionRequest$Parameters": "<p>A key-value map of parameters that match the declared parameters in the change template document.</p>", 795 "StepExecution$Outputs": "<p>Returned values from the execution of the step.</p>", 796 "StepExecution$OverriddenParameters": "<p>A user-specified list of parameters to override when running a step.</p>" 797 } 798 }, 799 "AutomationParameterValue": { 800 "base": null, 801 "refs": { 802 "AutomationParameterValueList$member": null 803 } 804 }, 805 "AutomationParameterValueList": { 806 "base": null, 807 "refs": { 808 "AutomationParameterMap$value": null 809 } 810 }, 811 "AutomationStepNotFoundException": { 812 "base": "<p>The specified step name and execution ID don't exist. Verify the information and try again.</p>", 813 "refs": { 814 } 815 }, 816 "AutomationSubtype": { 817 "base": null, 818 "refs": { 819 "AutomationExecution$AutomationSubtype": "<p>The subtype of the Automation operation. Currently, the only supported value is <code>ChangeRequest</code>.</p>", 820 "AutomationExecutionMetadata$AutomationSubtype": "<p>The subtype of the Automation operation. Currently, the only supported value is <code>ChangeRequest</code>.</p>" 821 } 822 }, 823 "AutomationTargetParameterName": { 824 "base": null, 825 "refs": { 826 "AssociationDescription$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>", 827 "CreateAssociationBatchRequestEntry$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>", 828 "CreateAssociationRequest$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>", 829 "UpdateAssociationRequest$AutomationTargetParameterName": "<p>Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>" 830 } 831 }, 832 "AutomationType": { 833 "base": null, 834 "refs": { 835 "AutomationExecutionMetadata$AutomationType": "<p>Use this filter with <a>DescribeAutomationExecutions</a>. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html\">Running Automation workflows in multiple Amazon Web Services Regions and accounts</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>" 836 } 837 }, 838 "BaselineDescription": { 839 "base": null, 840 "refs": { 841 "CreatePatchBaselineRequest$Description": "<p>A description of the patch baseline.</p>", 842 "GetPatchBaselineResult$Description": "<p>A description of the patch baseline.</p>", 843 "PatchBaselineIdentity$BaselineDescription": "<p>The description of the patch baseline.</p>", 844 "UpdatePatchBaselineRequest$Description": "<p>A description of the patch baseline.</p>", 845 "UpdatePatchBaselineResult$Description": "<p>A description of the patch baseline.</p>" 846 } 847 }, 848 "BaselineId": { 849 "base": null, 850 "refs": { 851 "CreatePatchBaselineResult$BaselineId": "<p>The ID of the created patch baseline.</p>", 852 "DeletePatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to delete.</p>", 853 "DeletePatchBaselineResult$BaselineId": "<p>The ID of the deleted patch baseline.</p>", 854 "DeregisterPatchBaselineForPatchGroupRequest$BaselineId": "<p>The ID of the patch baseline to deregister the patch group from.</p>", 855 "DeregisterPatchBaselineForPatchGroupResult$BaselineId": "<p>The ID of the patch baseline the patch group was deregistered from.</p>", 856 "DescribeEffectivePatchesForPatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to retrieve the effective patches for.</p>", 857 "GetDefaultPatchBaselineResult$BaselineId": "<p>The ID of the default patch baseline.</p>", 858 "GetPatchBaselineForPatchGroupResult$BaselineId": "<p>The ID of the patch baseline that should be used for the patch group.</p>", 859 "GetPatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to retrieve.</p> <note> <p>To retrieve information about an Amazon Web Services managed patch baseline, specify the full Amazon Resource Name (ARN) of the baseline. For example, for the baseline <code>AWS-AmazonLinuxDefaultPatchBaseline</code>, specify <code>arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7</code> instead of <code>pb-0e392de35e7c563b7</code>.</p> </note>", 860 "GetPatchBaselineResult$BaselineId": "<p>The ID of the retrieved patch baseline.</p>", 861 "InstancePatchState$BaselineId": "<p>The ID of the patch baseline used to patch the instance.</p>", 862 "PatchBaselineIdentity$BaselineId": "<p>The ID of the patch baseline.</p>", 863 "RegisterDefaultPatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline that should be the default patch baseline.</p>", 864 "RegisterDefaultPatchBaselineResult$BaselineId": "<p>The ID of the default patch baseline.</p>", 865 "RegisterPatchBaselineForPatchGroupRequest$BaselineId": "<p>The ID of the patch baseline to register with the patch group.</p>", 866 "RegisterPatchBaselineForPatchGroupResult$BaselineId": "<p>The ID of the patch baseline the patch group was registered with.</p>", 867 "UpdatePatchBaselineRequest$BaselineId": "<p>The ID of the patch baseline to update.</p>", 868 "UpdatePatchBaselineResult$BaselineId": "<p>The ID of the deleted patch baseline.</p>" 869 } 870 }, 871 "BaselineName": { 872 "base": null, 873 "refs": { 874 "CreatePatchBaselineRequest$Name": "<p>The name of the patch baseline.</p>", 875 "GetPatchBaselineResult$Name": "<p>The name of the patch baseline.</p>", 876 "PatchBaselineIdentity$BaselineName": "<p>The name of the patch baseline.</p>", 877 "UpdatePatchBaselineRequest$Name": "<p>The name of the patch baseline.</p>", 878 "UpdatePatchBaselineResult$Name": "<p>The name of the patch baseline.</p>" 879 } 880 }, 881 "BaselineOverride": { 882 "base": "<p>Defines the basic information about a patch baseline override.</p>", 883 "refs": { 884 "GetDeployablePatchSnapshotForInstanceRequest$BaselineOverride": "<p>Defines the basic information about a patch baseline override.</p>" 885 } 886 }, 887 "BatchErrorMessage": { 888 "base": null, 889 "refs": { 890 "FailedCreateAssociation$Message": "<p>A description of the failure.</p>" 891 } 892 }, 893 "Boolean": { 894 "base": null, 895 "refs": { 896 "Activation$Expired": "<p>Whether or not the activation is expired.</p>", 897 "AutomationExecution$StepExecutionsTruncated": "<p>A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.</p>", 898 "BaselineOverride$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is <code>false</code>. Applies to Linux instances only.</p>", 899 "CreatePatchBaselineRequest$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is <code>false</code>. Applies to Linux instances only.</p>", 900 "DeleteDocumentRequest$Force": "<p>Some SSM document types require that you specify a <code>Force</code> flag before you can delete the document. For example, you must specify a <code>Force</code> flag to delete a document of type <code>ApplicationConfigurationSchema</code>. You can restrict access to the <code>Force</code> flag in an Identity and Access Management (IAM) policy.</p>", 901 "DeregisterTargetFromMaintenanceWindowRequest$Safe": "<p>The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.</p>", 902 "DescribeAutomationStepExecutionsRequest$ReverseOrder": "<p>Indicates whether to list step executions in reverse order by start time. The default value is 'false'.</p>", 903 "DocumentVersionInfo$IsDefaultVersion": "<p>An identifier for the default version of the document.</p>", 904 "GetParameterHistoryRequest$WithDecryption": "<p>Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p>", 905 "GetParameterRequest$WithDecryption": "<p>Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p>", 906 "GetParametersByPathRequest$Recursive": "<p>Retrieve all parameters within a hierarchy.</p> <important> <p>If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path <code>/a</code>, then the user can also access <code>/a/b</code>. Even if a user has explicitly been denied access in IAM for parameter <code>/a/b</code>, they can still call the GetParametersByPath API operation recursively for <code>/a</code> and view <code>/a/b</code>.</p> </important>", 907 "GetParametersByPathRequest$WithDecryption": "<p>Retrieve all parameters in a hierarchy with their value decrypted.</p>", 908 "GetParametersRequest$WithDecryption": "<p>Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for <code>String</code> and <code>StringList</code> parameter types.</p>", 909 "GetPatchBaselineResult$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is <code>false</code>. Applies to Linux instances only.</p>", 910 "InstanceInformation$IsLatestVersion": "<p>Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field doesn't indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.</p>", 911 "ListCommandInvocationsRequest$Details": "<p>(Optional) If set this returns the response of the command executions and any command output. The default value is <code>false</code>. </p>", 912 "PatchRule$EnableNonSecurity": "<p>For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is <code>false</code>. Applies to Linux instances only.</p>", 913 "PutParameterRequest$Overwrite": "<p>Overwrite an existing parameter. The default value is <code>false</code>.</p>", 914 "ResolvedTargets$Truncated": "<p>A boolean value indicating whether the resolved target list is truncated.</p>", 915 "StartChangeRequestExecutionRequest$AutoApprove": "<p>Indicates whether the change request can be approved automatically without the need for manual approvals.</p> <p>If <code>AutoApprovable</code> is enabled in a change template, then setting <code>AutoApprove</code> to <code>true</code> in <code>StartChangeRequestExecution</code> creates a change request that bypasses approver review.</p> <note> <p>Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is <code>CLOSED</code>, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again <code>OPEN</code>. </p> </note>", 916 "StepExecution$IsEnd": "<p>The flag which can be used to end automation no matter whether the step succeeds or fails.</p>", 917 "StepExecution$IsCritical": "<p>The flag which can be used to help decide whether the failure of current step leads to the Automation failure.</p>", 918 "UpdateMaintenanceWindowRequest$Replace": "<p>If <code>True</code>, then all fields that are required by the <a>CreateMaintenanceWindow</a> operation are also required for this API request. Optional fields that aren't specified are set to null. </p>", 919 "UpdateMaintenanceWindowTargetRequest$Replace": "<p>If <code>True</code>, then all fields that are required by the <a>RegisterTargetWithMaintenanceWindow</a> operation are also required for this API request. Optional fields that aren't specified are set to null.</p>", 920 "UpdateMaintenanceWindowTaskRequest$Replace": "<p>If True, then all fields that are required by the <a>RegisterTaskWithMaintenanceWindow</a> operation are also required for this API request. Optional fields that aren't specified are set to null.</p>", 921 "UpdatePatchBaselineRequest$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is <code>false</code>. Applies to Linux instances only.</p>", 922 "UpdatePatchBaselineRequest$Replace": "<p>If True, then all fields that are required by the <a>CreatePatchBaseline</a> operation are also required for this API request. Optional fields that aren't specified are set to null.</p>", 923 "UpdatePatchBaselineResult$ApprovedPatchesEnableNonSecurity": "<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is <code>false</code>. Applies to Linux instances only.</p>" 924 } 925 }, 926 "CalendarNameOrARN": { 927 "base": null, 928 "refs": { 929 "CalendarNameOrARNList$member": null 930 } 931 }, 932 "CalendarNameOrARNList": { 933 "base": null, 934 "refs": { 935 "AssociationDescription$CalendarNames": "<p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar\">Amazon Web Services Systems Manager Change Calendar</a>.</p>", 936 "AssociationVersionInfo$CalendarNames": "<p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar\">Amazon Web Services Systems Manager Change Calendar</a>.</p>", 937 "CreateAssociationBatchRequestEntry$CalendarNames": "<p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar\">Amazon Web Services Systems Manager Change Calendar</a>.</p>", 938 "CreateAssociationRequest$CalendarNames": "<p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar\">Amazon Web Services Systems Manager Change Calendar</a>.</p>", 939 "GetCalendarStateRequest$CalendarNames": "<p>The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.</p>", 940 "UpdateAssociationRequest$CalendarNames": "<p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar\">Amazon Web Services Systems Manager Change Calendar</a>.</p>" 941 } 942 }, 943 "CalendarState": { 944 "base": null, 945 "refs": { 946 "GetCalendarStateResponse$State": "<p>The state of the calendar. An <code>OPEN</code> calendar indicates that actions are allowed to proceed, and a <code>CLOSED</code> calendar indicates that actions aren't allowed to proceed.</p>" 947 } 948 }, 949 "CancelCommandRequest": { 950 "base": "<p/>", 951 "refs": { 952 } 953 }, 954 "CancelCommandResult": { 955 "base": "<p>Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.</p>", 956 "refs": { 957 } 958 }, 959 "CancelMaintenanceWindowExecutionRequest": { 960 "base": null, 961 "refs": { 962 } 963 }, 964 "CancelMaintenanceWindowExecutionResult": { 965 "base": null, 966 "refs": { 967 } 968 }, 969 "ChangeDetailsValue": { 970 "base": null, 971 "refs": { 972 "StartChangeRequestExecutionRequest$ChangeDetails": "<p>User-provided details about the change. If no details are provided, content specified in the <b>Template information</b> section of the associated change template is added.</p>" 973 } 974 }, 975 "ChangeRequestName": { 976 "base": null, 977 "refs": { 978 "AutomationExecution$ChangeRequestName": "<p>The name of the Change Manager change request.</p>", 979 "AutomationExecutionMetadata$ChangeRequestName": "<p>The name of the Change Manager change request.</p>", 980 "StartChangeRequestExecutionRequest$ChangeRequestName": "<p>The name of the change request associated with the runbook workflow to be run.</p>" 981 } 982 }, 983 "ClientToken": { 984 "base": null, 985 "refs": { 986 "CreateMaintenanceWindowRequest$ClientToken": "<p>User-provided idempotency token.</p>", 987 "CreatePatchBaselineRequest$ClientToken": "<p>User-provided idempotency token.</p>", 988 "RegisterTargetWithMaintenanceWindowRequest$ClientToken": "<p>User-provided idempotency token.</p>", 989 "RegisterTaskWithMaintenanceWindowRequest$ClientToken": "<p>User-provided idempotency token.</p>" 990 } 991 }, 992 "CloudWatchLogGroupName": { 993 "base": null, 994 "refs": { 995 "CloudWatchOutputConfig$CloudWatchLogGroupName": "<p>The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, Amazon Web Services Systems Manager automatically creates a log group for you. The log group uses the following naming format:</p> <p> <code>aws/ssm/<i>SystemsManagerDocumentName</i> </code> </p>" 996 } 997 }, 998 "CloudWatchOutputConfig": { 999 "base": "<p>Configuration options for sending command output to Amazon CloudWatch Logs.</p>", 1000 "refs": { 1001 "Command$CloudWatchOutputConfig": "<p>Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.</p>", 1002 "CommandInvocation$CloudWatchOutputConfig": "<p>Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.</p>", 1003 "GetCommandInvocationResult$CloudWatchOutputConfig": "<p>Amazon CloudWatch Logs information where Systems Manager sent the command output.</p>", 1004 "MaintenanceWindowRunCommandParameters$CloudWatchOutputConfig": null, 1005 "SendCommandRequest$CloudWatchOutputConfig": "<p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.</p>" 1006 } 1007 }, 1008 "CloudWatchOutputEnabled": { 1009 "base": null, 1010 "refs": { 1011 "CloudWatchOutputConfig$CloudWatchOutputEnabled": "<p>Enables Systems Manager to send command output to CloudWatch Logs.</p>" 1012 } 1013 }, 1014 "Command": { 1015 "base": "<p>Describes a command request.</p>", 1016 "refs": { 1017 "CommandList$member": null, 1018 "SendCommandResult$Command": "<p>The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.</p>" 1019 } 1020 }, 1021 "CommandFilter": { 1022 "base": "<p>Describes a command filter.</p> <note> <p>An instance ID can't be specified when a command status is <code>Pending</code> because the command hasn't run on the instance yet.</p> </note>", 1023 "refs": { 1024 "CommandFilterList$member": null 1025 } 1026 }, 1027 "CommandFilterKey": { 1028 "base": null, 1029 "refs": { 1030 "CommandFilter$key": "<p>The name of the filter.</p>" 1031 } 1032 }, 1033 "CommandFilterList": { 1034 "base": null, 1035 "refs": { 1036 "ListCommandInvocationsRequest$Filters": "<p>(Optional) One or more filters. Use a filter to return a more specific list of results.</p>", 1037 "ListCommandsRequest$Filters": "<p>(Optional) One or more filters. Use a filter to return a more specific list of results. </p>" 1038 } 1039 }, 1040 "CommandFilterValue": { 1041 "base": null, 1042 "refs": { 1043 "CommandFilter$value": "<p>The filter value. Valid values for each filter key are as follows:</p> <ul> <li> <p> <b>InvokedAfter</b>: Specify a timestamp to limit your results. For example, specify <code>2021-07-07T00:00:00Z</code> to see a list of command executions occurring July 7, 2021, and later.</p> </li> <li> <p> <b>InvokedBefore</b>: Specify a timestamp to limit your results. For example, specify <code>2021-07-07T00:00:00Z</code> to see a list of command executions from before July 7, 2021.</p> </li> <li> <p> <b>Status</b>: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.</p> <p>The status values you can specify for <code>ListCommands</code> are:</p> <ul> <li> <p> <code>Pending</code> </p> </li> <li> <p> <code>InProgress</code> </p> </li> <li> <p> <code>Success</code> </p> </li> <li> <p> <code>Cancelled</code> </p> </li> <li> <p> <code>Failed</code> </p> </li> <li> <p> <code>TimedOut</code> (this includes both Delivery and Execution time outs) </p> </li> <li> <p> <code>AccessDenied</code> </p> </li> <li> <p> <code>DeliveryTimedOut</code> </p> </li> <li> <p> <code>ExecutionTimedOut</code> </p> </li> <li> <p> <code>Incomplete</code> </p> </li> <li> <p> <code>NoInstancesInTag</code> </p> </li> <li> <p> <code>LimitExceeded</code> </p> </li> </ul> <p>The status values you can specify for <code>ListCommandInvocations</code> are:</p> <ul> <li> <p> <code>Pending</code> </p> </li> <li> <p> <code>InProgress</code> </p> </li> <li> <p> <code>Delayed</code> </p> </li> <li> <p> <code>Success</code> </p> </li> <li> <p> <code>Cancelled</code> </p> </li> <li> <p> <code>Failed</code> </p> </li> <li> <p> <code>TimedOut</code> (this includes both Delivery and Execution time outs) </p> </li> <li> <p> <code>AccessDenied</code> </p> </li> <li> <p> <code>DeliveryTimedOut</code> </p> </li> <li> <p> <code>ExecutionTimedOut</code> </p> </li> <li> <p> <code>Undeliverable</code> </p> </li> <li> <p> <code>InvalidPlatform</code> </p> </li> <li> <p> <code>Terminated</code> </p> </li> </ul> </li> <li> <p> <b>DocumentName</b>: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify <code>AWS-RunPatchBaseline</code> to see command executions that used this SSM document to perform security patching operations on instances. </p> </li> <li> <p> <b>ExecutionStage</b>: Specify one of the following values:</p> <ul> <li> <p> <code>Executing</code>: Returns a list of command executions that are currently still running.</p> </li> <li> <p> <code>Complete</code>: Returns a list of command executions that have already completed. </p> </li> </ul> </li> </ul>" 1044 } 1045 }, 1046 "CommandId": { 1047 "base": null, 1048 "refs": { 1049 "CancelCommandRequest$CommandId": "<p>The ID of the command you want to cancel.</p>", 1050 "Command$CommandId": "<p>A unique identifier for this command.</p>", 1051 "CommandInvocation$CommandId": "<p>The command against which this invocation was requested.</p>", 1052 "GetCommandInvocationRequest$CommandId": "<p>(Required) The parent command ID of the invocation plugin.</p>", 1053 "GetCommandInvocationResult$CommandId": "<p>The parent command ID of the invocation plugin.</p>", 1054 "ListCommandInvocationsRequest$CommandId": "<p>(Optional) The invocations for a specific command ID.</p>", 1055 "ListCommandsRequest$CommandId": "<p>(Optional) If provided, lists only the specified command.</p>" 1056 } 1057 }, 1058 "CommandInvocation": { 1059 "base": "<p>An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you ran. </p>", 1060 "refs": { 1061 "CommandInvocationList$member": null 1062 } 1063 }, 1064 "CommandInvocationList": { 1065 "base": null, 1066 "refs": { 1067 "ListCommandInvocationsResult$CommandInvocations": "<p>(Optional) A list of all invocations. </p>" 1068 } 1069 }, 1070 "CommandInvocationStatus": { 1071 "base": null, 1072 "refs": { 1073 "CommandInvocation$Status": "<p>Whether or not the invocation succeeded, failed, or is pending.</p>", 1074 "GetCommandInvocationResult$Status": "<p>The status of this invocation plugin. This status can be different than <code>StatusDetails</code>.</p>" 1075 } 1076 }, 1077 "CommandList": { 1078 "base": null, 1079 "refs": { 1080 "ListCommandsResult$Commands": "<p>(Optional) The list of commands requested by the user. </p>" 1081 } 1082 }, 1083 "CommandMaxResults": { 1084 "base": null, 1085 "refs": { 1086 "ListCommandInvocationsRequest$MaxResults": "<p>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 1087 "ListCommandsRequest$MaxResults": "<p>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 1088 } 1089 }, 1090 "CommandPlugin": { 1091 "base": "<p>Describes plugin details.</p>", 1092 "refs": { 1093 "CommandPluginList$member": null 1094 } 1095 }, 1096 "CommandPluginList": { 1097 "base": null, 1098 "refs": { 1099 "CommandInvocation$CommandPlugins": "<p>Plugins processed by the command.</p>" 1100 } 1101 }, 1102 "CommandPluginName": { 1103 "base": null, 1104 "refs": { 1105 "CommandPlugin$Name": "<p>The name of the plugin. Must be one of the following: <code>aws:updateAgent</code>, <code>aws:domainjoin</code>, <code>aws:applications</code>, <code>aws:runPowerShellScript</code>, <code>aws:psmodule</code>, <code>aws:cloudWatch</code>, <code>aws:runShellScript</code>, or <code>aws:updateSSMAgent</code>. </p>", 1106 "GetCommandInvocationRequest$PluginName": "<p>The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.</p> <p>Plugin names are also referred to as <i>step names</i> in Systems Manager documents (SSM documents). For example, <code>aws:RunShellScript</code> is a plugin.</p> <p>To find the <code>PluginName</code>, check the document content and find the name of the plugin. Alternatively, use <a>ListCommandInvocations</a> with the <code>CommandId</code> and <code>Details</code> parameters. The <code>PluginName</code> is the <code>Name</code> attribute of the <code>CommandPlugin</code> object in the <code>CommandPlugins</code> list.</p>", 1107 "GetCommandInvocationResult$PluginName": "<p>The name of the plugin, or <i>step name</i>, for which details are reported. For example, <code>aws:RunShellScript</code> is a plugin.</p>" 1108 } 1109 }, 1110 "CommandPluginOutput": { 1111 "base": null, 1112 "refs": { 1113 "CommandPlugin$Output": "<p>Output of the plugin execution.</p>" 1114 } 1115 }, 1116 "CommandPluginStatus": { 1117 "base": null, 1118 "refs": { 1119 "CommandPlugin$Status": "<p>The status of this plugin. You can run a document with multiple plugins.</p>" 1120 } 1121 }, 1122 "CommandStatus": { 1123 "base": null, 1124 "refs": { 1125 "Command$Status": "<p>The status of the command.</p>" 1126 } 1127 }, 1128 "Comment": { 1129 "base": null, 1130 "refs": { 1131 "Command$Comment": "<p>User-specified information about the command, such as a brief description of what the command should do.</p>", 1132 "CommandInvocation$Comment": "<p>User-specified information about the command, such as a brief description of what the command should do.</p>", 1133 "GetCommandInvocationResult$Comment": "<p>The comment text for the command.</p>", 1134 "MaintenanceWindowRunCommandParameters$Comment": "<p>Information about the commands to run.</p>", 1135 "SendCommandRequest$Comment": "<p>User-specified information about the command, such as a brief description of what the command should do.</p>" 1136 } 1137 }, 1138 "CompletedCount": { 1139 "base": null, 1140 "refs": { 1141 "Command$CompletedCount": "<p>The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.</p>" 1142 } 1143 }, 1144 "ComplianceExecutionId": { 1145 "base": null, 1146 "refs": { 1147 "ComplianceExecutionSummary$ExecutionId": "<p>An ID created by the system when <code>PutComplianceItems</code> was called. For example, <code>CommandID</code> is a valid execution ID. You can use this ID in subsequent calls.</p>" 1148 } 1149 }, 1150 "ComplianceExecutionSummary": { 1151 "base": "<p>A summary of the call execution that includes an execution ID, the type of execution (for example, <code>Command</code>), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.</p>", 1152 "refs": { 1153 "ComplianceItem$ExecutionSummary": "<p>A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.</p>", 1154 "PutComplianceItemsRequest$ExecutionSummary": "<p>A summary of the call execution that includes an execution ID, the type of execution (for example, <code>Command</code>), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.</p>", 1155 "ResourceComplianceSummaryItem$ExecutionSummary": "<p>Information about the execution.</p>" 1156 } 1157 }, 1158 "ComplianceExecutionType": { 1159 "base": null, 1160 "refs": { 1161 "ComplianceExecutionSummary$ExecutionType": "<p>The type of execution. For example, <code>Command</code> is a valid execution type.</p>" 1162 } 1163 }, 1164 "ComplianceFilterValue": { 1165 "base": null, 1166 "refs": { 1167 "ComplianceStringFilterValueList$member": null 1168 } 1169 }, 1170 "ComplianceItem": { 1171 "base": "<p>Information about the compliance as defined by the resource type. For example, for a patch resource type, <code>Items</code> includes information about the PatchSeverity, Classification, and so on.</p>", 1172 "refs": { 1173 "ComplianceItemList$member": null 1174 } 1175 }, 1176 "ComplianceItemContentHash": { 1177 "base": null, 1178 "refs": { 1179 "PutComplianceItemsRequest$ItemContentHash": "<p>MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.</p>" 1180 } 1181 }, 1182 "ComplianceItemDetails": { 1183 "base": null, 1184 "refs": { 1185 "ComplianceItem$Details": "<p>A \"Key\": \"Value\" tag combination for the compliance item.</p>", 1186 "ComplianceItemEntry$Details": "<p>A \"Key\": \"Value\" tag combination for the compliance item.</p>" 1187 } 1188 }, 1189 "ComplianceItemEntry": { 1190 "base": "<p>Information about a compliance item.</p>", 1191 "refs": { 1192 "ComplianceItemEntryList$member": null 1193 } 1194 }, 1195 "ComplianceItemEntryList": { 1196 "base": null, 1197 "refs": { 1198 "PutComplianceItemsRequest$Items": "<p>Information about the compliance as defined by the resource type. For example, for a patch compliance type, <code>Items</code> includes information about the PatchSeverity, Classification, and so on.</p>" 1199 } 1200 }, 1201 "ComplianceItemId": { 1202 "base": null, 1203 "refs": { 1204 "ComplianceItem$Id": "<p>An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.</p>", 1205 "ComplianceItemEntry$Id": "<p>The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.</p>" 1206 } 1207 }, 1208 "ComplianceItemList": { 1209 "base": null, 1210 "refs": { 1211 "ListComplianceItemsResult$ComplianceItems": "<p>A list of compliance information for the specified resource ID. </p>" 1212 } 1213 }, 1214 "ComplianceItemTitle": { 1215 "base": null, 1216 "refs": { 1217 "ComplianceItem$Title": "<p>A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.</p>", 1218 "ComplianceItemEntry$Title": "<p>The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services. </p>" 1219 } 1220 }, 1221 "ComplianceQueryOperatorType": { 1222 "base": null, 1223 "refs": { 1224 "ComplianceStringFilter$Type": "<p>The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.</p>" 1225 } 1226 }, 1227 "ComplianceResourceId": { 1228 "base": null, 1229 "refs": { 1230 "ComplianceItem$ResourceId": "<p>An ID for the resource. For a managed instance, this is the instance ID.</p>", 1231 "ComplianceResourceIdList$member": null, 1232 "PutComplianceItemsRequest$ResourceId": "<p>Specify an ID for this resource. For a managed instance, this is the instance ID.</p>", 1233 "ResourceComplianceSummaryItem$ResourceId": "<p>The resource ID.</p>" 1234 } 1235 }, 1236 "ComplianceResourceIdList": { 1237 "base": null, 1238 "refs": { 1239 "ListComplianceItemsRequest$ResourceIds": "<p>The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.</p>" 1240 } 1241 }, 1242 "ComplianceResourceType": { 1243 "base": null, 1244 "refs": { 1245 "ComplianceItem$ResourceType": "<p>The type of resource. <code>ManagedInstance</code> is currently the only supported resource type.</p>", 1246 "ComplianceResourceTypeList$member": null, 1247 "PutComplianceItemsRequest$ResourceType": "<p>Specify the type of resource. <code>ManagedInstance</code> is currently the only supported resource type.</p>", 1248 "ResourceComplianceSummaryItem$ResourceType": "<p>The resource type.</p>" 1249 } 1250 }, 1251 "ComplianceResourceTypeList": { 1252 "base": null, 1253 "refs": { 1254 "ListComplianceItemsRequest$ResourceTypes": "<p>The type of resource from which to get compliance information. Currently, the only supported resource type is <code>ManagedInstance</code>.</p>" 1255 } 1256 }, 1257 "ComplianceSeverity": { 1258 "base": null, 1259 "refs": { 1260 "ComplianceItem$Severity": "<p>The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.</p>", 1261 "ComplianceItemEntry$Severity": "<p>The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.</p>", 1262 "ResourceComplianceSummaryItem$OverallSeverity": "<p>The highest severity item found for the resource. The resource is compliant for this item.</p>" 1263 } 1264 }, 1265 "ComplianceStatus": { 1266 "base": null, 1267 "refs": { 1268 "ComplianceItem$Status": "<p>The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).</p>", 1269 "ComplianceItemEntry$Status": "<p>The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.</p>", 1270 "ResourceComplianceSummaryItem$Status": "<p>The compliance status for the resource.</p>" 1271 } 1272 }, 1273 "ComplianceStringFilter": { 1274 "base": "<p>One or more filters. Use a filter to return a more specific list of results.</p>", 1275 "refs": { 1276 "ComplianceStringFilterList$member": null 1277 } 1278 }, 1279 "ComplianceStringFilterKey": { 1280 "base": null, 1281 "refs": { 1282 "ComplianceStringFilter$Key": "<p>The name of the filter.</p>" 1283 } 1284 }, 1285 "ComplianceStringFilterList": { 1286 "base": null, 1287 "refs": { 1288 "ListComplianceItemsRequest$Filters": "<p>One or more compliance filters. Use a filter to return a more specific list of results.</p>", 1289 "ListComplianceSummariesRequest$Filters": "<p>One or more compliance or inventory filters. Use a filter to return a more specific list of results.</p>", 1290 "ListResourceComplianceSummariesRequest$Filters": "<p>One or more filters. Use a filter to return a more specific list of results.</p>" 1291 } 1292 }, 1293 "ComplianceStringFilterValueList": { 1294 "base": null, 1295 "refs": { 1296 "ComplianceStringFilter$Values": "<p>The value for which to search.</p>" 1297 } 1298 }, 1299 "ComplianceSummaryCount": { 1300 "base": null, 1301 "refs": { 1302 "CompliantSummary$CompliantCount": "<p>The total number of resources that are compliant.</p>", 1303 "NonCompliantSummary$NonCompliantCount": "<p>The total number of compliance items that aren't compliant.</p>", 1304 "SeveritySummary$CriticalCount": "<p>The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.</p>", 1305 "SeveritySummary$HighCount": "<p>The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.</p>", 1306 "SeveritySummary$MediumCount": "<p>The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.</p>", 1307 "SeveritySummary$LowCount": "<p>The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.</p>", 1308 "SeveritySummary$InformationalCount": "<p>The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.</p>", 1309 "SeveritySummary$UnspecifiedCount": "<p>The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.</p>" 1310 } 1311 }, 1312 "ComplianceSummaryItem": { 1313 "base": "<p>A summary of compliance information by compliance type.</p>", 1314 "refs": { 1315 "ComplianceSummaryItemList$member": null 1316 } 1317 }, 1318 "ComplianceSummaryItemList": { 1319 "base": null, 1320 "refs": { 1321 "ListComplianceSummariesResult$ComplianceSummaryItems": "<p>A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.</p>" 1322 } 1323 }, 1324 "ComplianceTypeCountLimitExceededException": { 1325 "base": "<p>You specified too many custom compliance types. You can specify a maximum of 10 different types. </p>", 1326 "refs": { 1327 } 1328 }, 1329 "ComplianceTypeName": { 1330 "base": null, 1331 "refs": { 1332 "ComplianceItem$ComplianceType": "<p>The compliance type. For example, Association (for a State Manager association), Patch, or Custom:<code>string</code> are all valid compliance types.</p>", 1333 "ComplianceSummaryItem$ComplianceType": "<p>The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.</p>", 1334 "PutComplianceItemsRequest$ComplianceType": "<p>Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:<code>string</code>.</p>", 1335 "ResourceComplianceSummaryItem$ComplianceType": "<p>The compliance type.</p>" 1336 } 1337 }, 1338 "ComplianceUploadType": { 1339 "base": null, 1340 "refs": { 1341 "PutComplianceItemsRequest$UploadType": "<p>The mode for uploading compliance items. You can specify <code>COMPLETE</code> or <code>PARTIAL</code>. In <code>COMPLETE</code> mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.</p> <p>In <code>PARTIAL</code> mode, the system overwrites compliance information for a specific association. The association must be configured with <code>SyncCompliance</code> set to <code>MANUAL</code>. By default, all requests use <code>COMPLETE</code> mode.</p> <note> <p>This attribute is only valid for association compliance.</p> </note>" 1342 } 1343 }, 1344 "CompliantSummary": { 1345 "base": "<p>A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.</p>", 1346 "refs": { 1347 "ComplianceSummaryItem$CompliantSummary": "<p>A list of COMPLIANT items for the specified compliance type.</p>", 1348 "ResourceComplianceSummaryItem$CompliantSummary": "<p>A list of items that are compliant for the resource.</p>" 1349 } 1350 }, 1351 "ComputerName": { 1352 "base": null, 1353 "refs": { 1354 "InstanceInformation$ComputerName": "<p>The fully qualified host name of the managed instance.</p>" 1355 } 1356 }, 1357 "ConnectionStatus": { 1358 "base": null, 1359 "refs": { 1360 "GetConnectionStatusResponse$Status": "<p>The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.</p>" 1361 } 1362 }, 1363 "ContentLength": { 1364 "base": null, 1365 "refs": { 1366 "AttachmentContent$Size": "<p>The size of an attachment in bytes.</p>" 1367 } 1368 }, 1369 "CreateActivationRequest": { 1370 "base": null, 1371 "refs": { 1372 } 1373 }, 1374 "CreateActivationResult": { 1375 "base": null, 1376 "refs": { 1377 } 1378 }, 1379 "CreateAssociationBatchRequest": { 1380 "base": null, 1381 "refs": { 1382 } 1383 }, 1384 "CreateAssociationBatchRequestEntries": { 1385 "base": null, 1386 "refs": { 1387 "CreateAssociationBatchRequest$Entries": "<p>One or more associations.</p>" 1388 } 1389 }, 1390 "CreateAssociationBatchRequestEntry": { 1391 "base": "<p>Describes the association of a Amazon Web Services Systems Manager document (SSM document) and an instance.</p>", 1392 "refs": { 1393 "CreateAssociationBatchRequestEntries$member": null, 1394 "FailedCreateAssociation$Entry": "<p>The association.</p>" 1395 } 1396 }, 1397 "CreateAssociationBatchResult": { 1398 "base": null, 1399 "refs": { 1400 } 1401 }, 1402 "CreateAssociationRequest": { 1403 "base": null, 1404 "refs": { 1405 } 1406 }, 1407 "CreateAssociationResult": { 1408 "base": null, 1409 "refs": { 1410 } 1411 }, 1412 "CreateDocumentRequest": { 1413 "base": null, 1414 "refs": { 1415 } 1416 }, 1417 "CreateDocumentResult": { 1418 "base": null, 1419 "refs": { 1420 } 1421 }, 1422 "CreateMaintenanceWindowRequest": { 1423 "base": null, 1424 "refs": { 1425 } 1426 }, 1427 "CreateMaintenanceWindowResult": { 1428 "base": null, 1429 "refs": { 1430 } 1431 }, 1432 "CreateOpsItemRequest": { 1433 "base": null, 1434 "refs": { 1435 } 1436 }, 1437 "CreateOpsItemResponse": { 1438 "base": null, 1439 "refs": { 1440 } 1441 }, 1442 "CreateOpsMetadataRequest": { 1443 "base": null, 1444 "refs": { 1445 } 1446 }, 1447 "CreateOpsMetadataResult": { 1448 "base": null, 1449 "refs": { 1450 } 1451 }, 1452 "CreatePatchBaselineRequest": { 1453 "base": null, 1454 "refs": { 1455 } 1456 }, 1457 "CreatePatchBaselineResult": { 1458 "base": null, 1459 "refs": { 1460 } 1461 }, 1462 "CreateResourceDataSyncRequest": { 1463 "base": null, 1464 "refs": { 1465 } 1466 }, 1467 "CreateResourceDataSyncResult": { 1468 "base": null, 1469 "refs": { 1470 } 1471 }, 1472 "CreatedDate": { 1473 "base": null, 1474 "refs": { 1475 "Activation$CreatedDate": "<p>The date the activation was created.</p>" 1476 } 1477 }, 1478 "CustomSchemaCountLimitExceededException": { 1479 "base": "<p>You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.</p>", 1480 "refs": { 1481 } 1482 }, 1483 "DateTime": { 1484 "base": null, 1485 "refs": { 1486 "Association$LastExecutionDate": "<p>The date on which the association was last run.</p>", 1487 "AssociationDescription$Date": "<p>The date when the association was made.</p>", 1488 "AssociationDescription$LastUpdateAssociationDate": "<p>The date when the association was last updated.</p>", 1489 "AssociationDescription$LastExecutionDate": "<p>The date on which the association was last run.</p>", 1490 "AssociationDescription$LastSuccessfulExecutionDate": "<p>The last date on which the association was successfully run.</p>", 1491 "AssociationExecution$CreatedTime": "<p>The time the execution started.</p>", 1492 "AssociationExecution$LastExecutionDate": "<p>The date of the last execution.</p>", 1493 "AssociationExecutionTarget$LastExecutionDate": "<p>The date of the last execution.</p>", 1494 "AssociationStatus$Date": "<p>The date when the status changed.</p>", 1495 "AssociationVersionInfo$CreatedDate": "<p>The date the association version was created.</p>", 1496 "AutomationExecution$ExecutionStartTime": "<p>The time the execution started.</p>", 1497 "AutomationExecution$ExecutionEndTime": "<p>The time the execution finished.</p>", 1498 "AutomationExecution$ScheduledTime": "<p>The date and time the Automation operation is scheduled to start.</p>", 1499 "AutomationExecutionMetadata$ExecutionStartTime": "<p>The time the execution started.</p>", 1500 "AutomationExecutionMetadata$ExecutionEndTime": "<p>The time the execution finished. This isn't populated if the execution is still in progress.</p>", 1501 "AutomationExecutionMetadata$ScheduledTime": "<p>The date and time the Automation operation is scheduled to start.</p>", 1502 "Command$ExpiresAfter": "<p>If this time is reached and the command hasn't already started running, it won't run. Calculated based on the <code>ExpiresAfter</code> user input provided as part of the <code>SendCommand</code> API operation.</p>", 1503 "Command$RequestedDateTime": "<p>The date and time the command was requested.</p>", 1504 "CommandInvocation$RequestedDateTime": "<p>The time and date the request was sent to this instance.</p>", 1505 "CommandPlugin$ResponseStartDateTime": "<p>The time the plugin started running. </p>", 1506 "CommandPlugin$ResponseFinishDateTime": "<p>The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent. </p>", 1507 "ComplianceExecutionSummary$ExecutionTime": "<p>The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.</p>", 1508 "CreateOpsItemRequest$ActualStartTime": "<p>The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1509 "CreateOpsItemRequest$ActualEndTime": "<p>The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1510 "CreateOpsItemRequest$PlannedStartTime": "<p>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1511 "CreateOpsItemRequest$PlannedEndTime": "<p>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1512 "DocumentDescription$CreatedDate": "<p>The date when the document was created.</p>", 1513 "DocumentIdentifier$CreatedDate": "<p>The date the SSM document was created.</p>", 1514 "DocumentReviewerResponseSource$CreateTime": "<p>The date and time that a reviewer entered a response to a document review request.</p>", 1515 "DocumentReviewerResponseSource$UpdatedTime": "<p>The date and time that a reviewer last updated a response to a document review request.</p>", 1516 "DocumentVersionInfo$CreatedDate": "<p>The date the document was created.</p>", 1517 "GetDocumentResult$CreatedDate": "<p>The date the SSM document was created.</p>", 1518 "GetMaintenanceWindowExecutionResult$StartTime": "<p>The time the maintenance window started running.</p>", 1519 "GetMaintenanceWindowExecutionResult$EndTime": "<p>The time the maintenance window finished running.</p>", 1520 "GetMaintenanceWindowExecutionTaskInvocationResult$StartTime": "<p>The time that the task started running on the target.</p>", 1521 "GetMaintenanceWindowExecutionTaskInvocationResult$EndTime": "<p>The time that the task finished running on the target.</p>", 1522 "GetMaintenanceWindowExecutionTaskResult$StartTime": "<p>The time the task execution started.</p>", 1523 "GetMaintenanceWindowExecutionTaskResult$EndTime": "<p>The time the task execution completed.</p>", 1524 "GetMaintenanceWindowResult$CreatedDate": "<p>The date the maintenance window was created.</p>", 1525 "GetMaintenanceWindowResult$ModifiedDate": "<p>The date the maintenance window was last modified.</p>", 1526 "GetPatchBaselineResult$CreatedDate": "<p>The date the patch baseline was created.</p>", 1527 "GetPatchBaselineResult$ModifiedDate": "<p>The date the patch baseline was last modified.</p>", 1528 "InstanceAssociationStatusInfo$ExecutionDate": "<p>The date the instance association ran. </p>", 1529 "InstanceInformation$LastPingDateTime": "<p>The date and time when the agent last pinged the Systems Manager service. </p>", 1530 "InstanceInformation$RegistrationDate": "<p>The date the server or VM was registered with Amazon Web Services as a managed instance.</p>", 1531 "InstanceInformation$LastAssociationExecutionDate": "<p>The date the association was last run.</p>", 1532 "InstanceInformation$LastSuccessfulAssociationExecutionDate": "<p>The last date the association was successfully run.</p>", 1533 "InstancePatchState$OperationStartTime": "<p>The time the most recent patching operation was started on the instance.</p>", 1534 "InstancePatchState$OperationEndTime": "<p>The time the most recent patching operation completed on the instance.</p>", 1535 "InstancePatchState$LastNoRebootInstallOperationTime": "<p>The time of the last attempt to patch the instance with <code>NoReboot</code> specified as the reboot option.</p>", 1536 "MaintenanceWindowExecution$StartTime": "<p>The time the execution started.</p>", 1537 "MaintenanceWindowExecution$EndTime": "<p>The time the execution finished.</p>", 1538 "MaintenanceWindowExecutionTaskIdentity$StartTime": "<p>The time the task execution started.</p>", 1539 "MaintenanceWindowExecutionTaskIdentity$EndTime": "<p>The time the task execution finished.</p>", 1540 "MaintenanceWindowExecutionTaskInvocationIdentity$StartTime": "<p>The time the invocation started.</p>", 1541 "MaintenanceWindowExecutionTaskInvocationIdentity$EndTime": "<p>The time the invocation finished.</p>", 1542 "OpsItem$CreatedTime": "<p>The date and time the OpsItem was created.</p>", 1543 "OpsItem$LastModifiedTime": "<p>The date and time the OpsItem was last updated.</p>", 1544 "OpsItem$ActualStartTime": "<p>The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1545 "OpsItem$ActualEndTime": "<p>The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1546 "OpsItem$PlannedStartTime": "<p>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1547 "OpsItem$PlannedEndTime": "<p>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1548 "OpsItemEventSummary$CreatedTime": "<p>The date and time the OpsItem event was created.</p>", 1549 "OpsItemRelatedItemSummary$CreatedTime": "<p>The time the related-item association was created.</p>", 1550 "OpsItemRelatedItemSummary$LastModifiedTime": "<p>The time the related-item association was last updated.</p>", 1551 "OpsItemSummary$CreatedTime": "<p>The date and time the OpsItem was created.</p>", 1552 "OpsItemSummary$LastModifiedTime": "<p>The date and time the OpsItem was last updated.</p>", 1553 "OpsItemSummary$ActualStartTime": "<p>The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1554 "OpsItemSummary$ActualEndTime": "<p>The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1555 "OpsItemSummary$PlannedStartTime": "<p>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1556 "OpsItemSummary$PlannedEndTime": "<p>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1557 "OpsMetadata$LastModifiedDate": "<p>The date the OpsMetadata object was last updated.</p>", 1558 "OpsMetadata$CreationDate": "<p>The date the OpsMetadata objects was created.</p>", 1559 "Parameter$LastModifiedDate": "<p>Date the parameter was last changed or updated and the parameter version was created.</p>", 1560 "ParameterHistory$LastModifiedDate": "<p>Date the parameter was last changed or updated.</p>", 1561 "ParameterMetadata$LastModifiedDate": "<p>Date the parameter was last changed or updated.</p>", 1562 "Patch$ReleaseDate": "<p>The date the patch was released.</p>", 1563 "PatchComplianceData$InstalledTime": "<p>The date/time the patch was installed on the instance. Not all operating systems provide this level of information.</p>", 1564 "PatchStatus$ApprovalDate": "<p>The date the patch was approved (or will be approved if the status is <code>PENDING_APPROVAL</code>).</p>", 1565 "ReviewInformation$ReviewedTime": "<p>The time that the reviewer took action on the document review request.</p>", 1566 "ServiceSetting$LastModifiedDate": "<p>The last time the service setting was modified.</p>", 1567 "Session$StartDate": "<p>The date and time, in ISO-8601 Extended format, when the session began.</p>", 1568 "Session$EndDate": "<p>The date and time, in ISO-8601 Extended format, when the session was terminated.</p>", 1569 "StartChangeRequestExecutionRequest$ScheduledTime": "<p>The date and time specified in the change request to run the Automation runbooks.</p> <note> <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p> </note>", 1570 "StartChangeRequestExecutionRequest$ScheduledEndTime": "<p>The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.</p>", 1571 "StepExecution$ExecutionStartTime": "<p>If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.</p>", 1572 "StepExecution$ExecutionEndTime": "<p>If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.</p>", 1573 "UpdateOpsItemRequest$ActualStartTime": "<p>The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1574 "UpdateOpsItemRequest$ActualEndTime": "<p>The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1575 "UpdateOpsItemRequest$PlannedStartTime": "<p>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1576 "UpdateOpsItemRequest$PlannedEndTime": "<p>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>", 1577 "UpdatePatchBaselineResult$CreatedDate": "<p>The date when the patch baseline was created.</p>", 1578 "UpdatePatchBaselineResult$ModifiedDate": "<p>The date when the patch baseline was last modified.</p>" 1579 } 1580 }, 1581 "DefaultBaseline": { 1582 "base": null, 1583 "refs": { 1584 "PatchBaselineIdentity$DefaultBaseline": "<p>Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.</p>" 1585 } 1586 }, 1587 "DefaultInstanceName": { 1588 "base": null, 1589 "refs": { 1590 "Activation$DefaultInstanceName": "<p>A name for the managed instance when it is created.</p>", 1591 "CreateActivationRequest$DefaultInstanceName": "<p>The name of the registered, managed instance as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.</p> <important> <p>Don't enter personally identifiable information in this field.</p> </important>" 1592 } 1593 }, 1594 "DeleteActivationRequest": { 1595 "base": null, 1596 "refs": { 1597 } 1598 }, 1599 "DeleteActivationResult": { 1600 "base": null, 1601 "refs": { 1602 } 1603 }, 1604 "DeleteAssociationRequest": { 1605 "base": null, 1606 "refs": { 1607 } 1608 }, 1609 "DeleteAssociationResult": { 1610 "base": null, 1611 "refs": { 1612 } 1613 }, 1614 "DeleteDocumentRequest": { 1615 "base": null, 1616 "refs": { 1617 } 1618 }, 1619 "DeleteDocumentResult": { 1620 "base": null, 1621 "refs": { 1622 } 1623 }, 1624 "DeleteInventoryRequest": { 1625 "base": null, 1626 "refs": { 1627 } 1628 }, 1629 "DeleteInventoryResult": { 1630 "base": null, 1631 "refs": { 1632 } 1633 }, 1634 "DeleteMaintenanceWindowRequest": { 1635 "base": null, 1636 "refs": { 1637 } 1638 }, 1639 "DeleteMaintenanceWindowResult": { 1640 "base": null, 1641 "refs": { 1642 } 1643 }, 1644 "DeleteOpsMetadataRequest": { 1645 "base": null, 1646 "refs": { 1647 } 1648 }, 1649 "DeleteOpsMetadataResult": { 1650 "base": null, 1651 "refs": { 1652 } 1653 }, 1654 "DeleteParameterRequest": { 1655 "base": null, 1656 "refs": { 1657 } 1658 }, 1659 "DeleteParameterResult": { 1660 "base": null, 1661 "refs": { 1662 } 1663 }, 1664 "DeleteParametersRequest": { 1665 "base": null, 1666 "refs": { 1667 } 1668 }, 1669 "DeleteParametersResult": { 1670 "base": null, 1671 "refs": { 1672 } 1673 }, 1674 "DeletePatchBaselineRequest": { 1675 "base": null, 1676 "refs": { 1677 } 1678 }, 1679 "DeletePatchBaselineResult": { 1680 "base": null, 1681 "refs": { 1682 } 1683 }, 1684 "DeleteResourceDataSyncRequest": { 1685 "base": null, 1686 "refs": { 1687 } 1688 }, 1689 "DeleteResourceDataSyncResult": { 1690 "base": null, 1691 "refs": { 1692 } 1693 }, 1694 "DeliveryTimedOutCount": { 1695 "base": null, 1696 "refs": { 1697 "Command$DeliveryTimedOutCount": "<p>The number of targets for which the status is Delivery Timed Out.</p>" 1698 } 1699 }, 1700 "DeregisterManagedInstanceRequest": { 1701 "base": null, 1702 "refs": { 1703 } 1704 }, 1705 "DeregisterManagedInstanceResult": { 1706 "base": null, 1707 "refs": { 1708 } 1709 }, 1710 "DeregisterPatchBaselineForPatchGroupRequest": { 1711 "base": null, 1712 "refs": { 1713 } 1714 }, 1715 "DeregisterPatchBaselineForPatchGroupResult": { 1716 "base": null, 1717 "refs": { 1718 } 1719 }, 1720 "DeregisterTargetFromMaintenanceWindowRequest": { 1721 "base": null, 1722 "refs": { 1723 } 1724 }, 1725 "DeregisterTargetFromMaintenanceWindowResult": { 1726 "base": null, 1727 "refs": { 1728 } 1729 }, 1730 "DeregisterTaskFromMaintenanceWindowRequest": { 1731 "base": null, 1732 "refs": { 1733 } 1734 }, 1735 "DeregisterTaskFromMaintenanceWindowResult": { 1736 "base": null, 1737 "refs": { 1738 } 1739 }, 1740 "DescribeActivationsFilter": { 1741 "base": "<p>Filter for the DescribeActivation API.</p>", 1742 "refs": { 1743 "DescribeActivationsFilterList$member": null 1744 } 1745 }, 1746 "DescribeActivationsFilterKeys": { 1747 "base": null, 1748 "refs": { 1749 "DescribeActivationsFilter$FilterKey": "<p>The name of the filter.</p>" 1750 } 1751 }, 1752 "DescribeActivationsFilterList": { 1753 "base": null, 1754 "refs": { 1755 "DescribeActivationsRequest$Filters": "<p>A filter to view information about your activations.</p>" 1756 } 1757 }, 1758 "DescribeActivationsRequest": { 1759 "base": null, 1760 "refs": { 1761 } 1762 }, 1763 "DescribeActivationsResult": { 1764 "base": null, 1765 "refs": { 1766 } 1767 }, 1768 "DescribeAssociationExecutionTargetsRequest": { 1769 "base": null, 1770 "refs": { 1771 } 1772 }, 1773 "DescribeAssociationExecutionTargetsResult": { 1774 "base": null, 1775 "refs": { 1776 } 1777 }, 1778 "DescribeAssociationExecutionsRequest": { 1779 "base": null, 1780 "refs": { 1781 } 1782 }, 1783 "DescribeAssociationExecutionsResult": { 1784 "base": null, 1785 "refs": { 1786 } 1787 }, 1788 "DescribeAssociationRequest": { 1789 "base": null, 1790 "refs": { 1791 } 1792 }, 1793 "DescribeAssociationResult": { 1794 "base": null, 1795 "refs": { 1796 } 1797 }, 1798 "DescribeAutomationExecutionsRequest": { 1799 "base": null, 1800 "refs": { 1801 } 1802 }, 1803 "DescribeAutomationExecutionsResult": { 1804 "base": null, 1805 "refs": { 1806 } 1807 }, 1808 "DescribeAutomationStepExecutionsRequest": { 1809 "base": null, 1810 "refs": { 1811 } 1812 }, 1813 "DescribeAutomationStepExecutionsResult": { 1814 "base": null, 1815 "refs": { 1816 } 1817 }, 1818 "DescribeAvailablePatchesRequest": { 1819 "base": null, 1820 "refs": { 1821 } 1822 }, 1823 "DescribeAvailablePatchesResult": { 1824 "base": null, 1825 "refs": { 1826 } 1827 }, 1828 "DescribeDocumentPermissionRequest": { 1829 "base": null, 1830 "refs": { 1831 } 1832 }, 1833 "DescribeDocumentPermissionResponse": { 1834 "base": null, 1835 "refs": { 1836 } 1837 }, 1838 "DescribeDocumentRequest": { 1839 "base": null, 1840 "refs": { 1841 } 1842 }, 1843 "DescribeDocumentResult": { 1844 "base": null, 1845 "refs": { 1846 } 1847 }, 1848 "DescribeEffectiveInstanceAssociationsRequest": { 1849 "base": null, 1850 "refs": { 1851 } 1852 }, 1853 "DescribeEffectiveInstanceAssociationsResult": { 1854 "base": null, 1855 "refs": { 1856 } 1857 }, 1858 "DescribeEffectivePatchesForPatchBaselineRequest": { 1859 "base": null, 1860 "refs": { 1861 } 1862 }, 1863 "DescribeEffectivePatchesForPatchBaselineResult": { 1864 "base": null, 1865 "refs": { 1866 } 1867 }, 1868 "DescribeInstanceAssociationsStatusRequest": { 1869 "base": null, 1870 "refs": { 1871 } 1872 }, 1873 "DescribeInstanceAssociationsStatusResult": { 1874 "base": null, 1875 "refs": { 1876 } 1877 }, 1878 "DescribeInstanceInformationRequest": { 1879 "base": null, 1880 "refs": { 1881 } 1882 }, 1883 "DescribeInstanceInformationResult": { 1884 "base": null, 1885 "refs": { 1886 } 1887 }, 1888 "DescribeInstancePatchStatesForPatchGroupRequest": { 1889 "base": null, 1890 "refs": { 1891 } 1892 }, 1893 "DescribeInstancePatchStatesForPatchGroupResult": { 1894 "base": null, 1895 "refs": { 1896 } 1897 }, 1898 "DescribeInstancePatchStatesRequest": { 1899 "base": null, 1900 "refs": { 1901 } 1902 }, 1903 "DescribeInstancePatchStatesResult": { 1904 "base": null, 1905 "refs": { 1906 } 1907 }, 1908 "DescribeInstancePatchesRequest": { 1909 "base": null, 1910 "refs": { 1911 } 1912 }, 1913 "DescribeInstancePatchesResult": { 1914 "base": null, 1915 "refs": { 1916 } 1917 }, 1918 "DescribeInventoryDeletionsRequest": { 1919 "base": null, 1920 "refs": { 1921 } 1922 }, 1923 "DescribeInventoryDeletionsResult": { 1924 "base": null, 1925 "refs": { 1926 } 1927 }, 1928 "DescribeMaintenanceWindowExecutionTaskInvocationsRequest": { 1929 "base": null, 1930 "refs": { 1931 } 1932 }, 1933 "DescribeMaintenanceWindowExecutionTaskInvocationsResult": { 1934 "base": null, 1935 "refs": { 1936 } 1937 }, 1938 "DescribeMaintenanceWindowExecutionTasksRequest": { 1939 "base": null, 1940 "refs": { 1941 } 1942 }, 1943 "DescribeMaintenanceWindowExecutionTasksResult": { 1944 "base": null, 1945 "refs": { 1946 } 1947 }, 1948 "DescribeMaintenanceWindowExecutionsRequest": { 1949 "base": null, 1950 "refs": { 1951 } 1952 }, 1953 "DescribeMaintenanceWindowExecutionsResult": { 1954 "base": null, 1955 "refs": { 1956 } 1957 }, 1958 "DescribeMaintenanceWindowScheduleRequest": { 1959 "base": null, 1960 "refs": { 1961 } 1962 }, 1963 "DescribeMaintenanceWindowScheduleResult": { 1964 "base": null, 1965 "refs": { 1966 } 1967 }, 1968 "DescribeMaintenanceWindowTargetsRequest": { 1969 "base": null, 1970 "refs": { 1971 } 1972 }, 1973 "DescribeMaintenanceWindowTargetsResult": { 1974 "base": null, 1975 "refs": { 1976 } 1977 }, 1978 "DescribeMaintenanceWindowTasksRequest": { 1979 "base": null, 1980 "refs": { 1981 } 1982 }, 1983 "DescribeMaintenanceWindowTasksResult": { 1984 "base": null, 1985 "refs": { 1986 } 1987 }, 1988 "DescribeMaintenanceWindowsForTargetRequest": { 1989 "base": null, 1990 "refs": { 1991 } 1992 }, 1993 "DescribeMaintenanceWindowsForTargetResult": { 1994 "base": null, 1995 "refs": { 1996 } 1997 }, 1998 "DescribeMaintenanceWindowsRequest": { 1999 "base": null, 2000 "refs": { 2001 } 2002 }, 2003 "DescribeMaintenanceWindowsResult": { 2004 "base": null, 2005 "refs": { 2006 } 2007 }, 2008 "DescribeOpsItemsRequest": { 2009 "base": null, 2010 "refs": { 2011 } 2012 }, 2013 "DescribeOpsItemsResponse": { 2014 "base": null, 2015 "refs": { 2016 } 2017 }, 2018 "DescribeParametersRequest": { 2019 "base": null, 2020 "refs": { 2021 } 2022 }, 2023 "DescribeParametersResult": { 2024 "base": null, 2025 "refs": { 2026 } 2027 }, 2028 "DescribePatchBaselinesRequest": { 2029 "base": null, 2030 "refs": { 2031 } 2032 }, 2033 "DescribePatchBaselinesResult": { 2034 "base": null, 2035 "refs": { 2036 } 2037 }, 2038 "DescribePatchGroupStateRequest": { 2039 "base": null, 2040 "refs": { 2041 } 2042 }, 2043 "DescribePatchGroupStateResult": { 2044 "base": null, 2045 "refs": { 2046 } 2047 }, 2048 "DescribePatchGroupsRequest": { 2049 "base": null, 2050 "refs": { 2051 } 2052 }, 2053 "DescribePatchGroupsResult": { 2054 "base": null, 2055 "refs": { 2056 } 2057 }, 2058 "DescribePatchPropertiesRequest": { 2059 "base": null, 2060 "refs": { 2061 } 2062 }, 2063 "DescribePatchPropertiesResult": { 2064 "base": null, 2065 "refs": { 2066 } 2067 }, 2068 "DescribeSessionsRequest": { 2069 "base": null, 2070 "refs": { 2071 } 2072 }, 2073 "DescribeSessionsResponse": { 2074 "base": null, 2075 "refs": { 2076 } 2077 }, 2078 "DescriptionInDocument": { 2079 "base": null, 2080 "refs": { 2081 "DocumentDescription$Description": "<p>A description of the document. </p>" 2082 } 2083 }, 2084 "DisassociateOpsItemRelatedItemRequest": { 2085 "base": null, 2086 "refs": { 2087 } 2088 }, 2089 "DisassociateOpsItemRelatedItemResponse": { 2090 "base": null, 2091 "refs": { 2092 } 2093 }, 2094 "DocumentARN": { 2095 "base": null, 2096 "refs": { 2097 "Association$Name": "<p>The name of the SSM document.</p>", 2098 "AssociationDescription$Name": "<p>The name of the SSM document.</p>", 2099 "AssociationVersionInfo$Name": "<p>The name specified when the association was created.</p>", 2100 "CreateAssociationBatchRequestEntry$Name": "<p>The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation runbooks.</p> <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.</p> <p>For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:</p> <p> <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i> </code> </p> <p>For example:</p> <p> <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code> </p> <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or <code>My-Document</code>.</p>", 2101 "CreateAssociationRequest$Name": "<p>The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.</p> <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.</p> <p>For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:</p> <p> <code>arn:<i>partition</i>:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i> </code> </p> <p>For example:</p> <p> <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code> </p> <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or <code>My-Document</code>.</p>", 2102 "DeleteAssociationRequest$Name": "<p>The name of the SSM document.</p>", 2103 "DescribeAssociationRequest$Name": "<p>The name of the SSM document.</p>", 2104 "DescribeDocumentRequest$Name": "<p>The name of the SSM document.</p>", 2105 "DocumentDescription$Name": "<p>The name of the SSM document.</p>", 2106 "DocumentIdentifier$Name": "<p>The name of the SSM document.</p>", 2107 "DocumentRequires$Name": "<p>The name of the required SSM document. The name can be an Amazon Resource Name (ARN).</p>", 2108 "GetDocumentRequest$Name": "<p>The name of the SSM document.</p>", 2109 "GetDocumentResult$Name": "<p>The name of the SSM document.</p>", 2110 "InstanceAssociationStatusInfo$Name": "<p>The name of the association.</p>", 2111 "ListDocumentVersionsRequest$Name": "<p>The name of the document. You can specify an Amazon Resource Name (ARN).</p>", 2112 "Runbook$DocumentName": "<p>The name of the Automation runbook used in a runbook workflow.</p>", 2113 "SendCommandRequest$DocumentName": "<p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html\">Using shared SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <note> <p>If you specify a document name or ARN that hasn't been shared with your account, you receive an <code>InvalidDocument</code> error. </p> </note>", 2114 "StartAutomationExecutionRequest$DocumentName": "<p>The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html\">Using shared SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 2115 "StartChangeRequestExecutionRequest$DocumentName": "<p>The name of the change template document to run during the runbook workflow.</p>", 2116 "StartSessionRequest$DocumentName": "<p>The name of the SSM document to define the parameters and plugin settings for the session. For example, <code>SSM-SessionManagerRunShell</code>. You can call the <a>GetDocument</a> API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the instance is launched by default.</p>", 2117 "UpdateAssociationRequest$Name": "<p>The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.</p> <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.</p> <p>For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:</p> <p> <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i> </code> </p> <p>For example:</p> <p> <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code> </p> <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or <code>My-Document</code>.</p>", 2118 "UpdateAssociationStatusRequest$Name": "<p>The name of the SSM document.</p>" 2119 } 2120 }, 2121 "DocumentAlreadyExists": { 2122 "base": "<p>The specified document already exists.</p>", 2123 "refs": { 2124 } 2125 }, 2126 "DocumentAuthor": { 2127 "base": null, 2128 "refs": { 2129 "DocumentDescription$Author": "<p>The user in your organization who created the document.</p>", 2130 "DocumentIdentifier$Author": "<p>The user in your organization who created the document.</p>", 2131 "ListDocumentMetadataHistoryResponse$Author": "<p>The user ID of the person in the organization who requested the review of the change template.</p>" 2132 } 2133 }, 2134 "DocumentContent": { 2135 "base": null, 2136 "refs": { 2137 "CreateDocumentRequest$Content": "<p>The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.</p> <p>For examples, see the following topics in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html\">Create an SSM document (Amazon Web Services API)</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html\">Create an SSM document (Amazon Web Services CLI)</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html\">Create an SSM document (API)</a> </p> </li> </ul>", 2138 "GetDocumentResult$Content": "<p>The contents of the SSM document.</p>", 2139 "InstanceAssociation$Content": "<p>The content of the association document for the instance(s).</p>", 2140 "UpdateDocumentRequest$Content": "<p>A valid JSON or YAML string.</p>" 2141 } 2142 }, 2143 "DocumentDefaultVersionDescription": { 2144 "base": "<p>A default version of a document.</p>", 2145 "refs": { 2146 "UpdateDocumentDefaultVersionResult$Description": "<p>The description of a custom document that you want to set as the default version.</p>" 2147 } 2148 }, 2149 "DocumentDescription": { 2150 "base": "<p>Describes a Amazon Web Services Systems Manager document (SSM document). </p>", 2151 "refs": { 2152 "CreateDocumentResult$DocumentDescription": "<p>Information about the SSM document.</p>", 2153 "DescribeDocumentResult$Document": "<p>Information about the SSM document.</p>", 2154 "UpdateDocumentResult$DocumentDescription": "<p>A description of the document that was updated.</p>" 2155 } 2156 }, 2157 "DocumentDisplayName": { 2158 "base": null, 2159 "refs": { 2160 "CreateDocumentRequest$DisplayName": "<p>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 <a>UpdateDocument</a> operation.</p>", 2161 "DocumentDescription$DisplayName": "<p>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 <a>UpdateDocument</a>.</p>", 2162 "DocumentIdentifier$DisplayName": "<p>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 <a>UpdateDocument</a>.</p>", 2163 "DocumentVersionInfo$DisplayName": "<p>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 <a>UpdateDocument</a>.</p>", 2164 "GetDocumentResult$DisplayName": "<p>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 <a>UpdateDocument</a>.</p>", 2165 "UpdateDocumentRequest$DisplayName": "<p>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</p>" 2166 } 2167 }, 2168 "DocumentFilter": { 2169 "base": "<p>This data type is deprecated. Instead, use <a>DocumentKeyValuesFilter</a>.</p>", 2170 "refs": { 2171 "DocumentFilterList$member": null 2172 } 2173 }, 2174 "DocumentFilterKey": { 2175 "base": null, 2176 "refs": { 2177 "DocumentFilter$key": "<p>The name of the filter.</p>" 2178 } 2179 }, 2180 "DocumentFilterList": { 2181 "base": null, 2182 "refs": { 2183 "ListDocumentsRequest$DocumentFilterList": "<p>This data type is deprecated. Instead, use <code>Filters</code>.</p>" 2184 } 2185 }, 2186 "DocumentFilterValue": { 2187 "base": null, 2188 "refs": { 2189 "DocumentFilter$value": "<p>The value of the filter.</p>" 2190 } 2191 }, 2192 "DocumentFormat": { 2193 "base": null, 2194 "refs": { 2195 "CreateDocumentRequest$DocumentFormat": "<p>Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>", 2196 "DocumentDescription$DocumentFormat": "<p>The document format, either JSON or YAML.</p>", 2197 "DocumentIdentifier$DocumentFormat": "<p>The document format, either JSON or YAML.</p>", 2198 "DocumentVersionInfo$DocumentFormat": "<p>The document format, either JSON or YAML.</p>", 2199 "GetDocumentRequest$DocumentFormat": "<p>Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.</p>", 2200 "GetDocumentResult$DocumentFormat": "<p>The document format, either JSON or YAML.</p>", 2201 "UpdateDocumentRequest$DocumentFormat": "<p>Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.</p>" 2202 } 2203 }, 2204 "DocumentHash": { 2205 "base": null, 2206 "refs": { 2207 "DocumentDescription$Hash": "<p>The Sha256 or Sha1 hash created by the system when the document was created. </p> <note> <p>Sha1 hashes have been deprecated.</p> </note>", 2208 "MaintenanceWindowRunCommandParameters$DocumentHash": "<p>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.</p>", 2209 "SendCommandRequest$DocumentHash": "<p>The Sha256 or Sha1 hash created by the system when the document was created. </p> <note> <p>Sha1 hashes have been deprecated.</p> </note>" 2210 } 2211 }, 2212 "DocumentHashType": { 2213 "base": null, 2214 "refs": { 2215 "DocumentDescription$HashType": "<p>The hash type of the document. Valid values include <code>Sha256</code> or <code>Sha1</code>.</p> <note> <p>Sha1 hashes have been deprecated.</p> </note>", 2216 "MaintenanceWindowRunCommandParameters$DocumentHashType": "<p>SHA-256 or SHA-1. SHA-1 hashes have been deprecated.</p>", 2217 "SendCommandRequest$DocumentHashType": "<p>Sha256 or Sha1.</p> <note> <p>Sha1 hashes have been deprecated.</p> </note>" 2218 } 2219 }, 2220 "DocumentIdentifier": { 2221 "base": "<p>Describes the name of a SSM document.</p>", 2222 "refs": { 2223 "DocumentIdentifierList$member": null 2224 } 2225 }, 2226 "DocumentIdentifierList": { 2227 "base": null, 2228 "refs": { 2229 "ListDocumentsResult$DocumentIdentifiers": "<p>The names of the SSM documents.</p>" 2230 } 2231 }, 2232 "DocumentKeyValuesFilter": { 2233 "base": "<p>One or more filters. Use a filter to return a more specific list of documents.</p> <p>For keys, you can specify one or more tags that have been applied to a document. </p> <p>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:</p> <dl> <dt>DocumentType</dt> <dd> <ul> <li> <p> <code>ApplicationConfiguration</code> </p> </li> <li> <p> <code>ApplicationConfigurationSchema</code> </p> </li> <li> <p> <code>Automation</code> </p> </li> <li> <p> <code>ChangeCalendar</code> </p> </li> <li> <p> <code>Command</code> </p> </li> <li> <p> <code>DeploymentStrategy</code> </p> </li> <li> <p> <code>Package</code> </p> </li> <li> <p> <code>Policy</code> </p> </li> <li> <p> <code>Session</code> </p> </li> </ul> </dd> <dt>Owner</dt> <dd> <p>Note that only one <code>Owner</code> can be specified in a request. For example: <code>Key=Owner,Values=Self</code>.</p> <ul> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>Private</code> </p> </li> <li> <p> <code>Public</code> </p> </li> <li> <p> <code>Self</code> </p> </li> <li> <p> <code>ThirdParty</code> </p> </li> </ul> </dd> <dt>PlatformTypes</dt> <dd> <ul> <li> <p> <code>Linux</code> </p> </li> <li> <p> <code>Windows</code> </p> </li> </ul> </dd> </dl> <p> <code>Name</code> is another Amazon Web Services-provided key. If you use <code>Name</code> 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 <code>Te</code>, run the following command:</p> <p> <code>aws ssm list-documents --filters Key=Name,Values=Te</code> </p> <p>You can also use the <code>TargetType</code> Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p> <p>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.</p> <p>To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p> <p>For example, if you created a key called region and are using the Amazon Web Services CLI to call the <code>list-documents</code> command: </p> <p> <code>aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self</code> </p>", 2234 "refs": { 2235 "DocumentKeyValuesFilterList$member": null 2236 } 2237 }, 2238 "DocumentKeyValuesFilterKey": { 2239 "base": null, 2240 "refs": { 2241 "DocumentKeyValuesFilter$Key": "<p>The name of the filter key.</p>" 2242 } 2243 }, 2244 "DocumentKeyValuesFilterList": { 2245 "base": null, 2246 "refs": { 2247 "ListDocumentsRequest$Filters": "<p>One or more <code>DocumentKeyValuesFilter</code> 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 <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p> <note> <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code> </p> </note>" 2248 } 2249 }, 2250 "DocumentKeyValuesFilterValue": { 2251 "base": null, 2252 "refs": { 2253 "DocumentKeyValuesFilterValues$member": null 2254 } 2255 }, 2256 "DocumentKeyValuesFilterValues": { 2257 "base": null, 2258 "refs": { 2259 "DocumentKeyValuesFilter$Values": "<p>The value for the filter key.</p>" 2260 } 2261 }, 2262 "DocumentLimitExceeded": { 2263 "base": "<p>You can have at most 500 active SSM documents.</p>", 2264 "refs": { 2265 } 2266 }, 2267 "DocumentMetadataEnum": { 2268 "base": null, 2269 "refs": { 2270 "ListDocumentMetadataHistoryRequest$Metadata": "<p>The type of data for which details are being requested. Currently, the only supported value is <code>DocumentReviews</code>.</p>" 2271 } 2272 }, 2273 "DocumentMetadataResponseInfo": { 2274 "base": "<p>Details about the response to a document review request.</p>", 2275 "refs": { 2276 "ListDocumentMetadataHistoryResponse$Metadata": "<p>Information about the response to the change template approval request.</p>" 2277 } 2278 }, 2279 "DocumentName": { 2280 "base": null, 2281 "refs": { 2282 "AutomationExecution$DocumentName": "<p>The name of the Automation runbook used during the execution.</p>", 2283 "AutomationExecutionMetadata$DocumentName": "<p>The name of the Automation runbook used during execution.</p>", 2284 "Command$DocumentName": "<p>The name of the document requested for execution.</p>", 2285 "CommandInvocation$DocumentName": "<p>The document name that was requested for execution.</p>", 2286 "CreateDocumentRequest$Name": "<p>A name for the SSM document.</p> <important> <p>You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:</p> <ul> <li> <p> <code>aws-</code> </p> </li> <li> <p> <code>amazon</code> </p> </li> <li> <p> <code>amzn</code> </p> </li> </ul> </important>", 2287 "DeleteDocumentRequest$Name": "<p>The name of the document.</p>", 2288 "DescribeDocumentPermissionRequest$Name": "<p>The name of the document for which you are the owner.</p>", 2289 "DocumentDefaultVersionDescription$Name": "<p>The name of the document.</p>", 2290 "DocumentVersionInfo$Name": "<p>The document name.</p>", 2291 "GetCommandInvocationResult$DocumentName": "<p>The name of the document that was run. For example, <code>AWS-RunShellScript</code>.</p>", 2292 "ListDocumentMetadataHistoryRequest$Name": "<p>The name of the change template.</p>", 2293 "ListDocumentMetadataHistoryResponse$Name": "<p>The name of the change template.</p>", 2294 "ModifyDocumentPermissionRequest$Name": "<p>The name of the document that you want to share.</p>", 2295 "Session$DocumentName": "<p>The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, <code>SSM-SessionManagerRunShell</code>.</p>", 2296 "UpdateDocumentDefaultVersionRequest$Name": "<p>The name of a custom document that you want to set as the default version.</p>", 2297 "UpdateDocumentMetadataRequest$Name": "<p>The name of the change template for which a version's metadata is to be updated.</p>", 2298 "UpdateDocumentRequest$Name": "<p>The name of the SSM document that you want to update.</p>" 2299 } 2300 }, 2301 "DocumentOwner": { 2302 "base": null, 2303 "refs": { 2304 "DocumentDescription$Owner": "<p>The Amazon Web Services user account that created the document.</p>", 2305 "DocumentIdentifier$Owner": "<p>The Amazon Web Services user account that created the document.</p>" 2306 } 2307 }, 2308 "DocumentParameter": { 2309 "base": "<p>Parameters specified in a System Manager document that run on the server when the command is run. </p>", 2310 "refs": { 2311 "DocumentParameterList$member": null 2312 } 2313 }, 2314 "DocumentParameterDefaultValue": { 2315 "base": null, 2316 "refs": { 2317 "DocumentParameter$DefaultValue": "<p>If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.</p>" 2318 } 2319 }, 2320 "DocumentParameterDescrption": { 2321 "base": null, 2322 "refs": { 2323 "DocumentParameter$Description": "<p>A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.</p>" 2324 } 2325 }, 2326 "DocumentParameterList": { 2327 "base": null, 2328 "refs": { 2329 "DocumentDescription$Parameters": "<p>A description of the parameters for a document.</p>" 2330 } 2331 }, 2332 "DocumentParameterName": { 2333 "base": null, 2334 "refs": { 2335 "DocumentParameter$Name": "<p>The name of the parameter.</p>" 2336 } 2337 }, 2338 "DocumentParameterType": { 2339 "base": null, 2340 "refs": { 2341 "DocumentParameter$Type": "<p>The type of parameter. The type can be either String or StringList.</p>" 2342 } 2343 }, 2344 "DocumentPermissionLimit": { 2345 "base": "<p>The document can't be shared with more Amazon Web Services user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact Amazon Web Services Support.</p>", 2346 "refs": { 2347 } 2348 }, 2349 "DocumentPermissionMaxResults": { 2350 "base": null, 2351 "refs": { 2352 "DescribeDocumentPermissionRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 2353 } 2354 }, 2355 "DocumentPermissionType": { 2356 "base": null, 2357 "refs": { 2358 "DescribeDocumentPermissionRequest$PermissionType": "<p>The permission type for the document. The permission type can be <i>Share</i>.</p>", 2359 "ModifyDocumentPermissionRequest$PermissionType": "<p>The permission type for the document. The permission type can be <i>Share</i>.</p>" 2360 } 2361 }, 2362 "DocumentRequires": { 2363 "base": "<p>An SSM document required by the current document.</p>", 2364 "refs": { 2365 "DocumentRequiresList$member": null 2366 } 2367 }, 2368 "DocumentRequiresList": { 2369 "base": null, 2370 "refs": { 2371 "CreateDocumentRequest$Requires": "<p>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 <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document for validation purposes. For more information, see <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html\">What is AppConfig?</a> in the <i>AppConfig User Guide</i>.</p>", 2372 "DocumentDescription$Requires": "<p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>", 2373 "DocumentIdentifier$Requires": "<p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>", 2374 "GetDocumentResult$Requires": "<p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>" 2375 } 2376 }, 2377 "DocumentReviewAction": { 2378 "base": null, 2379 "refs": { 2380 "DocumentReviews$Action": "<p>The action to take on a document approval review request.</p>" 2381 } 2382 }, 2383 "DocumentReviewComment": { 2384 "base": null, 2385 "refs": { 2386 "DocumentReviewCommentSource$Content": "<p>The content of a comment entered by a user who requests a review of a new document version, or who reviews the new version.</p>" 2387 } 2388 }, 2389 "DocumentReviewCommentList": { 2390 "base": null, 2391 "refs": { 2392 "DocumentReviewerResponseSource$Comment": "<p>The comment entered by a reviewer as part of their document review response.</p>", 2393 "DocumentReviews$Comment": "<p>A comment entered by a user in your organization about the document review request.</p>" 2394 } 2395 }, 2396 "DocumentReviewCommentSource": { 2397 "base": "<p>Information about comments added to a document review request.</p>", 2398 "refs": { 2399 "DocumentReviewCommentList$member": null 2400 } 2401 }, 2402 "DocumentReviewCommentType": { 2403 "base": null, 2404 "refs": { 2405 "DocumentReviewCommentSource$Type": "<p>The type of information added to a review request. Currently, only the value <code>Comment</code> is supported.</p>" 2406 } 2407 }, 2408 "DocumentReviewerResponseList": { 2409 "base": null, 2410 "refs": { 2411 "DocumentMetadataResponseInfo$ReviewerResponse": "<p>Details about a reviewer's response to a document review request.</p>" 2412 } 2413 }, 2414 "DocumentReviewerResponseSource": { 2415 "base": "<p>Information about a reviewer's response to a document review request.</p>", 2416 "refs": { 2417 "DocumentReviewerResponseList$member": null 2418 } 2419 }, 2420 "DocumentReviews": { 2421 "base": "<p>Information about a document approval review.</p>", 2422 "refs": { 2423 "UpdateDocumentMetadataRequest$DocumentReviews": "<p>The change template review details to update.</p>" 2424 } 2425 }, 2426 "DocumentSchemaVersion": { 2427 "base": null, 2428 "refs": { 2429 "DocumentDescription$SchemaVersion": "<p>The schema version.</p>", 2430 "DocumentIdentifier$SchemaVersion": "<p>The schema version.</p>" 2431 } 2432 }, 2433 "DocumentSha1": { 2434 "base": null, 2435 "refs": { 2436 "DocumentDescription$Sha1": "<p>The SHA1 hash of the document, which you can use for verification.</p>" 2437 } 2438 }, 2439 "DocumentStatus": { 2440 "base": "<p>The status of a document.</p>", 2441 "refs": { 2442 "DocumentDescription$Status": "<p>The status of the SSM document.</p>", 2443 "DocumentVersionInfo$Status": "<p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Failed</code>, and <code>Deleting</code>.</p>", 2444 "GetDocumentResult$Status": "<p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Updating</code>, <code>Failed</code>, and <code>Deleting</code>.</p>" 2445 } 2446 }, 2447 "DocumentStatusInformation": { 2448 "base": null, 2449 "refs": { 2450 "DocumentDescription$StatusInformation": "<p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"</p>", 2451 "DocumentVersionInfo$StatusInformation": "<p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"</p>", 2452 "GetDocumentResult$StatusInformation": "<p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"</p>" 2453 } 2454 }, 2455 "DocumentType": { 2456 "base": null, 2457 "refs": { 2458 "CreateDocumentRequest$DocumentType": "<p>The type of document to create.</p>", 2459 "DocumentDescription$DocumentType": "<p>The type of document.</p>", 2460 "DocumentIdentifier$DocumentType": "<p>The document type.</p>", 2461 "GetDocumentResult$DocumentType": "<p>The document type.</p>" 2462 } 2463 }, 2464 "DocumentVersion": { 2465 "base": null, 2466 "refs": { 2467 "Association$DocumentVersion": "<p>The version of the document used in the association.</p>", 2468 "AssociationDescription$DocumentVersion": "<p>The document version.</p>", 2469 "AssociationVersionInfo$DocumentVersion": "<p>The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.</p>", 2470 "AutomationExecution$DocumentVersion": "<p>The version of the document to use during execution.</p>", 2471 "AutomationExecutionMetadata$DocumentVersion": "<p>The document version used during the execution.</p>", 2472 "Command$DocumentVersion": "<p>The Systems Manager document (SSM document) version.</p>", 2473 "CommandInvocation$DocumentVersion": "<p>The Systems Manager document (SSM document) version.</p>", 2474 "CreateAssociationBatchRequestEntry$DocumentVersion": "<p>The document version.</p>", 2475 "CreateAssociationRequest$DocumentVersion": "<p>The document version you want to associate with the target(s). Can be a specific version or the default version.</p>", 2476 "DeleteDocumentRequest$DocumentVersion": "<p>The version of the document that you want to delete. If not provided, all versions of the document are deleted.</p>", 2477 "DescribeDocumentRequest$DocumentVersion": "<p>The document version for which you want information. Can be a specific version or the default version.</p>", 2478 "DocumentDefaultVersionDescription$DefaultVersion": "<p>The default version of the document.</p>", 2479 "DocumentDescription$DocumentVersion": "<p>The document version.</p>", 2480 "DocumentDescription$LatestVersion": "<p>The latest version of the document.</p>", 2481 "DocumentDescription$DefaultVersion": "<p>The default version.</p>", 2482 "DocumentDescription$ApprovedVersion": "<p>The version of the document currently approved for use in the organization.</p>", 2483 "DocumentDescription$PendingReviewVersion": "<p>The version of the document that is currently under review.</p>", 2484 "DocumentIdentifier$DocumentVersion": "<p>The document version.</p>", 2485 "DocumentRequires$Version": "<p>The document version required by the current document.</p>", 2486 "DocumentVersionInfo$DocumentVersion": "<p>The document version.</p>", 2487 "GetCommandInvocationResult$DocumentVersion": "<p>The Systems Manager document (SSM document) version used in the request.</p>", 2488 "GetDocumentRequest$DocumentVersion": "<p>The document version for which you want information.</p>", 2489 "GetDocumentResult$DocumentVersion": "<p>The document version.</p>", 2490 "InstanceAssociationStatusInfo$DocumentVersion": "<p>The association document versions.</p>", 2491 "ListDocumentMetadataHistoryRequest$DocumentVersion": "<p>The version of the change template.</p>", 2492 "ListDocumentMetadataHistoryResponse$DocumentVersion": "<p>The version of the change template.</p>", 2493 "MaintenanceWindowAutomationParameters$DocumentVersion": "<p>The version of an Automation runbook to use during task execution.</p>", 2494 "MaintenanceWindowRunCommandParameters$DocumentVersion": "<p>The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify <code>$DEFAULT</code>, <code>$LATEST</code>, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p> <p> <code>--document-version \"\\$DEFAULT\"</code> </p> <p> <code>--document-version \"\\$LATEST\"</code> </p> <p> <code>--document-version \"3\"</code> </p>", 2495 "Runbook$DocumentVersion": "<p>The version of the Automation runbook used in a runbook workflow.</p>", 2496 "SendCommandRequest$DocumentVersion": "<p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p> <p>--document-version \"\\$DEFAULT\"</p> <p>--document-version \"\\$LATEST\"</p> <p>--document-version \"3\"</p>", 2497 "StartAutomationExecutionRequest$DocumentVersion": "<p>The version of the Automation runbook to use for this execution.</p>", 2498 "StartChangeRequestExecutionRequest$DocumentVersion": "<p>The version of the change template document to run during the runbook workflow.</p>", 2499 "UpdateAssociationRequest$DocumentVersion": "<p>The document version you want update for the association. </p>", 2500 "UpdateDocumentMetadataRequest$DocumentVersion": "<p>The version of a change template in which to update approval metadata.</p>", 2501 "UpdateDocumentRequest$DocumentVersion": "<p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p>" 2502 } 2503 }, 2504 "DocumentVersionInfo": { 2505 "base": "<p>Version information about the document.</p>", 2506 "refs": { 2507 "DocumentVersionList$member": null 2508 } 2509 }, 2510 "DocumentVersionLimitExceeded": { 2511 "base": "<p>The document has too many versions. Delete one or more document versions and try again.</p>", 2512 "refs": { 2513 } 2514 }, 2515 "DocumentVersionList": { 2516 "base": null, 2517 "refs": { 2518 "ListDocumentVersionsResult$DocumentVersions": "<p>The document versions.</p>" 2519 } 2520 }, 2521 "DocumentVersionName": { 2522 "base": null, 2523 "refs": { 2524 "CreateDocumentRequest$VersionName": "<p>An optional field specifying the version of the artifact you are creating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>", 2525 "DeleteDocumentRequest$VersionName": "<p>The version name of the document that you want to delete. If not provided, all versions of the document are deleted.</p>", 2526 "DescribeDocumentRequest$VersionName": "<p>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.</p>", 2527 "DocumentDefaultVersionDescription$DefaultVersionName": "<p>The default version of the artifact associated with the document.</p>", 2528 "DocumentDescription$VersionName": "<p>The version of the artifact associated with the document.</p>", 2529 "DocumentIdentifier$VersionName": "<p>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.</p>", 2530 "DocumentVersionInfo$VersionName": "<p>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.</p>", 2531 "GetDocumentRequest$VersionName": "<p>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.</p>", 2532 "GetDocumentResult$VersionName": "<p>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.</p>", 2533 "UpdateDocumentRequest$VersionName": "<p>An optional field specifying the version of the artifact you are updating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>" 2534 } 2535 }, 2536 "DocumentVersionNumber": { 2537 "base": null, 2538 "refs": { 2539 "UpdateDocumentDefaultVersionRequest$DocumentVersion": "<p>The version of a custom document that you want to set as the default version.</p>" 2540 } 2541 }, 2542 "DoesNotExistException": { 2543 "base": "<p>Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.</p> <p>For information about resource quotas in Amazon Web Services Systems Manager, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm\">Systems Manager service quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>", 2544 "refs": { 2545 } 2546 }, 2547 "DryRun": { 2548 "base": null, 2549 "refs": { 2550 "DeleteInventoryRequest$DryRun": "<p>Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the <code>DryRun</code> option.</p>" 2551 } 2552 }, 2553 "DuplicateDocumentContent": { 2554 "base": "<p>The content of the association document matches another document. Change the content of the document and try again.</p>", 2555 "refs": { 2556 } 2557 }, 2558 "DuplicateDocumentVersionName": { 2559 "base": "<p>The version name has already been used in this document. Specify a different version name, and then try again.</p>", 2560 "refs": { 2561 } 2562 }, 2563 "DuplicateInstanceId": { 2564 "base": "<p>You can't specify an instance ID in more than one association.</p>", 2565 "refs": { 2566 } 2567 }, 2568 "EffectiveInstanceAssociationMaxResults": { 2569 "base": null, 2570 "refs": { 2571 "DescribeEffectiveInstanceAssociationsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 2572 } 2573 }, 2574 "EffectivePatch": { 2575 "base": "<p>The <code>EffectivePatch</code> structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.</p>", 2576 "refs": { 2577 "EffectivePatchList$member": null 2578 } 2579 }, 2580 "EffectivePatchList": { 2581 "base": null, 2582 "refs": { 2583 "DescribeEffectivePatchesForPatchBaselineResult$EffectivePatches": "<p>An array of patches and patch status.</p>" 2584 } 2585 }, 2586 "ErrorCount": { 2587 "base": null, 2588 "refs": { 2589 "Command$ErrorCount": "<p>The number of targets for which the status is Failed or Execution Timed Out.</p>" 2590 } 2591 }, 2592 "ExecutionMode": { 2593 "base": null, 2594 "refs": { 2595 "AutomationExecution$Mode": "<p>The automation execution mode.</p>", 2596 "AutomationExecutionMetadata$Mode": "<p>The Automation execution mode.</p>", 2597 "StartAutomationExecutionRequest$Mode": "<p>The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.</p>" 2598 } 2599 }, 2600 "ExecutionRoleName": { 2601 "base": null, 2602 "refs": { 2603 "TargetLocation$ExecutionRoleName": "<p>The Automation execution role used by the currently running Automation. If not specified, the default value is <code>AWS-SystemsManager-AutomationExecutionRole</code>.</p>" 2604 } 2605 }, 2606 "ExpirationDate": { 2607 "base": null, 2608 "refs": { 2609 "Activation$ExpirationDate": "<p>The date when this activation can no longer be used to register managed instances.</p>", 2610 "CreateActivationRequest$ExpirationDate": "<p>The date by which this activation request should expire, in timestamp format, such as \"2021-07-07T00:00:00\". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.</p>" 2611 } 2612 }, 2613 "FailedCreateAssociation": { 2614 "base": "<p>Describes a failed association.</p>", 2615 "refs": { 2616 "FailedCreateAssociationList$member": null 2617 } 2618 }, 2619 "FailedCreateAssociationList": { 2620 "base": null, 2621 "refs": { 2622 "CreateAssociationBatchResult$Failed": "<p>Information about the associations that failed.</p>" 2623 } 2624 }, 2625 "FailureDetails": { 2626 "base": "<p>Information about an Automation failure.</p>", 2627 "refs": { 2628 "StepExecution$FailureDetails": "<p>Information about the Automation failure.</p>" 2629 } 2630 }, 2631 "Fault": { 2632 "base": null, 2633 "refs": { 2634 "FailedCreateAssociation$Fault": "<p>The source of the failure.</p>" 2635 } 2636 }, 2637 "FeatureNotAvailableException": { 2638 "base": "<p>You attempted to register a <code>LAMBDA</code> or <code>STEP_FUNCTIONS</code> task in a region where the corresponding service isn't available. </p>", 2639 "refs": { 2640 } 2641 }, 2642 "GetAutomationExecutionRequest": { 2643 "base": null, 2644 "refs": { 2645 } 2646 }, 2647 "GetAutomationExecutionResult": { 2648 "base": null, 2649 "refs": { 2650 } 2651 }, 2652 "GetCalendarStateRequest": { 2653 "base": null, 2654 "refs": { 2655 } 2656 }, 2657 "GetCalendarStateResponse": { 2658 "base": null, 2659 "refs": { 2660 } 2661 }, 2662 "GetCommandInvocationRequest": { 2663 "base": null, 2664 "refs": { 2665 } 2666 }, 2667 "GetCommandInvocationResult": { 2668 "base": null, 2669 "refs": { 2670 } 2671 }, 2672 "GetConnectionStatusRequest": { 2673 "base": null, 2674 "refs": { 2675 } 2676 }, 2677 "GetConnectionStatusResponse": { 2678 "base": null, 2679 "refs": { 2680 } 2681 }, 2682 "GetDefaultPatchBaselineRequest": { 2683 "base": null, 2684 "refs": { 2685 } 2686 }, 2687 "GetDefaultPatchBaselineResult": { 2688 "base": null, 2689 "refs": { 2690 } 2691 }, 2692 "GetDeployablePatchSnapshotForInstanceRequest": { 2693 "base": null, 2694 "refs": { 2695 } 2696 }, 2697 "GetDeployablePatchSnapshotForInstanceResult": { 2698 "base": null, 2699 "refs": { 2700 } 2701 }, 2702 "GetDocumentRequest": { 2703 "base": null, 2704 "refs": { 2705 } 2706 }, 2707 "GetDocumentResult": { 2708 "base": null, 2709 "refs": { 2710 } 2711 }, 2712 "GetInventoryRequest": { 2713 "base": null, 2714 "refs": { 2715 } 2716 }, 2717 "GetInventoryResult": { 2718 "base": null, 2719 "refs": { 2720 } 2721 }, 2722 "GetInventorySchemaMaxResults": { 2723 "base": null, 2724 "refs": { 2725 "GetInventorySchemaRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 2726 } 2727 }, 2728 "GetInventorySchemaRequest": { 2729 "base": null, 2730 "refs": { 2731 } 2732 }, 2733 "GetInventorySchemaResult": { 2734 "base": null, 2735 "refs": { 2736 } 2737 }, 2738 "GetMaintenanceWindowExecutionRequest": { 2739 "base": null, 2740 "refs": { 2741 } 2742 }, 2743 "GetMaintenanceWindowExecutionResult": { 2744 "base": null, 2745 "refs": { 2746 } 2747 }, 2748 "GetMaintenanceWindowExecutionTaskInvocationRequest": { 2749 "base": null, 2750 "refs": { 2751 } 2752 }, 2753 "GetMaintenanceWindowExecutionTaskInvocationResult": { 2754 "base": null, 2755 "refs": { 2756 } 2757 }, 2758 "GetMaintenanceWindowExecutionTaskRequest": { 2759 "base": null, 2760 "refs": { 2761 } 2762 }, 2763 "GetMaintenanceWindowExecutionTaskResult": { 2764 "base": null, 2765 "refs": { 2766 } 2767 }, 2768 "GetMaintenanceWindowRequest": { 2769 "base": null, 2770 "refs": { 2771 } 2772 }, 2773 "GetMaintenanceWindowResult": { 2774 "base": null, 2775 "refs": { 2776 } 2777 }, 2778 "GetMaintenanceWindowTaskRequest": { 2779 "base": null, 2780 "refs": { 2781 } 2782 }, 2783 "GetMaintenanceWindowTaskResult": { 2784 "base": null, 2785 "refs": { 2786 } 2787 }, 2788 "GetOpsItemRequest": { 2789 "base": null, 2790 "refs": { 2791 } 2792 }, 2793 "GetOpsItemResponse": { 2794 "base": null, 2795 "refs": { 2796 } 2797 }, 2798 "GetOpsMetadataMaxResults": { 2799 "base": null, 2800 "refs": { 2801 "GetOpsMetadataRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 2802 } 2803 }, 2804 "GetOpsMetadataRequest": { 2805 "base": null, 2806 "refs": { 2807 } 2808 }, 2809 "GetOpsMetadataResult": { 2810 "base": null, 2811 "refs": { 2812 } 2813 }, 2814 "GetOpsSummaryRequest": { 2815 "base": null, 2816 "refs": { 2817 } 2818 }, 2819 "GetOpsSummaryResult": { 2820 "base": null, 2821 "refs": { 2822 } 2823 }, 2824 "GetParameterHistoryRequest": { 2825 "base": null, 2826 "refs": { 2827 } 2828 }, 2829 "GetParameterHistoryResult": { 2830 "base": null, 2831 "refs": { 2832 } 2833 }, 2834 "GetParameterRequest": { 2835 "base": null, 2836 "refs": { 2837 } 2838 }, 2839 "GetParameterResult": { 2840 "base": null, 2841 "refs": { 2842 } 2843 }, 2844 "GetParametersByPathMaxResults": { 2845 "base": null, 2846 "refs": { 2847 "GetParametersByPathRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 2848 } 2849 }, 2850 "GetParametersByPathRequest": { 2851 "base": null, 2852 "refs": { 2853 } 2854 }, 2855 "GetParametersByPathResult": { 2856 "base": null, 2857 "refs": { 2858 } 2859 }, 2860 "GetParametersRequest": { 2861 "base": null, 2862 "refs": { 2863 } 2864 }, 2865 "GetParametersResult": { 2866 "base": null, 2867 "refs": { 2868 } 2869 }, 2870 "GetPatchBaselineForPatchGroupRequest": { 2871 "base": null, 2872 "refs": { 2873 } 2874 }, 2875 "GetPatchBaselineForPatchGroupResult": { 2876 "base": null, 2877 "refs": { 2878 } 2879 }, 2880 "GetPatchBaselineRequest": { 2881 "base": null, 2882 "refs": { 2883 } 2884 }, 2885 "GetPatchBaselineResult": { 2886 "base": null, 2887 "refs": { 2888 } 2889 }, 2890 "GetServiceSettingRequest": { 2891 "base": "<p>The request body of the GetServiceSetting API operation.</p>", 2892 "refs": { 2893 } 2894 }, 2895 "GetServiceSettingResult": { 2896 "base": "<p>The query result body of the GetServiceSetting API operation.</p>", 2897 "refs": { 2898 } 2899 }, 2900 "HierarchyLevelLimitExceededException": { 2901 "base": "<p>A hierarchy can have a maximum of 15 levels. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html\">Requirements and constraints for parameter names</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 2902 "refs": { 2903 } 2904 }, 2905 "HierarchyTypeMismatchException": { 2906 "base": "<p>Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a <code>String</code> type to a <code>SecureString</code> type. You must create a new, unique parameter.</p>", 2907 "refs": { 2908 } 2909 }, 2910 "IPAddress": { 2911 "base": null, 2912 "refs": { 2913 "InstanceInformation$IPAddress": "<p>The IP address of the managed instance.</p>" 2914 } 2915 }, 2916 "ISO8601String": { 2917 "base": null, 2918 "refs": { 2919 "GetCalendarStateRequest$AtTime": "<p>(Optional) The specific time for which you want to get calendar state information, in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> format. If you don't specify a value or <code>AtTime</code>, the current time is used.</p>", 2920 "GetCalendarStateResponse$AtTime": "<p>The time, as an <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> string, that you specified in your command. If you don't specify a time, <code>GetCalendarState</code> uses the current time.</p>", 2921 "GetCalendarStateResponse$NextTransitionTime": "<p>The time, as an <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> string, that the calendar state will change. If the current calendar state is <code>OPEN</code>, <code>NextTransitionTime</code> indicates when the calendar state changes to <code>CLOSED</code>, and vice-versa.</p>" 2922 } 2923 }, 2924 "IamRole": { 2925 "base": null, 2926 "refs": { 2927 "Activation$IamRole": "<p>The Identity and Access Management (IAM) role to assign to the managed instance.</p>", 2928 "CreateActivationRequest$IamRole": "<p>The name of the Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal <code>ssm.amazonaws.com</code>. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html\">Create an IAM service role for a hybrid environment</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 2929 "InstanceInformation$IamRole": "<p>The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href=\"https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html\">describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>", 2930 "UpdateManagedInstanceRoleRequest$IamRole": "<p>The IAM role you want to assign or change.</p>" 2931 } 2932 }, 2933 "IdempotencyToken": { 2934 "base": null, 2935 "refs": { 2936 "StartAutomationExecutionRequest$ClientToken": "<p>User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.</p>", 2937 "StartChangeRequestExecutionRequest$ClientToken": "<p>The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.</p>" 2938 } 2939 }, 2940 "IdempotentParameterMismatch": { 2941 "base": "<p>Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token. </p>", 2942 "refs": { 2943 } 2944 }, 2945 "IncompatiblePolicyException": { 2946 "base": "<p>There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.</p>", 2947 "refs": { 2948 } 2949 }, 2950 "InstallOverrideList": { 2951 "base": null, 2952 "refs": { 2953 "InstancePatchState$InstallOverrideList": "<p>An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document <code>AWS-RunPatchBaseline</code>, overrides the patches specified by the default patch baseline.</p> <p>For more information about the <code>InstallOverrideList</code> parameter, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html\">About the <code>AWS-RunPatchBaseline</code> </a> SSM document in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 2954 } 2955 }, 2956 "InstanceAggregatedAssociationOverview": { 2957 "base": "<p>Status information about the aggregated associations.</p>", 2958 "refs": { 2959 "InstanceInformation$AssociationOverview": "<p>Information about the association.</p>" 2960 } 2961 }, 2962 "InstanceAssociation": { 2963 "base": "<p>One or more association documents on the instance. </p>", 2964 "refs": { 2965 "InstanceAssociationList$member": null 2966 } 2967 }, 2968 "InstanceAssociationExecutionSummary": { 2969 "base": null, 2970 "refs": { 2971 "InstanceAssociationStatusInfo$ExecutionSummary": "<p>Summary information about association execution.</p>" 2972 } 2973 }, 2974 "InstanceAssociationList": { 2975 "base": null, 2976 "refs": { 2977 "DescribeEffectiveInstanceAssociationsResult$Associations": "<p>The associations for the requested instance.</p>" 2978 } 2979 }, 2980 "InstanceAssociationOutputLocation": { 2981 "base": "<p>An S3 bucket where you want to store the results of this request.</p> <p>For the minimal permissions required to enable Amazon S3 output for an association, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html\">Creating associations</a> in the <i>Systems Manager User Guide</i>. </p>", 2982 "refs": { 2983 "AssociationDescription$OutputLocation": "<p>An S3 bucket where you want to store the output details of the request.</p>", 2984 "AssociationVersionInfo$OutputLocation": "<p>The location in Amazon S3 specified for the association when the association version was created.</p>", 2985 "CreateAssociationBatchRequestEntry$OutputLocation": "<p>An S3 bucket where you want to store the results of this request.</p>", 2986 "CreateAssociationRequest$OutputLocation": "<p>An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.</p>", 2987 "UpdateAssociationRequest$OutputLocation": "<p>An S3 bucket where you want to store the results of this request.</p>" 2988 } 2989 }, 2990 "InstanceAssociationOutputUrl": { 2991 "base": "<p>The URL of S3 bucket where you want to store the results of this request.</p>", 2992 "refs": { 2993 "InstanceAssociationStatusInfo$OutputUrl": "<p>A URL for an S3 bucket where you want to store the results of this request.</p>" 2994 } 2995 }, 2996 "InstanceAssociationStatusAggregatedCount": { 2997 "base": null, 2998 "refs": { 2999 "InstanceAggregatedAssociationOverview$InstanceAssociationStatusAggregatedCount": "<p>The number of associations for the instance(s).</p>" 3000 } 3001 }, 3002 "InstanceAssociationStatusInfo": { 3003 "base": "<p>Status information about the instance association.</p>", 3004 "refs": { 3005 "InstanceAssociationStatusInfos$member": null 3006 } 3007 }, 3008 "InstanceAssociationStatusInfos": { 3009 "base": null, 3010 "refs": { 3011 "DescribeInstanceAssociationsStatusResult$InstanceAssociationStatusInfos": "<p>Status information about the association.</p>" 3012 } 3013 }, 3014 "InstanceCount": { 3015 "base": null, 3016 "refs": { 3017 "AssociationStatusAggregatedCount$value": null, 3018 "InstanceAssociationStatusAggregatedCount$value": null 3019 } 3020 }, 3021 "InstanceId": { 3022 "base": null, 3023 "refs": { 3024 "Association$InstanceId": "<p>The instance ID.</p>", 3025 "AssociationDescription$InstanceId": "<p>The instance ID.</p>", 3026 "CommandInvocation$InstanceId": "<p>The instance ID in which this invocation was requested.</p>", 3027 "CreateAssociationBatchRequestEntry$InstanceId": "<p>The instance ID.</p> <note> <p> <code>InstanceId</code> has been deprecated. To specify an instance ID for an association, use the <code>Targets</code> parameter. Requests that include the parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>, <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code> parameter.</p> </note>", 3028 "CreateAssociationRequest$InstanceId": "<p>The instance ID.</p> <note> <p> <code>InstanceId</code> has been deprecated. To specify an instance ID for an association, use the <code>Targets</code> parameter. Requests that include the parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>, <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code> parameter.</p> </note>", 3029 "DeleteAssociationRequest$InstanceId": "<p>The instance ID.</p> <note> <p> <code>InstanceId</code> has been deprecated. To specify an instance ID for an association, use the <code>Targets</code> parameter. Requests that include the parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>, <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code> parameter.</p> </note>", 3030 "DescribeAssociationRequest$InstanceId": "<p>The instance ID.</p>", 3031 "DescribeEffectiveInstanceAssociationsRequest$InstanceId": "<p>The instance ID for which you want to view all associations.</p>", 3032 "DescribeInstanceAssociationsStatusRequest$InstanceId": "<p>The instance IDs for which you want association status information.</p>", 3033 "DescribeInstancePatchesRequest$InstanceId": "<p>The ID of the instance whose patch state information should be retrieved.</p>", 3034 "GetCommandInvocationRequest$InstanceId": "<p>(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.</p>", 3035 "GetCommandInvocationResult$InstanceId": "<p>The ID of the managed instance targeted by the command. A managed instance can be an EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.</p>", 3036 "GetDeployablePatchSnapshotForInstanceRequest$InstanceId": "<p>The ID of the instance for which the appropriate patch snapshot should be retrieved.</p>", 3037 "GetDeployablePatchSnapshotForInstanceResult$InstanceId": "<p>The instance ID.</p>", 3038 "InstanceAssociation$InstanceId": "<p>The instance ID.</p>", 3039 "InstanceAssociationStatusInfo$InstanceId": "<p>The instance ID where the association was created.</p>", 3040 "InstanceIdList$member": null, 3041 "InstanceInformation$InstanceId": "<p>The instance ID. </p>", 3042 "InstancePatchState$InstanceId": "<p>The ID of the managed instance the high-level patch compliance information was collected for.</p>", 3043 "ListCommandInvocationsRequest$InstanceId": "<p>(Optional) The command execution details for a specific instance ID.</p>", 3044 "ListCommandsRequest$InstanceId": "<p>(Optional) Lists commands issued against this instance ID.</p> <note> <p>You can't specify an instance ID in the same command that you specify <code>Status</code> = <code>Pending</code>. This is because the command hasn't reached the instance yet.</p> </note>", 3045 "ListInventoryEntriesRequest$InstanceId": "<p>The instance ID for which you want inventory information.</p>", 3046 "ListInventoryEntriesResult$InstanceId": "<p>The instance ID targeted by the request to query inventory information.</p>", 3047 "PutInventoryRequest$InstanceId": "<p>An instance ID where you want to add or update inventory items.</p>", 3048 "UpdateAssociationStatusRequest$InstanceId": "<p>The instance ID.</p>" 3049 } 3050 }, 3051 "InstanceIdList": { 3052 "base": null, 3053 "refs": { 3054 "CancelCommandRequest$InstanceIds": "<p>(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.</p>", 3055 "Command$InstanceIds": "<p>The instance IDs against which this command was requested.</p>", 3056 "DescribeInstancePatchStatesRequest$InstanceIds": "<p>The ID of the instance for which patch state information should be retrieved.</p>", 3057 "SendCommandRequest$InstanceIds": "<p>The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.</p> <p>To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.</p> <p>For more information about how to use targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html\">Using targets and rate controls to send commands to a fleet</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 3058 } 3059 }, 3060 "InstanceInformation": { 3061 "base": "<p>Describes a filter for a specific list of instances. </p>", 3062 "refs": { 3063 "InstanceInformationList$member": null 3064 } 3065 }, 3066 "InstanceInformationFilter": { 3067 "base": "<p>Describes a filter for a specific list of instances. You can filter instances information by using tags. You specify tags by using a key-value mapping.</p> <p>Use this operation instead of the <a>DescribeInstanceInformationRequest$InstanceInformationFilterList</a> method. The <code>InstanceInformationFilterList</code> method is a legacy method and doesn't support tags. </p>", 3068 "refs": { 3069 "InstanceInformationFilterList$member": null 3070 } 3071 }, 3072 "InstanceInformationFilterKey": { 3073 "base": null, 3074 "refs": { 3075 "InstanceInformationFilter$key": "<p>The name of the filter. </p>" 3076 } 3077 }, 3078 "InstanceInformationFilterList": { 3079 "base": null, 3080 "refs": { 3081 "DescribeInstanceInformationRequest$InstanceInformationFilterList": "<p>This is a legacy method. We recommend that you don't use this method. Instead, use the <code>Filters</code> data type. <code>Filters</code> enables you to return instance information by filtering based on tags applied to managed instances.</p> <note> <p>Attempting to use <code>InstanceInformationFilterList</code> and <code>Filters</code> leads to an exception error. </p> </note>" 3082 } 3083 }, 3084 "InstanceInformationFilterValue": { 3085 "base": null, 3086 "refs": { 3087 "InstanceInformationFilterValueSet$member": null 3088 } 3089 }, 3090 "InstanceInformationFilterValueSet": { 3091 "base": null, 3092 "refs": { 3093 "InstanceInformationFilter$valueSet": "<p>The filter values.</p>", 3094 "InstanceInformationStringFilter$Values": "<p>The filter values.</p>" 3095 } 3096 }, 3097 "InstanceInformationList": { 3098 "base": null, 3099 "refs": { 3100 "DescribeInstanceInformationResult$InstanceInformationList": "<p>The instance information list.</p>" 3101 } 3102 }, 3103 "InstanceInformationStringFilter": { 3104 "base": "<p>The filters to describe or get information about your managed instances.</p>", 3105 "refs": { 3106 "InstanceInformationStringFilterList$member": null 3107 } 3108 }, 3109 "InstanceInformationStringFilterKey": { 3110 "base": null, 3111 "refs": { 3112 "InstanceInformationStringFilter$Key": "<p>The filter key name to describe your instances. For example:</p> <p>\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag Key\"</p> <important> <p> <code>Tag key</code> isn't a valid filter. You must specify either <code>tag-key</code> or <code>tag:keyname</code> and a string. Here are some valid examples: tag-key, tag:123, tag:al!, tag:Windows. Here are some <i>invalid</i> examples: tag-keys, Tag Key, tag:, tagKey, abc:keyname.</p> </important>" 3113 } 3114 }, 3115 "InstanceInformationStringFilterList": { 3116 "base": null, 3117 "refs": { 3118 "DescribeInstanceInformationRequest$Filters": "<p>One or more filters. Use a filter to return a more specific list of instances. You can filter based on tags applied to EC2 instances. Use this <code>Filters</code> data type instead of <code>InstanceInformationFilterList</code>, which is deprecated.</p>" 3119 } 3120 }, 3121 "InstancePatchState": { 3122 "base": "<p>Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.</p>", 3123 "refs": { 3124 "InstancePatchStateList$member": null, 3125 "InstancePatchStatesList$member": null 3126 } 3127 }, 3128 "InstancePatchStateFilter": { 3129 "base": "<p>Defines a filter used in <a>DescribeInstancePatchStatesForPatchGroup</a> to scope down the information returned by the API.</p> <p> <b>Example</b>: To filter for all instances in a patch group having more than three patches with a <code>FailedCount</code> status, use the following for the filter:</p> <ul> <li> <p>Value for <code>Key</code>: <code>FailedCount</code> </p> </li> <li> <p>Value for <code>Type</code>: <code>GreaterThan</code> </p> </li> <li> <p>Value for <code>Values</code>: <code>3</code> </p> </li> </ul>", 3130 "refs": { 3131 "InstancePatchStateFilterList$member": null 3132 } 3133 }, 3134 "InstancePatchStateFilterKey": { 3135 "base": null, 3136 "refs": { 3137 "InstancePatchStateFilter$Key": "<p>The key for the filter. Supported values include the following:</p> <ul> <li> <p> <code>InstalledCount</code> </p> </li> <li> <p> <code>InstalledOtherCount</code> </p> </li> <li> <p> <code>InstalledPendingRebootCount</code> </p> </li> <li> <p> <code>InstalledRejectedCount</code> </p> </li> <li> <p> <code>MissingCount</code> </p> </li> <li> <p> <code>FailedCount</code> </p> </li> <li> <p> <code>UnreportedNotApplicableCount</code> </p> </li> <li> <p> <code>NotApplicableCount</code> </p> </li> </ul>" 3138 } 3139 }, 3140 "InstancePatchStateFilterList": { 3141 "base": null, 3142 "refs": { 3143 "DescribeInstancePatchStatesForPatchGroupRequest$Filters": "<p>Each entry in the array is a structure containing:</p> <ul> <li> <p>Key (string between 1 and 200 characters)</p> </li> <li> <p>Values (array containing a single string)</p> </li> <li> <p>Type (string \"Equal\", \"NotEqual\", \"LessThan\", \"GreaterThan\")</p> </li> </ul>" 3144 } 3145 }, 3146 "InstancePatchStateFilterValue": { 3147 "base": null, 3148 "refs": { 3149 "InstancePatchStateFilterValues$member": null 3150 } 3151 }, 3152 "InstancePatchStateFilterValues": { 3153 "base": null, 3154 "refs": { 3155 "InstancePatchStateFilter$Values": "<p>The value for the filter. Must be an integer greater than or equal to 0.</p>" 3156 } 3157 }, 3158 "InstancePatchStateList": { 3159 "base": null, 3160 "refs": { 3161 "DescribeInstancePatchStatesResult$InstancePatchStates": "<p>The high-level patch state for the requested instances.</p>" 3162 } 3163 }, 3164 "InstancePatchStateOperatorType": { 3165 "base": null, 3166 "refs": { 3167 "InstancePatchStateFilter$Type": "<p>The type of comparison that should be performed for the value.</p>" 3168 } 3169 }, 3170 "InstancePatchStatesList": { 3171 "base": null, 3172 "refs": { 3173 "DescribeInstancePatchStatesForPatchGroupResult$InstancePatchStates": "<p>The high-level patch state for the requested instances. </p>" 3174 } 3175 }, 3176 "InstanceTagName": { 3177 "base": null, 3178 "refs": { 3179 "CommandInvocation$InstanceName": "<p>The fully qualified host name of the managed instance.</p>" 3180 } 3181 }, 3182 "InstancesCount": { 3183 "base": null, 3184 "refs": { 3185 "DescribePatchGroupStateResult$InstancesWithInstalledPendingRebootPatches": "<p>The number of instances with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these instances is <code>NON_COMPLIANT</code>.</p>", 3186 "DescribePatchGroupStateResult$InstancesWithInstalledRejectedPatches": "<p>The number of instances with patches installed that are specified in a <code>RejectedPatches</code> list. Patches with a status of <code>INSTALLED_REJECTED</code> were typically installed before they were added to a <code>RejectedPatches</code> list.</p> <note> <p>If <code>ALLOW_AS_DEPENDENCY</code> is the specified option for <code>RejectedPatchesAction</code>, the value of <code>InstancesWithInstalledRejectedPatches</code> will always be <code>0</code> (zero).</p> </note>", 3187 "DescribePatchGroupStateResult$InstancesWithCriticalNonCompliantPatches": "<p>The number of instances where patches that are specified as <code>Critical</code> for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is <code>NON_COMPLIANT</code>.</p>", 3188 "DescribePatchGroupStateResult$InstancesWithSecurityNonCompliantPatches": "<p>The number of instances where patches that are specified as <code>Security</code> in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is <code>NON_COMPLIANT</code>.</p>", 3189 "DescribePatchGroupStateResult$InstancesWithOtherNonCompliantPatches": "<p>The number of instances with patches installed that are specified as other than <code>Critical</code> or <code>Security</code> but aren't compliant with the patch baseline. The status of these instances is <code>NON_COMPLIANT</code>.</p>" 3190 } 3191 }, 3192 "Integer": { 3193 "base": null, 3194 "refs": { 3195 "DescribePatchGroupStateResult$Instances": "<p>The number of instances in the patch group.</p>", 3196 "DescribePatchGroupStateResult$InstancesWithInstalledPatches": "<p>The number of instances with installed patches.</p>", 3197 "DescribePatchGroupStateResult$InstancesWithInstalledOtherPatches": "<p>The number of instances with patches installed that aren't defined in the patch baseline.</p>", 3198 "DescribePatchGroupStateResult$InstancesWithMissingPatches": "<p>The number of instances with missing patches from the patch baseline.</p>", 3199 "DescribePatchGroupStateResult$InstancesWithFailedPatches": "<p>The number of instances with patches from the patch baseline that failed to install.</p>", 3200 "DescribePatchGroupStateResult$InstancesWithNotApplicablePatches": "<p>The number of instances with patches that aren't applicable.</p>", 3201 "DescribePatchGroupStateResult$InstancesWithUnreportedNotApplicablePatches": "<p>The number of instances with <code>NotApplicable</code> patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.</p>", 3202 "OpsItemLimitExceededException$Limit": null, 3203 "ProgressCounters$TotalSteps": "<p>The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.</p>", 3204 "ProgressCounters$SuccessSteps": "<p>The total number of steps that successfully completed in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.</p>", 3205 "ProgressCounters$FailedSteps": "<p>The total number of steps that failed to run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.</p>", 3206 "ProgressCounters$CancelledSteps": "<p>The total number of steps that the system cancelled in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.</p>", 3207 "ProgressCounters$TimedOutSteps": "<p>The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.</p>", 3208 "StepExecution$MaxAttempts": "<p>The maximum number of tries to run the action of the step. The default value is <code>1</code>.</p>" 3209 } 3210 }, 3211 "InternalServerError": { 3212 "base": "<p>An error occurred on the server side.</p>", 3213 "refs": { 3214 } 3215 }, 3216 "InvalidActivation": { 3217 "base": "<p>The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.</p>", 3218 "refs": { 3219 } 3220 }, 3221 "InvalidActivationId": { 3222 "base": "<p>The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.</p>", 3223 "refs": { 3224 } 3225 }, 3226 "InvalidAggregatorException": { 3227 "base": "<p>The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as <code>AWS:Application</code> or <code>AWS:InstanceInformation</code>.</p>", 3228 "refs": { 3229 } 3230 }, 3231 "InvalidAllowedPatternException": { 3232 "base": "<p>The request doesn't meet the regular expression requirement.</p>", 3233 "refs": { 3234 } 3235 }, 3236 "InvalidAssociation": { 3237 "base": "<p>The association isn't valid or doesn't exist. </p>", 3238 "refs": { 3239 } 3240 }, 3241 "InvalidAssociationVersion": { 3242 "base": "<p>The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the <code>$LATEST</code> parameter to view the latest version of the association.</p>", 3243 "refs": { 3244 } 3245 }, 3246 "InvalidAutomationExecutionParametersException": { 3247 "base": "<p>The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.</p>", 3248 "refs": { 3249 } 3250 }, 3251 "InvalidAutomationSignalException": { 3252 "base": "<p>The signal isn't valid for the current Automation execution.</p>", 3253 "refs": { 3254 } 3255 }, 3256 "InvalidAutomationStatusUpdateException": { 3257 "base": "<p>The specified update status operation isn't valid.</p>", 3258 "refs": { 3259 } 3260 }, 3261 "InvalidCommandId": { 3262 "base": "<p>The specified command ID isn't valid. Verify the ID and try again.</p>", 3263 "refs": { 3264 } 3265 }, 3266 "InvalidDeleteInventoryParametersException": { 3267 "base": "<p>One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.</p>", 3268 "refs": { 3269 } 3270 }, 3271 "InvalidDeletionIdException": { 3272 "base": "<p>The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.</p>", 3273 "refs": { 3274 } 3275 }, 3276 "InvalidDocument": { 3277 "base": "<p>The specified SSM document doesn't exist.</p>", 3278 "refs": { 3279 } 3280 }, 3281 "InvalidDocumentContent": { 3282 "base": "<p>The content for the document isn't valid.</p>", 3283 "refs": { 3284 } 3285 }, 3286 "InvalidDocumentOperation": { 3287 "base": "<p>You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.</p>", 3288 "refs": { 3289 } 3290 }, 3291 "InvalidDocumentSchemaVersion": { 3292 "base": "<p>The version of the document schema isn't supported.</p>", 3293 "refs": { 3294 } 3295 }, 3296 "InvalidDocumentType": { 3297 "base": "<p>The SSM document type isn't valid. Valid document types are described in the <code>DocumentType</code> property.</p>", 3298 "refs": { 3299 } 3300 }, 3301 "InvalidDocumentVersion": { 3302 "base": "<p>The document version isn't valid or doesn't exist.</p>", 3303 "refs": { 3304 } 3305 }, 3306 "InvalidFilter": { 3307 "base": "<p>The filter name isn't valid. Verify the you entered the correct name and try again.</p>", 3308 "refs": { 3309 } 3310 }, 3311 "InvalidFilterKey": { 3312 "base": "<p>The specified key isn't valid.</p>", 3313 "refs": { 3314 } 3315 }, 3316 "InvalidFilterOption": { 3317 "base": "<p>The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.</p>", 3318 "refs": { 3319 } 3320 }, 3321 "InvalidFilterValue": { 3322 "base": "<p>The filter value isn't valid. Verify the value and try again.</p>", 3323 "refs": { 3324 } 3325 }, 3326 "InvalidInstanceId": { 3327 "base": "<p>The following problems can cause this exception:</p> <ul> <li> <p>You don't have permission to access the instance.</p> </li> <li> <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.</p> </li> <li> <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p> </li> <li> <p>The instance isn't in valid state. Valid states are: <code>Running</code>, <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are: <code>Shutting-down</code> and <code>Terminated</code>.</p> </li> </ul>", 3328 "refs": { 3329 } 3330 }, 3331 "InvalidInstanceInformationFilterValue": { 3332 "base": "<p>The specified filter value isn't valid.</p>", 3333 "refs": { 3334 } 3335 }, 3336 "InvalidInventoryGroupException": { 3337 "base": "<p>The specified inventory group isn't valid.</p>", 3338 "refs": { 3339 } 3340 }, 3341 "InvalidInventoryItemContextException": { 3342 "base": "<p>You specified invalid keys or values in the <code>Context</code> attribute for <code>InventoryItem</code>. Verify the keys and values, and try again.</p>", 3343 "refs": { 3344 } 3345 }, 3346 "InvalidInventoryRequestException": { 3347 "base": "<p>The request isn't valid.</p>", 3348 "refs": { 3349 } 3350 }, 3351 "InvalidItemContentException": { 3352 "base": "<p>One or more content items isn't valid.</p>", 3353 "refs": { 3354 } 3355 }, 3356 "InvalidKeyId": { 3357 "base": "<p>The query key ID isn't valid.</p>", 3358 "refs": { 3359 } 3360 }, 3361 "InvalidNextToken": { 3362 "base": "<p>The specified token isn't valid.</p>", 3363 "refs": { 3364 } 3365 }, 3366 "InvalidNotificationConfig": { 3367 "base": "<p>One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.</p>", 3368 "refs": { 3369 } 3370 }, 3371 "InvalidOptionException": { 3372 "base": "<p>The delete inventory option specified isn't valid. Verify the option and try again.</p>", 3373 "refs": { 3374 } 3375 }, 3376 "InvalidOutputFolder": { 3377 "base": "<p>The S3 bucket doesn't exist.</p>", 3378 "refs": { 3379 } 3380 }, 3381 "InvalidOutputLocation": { 3382 "base": "<p>The output location isn't valid or doesn't exist.</p>", 3383 "refs": { 3384 } 3385 }, 3386 "InvalidParameters": { 3387 "base": "<p>You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.</p>", 3388 "refs": { 3389 } 3390 }, 3391 "InvalidPermissionType": { 3392 "base": "<p>The permission type isn't supported. <i>Share</i> is the only supported permission type.</p>", 3393 "refs": { 3394 } 3395 }, 3396 "InvalidPluginName": { 3397 "base": "<p>The plugin name isn't valid.</p>", 3398 "refs": { 3399 } 3400 }, 3401 "InvalidPolicyAttributeException": { 3402 "base": "<p>A policy attribute or its value is invalid. </p>", 3403 "refs": { 3404 } 3405 }, 3406 "InvalidPolicyTypeException": { 3407 "base": "<p>The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.</p>", 3408 "refs": { 3409 } 3410 }, 3411 "InvalidResourceId": { 3412 "base": "<p>The resource ID isn't valid. Verify that you entered the correct ID and try again.</p>", 3413 "refs": { 3414 } 3415 }, 3416 "InvalidResourceType": { 3417 "base": "<p>The resource type isn't valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.</p>", 3418 "refs": { 3419 } 3420 }, 3421 "InvalidResultAttributeException": { 3422 "base": "<p>The specified inventory item result attribute isn't valid.</p>", 3423 "refs": { 3424 } 3425 }, 3426 "InvalidRole": { 3427 "base": "<p>The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/rc-sns-notifications.html\">Configuring Amazon SNS Notifications for Run Command</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 3428 "refs": { 3429 } 3430 }, 3431 "InvalidSchedule": { 3432 "base": "<p>The schedule is invalid. Verify your cron or rate expression and try again.</p>", 3433 "refs": { 3434 } 3435 }, 3436 "InvalidTarget": { 3437 "base": "<p>The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.</p>", 3438 "refs": { 3439 } 3440 }, 3441 "InvalidTypeNameException": { 3442 "base": "<p>The parameter type name isn't valid.</p>", 3443 "refs": { 3444 } 3445 }, 3446 "InvalidUpdate": { 3447 "base": "<p>The update isn't valid.</p>", 3448 "refs": { 3449 } 3450 }, 3451 "InventoryAggregator": { 3452 "base": "<p>Specifies the inventory type and attribute for the aggregation execution.</p>", 3453 "refs": { 3454 "InventoryAggregatorList$member": null 3455 } 3456 }, 3457 "InventoryAggregatorExpression": { 3458 "base": null, 3459 "refs": { 3460 "InventoryAggregator$Expression": "<p>The inventory type and attribute name for aggregation.</p>" 3461 } 3462 }, 3463 "InventoryAggregatorList": { 3464 "base": null, 3465 "refs": { 3466 "GetInventoryRequest$Aggregators": "<p>Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the <code>AWS:InstanceInformation.PlatformType</code> type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet.</p>", 3467 "InventoryAggregator$Aggregators": "<p>Nested aggregators to further refine aggregation for an inventory type.</p>" 3468 } 3469 }, 3470 "InventoryAttributeDataType": { 3471 "base": null, 3472 "refs": { 3473 "InventoryItemAttribute$DataType": "<p>The data type of the inventory item attribute. </p>" 3474 } 3475 }, 3476 "InventoryDeletionLastStatusMessage": { 3477 "base": null, 3478 "refs": { 3479 "InventoryDeletionStatusItem$LastStatusMessage": "<p>Information about the status.</p>" 3480 } 3481 }, 3482 "InventoryDeletionLastStatusUpdateTime": { 3483 "base": null, 3484 "refs": { 3485 "InventoryDeletionStatusItem$LastStatusUpdateTime": "<p>The UTC timestamp of when the last status report.</p>" 3486 } 3487 }, 3488 "InventoryDeletionStartTime": { 3489 "base": null, 3490 "refs": { 3491 "InventoryDeletionStatusItem$DeletionStartTime": "<p>The UTC timestamp when the delete operation started.</p>" 3492 } 3493 }, 3494 "InventoryDeletionStatus": { 3495 "base": null, 3496 "refs": { 3497 "InventoryDeletionStatusItem$LastStatus": "<p>The status of the operation. Possible values are InProgress and Complete.</p>" 3498 } 3499 }, 3500 "InventoryDeletionStatusItem": { 3501 "base": "<p>Status information returned by the <code>DeleteInventory</code> operation.</p>", 3502 "refs": { 3503 "InventoryDeletionsList$member": null 3504 } 3505 }, 3506 "InventoryDeletionSummary": { 3507 "base": "<p>Information about the delete operation.</p>", 3508 "refs": { 3509 "DeleteInventoryResult$DeletionSummary": "<p>A summary of the delete operation. For more information about this summary, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete-summary\">Deleting custom inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 3510 "InventoryDeletionStatusItem$DeletionSummary": "<p>Information about the delete operation. For more information about this summary, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete\">Understanding the delete inventory summary</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 3511 } 3512 }, 3513 "InventoryDeletionSummaryItem": { 3514 "base": "<p>Either a count, remaining count, or a version number in a delete inventory summary.</p>", 3515 "refs": { 3516 "InventoryDeletionSummaryItems$member": null 3517 } 3518 }, 3519 "InventoryDeletionSummaryItems": { 3520 "base": null, 3521 "refs": { 3522 "InventoryDeletionSummary$SummaryItems": "<p>A list of counts and versions for deleted items.</p>" 3523 } 3524 }, 3525 "InventoryDeletionsList": { 3526 "base": null, 3527 "refs": { 3528 "DescribeInventoryDeletionsResult$InventoryDeletions": "<p>A list of status items for deleted inventory.</p>" 3529 } 3530 }, 3531 "InventoryFilter": { 3532 "base": "<p>One or more filters. Use a filter to return a more specific list of results.</p>", 3533 "refs": { 3534 "InventoryFilterList$member": null 3535 } 3536 }, 3537 "InventoryFilterKey": { 3538 "base": null, 3539 "refs": { 3540 "InventoryFilter$Key": "<p>The name of the filter key.</p>" 3541 } 3542 }, 3543 "InventoryFilterList": { 3544 "base": null, 3545 "refs": { 3546 "GetInventoryRequest$Filters": "<p>One or more filters. Use a filter to return a more specific list of results.</p>", 3547 "InventoryGroup$Filters": "<p>Filters define the criteria for the group. The <code>matchingCount</code> field displays the number of resources that match the criteria. The <code>notMatchingCount</code> field displays the number of resources that don't match the criteria. </p>", 3548 "ListInventoryEntriesRequest$Filters": "<p>One or more filters. Use a filter to return a more specific list of results.</p>" 3549 } 3550 }, 3551 "InventoryFilterValue": { 3552 "base": null, 3553 "refs": { 3554 "InventoryFilterValueList$member": null 3555 } 3556 }, 3557 "InventoryFilterValueList": { 3558 "base": null, 3559 "refs": { 3560 "InventoryFilter$Values": "<p>Inventory filter values. Example: inventory filter where instance IDs are specified as values <code>Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal</code>. </p>" 3561 } 3562 }, 3563 "InventoryGroup": { 3564 "base": "<p>A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.</p>", 3565 "refs": { 3566 "InventoryGroupList$member": null 3567 } 3568 }, 3569 "InventoryGroupList": { 3570 "base": null, 3571 "refs": { 3572 "InventoryAggregator$Groups": "<p>A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.</p>" 3573 } 3574 }, 3575 "InventoryGroupName": { 3576 "base": null, 3577 "refs": { 3578 "InventoryGroup$Name": "<p>The name of the group.</p>" 3579 } 3580 }, 3581 "InventoryItem": { 3582 "base": "<p>Information collected from managed instances based on your inventory policy document</p>", 3583 "refs": { 3584 "InventoryItemList$member": null 3585 } 3586 }, 3587 "InventoryItemAttribute": { 3588 "base": "<p>Attributes are the entries within the inventory item content. It contains name and value.</p>", 3589 "refs": { 3590 "InventoryItemAttributeList$member": null 3591 } 3592 }, 3593 "InventoryItemAttributeList": { 3594 "base": null, 3595 "refs": { 3596 "InventoryItemSchema$Attributes": "<p>The schema attributes for inventory. This contains data type and attribute name.</p>" 3597 } 3598 }, 3599 "InventoryItemAttributeName": { 3600 "base": null, 3601 "refs": { 3602 "InventoryItemAttribute$Name": "<p>Name of the inventory item attribute.</p>" 3603 } 3604 }, 3605 "InventoryItemCaptureTime": { 3606 "base": null, 3607 "refs": { 3608 "InventoryItem$CaptureTime": "<p>The time the inventory information was collected.</p>", 3609 "InventoryResultItem$CaptureTime": "<p>The time inventory item data was captured.</p>", 3610 "ListInventoryEntriesResult$CaptureTime": "<p>The time that inventory information was collected for the instance(s).</p>" 3611 } 3612 }, 3613 "InventoryItemContentContext": { 3614 "base": null, 3615 "refs": { 3616 "InventoryItem$Context": "<p>A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the <code>ExecutionId</code>, <code>ExecutionType</code>, <code>ComplianceType</code> properties of the <code>AWS:ComplianceItem</code> type.</p>" 3617 } 3618 }, 3619 "InventoryItemContentHash": { 3620 "base": null, 3621 "refs": { 3622 "InventoryItem$ContentHash": "<p>MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update. </p>", 3623 "InventoryResultItem$ContentHash": "<p>MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update. </p>" 3624 } 3625 }, 3626 "InventoryItemEntry": { 3627 "base": null, 3628 "refs": { 3629 "InventoryItemEntryList$member": null 3630 } 3631 }, 3632 "InventoryItemEntryList": { 3633 "base": null, 3634 "refs": { 3635 "InventoryItem$Content": "<p>The inventory data of the inventory type.</p>", 3636 "InventoryResultItem$Content": "<p>Contains all the inventory data of the item type. Results include attribute names and values. </p>", 3637 "ListInventoryEntriesResult$Entries": "<p>A list of inventory items on the instance(s).</p>" 3638 } 3639 }, 3640 "InventoryItemList": { 3641 "base": null, 3642 "refs": { 3643 "PutInventoryRequest$Items": "<p>The inventory items that you want to add or update on instances.</p>" 3644 } 3645 }, 3646 "InventoryItemSchema": { 3647 "base": "<p>The inventory item schema definition. Users can use this to compose inventory query filters.</p>", 3648 "refs": { 3649 "InventoryItemSchemaResultList$member": null 3650 } 3651 }, 3652 "InventoryItemSchemaResultList": { 3653 "base": null, 3654 "refs": { 3655 "GetInventorySchemaResult$Schemas": "<p>Inventory schemas returned by the request.</p>" 3656 } 3657 }, 3658 "InventoryItemSchemaVersion": { 3659 "base": null, 3660 "refs": { 3661 "InventoryDeletionSummaryItem$Version": "<p>The inventory type version.</p>", 3662 "InventoryItem$SchemaVersion": "<p>The schema version for the inventory item.</p>", 3663 "InventoryItemSchema$Version": "<p>The schema version for the inventory item.</p>", 3664 "InventoryResultItem$SchemaVersion": "<p>The schema version for the inventory result item/</p>", 3665 "ListInventoryEntriesResult$SchemaVersion": "<p>The inventory schema version used by the instance(s).</p>" 3666 } 3667 }, 3668 "InventoryItemTypeName": { 3669 "base": null, 3670 "refs": { 3671 "DeleteInventoryRequest$TypeName": "<p>The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself. </p>", 3672 "DeleteInventoryResult$TypeName": "<p>The name of the inventory data type specified in the request.</p>", 3673 "InvalidItemContentException$TypeName": null, 3674 "InventoryDeletionStatusItem$TypeName": "<p>The name of the inventory data type.</p>", 3675 "InventoryItem$TypeName": "<p>The name of the inventory type. Default inventory item type names start with <code>AWS</code>. Custom inventory type names will start with Custom. Default inventory item types include the following: <code>AWS:AWSComponent</code>, <code>AWS:Application</code>, <code>AWS:InstanceInformation</code>, <code>AWS:Network</code>, and <code>AWS:WindowsUpdate</code>.</p>", 3676 "InventoryItemSchema$TypeName": "<p>The name of the inventory type. Default inventory item type names start with Amazon Web Services. Custom inventory type names will start with Custom. Default inventory item types include the following: <code>AWS:AWSComponent</code>, <code>AWS:Application</code>, <code>AWS:InstanceInformation</code>, <code>AWS:Network</code>, and <code>AWS:WindowsUpdate</code>.</p>", 3677 "InventoryResultItem$TypeName": "<p>The name of the inventory result item type.</p>", 3678 "ItemContentMismatchException$TypeName": null, 3679 "ItemSizeLimitExceededException$TypeName": null, 3680 "ListInventoryEntriesRequest$TypeName": "<p>The type of inventory item for which you want information.</p>", 3681 "ListInventoryEntriesResult$TypeName": "<p>The type of inventory item returned by the request.</p>", 3682 "ResultAttribute$TypeName": "<p>Name of the inventory item type. Valid value: <code>AWS:InstanceInformation</code>. Default Value: <code>AWS:InstanceInformation</code>.</p>", 3683 "UnsupportedInventoryItemContextException$TypeName": null 3684 } 3685 }, 3686 "InventoryItemTypeNameFilter": { 3687 "base": null, 3688 "refs": { 3689 "GetInventorySchemaRequest$TypeName": "<p>The type of inventory item to return.</p>" 3690 } 3691 }, 3692 "InventoryQueryOperatorType": { 3693 "base": null, 3694 "refs": { 3695 "InventoryFilter$Type": "<p>The type of filter.</p> <note> <p>The <code>Exists</code> filter must be used with aggregators. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html\">Aggregating inventory data</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note>" 3696 } 3697 }, 3698 "InventoryResultEntity": { 3699 "base": "<p>Inventory query results.</p>", 3700 "refs": { 3701 "InventoryResultEntityList$member": null 3702 } 3703 }, 3704 "InventoryResultEntityId": { 3705 "base": null, 3706 "refs": { 3707 "InventoryResultEntity$Id": "<p>ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID. </p>" 3708 } 3709 }, 3710 "InventoryResultEntityList": { 3711 "base": null, 3712 "refs": { 3713 "GetInventoryResult$Entities": "<p>Collection of inventory entities such as a collection of instance inventory. </p>" 3714 } 3715 }, 3716 "InventoryResultItem": { 3717 "base": "<p>The inventory result item.</p>", 3718 "refs": { 3719 "InventoryResultItemMap$value": null 3720 } 3721 }, 3722 "InventoryResultItemKey": { 3723 "base": null, 3724 "refs": { 3725 "InventoryResultItemMap$key": null 3726 } 3727 }, 3728 "InventoryResultItemMap": { 3729 "base": null, 3730 "refs": { 3731 "InventoryResultEntity$Data": "<p>The data section in the inventory result entity JSON.</p>" 3732 } 3733 }, 3734 "InventorySchemaDeleteOption": { 3735 "base": null, 3736 "refs": { 3737 "DeleteInventoryRequest$SchemaDeleteOption": "<p>Use the <code>SchemaDeleteOption</code> to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:</p> <p>DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the <code>PutInventory</code> operation for a version greater than the disabled version.</p> <p>DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.</p>" 3738 } 3739 }, 3740 "InventoryTypeDisplayName": { 3741 "base": null, 3742 "refs": { 3743 "InventoryItemSchema$DisplayName": "<p>The alias name of the inventory type. The alias name is used for display purposes.</p>" 3744 } 3745 }, 3746 "InvocationDoesNotExist": { 3747 "base": "<p>The command ID and instance ID you specified didn't match any invocations. Verify the command ID and the instance ID and try again. </p>", 3748 "refs": { 3749 } 3750 }, 3751 "InvocationTraceOutput": { 3752 "base": null, 3753 "refs": { 3754 "CommandInvocation$TraceOutput": "<p> Gets the trace output sent by the agent. </p>" 3755 } 3756 }, 3757 "IsSubTypeSchema": { 3758 "base": null, 3759 "refs": { 3760 "GetInventorySchemaRequest$SubType": "<p>Returns the sub-type schema for a specified inventory type.</p>" 3761 } 3762 }, 3763 "ItemContentMismatchException": { 3764 "base": "<p>The inventory item has invalid content. </p>", 3765 "refs": { 3766 } 3767 }, 3768 "ItemSizeLimitExceededException": { 3769 "base": "<p>The inventory item size has exceeded the size limit.</p>", 3770 "refs": { 3771 } 3772 }, 3773 "KeyList": { 3774 "base": null, 3775 "refs": { 3776 "RemoveTagsFromResourceRequest$TagKeys": "<p>Tag keys that you want to remove from the specified resource.</p>" 3777 } 3778 }, 3779 "LabelParameterVersionRequest": { 3780 "base": null, 3781 "refs": { 3782 } 3783 }, 3784 "LabelParameterVersionResult": { 3785 "base": null, 3786 "refs": { 3787 } 3788 }, 3789 "LastResourceDataSyncMessage": { 3790 "base": null, 3791 "refs": { 3792 "ResourceDataSyncItem$LastSyncStatusMessage": "<p>The status message details reported by the last sync.</p>" 3793 } 3794 }, 3795 "LastResourceDataSyncStatus": { 3796 "base": null, 3797 "refs": { 3798 "ResourceDataSyncItem$LastStatus": "<p>The status reported by the last sync.</p>" 3799 } 3800 }, 3801 "LastResourceDataSyncTime": { 3802 "base": null, 3803 "refs": { 3804 "ResourceDataSyncItem$LastSyncTime": "<p>The last time the configuration attempted to sync (UTC).</p>" 3805 } 3806 }, 3807 "LastSuccessfulResourceDataSyncTime": { 3808 "base": null, 3809 "refs": { 3810 "ResourceDataSyncItem$LastSuccessfulSyncTime": "<p>The last time the sync operations returned a status of <code>SUCCESSFUL</code> (UTC).</p>" 3811 } 3812 }, 3813 "ListAssociationVersionsRequest": { 3814 "base": null, 3815 "refs": { 3816 } 3817 }, 3818 "ListAssociationVersionsResult": { 3819 "base": null, 3820 "refs": { 3821 } 3822 }, 3823 "ListAssociationsRequest": { 3824 "base": null, 3825 "refs": { 3826 } 3827 }, 3828 "ListAssociationsResult": { 3829 "base": null, 3830 "refs": { 3831 } 3832 }, 3833 "ListCommandInvocationsRequest": { 3834 "base": null, 3835 "refs": { 3836 } 3837 }, 3838 "ListCommandInvocationsResult": { 3839 "base": null, 3840 "refs": { 3841 } 3842 }, 3843 "ListCommandsRequest": { 3844 "base": null, 3845 "refs": { 3846 } 3847 }, 3848 "ListCommandsResult": { 3849 "base": null, 3850 "refs": { 3851 } 3852 }, 3853 "ListComplianceItemsRequest": { 3854 "base": null, 3855 "refs": { 3856 } 3857 }, 3858 "ListComplianceItemsResult": { 3859 "base": null, 3860 "refs": { 3861 } 3862 }, 3863 "ListComplianceSummariesRequest": { 3864 "base": null, 3865 "refs": { 3866 } 3867 }, 3868 "ListComplianceSummariesResult": { 3869 "base": null, 3870 "refs": { 3871 } 3872 }, 3873 "ListDocumentMetadataHistoryRequest": { 3874 "base": null, 3875 "refs": { 3876 } 3877 }, 3878 "ListDocumentMetadataHistoryResponse": { 3879 "base": null, 3880 "refs": { 3881 } 3882 }, 3883 "ListDocumentVersionsRequest": { 3884 "base": null, 3885 "refs": { 3886 } 3887 }, 3888 "ListDocumentVersionsResult": { 3889 "base": null, 3890 "refs": { 3891 } 3892 }, 3893 "ListDocumentsRequest": { 3894 "base": null, 3895 "refs": { 3896 } 3897 }, 3898 "ListDocumentsResult": { 3899 "base": null, 3900 "refs": { 3901 } 3902 }, 3903 "ListInventoryEntriesRequest": { 3904 "base": null, 3905 "refs": { 3906 } 3907 }, 3908 "ListInventoryEntriesResult": { 3909 "base": null, 3910 "refs": { 3911 } 3912 }, 3913 "ListOpsItemEventsRequest": { 3914 "base": null, 3915 "refs": { 3916 } 3917 }, 3918 "ListOpsItemEventsResponse": { 3919 "base": null, 3920 "refs": { 3921 } 3922 }, 3923 "ListOpsItemRelatedItemsRequest": { 3924 "base": null, 3925 "refs": { 3926 } 3927 }, 3928 "ListOpsItemRelatedItemsResponse": { 3929 "base": null, 3930 "refs": { 3931 } 3932 }, 3933 "ListOpsMetadataMaxResults": { 3934 "base": null, 3935 "refs": { 3936 "ListOpsMetadataRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 3937 } 3938 }, 3939 "ListOpsMetadataRequest": { 3940 "base": null, 3941 "refs": { 3942 } 3943 }, 3944 "ListOpsMetadataResult": { 3945 "base": null, 3946 "refs": { 3947 } 3948 }, 3949 "ListResourceComplianceSummariesRequest": { 3950 "base": null, 3951 "refs": { 3952 } 3953 }, 3954 "ListResourceComplianceSummariesResult": { 3955 "base": null, 3956 "refs": { 3957 } 3958 }, 3959 "ListResourceDataSyncRequest": { 3960 "base": null, 3961 "refs": { 3962 } 3963 }, 3964 "ListResourceDataSyncResult": { 3965 "base": null, 3966 "refs": { 3967 } 3968 }, 3969 "ListTagsForResourceRequest": { 3970 "base": null, 3971 "refs": { 3972 } 3973 }, 3974 "ListTagsForResourceResult": { 3975 "base": null, 3976 "refs": { 3977 } 3978 }, 3979 "LoggingInfo": { 3980 "base": "<p>Information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 3981 "refs": { 3982 "GetMaintenanceWindowTaskResult$LoggingInfo": "<p>The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 3983 "MaintenanceWindowTask$LoggingInfo": "<p>Information about an S3 bucket to write task-level logs to.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 3984 "RegisterTaskWithMaintenanceWindowRequest$LoggingInfo": "<p>A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write instance-level logs to. </p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 3985 "UpdateMaintenanceWindowTaskRequest$LoggingInfo": "<p>The new logging location in Amazon S3 to specify.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 3986 "UpdateMaintenanceWindowTaskResult$LoggingInfo": "<p>The updated logging information in Amazon S3.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>" 3987 } 3988 }, 3989 "Long": { 3990 "base": null, 3991 "refs": { 3992 "StepExecution$TimeoutSeconds": "<p>The timeout seconds of the step.</p>" 3993 } 3994 }, 3995 "MaintenanceWindowAllowUnassociatedTargets": { 3996 "base": null, 3997 "refs": { 3998 "CreateMaintenanceWindowRequest$AllowUnassociatedTargets": "<p>Enables a maintenance window task to run on managed instances, even if you haven't registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.</p> <p>If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.</p>", 3999 "GetMaintenanceWindowResult$AllowUnassociatedTargets": "<p>Whether targets must be registered with the maintenance window before tasks can be defined for those targets.</p>", 4000 "UpdateMaintenanceWindowRequest$AllowUnassociatedTargets": "<p>Whether targets must be registered with the maintenance window before tasks can be defined for those targets.</p>", 4001 "UpdateMaintenanceWindowResult$AllowUnassociatedTargets": "<p>Whether targets must be registered with the maintenance window before tasks can be defined for those targets.</p>" 4002 } 4003 }, 4004 "MaintenanceWindowAutomationParameters": { 4005 "base": "<p>The parameters for an <code>AUTOMATION</code> task type.</p>", 4006 "refs": { 4007 "MaintenanceWindowTaskInvocationParameters$Automation": "<p>The parameters for an <code>AUTOMATION</code> task type.</p>" 4008 } 4009 }, 4010 "MaintenanceWindowCutoff": { 4011 "base": null, 4012 "refs": { 4013 "CreateMaintenanceWindowRequest$Cutoff": "<p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</p>", 4014 "GetMaintenanceWindowResult$Cutoff": "<p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</p>", 4015 "MaintenanceWindowIdentity$Cutoff": "<p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</p>", 4016 "UpdateMaintenanceWindowRequest$Cutoff": "<p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</p>", 4017 "UpdateMaintenanceWindowResult$Cutoff": "<p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.</p>" 4018 } 4019 }, 4020 "MaintenanceWindowDescription": { 4021 "base": null, 4022 "refs": { 4023 "CreateMaintenanceWindowRequest$Description": "<p>An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows. </p>", 4024 "GetMaintenanceWindowResult$Description": "<p>The description of the maintenance window.</p>", 4025 "GetMaintenanceWindowTaskResult$Description": "<p>The retrieved task description.</p>", 4026 "MaintenanceWindowIdentity$Description": "<p>A description of the maintenance window.</p>", 4027 "MaintenanceWindowTarget$Description": "<p>A description for the target.</p>", 4028 "MaintenanceWindowTask$Description": "<p>A description of the task.</p>", 4029 "RegisterTargetWithMaintenanceWindowRequest$Description": "<p>An optional description for the target.</p>", 4030 "RegisterTaskWithMaintenanceWindowRequest$Description": "<p>An optional description for the task.</p>", 4031 "UpdateMaintenanceWindowRequest$Description": "<p>An optional description for the update request.</p>", 4032 "UpdateMaintenanceWindowResult$Description": "<p>An optional description of the update.</p>", 4033 "UpdateMaintenanceWindowTargetRequest$Description": "<p>An optional description for the update.</p>", 4034 "UpdateMaintenanceWindowTargetResult$Description": "<p>The updated description.</p>", 4035 "UpdateMaintenanceWindowTaskRequest$Description": "<p>The new task description to specify.</p>", 4036 "UpdateMaintenanceWindowTaskResult$Description": "<p>The updated task description.</p>" 4037 } 4038 }, 4039 "MaintenanceWindowDurationHours": { 4040 "base": null, 4041 "refs": { 4042 "CreateMaintenanceWindowRequest$Duration": "<p>The duration of the maintenance window in hours.</p>", 4043 "GetMaintenanceWindowResult$Duration": "<p>The duration of the maintenance window in hours.</p>", 4044 "MaintenanceWindowIdentity$Duration": "<p>The duration of the maintenance window in hours.</p>", 4045 "UpdateMaintenanceWindowRequest$Duration": "<p>The duration of the maintenance window in hours.</p>", 4046 "UpdateMaintenanceWindowResult$Duration": "<p>The duration of the maintenance window in hours.</p>" 4047 } 4048 }, 4049 "MaintenanceWindowEnabled": { 4050 "base": null, 4051 "refs": { 4052 "GetMaintenanceWindowResult$Enabled": "<p>Indicates whether the maintenance window is enabled.</p>", 4053 "MaintenanceWindowIdentity$Enabled": "<p>Indicates whether the maintenance window is enabled.</p>", 4054 "UpdateMaintenanceWindowRequest$Enabled": "<p>Whether the maintenance window is enabled.</p>", 4055 "UpdateMaintenanceWindowResult$Enabled": "<p>Whether the maintenance window is enabled.</p>" 4056 } 4057 }, 4058 "MaintenanceWindowExecution": { 4059 "base": "<p>Describes the information about an execution of a maintenance window. </p>", 4060 "refs": { 4061 "MaintenanceWindowExecutionList$member": null 4062 } 4063 }, 4064 "MaintenanceWindowExecutionId": { 4065 "base": null, 4066 "refs": { 4067 "CancelMaintenanceWindowExecutionRequest$WindowExecutionId": "<p>The ID of the maintenance window execution to stop.</p>", 4068 "CancelMaintenanceWindowExecutionResult$WindowExecutionId": "<p>The ID of the maintenance window execution that has been stopped.</p>", 4069 "DescribeMaintenanceWindowExecutionTaskInvocationsRequest$WindowExecutionId": "<p>The ID of the maintenance window execution the task is part of.</p>", 4070 "DescribeMaintenanceWindowExecutionTasksRequest$WindowExecutionId": "<p>The ID of the maintenance window execution whose task executions should be retrieved.</p>", 4071 "GetMaintenanceWindowExecutionRequest$WindowExecutionId": "<p>The ID of the maintenance window execution that includes the task.</p>", 4072 "GetMaintenanceWindowExecutionResult$WindowExecutionId": "<p>The ID of the maintenance window execution.</p>", 4073 "GetMaintenanceWindowExecutionTaskInvocationRequest$WindowExecutionId": "<p>The ID of the maintenance window execution for which the task is a part.</p>", 4074 "GetMaintenanceWindowExecutionTaskInvocationResult$WindowExecutionId": "<p>The maintenance window execution ID.</p>", 4075 "GetMaintenanceWindowExecutionTaskRequest$WindowExecutionId": "<p>The ID of the maintenance window execution that includes the task.</p>", 4076 "GetMaintenanceWindowExecutionTaskResult$WindowExecutionId": "<p>The ID of the maintenance window execution that includes the task.</p>", 4077 "MaintenanceWindowExecution$WindowExecutionId": "<p>The ID of the maintenance window execution.</p>", 4078 "MaintenanceWindowExecutionTaskIdentity$WindowExecutionId": "<p>The ID of the maintenance window execution that ran the task.</p>", 4079 "MaintenanceWindowExecutionTaskInvocationIdentity$WindowExecutionId": "<p>The ID of the maintenance window execution that ran the task.</p>" 4080 } 4081 }, 4082 "MaintenanceWindowExecutionList": { 4083 "base": null, 4084 "refs": { 4085 "DescribeMaintenanceWindowExecutionsResult$WindowExecutions": "<p>Information about the maintenance window executions.</p>" 4086 } 4087 }, 4088 "MaintenanceWindowExecutionStatus": { 4089 "base": null, 4090 "refs": { 4091 "GetMaintenanceWindowExecutionResult$Status": "<p>The status of the maintenance window execution.</p>", 4092 "GetMaintenanceWindowExecutionTaskInvocationResult$Status": "<p>The task status for an invocation.</p>", 4093 "GetMaintenanceWindowExecutionTaskResult$Status": "<p>The status of the task.</p>", 4094 "MaintenanceWindowExecution$Status": "<p>The status of the execution.</p>", 4095 "MaintenanceWindowExecutionTaskIdentity$Status": "<p>The status of the task execution.</p>", 4096 "MaintenanceWindowExecutionTaskInvocationIdentity$Status": "<p>The status of the task invocation.</p>" 4097 } 4098 }, 4099 "MaintenanceWindowExecutionStatusDetails": { 4100 "base": null, 4101 "refs": { 4102 "GetMaintenanceWindowExecutionResult$StatusDetails": "<p>The details explaining the status. Not available for all status values.</p>", 4103 "GetMaintenanceWindowExecutionTaskInvocationResult$StatusDetails": "<p>The details explaining the status. Details are only available for certain status values.</p>", 4104 "GetMaintenanceWindowExecutionTaskResult$StatusDetails": "<p>The details explaining the status. Not available for all status values.</p>", 4105 "MaintenanceWindowExecution$StatusDetails": "<p>The details explaining the status. Not available for all status values.</p>", 4106 "MaintenanceWindowExecutionTaskIdentity$StatusDetails": "<p>The details explaining the status of the task execution. Not available for all status values.</p>", 4107 "MaintenanceWindowExecutionTaskInvocationIdentity$StatusDetails": "<p>The details explaining the status of the task invocation. Not available for all status values. </p>" 4108 } 4109 }, 4110 "MaintenanceWindowExecutionTaskExecutionId": { 4111 "base": null, 4112 "refs": { 4113 "GetMaintenanceWindowExecutionTaskInvocationResult$ExecutionId": "<p>The execution ID.</p>", 4114 "MaintenanceWindowExecutionTaskInvocationIdentity$ExecutionId": "<p>The ID of the action performed in the service that actually handled the task invocation. If the task type is <code>RUN_COMMAND</code>, this value is the command ID.</p>" 4115 } 4116 }, 4117 "MaintenanceWindowExecutionTaskId": { 4118 "base": null, 4119 "refs": { 4120 "DescribeMaintenanceWindowExecutionTaskInvocationsRequest$TaskId": "<p>The ID of the specific task in the maintenance window task that should be retrieved.</p>", 4121 "GetMaintenanceWindowExecutionTaskInvocationRequest$TaskId": "<p>The ID of the specific task in the maintenance window task that should be retrieved. </p>", 4122 "GetMaintenanceWindowExecutionTaskInvocationResult$TaskExecutionId": "<p>The task execution ID.</p>", 4123 "GetMaintenanceWindowExecutionTaskRequest$TaskId": "<p>The ID of the specific task execution in the maintenance window task that should be retrieved.</p>", 4124 "GetMaintenanceWindowExecutionTaskResult$TaskExecutionId": "<p>The ID of the specific task execution in the maintenance window task that was retrieved.</p>", 4125 "MaintenanceWindowExecutionTaskIdList$member": null, 4126 "MaintenanceWindowExecutionTaskIdentity$TaskExecutionId": "<p>The ID of the specific task execution in the maintenance window execution.</p>", 4127 "MaintenanceWindowExecutionTaskInvocationIdentity$TaskExecutionId": "<p>The ID of the specific task execution in the maintenance window execution.</p>" 4128 } 4129 }, 4130 "MaintenanceWindowExecutionTaskIdList": { 4131 "base": null, 4132 "refs": { 4133 "GetMaintenanceWindowExecutionResult$TaskIds": "<p>The ID of the task executions from the maintenance window execution.</p>" 4134 } 4135 }, 4136 "MaintenanceWindowExecutionTaskIdentity": { 4137 "base": "<p>Information about a task execution performed as part of a maintenance window execution.</p>", 4138 "refs": { 4139 "MaintenanceWindowExecutionTaskIdentityList$member": null 4140 } 4141 }, 4142 "MaintenanceWindowExecutionTaskIdentityList": { 4143 "base": null, 4144 "refs": { 4145 "DescribeMaintenanceWindowExecutionTasksResult$WindowExecutionTaskIdentities": "<p>Information about the task executions.</p>" 4146 } 4147 }, 4148 "MaintenanceWindowExecutionTaskInvocationId": { 4149 "base": null, 4150 "refs": { 4151 "GetMaintenanceWindowExecutionTaskInvocationRequest$InvocationId": "<p>The invocation ID to retrieve.</p>", 4152 "GetMaintenanceWindowExecutionTaskInvocationResult$InvocationId": "<p>The invocation ID.</p>", 4153 "MaintenanceWindowExecutionTaskInvocationIdentity$InvocationId": "<p>The ID of the task invocation.</p>" 4154 } 4155 }, 4156 "MaintenanceWindowExecutionTaskInvocationIdentity": { 4157 "base": "<p>Describes the information about a task invocation for a particular target as part of a task execution performed as part of a maintenance window execution.</p>", 4158 "refs": { 4159 "MaintenanceWindowExecutionTaskInvocationIdentityList$member": null 4160 } 4161 }, 4162 "MaintenanceWindowExecutionTaskInvocationIdentityList": { 4163 "base": null, 4164 "refs": { 4165 "DescribeMaintenanceWindowExecutionTaskInvocationsResult$WindowExecutionTaskInvocationIdentities": "<p>Information about the task invocation results per invocation.</p>" 4166 } 4167 }, 4168 "MaintenanceWindowExecutionTaskInvocationParameters": { 4169 "base": null, 4170 "refs": { 4171 "GetMaintenanceWindowExecutionTaskInvocationResult$Parameters": "<p>The parameters used at the time that the task ran.</p>", 4172 "MaintenanceWindowExecutionTaskInvocationIdentity$Parameters": "<p>The parameters that were provided for the invocation when it was run.</p>" 4173 } 4174 }, 4175 "MaintenanceWindowFilter": { 4176 "base": "<p>Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use <code>MaintenanceWindowFilter></code> include the following:</p> <ul> <li> <p> <a>DescribeMaintenanceWindowExecutions</a> </p> </li> <li> <p> <a>DescribeMaintenanceWindowExecutionTaskInvocations</a> </p> </li> <li> <p> <a>DescribeMaintenanceWindowExecutionTasks</a> </p> </li> <li> <p> <a>DescribeMaintenanceWindows</a> </p> </li> <li> <p> <a>DescribeMaintenanceWindowTargets</a> </p> </li> <li> <p> <a>DescribeMaintenanceWindowTasks</a> </p> </li> </ul>", 4177 "refs": { 4178 "MaintenanceWindowFilterList$member": null 4179 } 4180 }, 4181 "MaintenanceWindowFilterKey": { 4182 "base": null, 4183 "refs": { 4184 "MaintenanceWindowFilter$Key": "<p>The name of the filter.</p>" 4185 } 4186 }, 4187 "MaintenanceWindowFilterList": { 4188 "base": null, 4189 "refs": { 4190 "DescribeMaintenanceWindowExecutionTaskInvocationsRequest$Filters": "<p>Optional filters used to scope down the returned task invocations. The supported filter key is <code>STATUS</code> with the corresponding values <code>PENDING</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, <code>CANCELLING</code>, and <code>CANCELLED</code>.</p>", 4191 "DescribeMaintenanceWindowExecutionTasksRequest$Filters": "<p>Optional filters used to scope down the returned tasks. The supported filter key is <code>STATUS</code> with the corresponding values <code>PENDING</code>, <code>IN_PROGRESS</code>, <code>SUCCESS</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, <code>CANCELLING</code>, and <code>CANCELLED</code>.</p>", 4192 "DescribeMaintenanceWindowExecutionsRequest$Filters": "<p>Each entry in the array is a structure containing:</p> <ul> <li> <p>Key. A string between 1 and 128 characters. Supported keys include <code>ExecutedBefore</code> and <code>ExecutedAfter</code>.</p> </li> <li> <p>Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as <code>2021-11-04T05:00:00Z</code>.</p> </li> </ul>", 4193 "DescribeMaintenanceWindowTargetsRequest$Filters": "<p>Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are <code>Type</code>, <code>WindowTargetId</code>, and <code>OwnerInformation</code>.</p>", 4194 "DescribeMaintenanceWindowTasksRequest$Filters": "<p>Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are <code>WindowTaskId</code>, <code>TaskArn</code>, <code>Priority</code>, and <code>TaskType</code>.</p>", 4195 "DescribeMaintenanceWindowsRequest$Filters": "<p>Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are <code>Name</code> and <code>Enabled</code>. For example, <code>Name=MyMaintenanceWindow</code> and <code>Enabled=True</code>.</p>" 4196 } 4197 }, 4198 "MaintenanceWindowFilterValue": { 4199 "base": null, 4200 "refs": { 4201 "MaintenanceWindowFilterValues$member": null 4202 } 4203 }, 4204 "MaintenanceWindowFilterValues": { 4205 "base": null, 4206 "refs": { 4207 "MaintenanceWindowFilter$Values": "<p>The filter values.</p>" 4208 } 4209 }, 4210 "MaintenanceWindowId": { 4211 "base": null, 4212 "refs": { 4213 "CreateMaintenanceWindowResult$WindowId": "<p>The ID of the created maintenance window.</p>", 4214 "DeleteMaintenanceWindowRequest$WindowId": "<p>The ID of the maintenance window to delete.</p>", 4215 "DeleteMaintenanceWindowResult$WindowId": "<p>The ID of the deleted maintenance window.</p>", 4216 "DeregisterTargetFromMaintenanceWindowRequest$WindowId": "<p>The ID of the maintenance window the target should be removed from.</p>", 4217 "DeregisterTargetFromMaintenanceWindowResult$WindowId": "<p>The ID of the maintenance window the target was removed from.</p>", 4218 "DeregisterTaskFromMaintenanceWindowRequest$WindowId": "<p>The ID of the maintenance window the task should be removed from.</p>", 4219 "DeregisterTaskFromMaintenanceWindowResult$WindowId": "<p>The ID of the maintenance window the task was removed from.</p>", 4220 "DescribeMaintenanceWindowExecutionsRequest$WindowId": "<p>The ID of the maintenance window whose executions should be retrieved.</p>", 4221 "DescribeMaintenanceWindowScheduleRequest$WindowId": "<p>The ID of the maintenance window to retrieve information about.</p>", 4222 "DescribeMaintenanceWindowTargetsRequest$WindowId": "<p>The ID of the maintenance window whose targets should be retrieved.</p>", 4223 "DescribeMaintenanceWindowTasksRequest$WindowId": "<p>The ID of the maintenance window whose tasks should be retrieved.</p>", 4224 "GetMaintenanceWindowRequest$WindowId": "<p>The ID of the maintenance window for which you want to retrieve information.</p>", 4225 "GetMaintenanceWindowResult$WindowId": "<p>The ID of the created maintenance window.</p>", 4226 "GetMaintenanceWindowTaskRequest$WindowId": "<p>The maintenance window ID that includes the task to retrieve.</p>", 4227 "GetMaintenanceWindowTaskResult$WindowId": "<p>The retrieved maintenance window ID.</p>", 4228 "MaintenanceWindowExecution$WindowId": "<p>The ID of the maintenance window.</p>", 4229 "MaintenanceWindowIdentity$WindowId": "<p>The ID of the maintenance window.</p>", 4230 "MaintenanceWindowIdentityForTarget$WindowId": "<p>The ID of the maintenance window.</p>", 4231 "MaintenanceWindowTarget$WindowId": "<p>The ID of the maintenance window to register the target with.</p>", 4232 "MaintenanceWindowTask$WindowId": "<p>The ID of the maintenance window where the task is registered.</p>", 4233 "RegisterTargetWithMaintenanceWindowRequest$WindowId": "<p>The ID of the maintenance window the target should be registered with.</p>", 4234 "RegisterTaskWithMaintenanceWindowRequest$WindowId": "<p>The ID of the maintenance window the task should be added to.</p>", 4235 "ScheduledWindowExecution$WindowId": "<p>The ID of the maintenance window to be run.</p>", 4236 "UpdateMaintenanceWindowRequest$WindowId": "<p>The ID of the maintenance window to update.</p>", 4237 "UpdateMaintenanceWindowResult$WindowId": "<p>The ID of the created maintenance window.</p>", 4238 "UpdateMaintenanceWindowTargetRequest$WindowId": "<p>The maintenance window ID with which to modify the target.</p>", 4239 "UpdateMaintenanceWindowTargetResult$WindowId": "<p>The maintenance window ID specified in the update request.</p>", 4240 "UpdateMaintenanceWindowTaskRequest$WindowId": "<p>The maintenance window ID that contains the task to modify.</p>", 4241 "UpdateMaintenanceWindowTaskResult$WindowId": "<p>The ID of the maintenance window that was updated.</p>" 4242 } 4243 }, 4244 "MaintenanceWindowIdentity": { 4245 "base": "<p>Information about the maintenance window.</p>", 4246 "refs": { 4247 "MaintenanceWindowIdentityList$member": null 4248 } 4249 }, 4250 "MaintenanceWindowIdentityForTarget": { 4251 "base": "<p>The maintenance window to which the specified target belongs.</p>", 4252 "refs": { 4253 "MaintenanceWindowsForTargetList$member": null 4254 } 4255 }, 4256 "MaintenanceWindowIdentityList": { 4257 "base": null, 4258 "refs": { 4259 "DescribeMaintenanceWindowsResult$WindowIdentities": "<p>Information about the maintenance windows.</p>" 4260 } 4261 }, 4262 "MaintenanceWindowLambdaClientContext": { 4263 "base": null, 4264 "refs": { 4265 "MaintenanceWindowLambdaParameters$ClientContext": "<p>Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.</p>" 4266 } 4267 }, 4268 "MaintenanceWindowLambdaParameters": { 4269 "base": "<p>The parameters for a <code>LAMBDA</code> task type.</p> <p>For information about specifying and updating task parameters, see <a>RegisterTaskWithMaintenanceWindow</a> and <a>UpdateMaintenanceWindowTask</a>.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p>For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.</p> </note>", 4270 "refs": { 4271 "MaintenanceWindowTaskInvocationParameters$Lambda": "<p>The parameters for a <code>LAMBDA</code> task type.</p>" 4272 } 4273 }, 4274 "MaintenanceWindowLambdaPayload": { 4275 "base": null, 4276 "refs": { 4277 "MaintenanceWindowLambdaParameters$Payload": "<p>JSON to provide to your Lambda function as input.</p>" 4278 } 4279 }, 4280 "MaintenanceWindowLambdaQualifier": { 4281 "base": null, 4282 "refs": { 4283 "MaintenanceWindowLambdaParameters$Qualifier": "<p>(Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.</p>" 4284 } 4285 }, 4286 "MaintenanceWindowMaxResults": { 4287 "base": null, 4288 "refs": { 4289 "DescribeMaintenanceWindowExecutionTaskInvocationsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4290 "DescribeMaintenanceWindowExecutionTasksRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4291 "DescribeMaintenanceWindowExecutionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4292 "DescribeMaintenanceWindowTargetsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4293 "DescribeMaintenanceWindowTasksRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4294 "DescribeMaintenanceWindowsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 4295 } 4296 }, 4297 "MaintenanceWindowName": { 4298 "base": null, 4299 "refs": { 4300 "CreateMaintenanceWindowRequest$Name": "<p>The name of the maintenance window.</p>", 4301 "GetMaintenanceWindowResult$Name": "<p>The name of the maintenance window.</p>", 4302 "GetMaintenanceWindowTaskResult$Name": "<p>The retrieved task name.</p>", 4303 "MaintenanceWindowIdentity$Name": "<p>The name of the maintenance window.</p>", 4304 "MaintenanceWindowIdentityForTarget$Name": "<p>The name of the maintenance window.</p>", 4305 "MaintenanceWindowTarget$Name": "<p>The name for the maintenance window target.</p>", 4306 "MaintenanceWindowTask$Name": "<p>The task name.</p>", 4307 "RegisterTargetWithMaintenanceWindowRequest$Name": "<p>An optional name for the target.</p>", 4308 "RegisterTaskWithMaintenanceWindowRequest$Name": "<p>An optional name for the task.</p>", 4309 "ScheduledWindowExecution$Name": "<p>The name of the maintenance window to be run.</p>", 4310 "UpdateMaintenanceWindowRequest$Name": "<p>The name of the maintenance window.</p>", 4311 "UpdateMaintenanceWindowResult$Name": "<p>The name of the maintenance window.</p>", 4312 "UpdateMaintenanceWindowTargetRequest$Name": "<p>A name for the update.</p>", 4313 "UpdateMaintenanceWindowTargetResult$Name": "<p>The updated name.</p>", 4314 "UpdateMaintenanceWindowTaskRequest$Name": "<p>The new task name to specify.</p>", 4315 "UpdateMaintenanceWindowTaskResult$Name": "<p>The updated task name.</p>" 4316 } 4317 }, 4318 "MaintenanceWindowOffset": { 4319 "base": null, 4320 "refs": { 4321 "CreateMaintenanceWindowRequest$ScheduleOffset": "<p>The number of days to wait after the date and time specified by a cron expression before running the maintenance window.</p> <p>For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.</p> <p> <code>cron(30 23 ? * TUE#3 *)</code> </p> <p>If the schedule offset is <code>2</code>, the maintenance window won't run until two days later.</p>", 4322 "GetMaintenanceWindowResult$ScheduleOffset": "<p>The number of days to wait to run a maintenance window after the scheduled cron expression date and time.</p>", 4323 "MaintenanceWindowIdentity$ScheduleOffset": "<p>The number of days to wait to run a maintenance window after the scheduled cron expression date and time.</p>", 4324 "UpdateMaintenanceWindowRequest$ScheduleOffset": "<p>The number of days to wait after the date and time specified by a cron expression before running the maintenance window.</p> <p>For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.</p> <p> <code>cron(30 23 ? * TUE#3 *)</code> </p> <p>If the schedule offset is <code>2</code>, the maintenance window won't run until two days later.</p>", 4325 "UpdateMaintenanceWindowResult$ScheduleOffset": "<p>The number of days to wait to run a maintenance window after the scheduled cron expression date and time.</p>" 4326 } 4327 }, 4328 "MaintenanceWindowResourceType": { 4329 "base": null, 4330 "refs": { 4331 "DescribeMaintenanceWindowScheduleRequest$ResourceType": "<p>The type of resource you want to retrieve information about. For example, <code>INSTANCE</code>.</p>", 4332 "DescribeMaintenanceWindowsForTargetRequest$ResourceType": "<p>The type of resource you want to retrieve information about. For example, <code>INSTANCE</code>.</p>", 4333 "MaintenanceWindowTarget$ResourceType": "<p>The type of target that is being registered with the maintenance window.</p>", 4334 "RegisterTargetWithMaintenanceWindowRequest$ResourceType": "<p>The type of target being registered with the maintenance window.</p>" 4335 } 4336 }, 4337 "MaintenanceWindowRunCommandParameters": { 4338 "base": "<p>The parameters for a <code>RUN_COMMAND</code> task type.</p> <p>For information about specifying and updating task parameters, see <a>RegisterTaskWithMaintenanceWindow</a> and <a>UpdateMaintenanceWindowTask</a>.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p>For <code>RUN_COMMAND</code> tasks, Systems Manager uses specified values for <code>TaskParameters</code> and <code>LoggingInfo</code> only if no values are specified for <code>TaskInvocationParameters</code>. </p> </note>", 4339 "refs": { 4340 "MaintenanceWindowTaskInvocationParameters$RunCommand": "<p>The parameters for a <code>RUN_COMMAND</code> task type.</p>" 4341 } 4342 }, 4343 "MaintenanceWindowSchedule": { 4344 "base": null, 4345 "refs": { 4346 "CreateMaintenanceWindowRequest$Schedule": "<p>The schedule of the maintenance window in the form of a cron or rate expression.</p>", 4347 "GetMaintenanceWindowResult$Schedule": "<p>The schedule of the maintenance window in the form of a cron or rate expression.</p>", 4348 "MaintenanceWindowIdentity$Schedule": "<p>The schedule of the maintenance window in the form of a cron or rate expression.</p>", 4349 "UpdateMaintenanceWindowRequest$Schedule": "<p>The schedule of the maintenance window in the form of a cron or rate expression.</p>", 4350 "UpdateMaintenanceWindowResult$Schedule": "<p>The schedule of the maintenance window in the form of a cron or rate expression.</p>" 4351 } 4352 }, 4353 "MaintenanceWindowSearchMaxResults": { 4354 "base": null, 4355 "refs": { 4356 "DescribeMaintenanceWindowScheduleRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4357 "DescribeMaintenanceWindowsForTargetRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 4358 } 4359 }, 4360 "MaintenanceWindowStepFunctionsInput": { 4361 "base": null, 4362 "refs": { 4363 "MaintenanceWindowStepFunctionsParameters$Input": "<p>The inputs for the <code>STEP_FUNCTIONS</code> task.</p>" 4364 } 4365 }, 4366 "MaintenanceWindowStepFunctionsName": { 4367 "base": null, 4368 "refs": { 4369 "MaintenanceWindowStepFunctionsParameters$Name": "<p>The name of the <code>STEP_FUNCTIONS</code> task.</p>" 4370 } 4371 }, 4372 "MaintenanceWindowStepFunctionsParameters": { 4373 "base": "<p>The parameters for a <code>STEP_FUNCTIONS</code> task.</p> <p>For information about specifying and updating task parameters, see <a>RegisterTaskWithMaintenanceWindow</a> and <a>UpdateMaintenanceWindowTask</a>.</p> <note> <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> <p>For Step Functions tasks, Systems Manager ignores any values specified for <code>TaskParameters</code> and <code>LoggingInfo</code>.</p> </note>", 4374 "refs": { 4375 "MaintenanceWindowTaskInvocationParameters$StepFunctions": "<p>The parameters for a <code>STEP_FUNCTIONS</code> task type.</p>" 4376 } 4377 }, 4378 "MaintenanceWindowStringDateTime": { 4379 "base": null, 4380 "refs": { 4381 "CreateMaintenanceWindowRequest$StartDate": "<p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. <code>StartDate</code> allows you to delay activation of the maintenance window until the specified future date.</p>", 4382 "CreateMaintenanceWindowRequest$EndDate": "<p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. <code>EndDate</code> allows you to set a date and time in the future when the maintenance window will no longer run.</p>", 4383 "GetMaintenanceWindowResult$StartDate": "<p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.</p>", 4384 "GetMaintenanceWindowResult$EndDate": "<p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.</p>", 4385 "GetMaintenanceWindowResult$NextExecutionTime": "<p>The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.</p>", 4386 "MaintenanceWindowIdentity$EndDate": "<p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.</p>", 4387 "MaintenanceWindowIdentity$StartDate": "<p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.</p>", 4388 "MaintenanceWindowIdentity$NextExecutionTime": "<p>The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.</p>", 4389 "ScheduledWindowExecution$ExecutionTime": "<p>The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.</p>", 4390 "UpdateMaintenanceWindowRequest$StartDate": "<p>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p>", 4391 "UpdateMaintenanceWindowRequest$EndDate": "<p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. <code>EndDate</code> allows you to set a date and time in the future when the maintenance window will no longer run.</p>", 4392 "UpdateMaintenanceWindowResult$StartDate": "<p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.</p>", 4393 "UpdateMaintenanceWindowResult$EndDate": "<p>The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.</p>" 4394 } 4395 }, 4396 "MaintenanceWindowTarget": { 4397 "base": "<p>The target registered with the maintenance window.</p>", 4398 "refs": { 4399 "MaintenanceWindowTargetList$member": null 4400 } 4401 }, 4402 "MaintenanceWindowTargetId": { 4403 "base": null, 4404 "refs": { 4405 "DeregisterTargetFromMaintenanceWindowRequest$WindowTargetId": "<p>The ID of the target definition to remove.</p>", 4406 "DeregisterTargetFromMaintenanceWindowResult$WindowTargetId": "<p>The ID of the removed target definition.</p>", 4407 "MaintenanceWindowTarget$WindowTargetId": "<p>The ID of the target.</p>", 4408 "RegisterTargetWithMaintenanceWindowResult$WindowTargetId": "<p>The ID of the target definition in this maintenance window.</p>", 4409 "UpdateMaintenanceWindowTargetRequest$WindowTargetId": "<p>The target ID to modify.</p>", 4410 "UpdateMaintenanceWindowTargetResult$WindowTargetId": "<p>The target ID specified in the update request.</p>" 4411 } 4412 }, 4413 "MaintenanceWindowTargetList": { 4414 "base": null, 4415 "refs": { 4416 "DescribeMaintenanceWindowTargetsResult$Targets": "<p>Information about the targets in the maintenance window.</p>" 4417 } 4418 }, 4419 "MaintenanceWindowTask": { 4420 "base": "<p>Information about a task defined for a maintenance window.</p>", 4421 "refs": { 4422 "MaintenanceWindowTaskList$member": null 4423 } 4424 }, 4425 "MaintenanceWindowTaskArn": { 4426 "base": null, 4427 "refs": { 4428 "GetMaintenanceWindowExecutionTaskResult$TaskArn": "<p>The Amazon Resource Name (ARN) of the task that ran.</p>", 4429 "GetMaintenanceWindowTaskResult$TaskArn": "<p>The resource that the task used during execution. For <code>RUN_COMMAND</code> and <code>AUTOMATION</code> task types, the value of <code>TaskArn</code> is the SSM document name/ARN. For <code>LAMBDA</code> tasks, the value is the function name/ARN. For <code>STEP_FUNCTIONS</code> tasks, the value is the state machine ARN.</p>", 4430 "MaintenanceWindowExecutionTaskIdentity$TaskArn": "<p>The Amazon Resource Name (ARN) of the task that ran.</p>", 4431 "MaintenanceWindowTask$TaskArn": "<p>The resource that the task uses during execution. For <code>RUN_COMMAND</code> and <code>AUTOMATION</code> task types, <code>TaskArn</code> is the Amazon Web Services Systems Manager (SSM document) name or ARN. For <code>LAMBDA</code> tasks, it's the function name or ARN. For <code>STEP_FUNCTIONS</code> tasks, it's the state machine ARN.</p>", 4432 "RegisterTaskWithMaintenanceWindowRequest$TaskArn": "<p>The ARN of the task to run.</p>", 4433 "UpdateMaintenanceWindowTaskRequest$TaskArn": "<p>The task ARN to modify.</p>", 4434 "UpdateMaintenanceWindowTaskResult$TaskArn": "<p>The updated task ARN value.</p>" 4435 } 4436 }, 4437 "MaintenanceWindowTaskCutoffBehavior": { 4438 "base": null, 4439 "refs": { 4440 "GetMaintenanceWindowTaskResult$CutoffBehavior": "<p>The action to take on tasks when the maintenance window cutoff time is reached. <code>CONTINUE_TASK</code> means that tasks continue to run. For Automation, Lambda, Step Functions tasks, <code>CANCEL_TASK</code> means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, <code>CANCEL_TASK</code> means the system attempts to stop the task by sending a <code>CancelCommand</code> operation.</p>", 4441 "MaintenanceWindowTask$CutoffBehavior": "<p>The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </p>", 4442 "RegisterTaskWithMaintenanceWindowRequest$CutoffBehavior": "<p>Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </p> <ul> <li> <p> <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running continue. The default value.</p> </li> <li> <p> <code>CANCEL_TASK</code>:</p> <ul> <li> <p>For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.</p> </li> <li> <p>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.</p> </li> </ul> <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p> </li> </ul>", 4443 "UpdateMaintenanceWindowTaskRequest$CutoffBehavior": "<p>Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </p> <ul> <li> <p> <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running continue. The default value.</p> </li> <li> <p> <code>CANCEL_TASK</code>:</p> <ul> <li> <p>For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.</p> </li> <li> <p>For Run Command tasks: When the cutoff time is reached, the system sends a <a>CancelCommand</a> operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.</p> </li> </ul> <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p> </li> </ul>", 4444 "UpdateMaintenanceWindowTaskResult$CutoffBehavior": "<p>The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </p>" 4445 } 4446 }, 4447 "MaintenanceWindowTaskId": { 4448 "base": null, 4449 "refs": { 4450 "DeregisterTaskFromMaintenanceWindowRequest$WindowTaskId": "<p>The ID of the task to remove from the maintenance window.</p>", 4451 "DeregisterTaskFromMaintenanceWindowResult$WindowTaskId": "<p>The ID of the task removed from the maintenance window.</p>", 4452 "GetMaintenanceWindowTaskRequest$WindowTaskId": "<p>The maintenance window task ID to retrieve.</p>", 4453 "GetMaintenanceWindowTaskResult$WindowTaskId": "<p>The retrieved maintenance window task ID.</p>", 4454 "MaintenanceWindowTask$WindowTaskId": "<p>The task ID.</p>", 4455 "RegisterTaskWithMaintenanceWindowResult$WindowTaskId": "<p>The ID of the task in the maintenance window.</p>", 4456 "UpdateMaintenanceWindowTaskRequest$WindowTaskId": "<p>The task ID to modify.</p>", 4457 "UpdateMaintenanceWindowTaskResult$WindowTaskId": "<p>The task ID of the maintenance window that was updated.</p>" 4458 } 4459 }, 4460 "MaintenanceWindowTaskInvocationParameters": { 4461 "base": "<p>The parameters for task execution.</p>", 4462 "refs": { 4463 "GetMaintenanceWindowTaskResult$TaskInvocationParameters": "<p>The parameters to pass to the task when it runs.</p>", 4464 "RegisterTaskWithMaintenanceWindowRequest$TaskInvocationParameters": "<p>The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty. </p>", 4465 "UpdateMaintenanceWindowTaskRequest$TaskInvocationParameters": "<p>The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.</p> <important> <p>When you update a maintenance window task that has options specified in <code>TaskInvocationParameters</code>, you must provide again all the <code>TaskInvocationParameters</code> values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified <code>TaskInvocationParameters</code> values for <code>Comment</code>, <code>NotificationConfig</code>, and <code>OutputS3BucketName</code>. If you update the maintenance window task and specify only a different <code>OutputS3BucketName</code> value, the values for <code>Comment</code> and <code>NotificationConfig</code> are removed.</p> </important>", 4466 "UpdateMaintenanceWindowTaskResult$TaskInvocationParameters": "<p>The updated parameter values.</p>" 4467 } 4468 }, 4469 "MaintenanceWindowTaskList": { 4470 "base": null, 4471 "refs": { 4472 "DescribeMaintenanceWindowTasksResult$Tasks": "<p>Information about the tasks in the maintenance window.</p>" 4473 } 4474 }, 4475 "MaintenanceWindowTaskParameterName": { 4476 "base": null, 4477 "refs": { 4478 "MaintenanceWindowTaskParameters$key": null 4479 } 4480 }, 4481 "MaintenanceWindowTaskParameterValue": { 4482 "base": null, 4483 "refs": { 4484 "MaintenanceWindowTaskParameterValueList$member": null 4485 } 4486 }, 4487 "MaintenanceWindowTaskParameterValueExpression": { 4488 "base": "<p>Defines the values for a task parameter.</p>", 4489 "refs": { 4490 "MaintenanceWindowTaskParameters$value": null 4491 } 4492 }, 4493 "MaintenanceWindowTaskParameterValueList": { 4494 "base": null, 4495 "refs": { 4496 "MaintenanceWindowTaskParameterValueExpression$Values": "<p>This field contains an array of 0 or more strings, each 1 to 255 characters in length.</p>" 4497 } 4498 }, 4499 "MaintenanceWindowTaskParameters": { 4500 "base": null, 4501 "refs": { 4502 "GetMaintenanceWindowTaskResult$TaskParameters": "<p>The parameters to pass to the task when it runs.</p> <note> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 4503 "MaintenanceWindowTask$TaskParameters": "<p>The parameters that should be passed to the task when it is run.</p> <note> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 4504 "MaintenanceWindowTaskParametersList$member": null, 4505 "RegisterTaskWithMaintenanceWindowRequest$TaskParameters": "<p>The parameters that should be passed to the task when it is run.</p> <note> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>", 4506 "UpdateMaintenanceWindowTaskRequest$TaskParameters": "<p>The parameters to modify.</p> <note> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note> <p>The map has the following format:</p> <p>Key: string, between 1 and 255 characters</p> <p>Value: an array of strings, each string is between 1 and 255 characters</p>", 4507 "UpdateMaintenanceWindowTaskResult$TaskParameters": "<p>The updated parameter values.</p> <note> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note>" 4508 } 4509 }, 4510 "MaintenanceWindowTaskParametersList": { 4511 "base": null, 4512 "refs": { 4513 "GetMaintenanceWindowExecutionTaskResult$TaskParameters": "<p>The parameters passed to the task when it was run.</p> <note> <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a>MaintenanceWindowTaskInvocationParameters</a>.</p> </note> <p>The map has the following format:</p> <ul> <li> <p> <code>Key</code>: string, between 1 and 255 characters</p> </li> <li> <p> <code>Value</code>: an array of strings, each between 1 and 255 characters</p> </li> </ul>" 4514 } 4515 }, 4516 "MaintenanceWindowTaskPriority": { 4517 "base": null, 4518 "refs": { 4519 "GetMaintenanceWindowExecutionTaskResult$Priority": "<p>The priority of the task.</p>", 4520 "GetMaintenanceWindowTaskResult$Priority": "<p>The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.</p>", 4521 "MaintenanceWindowTask$Priority": "<p>The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.</p>", 4522 "RegisterTaskWithMaintenanceWindowRequest$Priority": "<p>The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.</p>", 4523 "UpdateMaintenanceWindowTaskRequest$Priority": "<p>The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.</p>", 4524 "UpdateMaintenanceWindowTaskResult$Priority": "<p>The updated priority value.</p>" 4525 } 4526 }, 4527 "MaintenanceWindowTaskTargetId": { 4528 "base": null, 4529 "refs": { 4530 "GetMaintenanceWindowExecutionTaskInvocationResult$WindowTargetId": "<p>The maintenance window target ID.</p>", 4531 "MaintenanceWindowExecutionTaskInvocationIdentity$WindowTargetId": "<p>The ID of the target definition in this maintenance window the invocation was performed for.</p>" 4532 } 4533 }, 4534 "MaintenanceWindowTaskType": { 4535 "base": null, 4536 "refs": { 4537 "GetMaintenanceWindowExecutionTaskInvocationResult$TaskType": "<p>Retrieves the task type for a maintenance window.</p>", 4538 "GetMaintenanceWindowExecutionTaskResult$Type": "<p>The type of task that was run.</p>", 4539 "GetMaintenanceWindowTaskResult$TaskType": "<p>The type of task to run.</p>", 4540 "MaintenanceWindowExecutionTaskIdentity$TaskType": "<p>The type of task that ran.</p>", 4541 "MaintenanceWindowExecutionTaskInvocationIdentity$TaskType": "<p>The task type.</p>", 4542 "MaintenanceWindowTask$Type": "<p>The type of task.</p>", 4543 "RegisterTaskWithMaintenanceWindowRequest$TaskType": "<p>The type of task being registered.</p>" 4544 } 4545 }, 4546 "MaintenanceWindowTimezone": { 4547 "base": null, 4548 "refs": { 4549 "CreateMaintenanceWindowRequest$ScheduleTimezone": "<p>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p>", 4550 "GetMaintenanceWindowResult$ScheduleTimezone": "<p>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p>", 4551 "MaintenanceWindowIdentity$ScheduleTimezone": "<p>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.</p>", 4552 "UpdateMaintenanceWindowRequest$ScheduleTimezone": "<p>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p>", 4553 "UpdateMaintenanceWindowResult$ScheduleTimezone": "<p>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p>" 4554 } 4555 }, 4556 "MaintenanceWindowsForTargetList": { 4557 "base": null, 4558 "refs": { 4559 "DescribeMaintenanceWindowsForTargetResult$WindowIdentities": "<p>Information about the maintenance window targets and tasks an instance is associated with.</p>" 4560 } 4561 }, 4562 "ManagedInstanceId": { 4563 "base": null, 4564 "refs": { 4565 "DeregisterManagedInstanceRequest$InstanceId": "<p>The ID assigned to the managed instance when you registered it using the activation process. </p>", 4566 "UpdateManagedInstanceRoleRequest$InstanceId": "<p>The ID of the managed instance where you want to update the role.</p>" 4567 } 4568 }, 4569 "MaxConcurrency": { 4570 "base": null, 4571 "refs": { 4572 "AssociationDescription$MaxConcurrency": "<p>The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.</p> <p>If a new instance starts and attempts to run an association while Systems Manager is running <code>MaxConcurrency</code> associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for <code>MaxConcurrency</code>.</p>", 4573 "AssociationVersionInfo$MaxConcurrency": "<p>The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.</p> <p>If a new instance starts and attempts to run an association while Systems Manager is running <code>MaxConcurrency</code> associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for <code>MaxConcurrency</code>.</p>", 4574 "AutomationExecution$MaxConcurrency": "<p>The <code>MaxConcurrency</code> value specified by the user when the execution started.</p>", 4575 "AutomationExecutionMetadata$MaxConcurrency": "<p>The <code>MaxConcurrency</code> value specified by the user when starting the automation.</p>", 4576 "Command$MaxConcurrency": "<p>The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use <code>MaxConcurrency</code>, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html\">Running commands using Systems Manager Run Command</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 4577 "CreateAssociationBatchRequestEntry$MaxConcurrency": "<p>The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.</p> <p>If a new instance starts and attempts to run an association while Systems Manager is running <code>MaxConcurrency</code> associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for <code>MaxConcurrency</code>.</p>", 4578 "CreateAssociationRequest$MaxConcurrency": "<p>The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.</p> <p>If a new instance starts and attempts to run an association while Systems Manager is running <code>MaxConcurrency</code> associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for <code>MaxConcurrency</code>.</p>", 4579 "GetMaintenanceWindowExecutionTaskResult$MaxConcurrency": "<p>The defined maximum number of task executions that could be run in parallel.</p>", 4580 "GetMaintenanceWindowTaskResult$MaxConcurrency": "<p>The maximum number of targets allowed to run this task in parallel.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.</p> </note>", 4581 "MaintenanceWindowTask$MaxConcurrency": "<p>The maximum number of targets this task can be run for, in parallel.</p>", 4582 "RegisterTaskWithMaintenanceWindowRequest$MaxConcurrency": "<p>The maximum number of targets this task can be run for in parallel.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>", 4583 "Runbook$MaxConcurrency": "<p>The <code>MaxConcurrency</code> value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.</p>", 4584 "SendCommandRequest$MaxConcurrency": "<p>(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity\">Using concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 4585 "StartAutomationExecutionRequest$MaxConcurrency": "<p>The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is <code>10</code>.</p>", 4586 "TargetLocation$TargetLocationMaxConcurrency": "<p>The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.</p>", 4587 "UpdateAssociationRequest$MaxConcurrency": "<p>The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.</p> <p>If a new instance starts and attempts to run an association while Systems Manager is running <code>MaxConcurrency</code> associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for <code>MaxConcurrency</code>.</p>", 4588 "UpdateMaintenanceWindowTaskRequest$MaxConcurrency": "<p>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code> is the number of targets that are allowed to run this task in parallel.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.</p> </note>", 4589 "UpdateMaintenanceWindowTaskResult$MaxConcurrency": "<p>The updated <code>MaxConcurrency</code> value.</p>" 4590 } 4591 }, 4592 "MaxDocumentSizeExceeded": { 4593 "base": "<p>The size limit of a document is 64 KB.</p>", 4594 "refs": { 4595 } 4596 }, 4597 "MaxErrors": { 4598 "base": null, 4599 "refs": { 4600 "AssociationDescription$MaxErrors": "<p>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set <code>MaxError</code> to 10%, then the system stops sending the request when the sixth error is received.</p> <p>Executions that are already running an association when <code>MaxErrors</code> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1 so that executions proceed one at a time.</p>", 4601 "AssociationVersionInfo$MaxErrors": "<p>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set <code>MaxError</code> to 10%, then the system stops sending the request when the sixth error is received.</p> <p>Executions that are already running an association when <code>MaxErrors</code> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1 so that executions proceed one at a time.</p>", 4602 "AutomationExecution$MaxErrors": "<p>The MaxErrors value specified by the user when the execution started.</p>", 4603 "AutomationExecutionMetadata$MaxErrors": "<p>The <code>MaxErrors</code> value specified by the user when starting the automation.</p>", 4604 "Command$MaxErrors": "<p>The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html\">Running commands using Systems Manager Run Command</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 4605 "CreateAssociationBatchRequestEntry$MaxErrors": "<p>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set <code>MaxError</code> to 10%, then the system stops sending the request when the sixth error is received.</p> <p>Executions that are already running an association when <code>MaxErrors</code> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1 so that executions proceed one at a time.</p>", 4606 "CreateAssociationRequest$MaxErrors": "<p>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set <code>MaxError</code> to 10%, then the system stops sending the request when the sixth error is received.</p> <p>Executions that are already running an association when <code>MaxErrors</code> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1 so that executions proceed one at a time.</p>", 4607 "GetMaintenanceWindowExecutionTaskResult$MaxErrors": "<p>The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.</p>", 4608 "GetMaintenanceWindowTaskResult$MaxErrors": "<p>The maximum number of errors allowed before the task stops being scheduled.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.</p> </note>", 4609 "MaintenanceWindowTask$MaxErrors": "<p>The maximum number of errors allowed before this task stops being scheduled.</p>", 4610 "RegisterTaskWithMaintenanceWindowRequest$MaxErrors": "<p>The maximum number of errors allowed before this task stops being scheduled.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>", 4611 "Runbook$MaxErrors": "<p>The <code>MaxErrors</code> value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.</p>", 4612 "SendCommandRequest$MaxErrors": "<p>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of <code>MaxErrors</code>, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors\">Using error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 4613 "StartAutomationExecutionRequest$MaxErrors": "<p>The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.</p> <p>Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.</p>", 4614 "TargetLocation$TargetLocationMaxErrors": "<p>The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.</p>", 4615 "UpdateAssociationRequest$MaxErrors": "<p>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set <code>MaxError</code> to 10%, then the system stops sending the request when the sixth error is received.</p> <p>Executions that are already running an association when <code>MaxErrors</code> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1 so that executions proceed one at a time.</p>", 4616 "UpdateMaintenanceWindowTaskRequest$MaxErrors": "<p>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum number of errors that are allowed before the task stops being scheduled.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.</p> </note>", 4617 "UpdateMaintenanceWindowTaskResult$MaxErrors": "<p>The updated <code>MaxErrors</code> value.</p>" 4618 } 4619 }, 4620 "MaxResults": { 4621 "base": null, 4622 "refs": { 4623 "DescribeActivationsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4624 "DescribeAssociationExecutionTargetsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4625 "DescribeAssociationExecutionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4626 "DescribeAutomationExecutionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4627 "DescribeAutomationStepExecutionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4628 "DescribeInstanceAssociationsStatusRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4629 "DescribeInventoryDeletionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4630 "DescribeParametersRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4631 "DescribePatchPropertiesRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4632 "GetInventoryRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4633 "GetOpsSummaryRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4634 "GetParameterHistoryRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4635 "ListAssociationVersionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4636 "ListAssociationsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4637 "ListComplianceItemsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4638 "ListComplianceSummariesRequest$MaxResults": "<p>The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4639 "ListDocumentMetadataHistoryRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4640 "ListDocumentVersionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4641 "ListDocumentsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4642 "ListInventoryEntriesRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4643 "ListResourceComplianceSummariesRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4644 "ListResourceDataSyncRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 4645 } 4646 }, 4647 "MaxResultsEC2Compatible": { 4648 "base": null, 4649 "refs": { 4650 "DescribeInstanceInformationRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </p>" 4651 } 4652 }, 4653 "MetadataKey": { 4654 "base": null, 4655 "refs": { 4656 "MetadataKeysToDeleteList$member": null, 4657 "MetadataMap$key": null 4658 } 4659 }, 4660 "MetadataKeysToDeleteList": { 4661 "base": null, 4662 "refs": { 4663 "UpdateOpsMetadataRequest$KeysToDelete": "<p>The metadata keys to delete from the OpsMetadata object. </p>" 4664 } 4665 }, 4666 "MetadataMap": { 4667 "base": null, 4668 "refs": { 4669 "CreateOpsMetadataRequest$Metadata": "<p>Metadata for a new Application Manager application. </p>", 4670 "GetOpsMetadataResult$Metadata": "<p>OpsMetadata for an Application Manager application.</p>", 4671 "UpdateOpsMetadataRequest$MetadataToUpdate": "<p>Metadata to add to an OpsMetadata object.</p>" 4672 } 4673 }, 4674 "MetadataValue": { 4675 "base": "<p>Metadata to assign to an Application Manager application.</p>", 4676 "refs": { 4677 "MetadataMap$value": null 4678 } 4679 }, 4680 "MetadataValueString": { 4681 "base": null, 4682 "refs": { 4683 "MetadataValue$Value": "<p>Metadata value to assign to an Application Manager application.</p>" 4684 } 4685 }, 4686 "ModifyDocumentPermissionRequest": { 4687 "base": null, 4688 "refs": { 4689 } 4690 }, 4691 "ModifyDocumentPermissionResponse": { 4692 "base": null, 4693 "refs": { 4694 } 4695 }, 4696 "NextToken": { 4697 "base": null, 4698 "refs": { 4699 "DescribeActivationsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4700 "DescribeActivationsResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results. </p>", 4701 "DescribeAssociationExecutionTargetsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4702 "DescribeAssociationExecutionTargetsResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4703 "DescribeAssociationExecutionsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4704 "DescribeAssociationExecutionsResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4705 "DescribeAutomationExecutionsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4706 "DescribeAutomationExecutionsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4707 "DescribeAutomationStepExecutionsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4708 "DescribeAutomationStepExecutionsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4709 "DescribeAvailablePatchesRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4710 "DescribeAvailablePatchesResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4711 "DescribeDocumentPermissionRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4712 "DescribeDocumentPermissionResponse$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4713 "DescribeEffectiveInstanceAssociationsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4714 "DescribeEffectiveInstanceAssociationsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4715 "DescribeEffectivePatchesForPatchBaselineRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4716 "DescribeEffectivePatchesForPatchBaselineResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4717 "DescribeInstanceAssociationsStatusRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4718 "DescribeInstanceAssociationsStatusResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4719 "DescribeInstanceInformationRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4720 "DescribeInstanceInformationResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </p>", 4721 "DescribeInstancePatchStatesForPatchGroupRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4722 "DescribeInstancePatchStatesForPatchGroupResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4723 "DescribeInstancePatchStatesRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4724 "DescribeInstancePatchStatesResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4725 "DescribeInstancePatchesRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4726 "DescribeInstancePatchesResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4727 "DescribeInventoryDeletionsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4728 "DescribeInventoryDeletionsResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4729 "DescribeMaintenanceWindowExecutionTaskInvocationsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4730 "DescribeMaintenanceWindowExecutionTaskInvocationsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4731 "DescribeMaintenanceWindowExecutionTasksRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4732 "DescribeMaintenanceWindowExecutionTasksResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4733 "DescribeMaintenanceWindowExecutionsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4734 "DescribeMaintenanceWindowExecutionsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4735 "DescribeMaintenanceWindowScheduleRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4736 "DescribeMaintenanceWindowScheduleResult$NextToken": "<p>The token for the next set of items to return. (You use this token in the next call.)</p>", 4737 "DescribeMaintenanceWindowTargetsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4738 "DescribeMaintenanceWindowTargetsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4739 "DescribeMaintenanceWindowTasksRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4740 "DescribeMaintenanceWindowTasksResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4741 "DescribeMaintenanceWindowsForTargetRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4742 "DescribeMaintenanceWindowsForTargetResult$NextToken": "<p>The token for the next set of items to return. (You use this token in the next call.)</p>", 4743 "DescribeMaintenanceWindowsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4744 "DescribeMaintenanceWindowsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4745 "DescribeParametersRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4746 "DescribeParametersResult$NextToken": "<p>The token to use when requesting the next set of items.</p>", 4747 "DescribePatchBaselinesRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4748 "DescribePatchBaselinesResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4749 "DescribePatchGroupsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4750 "DescribePatchGroupsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4751 "DescribePatchPropertiesRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4752 "DescribePatchPropertiesResult$NextToken": "<p>The token for the next set of items to return. (You use this token in the next call.)</p>", 4753 "DescribeSessionsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4754 "DescribeSessionsResponse$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4755 "GetInventoryRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4756 "GetInventoryResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4757 "GetInventorySchemaRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4758 "GetInventorySchemaResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4759 "GetOpsMetadataRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results.</p>", 4760 "GetOpsMetadataResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4761 "GetOpsSummaryRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4762 "GetOpsSummaryResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4763 "GetParameterHistoryRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4764 "GetParameterHistoryResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4765 "GetParametersByPathRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4766 "GetParametersByPathResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4767 "ListAssociationVersionsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4768 "ListAssociationVersionsResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4769 "ListAssociationsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4770 "ListAssociationsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4771 "ListCommandInvocationsRequest$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>", 4772 "ListCommandInvocationsResult$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>", 4773 "ListCommandsRequest$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>", 4774 "ListCommandsResult$NextToken": "<p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>", 4775 "ListComplianceItemsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4776 "ListComplianceItemsResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4777 "ListComplianceSummariesRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4778 "ListComplianceSummariesResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4779 "ListDocumentMetadataHistoryRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4780 "ListDocumentMetadataHistoryResponse$NextToken": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 4781 "ListDocumentVersionsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4782 "ListDocumentVersionsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4783 "ListDocumentsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4784 "ListDocumentsResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4785 "ListInventoryEntriesRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 4786 "ListInventoryEntriesResult$NextToken": "<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>", 4787 "ListOpsMetadataRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results.</p>", 4788 "ListOpsMetadataResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4789 "ListResourceComplianceSummariesRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4790 "ListResourceComplianceSummariesResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 4791 "ListResourceDataSyncRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 4792 "ListResourceDataSyncResult$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>" 4793 } 4794 }, 4795 "NonCompliantSummary": { 4796 "base": "<p>A summary of resources that aren't compliant. The summary is organized according to resource type.</p>", 4797 "refs": { 4798 "ComplianceSummaryItem$NonCompliantSummary": "<p>A list of NON_COMPLIANT items for the specified compliance type.</p>", 4799 "ResourceComplianceSummaryItem$NonCompliantSummary": "<p>A list of items that aren't compliant for the resource.</p>" 4800 } 4801 }, 4802 "NormalStringMap": { 4803 "base": null, 4804 "refs": { 4805 "StepExecution$Inputs": "<p>Fully-resolved values passed into the step before execution.</p>" 4806 } 4807 }, 4808 "NotificationArn": { 4809 "base": null, 4810 "refs": { 4811 "NotificationConfig$NotificationArn": "<p>An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.</p>" 4812 } 4813 }, 4814 "NotificationConfig": { 4815 "base": "<p>Configurations for sending notifications.</p>", 4816 "refs": { 4817 "Command$NotificationConfig": "<p>Configurations for sending notifications about command status changes. </p>", 4818 "CommandInvocation$NotificationConfig": "<p>Configurations for sending notifications about command status changes on a per instance basis.</p>", 4819 "MaintenanceWindowRunCommandParameters$NotificationConfig": "<p>Configurations for sending notifications about command status changes on a per-instance basis.</p>", 4820 "SendCommandRequest$NotificationConfig": "<p>Configurations for sending notifications.</p>" 4821 } 4822 }, 4823 "NotificationEvent": { 4824 "base": null, 4825 "refs": { 4826 "NotificationEventList$member": null 4827 } 4828 }, 4829 "NotificationEventList": { 4830 "base": null, 4831 "refs": { 4832 "NotificationConfig$NotificationEvents": "<p>The different events for which you can receive notifications. To learn more about these events, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html\">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 4833 } 4834 }, 4835 "NotificationType": { 4836 "base": null, 4837 "refs": { 4838 "NotificationConfig$NotificationType": "<p>The type of notification.</p> <ul> <li> <p> <code>Command</code>: Receive notification when the status of a command changes.</p> </li> <li> <p> <code>Invocation</code>: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. </p> </li> </ul>" 4839 } 4840 }, 4841 "OperatingSystem": { 4842 "base": null, 4843 "refs": { 4844 "BaselineOverride$OperatingSystem": "<p>The operating system rule used by the patch baseline override.</p>", 4845 "CreatePatchBaselineRequest$OperatingSystem": "<p>Defines the operating system the patch baseline applies to. The default value is <code>WINDOWS</code>.</p>", 4846 "DescribePatchPropertiesRequest$OperatingSystem": "<p>The operating system type for which to list patches.</p>", 4847 "GetDefaultPatchBaselineRequest$OperatingSystem": "<p>Returns the default patch baseline for the specified operating system.</p>", 4848 "GetDefaultPatchBaselineResult$OperatingSystem": "<p>The operating system for the returned patch baseline. </p>", 4849 "GetPatchBaselineForPatchGroupRequest$OperatingSystem": "<p>Returns he operating system rule specified for patch groups using the patch baseline.</p>", 4850 "GetPatchBaselineForPatchGroupResult$OperatingSystem": "<p>The operating system rule specified for patch groups using the patch baseline.</p>", 4851 "GetPatchBaselineResult$OperatingSystem": "<p>Returns the operating system specified for the patch baseline.</p>", 4852 "PatchBaselineIdentity$OperatingSystem": "<p>Defines the operating system the patch baseline applies to. The default value is <code>WINDOWS</code>. </p>", 4853 "UpdatePatchBaselineResult$OperatingSystem": "<p>The operating system rule used by the updated patch baseline.</p>" 4854 } 4855 }, 4856 "OpsAggregator": { 4857 "base": "<p>One or more aggregators for viewing counts of OpsData using different dimensions such as <code>Source</code>, <code>CreatedTime</code>, or <code>Source and CreatedTime</code>, to name a few.</p>", 4858 "refs": { 4859 "OpsAggregatorList$member": null 4860 } 4861 }, 4862 "OpsAggregatorList": { 4863 "base": null, 4864 "refs": { 4865 "GetOpsSummaryRequest$Aggregators": "<p>Optional aggregators that return counts of OpsData based on one or more expressions.</p>", 4866 "OpsAggregator$Aggregators": "<p>A nested aggregator for viewing counts of OpsData.</p>" 4867 } 4868 }, 4869 "OpsAggregatorType": { 4870 "base": null, 4871 "refs": { 4872 "OpsAggregator$AggregatorType": "<p>Either a <code>Range</code> or <code>Count</code> aggregator for limiting an OpsData summary.</p>" 4873 } 4874 }, 4875 "OpsAggregatorValue": { 4876 "base": null, 4877 "refs": { 4878 "OpsAggregatorValueMap$value": null 4879 } 4880 }, 4881 "OpsAggregatorValueKey": { 4882 "base": null, 4883 "refs": { 4884 "OpsAggregatorValueMap$key": null 4885 } 4886 }, 4887 "OpsAggregatorValueMap": { 4888 "base": null, 4889 "refs": { 4890 "OpsAggregator$Values": "<p>The aggregator value.</p>" 4891 } 4892 }, 4893 "OpsDataAttributeName": { 4894 "base": null, 4895 "refs": { 4896 "OpsAggregator$AttributeName": "<p>The name of an OpsData attribute on which to limit the count of OpsData.</p>" 4897 } 4898 }, 4899 "OpsDataTypeName": { 4900 "base": null, 4901 "refs": { 4902 "OpsAggregator$TypeName": "<p>The data type name to use for viewing counts of OpsData.</p>", 4903 "OpsResultAttribute$TypeName": "<p>Name of the data type. Valid value: <code>AWS:OpsItem</code>, <code>AWS:EC2InstanceInformation</code>, <code>AWS:OpsItemTrendline</code>, or <code>AWS:ComplianceSummary</code>.</p>" 4904 } 4905 }, 4906 "OpsEntity": { 4907 "base": "<p>The result of the query.</p>", 4908 "refs": { 4909 "OpsEntityList$member": null 4910 } 4911 }, 4912 "OpsEntityId": { 4913 "base": null, 4914 "refs": { 4915 "OpsEntity$Id": "<p>The query ID.</p>" 4916 } 4917 }, 4918 "OpsEntityItem": { 4919 "base": "<p>The OpsData summary.</p>", 4920 "refs": { 4921 "OpsEntityItemMap$value": null 4922 } 4923 }, 4924 "OpsEntityItemCaptureTime": { 4925 "base": null, 4926 "refs": { 4927 "OpsEntityItem$CaptureTime": "<p>The time the OpsData was captured.</p>" 4928 } 4929 }, 4930 "OpsEntityItemEntry": { 4931 "base": null, 4932 "refs": { 4933 "OpsEntityItemEntryList$member": null 4934 } 4935 }, 4936 "OpsEntityItemEntryList": { 4937 "base": null, 4938 "refs": { 4939 "OpsEntityItem$Content": "<p>The details of an OpsData summary.</p>" 4940 } 4941 }, 4942 "OpsEntityItemKey": { 4943 "base": null, 4944 "refs": { 4945 "OpsEntityItemMap$key": null 4946 } 4947 }, 4948 "OpsEntityItemMap": { 4949 "base": null, 4950 "refs": { 4951 "OpsEntity$Data": "<p>The data returned by the query.</p>" 4952 } 4953 }, 4954 "OpsEntityList": { 4955 "base": null, 4956 "refs": { 4957 "GetOpsSummaryResult$Entities": "<p>The list of aggregated details and filtered OpsData.</p>" 4958 } 4959 }, 4960 "OpsFilter": { 4961 "base": "<p>A filter for viewing OpsData summaries.</p>", 4962 "refs": { 4963 "OpsFilterList$member": null 4964 } 4965 }, 4966 "OpsFilterKey": { 4967 "base": null, 4968 "refs": { 4969 "OpsFilter$Key": "<p>The name of the filter.</p>" 4970 } 4971 }, 4972 "OpsFilterList": { 4973 "base": null, 4974 "refs": { 4975 "GetOpsSummaryRequest$Filters": "<p>Optional filters used to scope down the returned OpsData. </p>", 4976 "OpsAggregator$Filters": "<p>The aggregator filters.</p>" 4977 } 4978 }, 4979 "OpsFilterOperatorType": { 4980 "base": null, 4981 "refs": { 4982 "OpsFilter$Type": "<p>The type of filter.</p>" 4983 } 4984 }, 4985 "OpsFilterValue": { 4986 "base": null, 4987 "refs": { 4988 "OpsFilterValueList$member": null 4989 } 4990 }, 4991 "OpsFilterValueList": { 4992 "base": null, 4993 "refs": { 4994 "OpsFilter$Values": "<p>The filter value.</p>" 4995 } 4996 }, 4997 "OpsItem": { 4998 "base": "<p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their Amazon Web Services resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can configure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any Amazon Web Services service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with Amazon Web Services resources from a single console.</p> <p>To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the Amazon Web Services resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the Amazon Web Services resource, OpsCenter aggregates information from Config, CloudTrail logs, and EventBridge, so you don't have to navigate across multiple console pages during your investigation. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 4999 "refs": { 5000 "GetOpsItemResponse$OpsItem": "<p>The OpsItem.</p>" 5001 } 5002 }, 5003 "OpsItemAlreadyExistsException": { 5004 "base": "<p>The OpsItem already exists.</p>", 5005 "refs": { 5006 } 5007 }, 5008 "OpsItemCategory": { 5009 "base": null, 5010 "refs": { 5011 "CreateOpsItemRequest$Category": "<p>Specify a category to assign to an OpsItem. </p>", 5012 "OpsItem$Category": "<p>An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.</p>", 5013 "OpsItemSummary$Category": "<p>A list of OpsItems by category.</p>", 5014 "UpdateOpsItemRequest$Category": "<p>Specify a new category for an OpsItem.</p>" 5015 } 5016 }, 5017 "OpsItemDataKey": { 5018 "base": null, 5019 "refs": { 5020 "OpsItemOperationalData$key": null 5021 } 5022 }, 5023 "OpsItemDataType": { 5024 "base": null, 5025 "refs": { 5026 "OpsItemDataValue$Type": "<p>The type of key-value pair. Valid types include <code>SearchableString</code> and <code>String</code>.</p>" 5027 } 5028 }, 5029 "OpsItemDataValue": { 5030 "base": "<p>An object that defines the value of the key and its type in the OperationalData map.</p>", 5031 "refs": { 5032 "OpsItemOperationalData$value": null 5033 } 5034 }, 5035 "OpsItemDataValueString": { 5036 "base": null, 5037 "refs": { 5038 "OpsItemDataValue$Value": "<p>The value of the OperationalData key.</p>" 5039 } 5040 }, 5041 "OpsItemDescription": { 5042 "base": null, 5043 "refs": { 5044 "CreateOpsItemRequest$Description": "<p>Information about the OpsItem. </p>", 5045 "OpsItem$Description": "<p>The OpsItem description.</p>", 5046 "UpdateOpsItemRequest$Description": "<p>Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue. </p>" 5047 } 5048 }, 5049 "OpsItemEventFilter": { 5050 "base": "<p>Describes a filter for a specific list of OpsItem events. You can filter event information by using tags. You specify tags by using a key-value pair mapping. </p>", 5051 "refs": { 5052 "OpsItemEventFilters$member": null 5053 } 5054 }, 5055 "OpsItemEventFilterKey": { 5056 "base": null, 5057 "refs": { 5058 "OpsItemEventFilter$Key": "<p>The name of the filter key. Currently, the only supported value is <code>OpsItemId</code>.</p>" 5059 } 5060 }, 5061 "OpsItemEventFilterOperator": { 5062 "base": null, 5063 "refs": { 5064 "OpsItemEventFilter$Operator": "<p>The operator used by the filter call. Currently, the only supported value is <code>Equal</code>.</p>" 5065 } 5066 }, 5067 "OpsItemEventFilterValue": { 5068 "base": null, 5069 "refs": { 5070 "OpsItemEventFilterValues$member": null 5071 } 5072 }, 5073 "OpsItemEventFilterValues": { 5074 "base": null, 5075 "refs": { 5076 "OpsItemEventFilter$Values": "<p>The values for the filter, consisting of one or more OpsItem IDs.</p>" 5077 } 5078 }, 5079 "OpsItemEventFilters": { 5080 "base": null, 5081 "refs": { 5082 "ListOpsItemEventsRequest$Filters": "<p>One or more OpsItem filters. Use a filter to return a more specific list of results. </p>" 5083 } 5084 }, 5085 "OpsItemEventMaxResults": { 5086 "base": null, 5087 "refs": { 5088 "ListOpsItemEventsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </p>" 5089 } 5090 }, 5091 "OpsItemEventSummaries": { 5092 "base": null, 5093 "refs": { 5094 "ListOpsItemEventsResponse$Summaries": "<p>A list of event information for the specified OpsItems.</p>" 5095 } 5096 }, 5097 "OpsItemEventSummary": { 5098 "base": "<p>Summary information about an OpsItem event or that associated an OpsItem with a related item.</p>", 5099 "refs": { 5100 "OpsItemEventSummaries$member": null 5101 } 5102 }, 5103 "OpsItemFilter": { 5104 "base": "<p>Describes an OpsItem filter.</p>", 5105 "refs": { 5106 "OpsItemFilters$member": null 5107 } 5108 }, 5109 "OpsItemFilterKey": { 5110 "base": null, 5111 "refs": { 5112 "OpsItemFilter$Key": "<p>The name of the filter.</p>" 5113 } 5114 }, 5115 "OpsItemFilterOperator": { 5116 "base": null, 5117 "refs": { 5118 "OpsItemFilter$Operator": "<p>The operator used by the filter call.</p>" 5119 } 5120 }, 5121 "OpsItemFilterValue": { 5122 "base": null, 5123 "refs": { 5124 "OpsItemFilterValues$member": null 5125 } 5126 }, 5127 "OpsItemFilterValues": { 5128 "base": null, 5129 "refs": { 5130 "OpsItemFilter$Values": "<p>The filter value.</p>" 5131 } 5132 }, 5133 "OpsItemFilters": { 5134 "base": null, 5135 "refs": { 5136 "DescribeOpsItemsRequest$OpsItemFilters": "<p>One or more filters to limit the response.</p> <ul> <li> <p>Key: CreatedTime</p> <p>Operations: GreaterThan, LessThan</p> </li> <li> <p>Key: LastModifiedBy</p> <p>Operations: Contains, Equals</p> </li> <li> <p>Key: LastModifiedTime</p> <p>Operations: GreaterThan, LessThan</p> </li> <li> <p>Key: Priority</p> <p>Operations: Equals</p> </li> <li> <p>Key: Source</p> <p>Operations: Contains, Equals</p> </li> <li> <p>Key: Status</p> <p>Operations: Equals</p> </li> <li> <p>Key: Title*</p> <p>Operations: Equals,Contains</p> </li> <li> <p>Key: OperationalData**</p> <p>Operations: Equals</p> </li> <li> <p>Key: OperationalDataKey</p> <p>Operations: Equals</p> </li> <li> <p>Key: OperationalDataValue</p> <p>Operations: Equals, Contains</p> </li> <li> <p>Key: OpsItemId</p> <p>Operations: Equals</p> </li> <li> <p>Key: ResourceId</p> <p>Operations: Contains</p> </li> <li> <p>Key: AutomationId</p> <p>Operations: Equals</p> </li> </ul> <p>*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.</p> <p>**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}</p>" 5137 } 5138 }, 5139 "OpsItemId": { 5140 "base": null, 5141 "refs": { 5142 "AssociateOpsItemRelatedItemRequest$OpsItemId": "<p>The ID of the OpsItem to which you want to associate a resource as a related item.</p>", 5143 "DisassociateOpsItemRelatedItemRequest$OpsItemId": "<p>The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.</p>", 5144 "GetOpsItemRequest$OpsItemId": "<p>The ID of the OpsItem that you want to get.</p>", 5145 "ListOpsItemRelatedItemsRequest$OpsItemId": "<p>The ID of the OpsItem for which you want to list all related-item resources.</p>", 5146 "OpsItem$OpsItemId": "<p>The ID of the OpsItem.</p>", 5147 "OpsItemRelatedItemAlreadyExistsException$OpsItemId": null, 5148 "OpsItemRelatedItemSummary$OpsItemId": "<p>The OpsItem ID.</p>", 5149 "OpsItemSummary$OpsItemId": "<p>The ID of the OpsItem.</p>", 5150 "UpdateOpsItemRequest$OpsItemId": "<p>The ID of the OpsItem.</p>" 5151 } 5152 }, 5153 "OpsItemIdentity": { 5154 "base": "<p>Information about the user or resource that created an OpsItem event.</p>", 5155 "refs": { 5156 "OpsItemEventSummary$CreatedBy": "<p>Information about the user or resource that created the OpsItem event.</p>", 5157 "OpsItemRelatedItemSummary$CreatedBy": null, 5158 "OpsItemRelatedItemSummary$LastModifiedBy": null 5159 } 5160 }, 5161 "OpsItemInvalidParameterException": { 5162 "base": "<p>A specified parameter argument isn't valid. Verify the available arguments and try again.</p>", 5163 "refs": { 5164 } 5165 }, 5166 "OpsItemLimitExceededException": { 5167 "base": "<p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits\">What are the resource limits for OpsCenter?</a>.</p>", 5168 "refs": { 5169 } 5170 }, 5171 "OpsItemMaxResults": { 5172 "base": null, 5173 "refs": { 5174 "DescribeOpsItemsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 5175 } 5176 }, 5177 "OpsItemNotFoundException": { 5178 "base": "<p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>", 5179 "refs": { 5180 } 5181 }, 5182 "OpsItemNotification": { 5183 "base": "<p>A notification about the OpsItem.</p>", 5184 "refs": { 5185 "OpsItemNotifications$member": null 5186 } 5187 }, 5188 "OpsItemNotifications": { 5189 "base": null, 5190 "refs": { 5191 "CreateOpsItemRequest$Notifications": "<p>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.</p>", 5192 "OpsItem$Notifications": "<p>The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.</p>", 5193 "UpdateOpsItemRequest$Notifications": "<p>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.</p>" 5194 } 5195 }, 5196 "OpsItemOperationalData": { 5197 "base": null, 5198 "refs": { 5199 "CreateOpsItemRequest$OperationalData": "<p>Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.</p> <important> <p>Operational data keys <i>can't</i> begin with the following: <code>amazon</code>, <code>aws</code>, <code>amzn</code>, <code>ssm</code>, <code>/amazon</code>, <code>/aws</code>, <code>/amzn</code>, <code>/ssm</code>.</p> </important> <p>You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the <a>DescribeOpsItems</a> API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the <a>GetOpsItem</a> API operation).</p> <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in the request. Use the <code>/aws/automations</code> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems\">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 5200 "OpsItem$OperationalData": "<p>Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.</p> <important> <p>Operational data keys <i>can't</i> begin with the following: <code>amazon</code>, <code>aws</code>, <code>amzn</code>, <code>ssm</code>, <code>/amazon</code>, <code>/aws</code>, <code>/amzn</code>, <code>/ssm</code>.</p> </important> <p>You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the <a>DescribeOpsItems</a> API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the <a>GetOpsItem</a> API operation).</p> <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in the request. Use the <code>/aws/automations</code> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems\">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 5201 "OpsItemSummary$OperationalData": "<p>Operational data is custom data that provides useful reference details about the OpsItem. </p>", 5202 "UpdateOpsItemRequest$OperationalData": "<p>Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.</p> <p>Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.</p> <important> <p>Operational data keys <i>can't</i> begin with the following: <code>amazon</code>, <code>aws</code>, <code>amzn</code>, <code>ssm</code>, <code>/amazon</code>, <code>/aws</code>, <code>/amzn</code>, <code>/ssm</code>.</p> </important> <p>You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the <a>DescribeOpsItems</a> API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the <a>GetOpsItem</a> API operation).</p> <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in the request. Use the <code>/aws/automations</code> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems\">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 5203 } 5204 }, 5205 "OpsItemOpsDataKeysList": { 5206 "base": null, 5207 "refs": { 5208 "UpdateOpsItemRequest$OperationalDataToDelete": "<p>Keys that you want to remove from the OperationalData map.</p>" 5209 } 5210 }, 5211 "OpsItemParameterNamesList": { 5212 "base": null, 5213 "refs": { 5214 "OpsItemInvalidParameterException$ParameterNames": null, 5215 "OpsItemLimitExceededException$ResourceTypes": null 5216 } 5217 }, 5218 "OpsItemPriority": { 5219 "base": null, 5220 "refs": { 5221 "CreateOpsItemRequest$Priority": "<p>The importance of this OpsItem in relation to other OpsItems in the system.</p>", 5222 "OpsItem$Priority": "<p>The importance of this OpsItem in relation to other OpsItems in the system.</p>", 5223 "OpsItemSummary$Priority": "<p>The importance of this OpsItem in relation to other OpsItems in the system.</p>", 5224 "UpdateOpsItemRequest$Priority": "<p>The importance of this OpsItem in relation to other OpsItems in the system.</p>" 5225 } 5226 }, 5227 "OpsItemRelatedItemAlreadyExistsException": { 5228 "base": "<p>The Amazon Resource Name (ARN) is already associated with the OpsItem.</p>", 5229 "refs": { 5230 } 5231 }, 5232 "OpsItemRelatedItemAssociationId": { 5233 "base": null, 5234 "refs": { 5235 "AssociateOpsItemRelatedItemResponse$AssociationId": "<p>The association ID.</p>", 5236 "DisassociateOpsItemRelatedItemRequest$AssociationId": "<p>The ID of the association for which you want to delete an association between the OpsItem and a related item.</p>", 5237 "OpsItemRelatedItemSummary$AssociationId": "<p>The association ID.</p>" 5238 } 5239 }, 5240 "OpsItemRelatedItemAssociationNotFoundException": { 5241 "base": "<p>The association wasn't found using the parameters you specified in the call. Verify the information and try again.</p>", 5242 "refs": { 5243 } 5244 }, 5245 "OpsItemRelatedItemAssociationResourceType": { 5246 "base": null, 5247 "refs": { 5248 "AssociateOpsItemRelatedItemRequest$ResourceType": "<p>The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:</p> <p> <code>AWS::SSMIncidents::IncidentRecord</code>: an Incident Manager incident. </p> <p> <code>AWS::SSM::Document</code>: a Systems Manager (SSM) document.</p>", 5249 "OpsItemRelatedItemSummary$ResourceType": "<p>The resource type.</p>" 5250 } 5251 }, 5252 "OpsItemRelatedItemAssociationResourceUri": { 5253 "base": null, 5254 "refs": { 5255 "AssociateOpsItemRelatedItemRequest$ResourceUri": "<p>The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.</p>", 5256 "OpsItemRelatedItemAlreadyExistsException$ResourceUri": null, 5257 "OpsItemRelatedItemSummary$ResourceUri": "<p>The Amazon Resource Name (ARN) of the related-item resource.</p>" 5258 } 5259 }, 5260 "OpsItemRelatedItemAssociationType": { 5261 "base": null, 5262 "refs": { 5263 "AssociateOpsItemRelatedItemRequest$AssociationType": "<p>The type of association that you want to create between an OpsItem and a resource. OpsCenter supports <code>IsParentOf</code> and <code>RelatesTo</code> association types.</p>", 5264 "OpsItemRelatedItemSummary$AssociationType": "<p>The association type.</p>" 5265 } 5266 }, 5267 "OpsItemRelatedItemSummaries": { 5268 "base": null, 5269 "refs": { 5270 "ListOpsItemRelatedItemsResponse$Summaries": "<p>A list of related-item resources for the specified OpsItem.</p>" 5271 } 5272 }, 5273 "OpsItemRelatedItemSummary": { 5274 "base": "<p>Summary information about related-item resources for an OpsItem.</p>", 5275 "refs": { 5276 "OpsItemRelatedItemSummaries$member": null 5277 } 5278 }, 5279 "OpsItemRelatedItemsFilter": { 5280 "base": "<p>Describes a filter for a specific list of related-item resources. </p>", 5281 "refs": { 5282 "OpsItemRelatedItemsFilters$member": null 5283 } 5284 }, 5285 "OpsItemRelatedItemsFilterKey": { 5286 "base": null, 5287 "refs": { 5288 "OpsItemRelatedItemsFilter$Key": "<p>The name of the filter key. Supported values include <code>ResourceUri</code>, <code>ResourceType</code>, or <code>AssociationId</code>.</p>" 5289 } 5290 }, 5291 "OpsItemRelatedItemsFilterOperator": { 5292 "base": null, 5293 "refs": { 5294 "OpsItemRelatedItemsFilter$Operator": "<p>The operator used by the filter call. The only supported operator is <code>EQUAL</code>.</p>" 5295 } 5296 }, 5297 "OpsItemRelatedItemsFilterValue": { 5298 "base": null, 5299 "refs": { 5300 "OpsItemRelatedItemsFilterValues$member": null 5301 } 5302 }, 5303 "OpsItemRelatedItemsFilterValues": { 5304 "base": null, 5305 "refs": { 5306 "OpsItemRelatedItemsFilter$Values": "<p>The values for the filter.</p>" 5307 } 5308 }, 5309 "OpsItemRelatedItemsFilters": { 5310 "base": null, 5311 "refs": { 5312 "ListOpsItemRelatedItemsRequest$Filters": "<p>One or more OpsItem filters. Use a filter to return a more specific list of results. </p>" 5313 } 5314 }, 5315 "OpsItemRelatedItemsMaxResults": { 5316 "base": null, 5317 "refs": { 5318 "ListOpsItemRelatedItemsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 5319 } 5320 }, 5321 "OpsItemSeverity": { 5322 "base": null, 5323 "refs": { 5324 "CreateOpsItemRequest$Severity": "<p>Specify a severity to assign to an OpsItem.</p>", 5325 "OpsItem$Severity": "<p>The severity of the OpsItem. Severity options range from 1 to 4.</p>", 5326 "OpsItemSummary$Severity": "<p>A list of OpsItems by severity.</p>", 5327 "UpdateOpsItemRequest$Severity": "<p>Specify a new severity for an OpsItem.</p>" 5328 } 5329 }, 5330 "OpsItemSource": { 5331 "base": null, 5332 "refs": { 5333 "CreateOpsItemRequest$Source": "<p>The origin of the OpsItem, such as Amazon EC2 or Systems Manager.</p> <note> <p>The source name can't contain the following strings: <code>aws</code>, <code>amazon</code>, and <code>amzn</code>. </p> </note>", 5334 "OpsItem$Source": "<p>The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.</p>", 5335 "OpsItemSummary$Source": "<p>The impacted Amazon Web Services resource.</p>" 5336 } 5337 }, 5338 "OpsItemStatus": { 5339 "base": null, 5340 "refs": { 5341 "OpsItem$Status": "<p>The OpsItem status. Status can be <code>Open</code>, <code>In Progress</code>, or <code>Resolved</code>. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html\">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 5342 "OpsItemSummary$Status": "<p>The OpsItem status. Status can be <code>Open</code>, <code>In Progress</code>, or <code>Resolved</code>.</p>", 5343 "UpdateOpsItemRequest$Status": "<p>The OpsItem status. Status can be <code>Open</code>, <code>In Progress</code>, or <code>Resolved</code>. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details\">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 5344 } 5345 }, 5346 "OpsItemSummaries": { 5347 "base": null, 5348 "refs": { 5349 "DescribeOpsItemsResponse$OpsItemSummaries": "<p>A list of OpsItems.</p>" 5350 } 5351 }, 5352 "OpsItemSummary": { 5353 "base": "<p>A count of OpsItems.</p>", 5354 "refs": { 5355 "OpsItemSummaries$member": null 5356 } 5357 }, 5358 "OpsItemTitle": { 5359 "base": null, 5360 "refs": { 5361 "CreateOpsItemRequest$Title": "<p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>", 5362 "OpsItem$Title": "<p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>", 5363 "OpsItemSummary$Title": "<p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>", 5364 "UpdateOpsItemRequest$Title": "<p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>" 5365 } 5366 }, 5367 "OpsItemType": { 5368 "base": null, 5369 "refs": { 5370 "CreateOpsItemRequest$OpsItemType": "<p>The type of OpsItem to create. Currently, the only valid values are <code>/aws/changerequest</code> and <code>/aws/issue</code>.</p>", 5371 "OpsItem$OpsItemType": "<p>The type of OpsItem. Currently, the only valid values are <code>/aws/changerequest</code> and <code>/aws/issue</code>.</p>", 5372 "OpsItemSummary$OpsItemType": "<p>The type of OpsItem. Currently, the only valid values are <code>/aws/changerequest</code> and <code>/aws/issue</code>.</p>" 5373 } 5374 }, 5375 "OpsMetadata": { 5376 "base": "<p>Operational metadata for an application in Application Manager.</p>", 5377 "refs": { 5378 "OpsMetadataList$member": null 5379 } 5380 }, 5381 "OpsMetadataAlreadyExistsException": { 5382 "base": "<p>An OpsMetadata object already exists for the selected resource.</p>", 5383 "refs": { 5384 } 5385 }, 5386 "OpsMetadataArn": { 5387 "base": null, 5388 "refs": { 5389 "CreateOpsMetadataResult$OpsMetadataArn": "<p>The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.</p>", 5390 "DeleteOpsMetadataRequest$OpsMetadataArn": "<p>The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.</p>", 5391 "GetOpsMetadataRequest$OpsMetadataArn": "<p>The Amazon Resource Name (ARN) of an OpsMetadata Object to view.</p>", 5392 "OpsMetadata$OpsMetadataArn": "<p>The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.</p>", 5393 "UpdateOpsMetadataRequest$OpsMetadataArn": "<p>The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.</p>", 5394 "UpdateOpsMetadataResult$OpsMetadataArn": "<p>The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.</p>" 5395 } 5396 }, 5397 "OpsMetadataFilter": { 5398 "base": "<p>A filter to limit the number of OpsMetadata objects displayed.</p>", 5399 "refs": { 5400 "OpsMetadataFilterList$member": null 5401 } 5402 }, 5403 "OpsMetadataFilterKey": { 5404 "base": null, 5405 "refs": { 5406 "OpsMetadataFilter$Key": "<p>A filter key.</p>" 5407 } 5408 }, 5409 "OpsMetadataFilterList": { 5410 "base": null, 5411 "refs": { 5412 "ListOpsMetadataRequest$Filters": "<p>One or more filters to limit the number of OpsMetadata objects returned by the call.</p>" 5413 } 5414 }, 5415 "OpsMetadataFilterValue": { 5416 "base": null, 5417 "refs": { 5418 "OpsMetadataFilterValueList$member": null 5419 } 5420 }, 5421 "OpsMetadataFilterValueList": { 5422 "base": null, 5423 "refs": { 5424 "OpsMetadataFilter$Values": "<p>A filter value.</p>" 5425 } 5426 }, 5427 "OpsMetadataInvalidArgumentException": { 5428 "base": "<p>One of the arguments passed is invalid. </p>", 5429 "refs": { 5430 } 5431 }, 5432 "OpsMetadataKeyLimitExceededException": { 5433 "base": "<p>The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.</p>", 5434 "refs": { 5435 } 5436 }, 5437 "OpsMetadataLimitExceededException": { 5438 "base": "<p>Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.</p>", 5439 "refs": { 5440 } 5441 }, 5442 "OpsMetadataList": { 5443 "base": null, 5444 "refs": { 5445 "ListOpsMetadataResult$OpsMetadataList": "<p>Returns a list of OpsMetadata objects.</p>" 5446 } 5447 }, 5448 "OpsMetadataNotFoundException": { 5449 "base": "<p>The OpsMetadata object doesn't exist. </p>", 5450 "refs": { 5451 } 5452 }, 5453 "OpsMetadataResourceId": { 5454 "base": null, 5455 "refs": { 5456 "CreateOpsMetadataRequest$ResourceId": "<p>A resource ID for a new Application Manager application.</p>", 5457 "GetOpsMetadataResult$ResourceId": "<p>The resource ID of the Application Manager application.</p>", 5458 "OpsMetadata$ResourceId": "<p>The ID of the Application Manager application.</p>" 5459 } 5460 }, 5461 "OpsMetadataTooManyUpdatesException": { 5462 "base": "<p>The system is processing too many concurrent updates. Wait a few moments and try again.</p>", 5463 "refs": { 5464 } 5465 }, 5466 "OpsResultAttribute": { 5467 "base": "<p>The OpsItem data type to return.</p>", 5468 "refs": { 5469 "OpsResultAttributeList$member": null 5470 } 5471 }, 5472 "OpsResultAttributeList": { 5473 "base": null, 5474 "refs": { 5475 "GetOpsSummaryRequest$ResultAttributes": "<p>The OpsData data type to return.</p>" 5476 } 5477 }, 5478 "OutputSource": { 5479 "base": "<p>Information about the source where the association execution details are stored.</p>", 5480 "refs": { 5481 "AssociationExecutionTarget$OutputSource": "<p>The location where the association details are saved.</p>" 5482 } 5483 }, 5484 "OutputSourceId": { 5485 "base": null, 5486 "refs": { 5487 "OutputSource$OutputSourceId": "<p>The ID of the output source, for example the URL of an S3 bucket.</p>" 5488 } 5489 }, 5490 "OutputSourceType": { 5491 "base": null, 5492 "refs": { 5493 "OutputSource$OutputSourceType": "<p>The type of source where the association execution details are stored, for example, Amazon S3.</p>" 5494 } 5495 }, 5496 "OwnerInformation": { 5497 "base": null, 5498 "refs": { 5499 "GetMaintenanceWindowExecutionTaskInvocationResult$OwnerInformation": "<p>User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.</p>", 5500 "InstancePatchState$OwnerInformation": "<p>Placeholder information. This field will always be empty in the current release of the service.</p>", 5501 "MaintenanceWindowExecutionTaskInvocationIdentity$OwnerInformation": "<p>User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.</p>", 5502 "MaintenanceWindowTarget$OwnerInformation": "<p>A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.</p>", 5503 "RegisterTargetWithMaintenanceWindowRequest$OwnerInformation": "<p>User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.</p>", 5504 "UpdateMaintenanceWindowTargetRequest$OwnerInformation": "<p>User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.</p>", 5505 "UpdateMaintenanceWindowTargetResult$OwnerInformation": "<p>The updated owner.</p>" 5506 } 5507 }, 5508 "PSParameterName": { 5509 "base": null, 5510 "refs": { 5511 "DeleteParameterRequest$Name": "<p>The name of the parameter to delete.</p>", 5512 "GetParameterHistoryRequest$Name": "<p>The name of the parameter for which you want to review history.</p>", 5513 "GetParameterRequest$Name": "<p>The name of the parameter you want to query.</p> <p>To query by parameter label, use <code>\"Name\": \"name:label\"</code>. To query by parameter version, use <code>\"Name\": \"name:version\"</code>.</p>", 5514 "GetParametersByPathRequest$Path": "<p>The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: <code>/Finance/Prod/IAD/WinServ2016/license33 </code> </p>", 5515 "LabelParameterVersionRequest$Name": "<p>The parameter name on which you want to attach one or more labels.</p>", 5516 "Parameter$Name": "<p>The name of the parameter.</p>", 5517 "ParameterHistory$Name": "<p>The name of the parameter.</p>", 5518 "ParameterMetadata$Name": "<p>The parameter name.</p>", 5519 "ParameterNameList$member": null, 5520 "PutParameterRequest$Name": "<p>The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code> </p> <p>Naming Constraints:</p> <ul> <li> <p>Parameter names are case sensitive.</p> </li> <li> <p>A parameter name must be unique within an Amazon Web Services Region</p> </li> <li> <p>A parameter name can't be prefixed with \"<code>aws</code>\" or \"<code>ssm</code>\" (case-insensitive).</p> </li> <li> <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code> </p> <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code> </p> </li> <li> <p>A parameter name can't include spaces.</p> </li> <li> <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p> </li> </ul> <p>For additional information about valid values for parameter names, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html\">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <note> <p>The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:</p> <p> <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code> </p> </note>", 5521 "UnlabelParameterVersionRequest$Name": "<p>The name of the parameter from which you want to delete one or more labels.</p>" 5522 } 5523 }, 5524 "PSParameterSelector": { 5525 "base": null, 5526 "refs": { 5527 "Parameter$Selector": "<p>Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:</p> <p>parameter_name:version</p> <p>parameter_name:label</p>" 5528 } 5529 }, 5530 "PSParameterValue": { 5531 "base": null, 5532 "refs": { 5533 "Parameter$Value": "<p>The parameter value.</p>", 5534 "ParameterHistory$Value": "<p>The parameter value.</p>", 5535 "PutParameterRequest$Value": "<p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p> <note> <p>Parameters can't be referenced or nested in the values of other parameters. You can't include <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p> </note>" 5536 } 5537 }, 5538 "PSParameterVersion": { 5539 "base": null, 5540 "refs": { 5541 "LabelParameterVersionRequest$ParameterVersion": "<p>The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.</p>", 5542 "LabelParameterVersionResult$ParameterVersion": "<p>The version of the parameter that has been labeled.</p>", 5543 "Parameter$Version": "<p>The parameter version.</p>", 5544 "ParameterHistory$Version": "<p>The parameter version.</p>", 5545 "ParameterMetadata$Version": "<p>The parameter version.</p>", 5546 "PutParameterResult$Version": "<p>The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.</p>", 5547 "UnlabelParameterVersionRequest$ParameterVersion": "<p>The specific version of the parameter which you want to delete one or more labels from. If it isn't present, the call will fail.</p>" 5548 } 5549 }, 5550 "Parameter": { 5551 "base": "<p>An Amazon Web Services Systems Manager parameter in Parameter Store.</p>", 5552 "refs": { 5553 "GetParameterResult$Parameter": "<p>Information about a parameter.</p>", 5554 "ParameterList$member": null 5555 } 5556 }, 5557 "ParameterAlreadyExists": { 5558 "base": "<p>The parameter already exists. You can't create duplicate parameters.</p>", 5559 "refs": { 5560 } 5561 }, 5562 "ParameterDataType": { 5563 "base": null, 5564 "refs": { 5565 "Parameter$DataType": "<p>The data type of the parameter, such as <code>text</code> or <code>aws:ec2:image</code>. The default is <code>text</code>.</p>", 5566 "ParameterHistory$DataType": "<p>The data type of the parameter, such as <code>text</code> or <code>aws:ec2:image</code>. The default is <code>text</code>.</p>", 5567 "ParameterMetadata$DataType": "<p>The data type of the parameter, such as <code>text</code> or <code>aws:ec2:image</code>. The default is <code>text</code>.</p>", 5568 "PutParameterRequest$DataType": "<p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p> <p> <b>The following data type values are supported.</b> </p> <ul> <li> <p> <code>text</code> </p> </li> <li> <p> <code>aws:ec2:image</code> </p> </li> </ul> <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html\">Native parameter support for Amazon Machine Image (AMI) IDs</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 5569 } 5570 }, 5571 "ParameterDescription": { 5572 "base": null, 5573 "refs": { 5574 "ParameterHistory$Description": "<p>Information about the parameter.</p>", 5575 "ParameterMetadata$Description": "<p>Description of the parameter actions.</p>", 5576 "PutParameterRequest$Description": "<p>Information about the parameter that you want to add to the system. Optional but recommended.</p> <important> <p>Don't enter personally identifiable information in this field.</p> </important>" 5577 } 5578 }, 5579 "ParameterHistory": { 5580 "base": "<p>Information about parameter usage.</p>", 5581 "refs": { 5582 "ParameterHistoryList$member": null 5583 } 5584 }, 5585 "ParameterHistoryList": { 5586 "base": null, 5587 "refs": { 5588 "GetParameterHistoryResult$Parameters": "<p>A list of parameters returned by the request.</p>" 5589 } 5590 }, 5591 "ParameterInlinePolicy": { 5592 "base": "<p>One or more policies assigned to a parameter.</p>", 5593 "refs": { 5594 "ParameterPolicyList$member": null 5595 } 5596 }, 5597 "ParameterKeyId": { 5598 "base": null, 5599 "refs": { 5600 "ParameterHistory$KeyId": "<p>The ID of the query key used for this parameter.</p>", 5601 "ParameterMetadata$KeyId": "<p>The ID of the query key used for this parameter.</p>", 5602 "PutParameterRequest$KeyId": "<p>The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Either the default KMS key automatically assigned to your Amazon Web Services account or a custom key. Required for parameters that use the <code>SecureString</code> data type.</p> <p>If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account.</p> <ul> <li> <p>To use your default KMS key, choose the <code>SecureString</code> data type, and do <i>not</i> specify the <code>Key ID</code> when you create the parameter. The system automatically populates <code>Key ID</code> with your default KMS key.</p> </li> <li> <p>To use a custom KMS key, choose the <code>SecureString</code> data type with the <code>Key ID</code> parameter.</p> </li> </ul>" 5603 } 5604 }, 5605 "ParameterLabel": { 5606 "base": null, 5607 "refs": { 5608 "ParameterLabelList$member": null 5609 } 5610 }, 5611 "ParameterLabelList": { 5612 "base": null, 5613 "refs": { 5614 "LabelParameterVersionRequest$Labels": "<p>One or more labels to attach to the specified parameter version.</p>", 5615 "LabelParameterVersionResult$InvalidLabels": "<p>The label doesn't meet the requirements. For information about parameter label requirements, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html\">Labeling parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 5616 "ParameterHistory$Labels": "<p>Labels assigned to the parameter version.</p>", 5617 "UnlabelParameterVersionRequest$Labels": "<p>One or more labels to delete from the specified parameter version.</p>", 5618 "UnlabelParameterVersionResult$RemovedLabels": "<p>A list of all labels deleted from the parameter.</p>", 5619 "UnlabelParameterVersionResult$InvalidLabels": "<p>The labels that aren't attached to the given parameter version.</p>" 5620 } 5621 }, 5622 "ParameterLimitExceeded": { 5623 "base": "<p>You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more parameters and try again.</p>", 5624 "refs": { 5625 } 5626 }, 5627 "ParameterList": { 5628 "base": null, 5629 "refs": { 5630 "GetParametersByPathResult$Parameters": "<p>A list of parameters found in the specified hierarchy.</p>", 5631 "GetParametersResult$Parameters": "<p>A list of details for a parameter.</p>" 5632 } 5633 }, 5634 "ParameterMaxVersionLimitExceeded": { 5635 "base": "<p>Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a <i>label</i> attached to it, Parameter Store won't delete the version and instead presents this error message:</p> <p> <code>An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of <i>parameter-name</i> by calling the PutParameter API with the overwrite flag. Version <i>version-number</i>, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.</code> </p> <p>This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-console-move\">Move a parameter label (console)</a> or <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-cli-move\">Move a parameter label (CLI)</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 5636 "refs": { 5637 } 5638 }, 5639 "ParameterMetadata": { 5640 "base": "<p>Metadata includes information like the ARN of the last user and the date/time the parameter was last used.</p>", 5641 "refs": { 5642 "ParameterMetadataList$member": null 5643 } 5644 }, 5645 "ParameterMetadataList": { 5646 "base": null, 5647 "refs": { 5648 "DescribeParametersResult$Parameters": "<p>Parameters returned by the request.</p>" 5649 } 5650 }, 5651 "ParameterName": { 5652 "base": null, 5653 "refs": { 5654 "Parameters$key": null 5655 } 5656 }, 5657 "ParameterNameList": { 5658 "base": null, 5659 "refs": { 5660 "DeleteParametersRequest$Names": "<p>The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.</p>", 5661 "DeleteParametersResult$DeletedParameters": "<p>The names of the deleted parameters.</p>", 5662 "DeleteParametersResult$InvalidParameters": "<p>The names of parameters that weren't deleted because the parameters aren't valid.</p>", 5663 "GetParametersRequest$Names": "<p>Names of the parameters for which you want to query information.</p> <p>To query by parameter label, use <code>\"Name\": \"name:label\"</code>. To query by parameter version, use <code>\"Name\": \"name:version\"</code>.</p>", 5664 "GetParametersResult$InvalidParameters": "<p>A list of parameters that aren't formatted correctly or don't run during an execution.</p>" 5665 } 5666 }, 5667 "ParameterNotFound": { 5668 "base": "<p>The parameter couldn't be found. Verify the name and try again.</p>", 5669 "refs": { 5670 } 5671 }, 5672 "ParameterPatternMismatchException": { 5673 "base": "<p>The parameter name isn't valid.</p>", 5674 "refs": { 5675 } 5676 }, 5677 "ParameterPolicies": { 5678 "base": null, 5679 "refs": { 5680 "PutParameterRequest$Policies": "<p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a capability of Amazon Web Services Systems Manager supports the following policy types:</p> <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p> <p>ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p> <p>NoChangeNotification: This policy triggers a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p> <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html\">Assigning parameter policies</a>. </p>" 5681 } 5682 }, 5683 "ParameterPolicyList": { 5684 "base": null, 5685 "refs": { 5686 "ParameterHistory$Policies": "<p>Information about the policies assigned to a parameter.</p> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html\">Assigning parameter policies</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 5687 "ParameterMetadata$Policies": "<p>A list of policies associated with a parameter.</p>" 5688 } 5689 }, 5690 "ParameterStringFilter": { 5691 "base": "<p>One or more filters. Use a filter to return a more specific list of results.</p>", 5692 "refs": { 5693 "ParameterStringFilterList$member": null 5694 } 5695 }, 5696 "ParameterStringFilterKey": { 5697 "base": null, 5698 "refs": { 5699 "ParameterStringFilter$Key": "<p>The name of the filter.</p> <p>The <code>ParameterStringFilter</code> object is used by the <a>DescribeParameters</a> and <a>GetParametersByPath</a> API operations. However, not all of the pattern values listed for <code>Key</code> can be used with both operations.</p> <p>For <code>DescribeActions</code>, all of the listed patterns are valid except <code>Label</code>.</p> <p>For <code>GetParametersByPath</code>, the following patterns listed for <code>Key</code> aren't valid: <code>tag</code>, <code>DataType</code>, <code>Name</code>, <code>Path</code>, and <code>Tier</code>.</p> <p>For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html\">Searching for Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 5700 } 5701 }, 5702 "ParameterStringFilterList": { 5703 "base": null, 5704 "refs": { 5705 "DescribeParametersRequest$ParameterFilters": "<p>Filters to limit the request results.</p>", 5706 "GetParametersByPathRequest$ParameterFilters": "<p>Filters to limit the request results.</p> <note> <p>The following <code>Key</code> values are supported for <code>GetParametersByPath</code>: <code>Type</code>, <code>KeyId</code>, and <code>Label</code>.</p> <p>The following <code>Key</code> values aren't supported for <code>GetParametersByPath</code>: <code>tag</code>, <code>DataType</code>, <code>Name</code>, <code>Path</code>, and <code>Tier</code>.</p> </note>" 5707 } 5708 }, 5709 "ParameterStringFilterValue": { 5710 "base": null, 5711 "refs": { 5712 "ParameterStringFilterValueList$member": null 5713 } 5714 }, 5715 "ParameterStringFilterValueList": { 5716 "base": null, 5717 "refs": { 5718 "ParameterStringFilter$Values": "<p>The value you want to search for.</p>" 5719 } 5720 }, 5721 "ParameterStringQueryOption": { 5722 "base": null, 5723 "refs": { 5724 "ParameterStringFilter$Option": "<p>For all filters used with <a>DescribeParameters</a>, valid options include <code>Equals</code> and <code>BeginsWith</code>. The <code>Name</code> filter additionally supports the <code>Contains</code> option. (Exception: For filters using the key <code>Path</code>, valid options include <code>Recursive</code> and <code>OneLevel</code>.)</p> <p>For filters used with <a>GetParametersByPath</a>, valid options include <code>Equals</code> and <code>BeginsWith</code>. (Exception: For filters using <code>Label</code> as the Key name, the only valid option is <code>Equals</code>.)</p>" 5725 } 5726 }, 5727 "ParameterTier": { 5728 "base": null, 5729 "refs": { 5730 "ParameterHistory$Tier": "<p>The parameter tier.</p>", 5731 "ParameterMetadata$Tier": "<p>The parameter tier.</p>", 5732 "PutParameterRequest$Tier": "<p>The parameter tier to assign to a parameter.</p> <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost. </p> <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html\">Standard and advanced parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters. </p> <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. </p> <p> <b>Using the Default Tier Configuration</b> </p> <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</p> <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</p> <ul> <li> <p> <b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters. </p> </li> <li> <p> <b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced. </p> <p>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</p> <p>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary. </p> </li> </ul> <p>Options that require an advanced parameter include the following:</p> <ul> <li> <p>The content size of the parameter is more than 4 KB.</p> </li> <li> <p>The parameter uses a parameter policy.</p> </li> <li> <p>More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.</p> </li> </ul> <p>For more information about configuring the default tier option, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html\">Specifying a default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 5733 "PutParameterResult$Tier": "<p>The tier assigned to the parameter.</p>" 5734 } 5735 }, 5736 "ParameterType": { 5737 "base": null, 5738 "refs": { 5739 "Parameter$Type": "<p>The type of parameter. Valid values include the following: <code>String</code>, <code>StringList</code>, and <code>SecureString</code>.</p>", 5740 "ParameterHistory$Type": "<p>The type of parameter used.</p>", 5741 "ParameterMetadata$Type": "<p>The type of parameter. Valid parameter types include the following: <code>String</code>, <code>StringList</code>, and <code>SecureString</code>.</p>", 5742 "PutParameterRequest$Type": "<p>The type of parameter that you want to add to the system.</p> <note> <p> <code>SecureString</code> isn't currently supported for CloudFormation templates.</p> </note> <p>Items in a <code>StringList</code> must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the <code>String</code> data type.</p> <important> <p>Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.</p> </important>" 5743 } 5744 }, 5745 "ParameterValue": { 5746 "base": null, 5747 "refs": { 5748 "ParameterValueList$member": null, 5749 "TargetParameterList$member": null 5750 } 5751 }, 5752 "ParameterValueList": { 5753 "base": null, 5754 "refs": { 5755 "Parameters$value": null 5756 } 5757 }, 5758 "ParameterVersionLabelLimitExceeded": { 5759 "base": "<p>A parameter version can have a maximum of ten labels.</p>", 5760 "refs": { 5761 } 5762 }, 5763 "ParameterVersionNotFound": { 5764 "base": "<p>The specified parameter version wasn't found. Verify the parameter name and version, and try again.</p>", 5765 "refs": { 5766 } 5767 }, 5768 "Parameters": { 5769 "base": null, 5770 "refs": { 5771 "AssociationDescription$Parameters": "<p>A description of the parameters for a document. </p>", 5772 "AssociationVersionInfo$Parameters": "<p>Parameters specified when the association version was created.</p>", 5773 "Command$Parameters": "<p>The parameter values to be inserted in the document when running the command.</p>", 5774 "CreateAssociationBatchRequestEntry$Parameters": "<p>A description of the parameters for a document. </p>", 5775 "CreateAssociationRequest$Parameters": "<p>The parameters for the runtime configuration of the document.</p>", 5776 "MaintenanceWindowRunCommandParameters$Parameters": "<p>The parameters for the <code>RUN_COMMAND</code> task execution.</p>", 5777 "SendCommandRequest$Parameters": "<p>The required and optional parameters specified in the document being run.</p>", 5778 "UpdateAssociationRequest$Parameters": "<p>The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using <code>{{ssm:parameter-name}}</code>.</p>" 5779 } 5780 }, 5781 "ParametersFilter": { 5782 "base": "<p>This data type is deprecated. Instead, use <a>ParameterStringFilter</a>.</p>", 5783 "refs": { 5784 "ParametersFilterList$member": null 5785 } 5786 }, 5787 "ParametersFilterKey": { 5788 "base": null, 5789 "refs": { 5790 "ParametersFilter$Key": "<p>The name of the filter.</p>" 5791 } 5792 }, 5793 "ParametersFilterList": { 5794 "base": null, 5795 "refs": { 5796 "DescribeParametersRequest$Filters": "<p>This data type is deprecated. Instead, use <code>ParameterFilters</code>.</p>" 5797 } 5798 }, 5799 "ParametersFilterValue": { 5800 "base": null, 5801 "refs": { 5802 "ParametersFilterValueList$member": null 5803 } 5804 }, 5805 "ParametersFilterValueList": { 5806 "base": null, 5807 "refs": { 5808 "ParametersFilter$Values": "<p>The filter values.</p>" 5809 } 5810 }, 5811 "Patch": { 5812 "base": "<p>Represents metadata about a patch.</p>", 5813 "refs": { 5814 "EffectivePatch$Patch": "<p>Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.</p>", 5815 "PatchList$member": null 5816 } 5817 }, 5818 "PatchAction": { 5819 "base": null, 5820 "refs": { 5821 "BaselineOverride$RejectedPatchesAction": "<p>The action for Patch Manager to take on patches included in the <code>RejectedPackages</code> list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.</p>", 5822 "CreatePatchBaselineRequest$RejectedPatchesAction": "<p>The action for Patch Manager to take on patches included in the <code>RejectedPackages</code> list.</p> <ul> <li> <p> <b> <code>ALLOW_AS_DEPENDENCY</code> </b>: A package in the <code>Rejected</code> patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as <code>InstalledOther</code>. This is the default action if no option is specified.</p> </li> <li> <p> <b> <code>BLOCK</code> </b>: Packages in the <code>RejectedPatches</code> list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as <code>InstalledRejected</code>.</p> </li> </ul>", 5823 "GetPatchBaselineResult$RejectedPatchesAction": "<p>The action specified to take on patches included in the <code>RejectedPatches</code> list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.</p>", 5824 "UpdatePatchBaselineRequest$RejectedPatchesAction": "<p>The action for Patch Manager to take on patches included in the <code>RejectedPackages</code> list.</p> <ul> <li> <p> <b> <code>ALLOW_AS_DEPENDENCY</code> </b>: A package in the <code>Rejected</code> patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as <code>InstalledOther</code>. This is the default action if no option is specified.</p> </li> <li> <p> <b> <code>BLOCK</code> </b>: Packages in the <code>RejectedPatches</code> list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the <code>Rejected</code> patches list, it is considered non-compliant with the patch baseline, and its status is reported as <code>InstalledRejected</code>.</p> </li> </ul>", 5825 "UpdatePatchBaselineResult$RejectedPatchesAction": "<p>The action specified to take on patches included in the <code>RejectedPatches</code> list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.</p>" 5826 } 5827 }, 5828 "PatchAdvisoryId": { 5829 "base": null, 5830 "refs": { 5831 "PatchAdvisoryIdList$member": null 5832 } 5833 }, 5834 "PatchAdvisoryIdList": { 5835 "base": null, 5836 "refs": { 5837 "Patch$AdvisoryIds": "<p>The Advisory ID of the patch. For example, <code>RHSA-2020:3779</code>. Applies to Linux-based instances only.</p>" 5838 } 5839 }, 5840 "PatchArch": { 5841 "base": null, 5842 "refs": { 5843 "Patch$Arch": "<p>The architecture of the patch. For example, in <code>example-pkg-0.710.10-2.7.abcd.x86_64</code>, the architecture is indicated by <code>x86_64</code>. Applies to Linux-based instances only.</p>" 5844 } 5845 }, 5846 "PatchBaselineIdentity": { 5847 "base": "<p>Defines the basic information about a patch baseline.</p>", 5848 "refs": { 5849 "PatchBaselineIdentityList$member": null, 5850 "PatchGroupPatchBaselineMapping$BaselineIdentity": "<p>The patch baseline the patch group is registered with.</p>" 5851 } 5852 }, 5853 "PatchBaselineIdentityList": { 5854 "base": null, 5855 "refs": { 5856 "DescribePatchBaselinesResult$BaselineIdentities": "<p>An array of <code>PatchBaselineIdentity</code> elements.</p>" 5857 } 5858 }, 5859 "PatchBaselineMaxResults": { 5860 "base": null, 5861 "refs": { 5862 "DescribeAvailablePatchesRequest$MaxResults": "<p>The maximum number of patches to return (per page).</p>", 5863 "DescribeEffectivePatchesForPatchBaselineRequest$MaxResults": "<p>The maximum number of patches to return (per page).</p>", 5864 "DescribePatchBaselinesRequest$MaxResults": "<p>The maximum number of patch baselines to return (per page).</p>", 5865 "DescribePatchGroupsRequest$MaxResults": "<p>The maximum number of patch groups to return (per page).</p>" 5866 } 5867 }, 5868 "PatchBugzillaId": { 5869 "base": null, 5870 "refs": { 5871 "PatchBugzillaIdList$member": null 5872 } 5873 }, 5874 "PatchBugzillaIdList": { 5875 "base": null, 5876 "refs": { 5877 "Patch$BugzillaIds": "<p>The Bugzilla ID of the patch. For example, <code>1600646</code>. Applies to Linux-based instances only.</p>" 5878 } 5879 }, 5880 "PatchCVEId": { 5881 "base": null, 5882 "refs": { 5883 "PatchCVEIdList$member": null 5884 } 5885 }, 5886 "PatchCVEIdList": { 5887 "base": null, 5888 "refs": { 5889 "Patch$CVEIds": "<p>The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, <code>CVE-2011-3192</code>. Applies to Linux-based instances only.</p>" 5890 } 5891 }, 5892 "PatchCVEIds": { 5893 "base": null, 5894 "refs": { 5895 "PatchComplianceData$CVEIds": "<p>The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.</p>" 5896 } 5897 }, 5898 "PatchClassification": { 5899 "base": null, 5900 "refs": { 5901 "Patch$Classification": "<p>The classification of the patch. For example, <code>SecurityUpdates</code>, <code>Updates</code>, or <code>CriticalUpdates</code>.</p>", 5902 "PatchComplianceData$Classification": "<p>The classification of the patch, such as <code>SecurityUpdates</code>, <code>Updates</code>, and <code>CriticalUpdates</code>.</p>" 5903 } 5904 }, 5905 "PatchComplianceData": { 5906 "base": "<p>Information about the state of a patch on a particular instance as it relates to the patch baseline used to patch the instance.</p>", 5907 "refs": { 5908 "PatchComplianceDataList$member": null 5909 } 5910 }, 5911 "PatchComplianceDataList": { 5912 "base": null, 5913 "refs": { 5914 "DescribeInstancePatchesResult$Patches": "<p>Each entry in the array is a structure containing:</p> <ul> <li> <p>Title (string)</p> </li> <li> <p>KBId (string)</p> </li> <li> <p>Classification (string)</p> </li> <li> <p>Severity (string)</p> </li> <li> <p>State (string, such as \"INSTALLED\" or \"FAILED\")</p> </li> <li> <p>InstalledTime (DateTime)</p> </li> <li> <p>InstalledBy (string)</p> </li> </ul>" 5915 } 5916 }, 5917 "PatchComplianceDataState": { 5918 "base": null, 5919 "refs": { 5920 "PatchComplianceData$State": "<p>The state of the patch on the instance, such as INSTALLED or FAILED.</p> <p>For descriptions of each patch state, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch\">About patch compliance</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 5921 } 5922 }, 5923 "PatchComplianceLevel": { 5924 "base": null, 5925 "refs": { 5926 "BaselineOverride$ApprovedPatchesComplianceLevel": "<p>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.</p>", 5927 "CreatePatchBaselineRequest$ApprovedPatchesComplianceLevel": "<p>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is <code>UNSPECIFIED</code>.</p>", 5928 "GetPatchBaselineResult$ApprovedPatchesComplianceLevel": "<p>Returns the specified compliance severity level for approved patches in the patch baseline.</p>", 5929 "PatchRule$ComplianceLevel": "<p>A compliance severity level for all approved patches in a patch baseline.</p>", 5930 "PatchStatus$ComplianceLevel": "<p>The compliance severity level for a patch.</p>", 5931 "UpdatePatchBaselineRequest$ApprovedPatchesComplianceLevel": "<p>Assigns a new compliance severity level to an existing patch baseline.</p>", 5932 "UpdatePatchBaselineResult$ApprovedPatchesComplianceLevel": "<p>The compliance severity level assigned to the patch baseline after the update completed.</p>" 5933 } 5934 }, 5935 "PatchComplianceMaxResults": { 5936 "base": null, 5937 "refs": { 5938 "DescribeInstancePatchStatesForPatchGroupRequest$MaxResults": "<p>The maximum number of patches to return (per page).</p>", 5939 "DescribeInstancePatchStatesRequest$MaxResults": "<p>The maximum number of instances to return (per page).</p>", 5940 "DescribeInstancePatchesRequest$MaxResults": "<p>The maximum number of patches to return (per page).</p>" 5941 } 5942 }, 5943 "PatchContentUrl": { 5944 "base": null, 5945 "refs": { 5946 "Patch$ContentUrl": "<p>The URL where more information can be obtained about the patch.</p>" 5947 } 5948 }, 5949 "PatchCriticalNonCompliantCount": { 5950 "base": null, 5951 "refs": { 5952 "InstancePatchState$CriticalNonCompliantCount": "<p>The number of instances where patches that are specified as <code>Critical</code> for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is <code>NON_COMPLIANT</code>.</p>" 5953 } 5954 }, 5955 "PatchDeploymentStatus": { 5956 "base": null, 5957 "refs": { 5958 "PatchStatus$DeploymentStatus": "<p>The approval status of a patch.</p>" 5959 } 5960 }, 5961 "PatchDescription": { 5962 "base": null, 5963 "refs": { 5964 "Patch$Description": "<p>The description of the patch.</p>" 5965 } 5966 }, 5967 "PatchEpoch": { 5968 "base": null, 5969 "refs": { 5970 "Patch$Epoch": "<p>The epoch of the patch. For example in <code>pkg-example-EE-20180914-2.2.amzn1.noarch</code>, the epoch value is <code>20180914-2</code>. Applies to Linux-based instances only.</p>" 5971 } 5972 }, 5973 "PatchFailedCount": { 5974 "base": null, 5975 "refs": { 5976 "InstancePatchState$FailedCount": "<p>The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.</p>" 5977 } 5978 }, 5979 "PatchFilter": { 5980 "base": "<p> Defines which patches should be included in a patch baseline.</p> <p>A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for <code>WINDOWS</code> are <code>PATCH_SET</code>, <code>PRODUCT</code>, <code>PRODUCT_FAMILY</code>, <code>CLASSIFICATION</code>, and <code>MSRC_SEVERITY</code>.</p> <p>The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is <code>PRODUCT</code> and the filter values are <code>[\"Office 2013\", \"Office 2016\"]</code>, then the filter accepts all patches where product name is either \"Office 2013\" or \"Office 2016\". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.</p> <p>You can view lists of valid values for the patch properties by running the <code>DescribePatchProperties</code> command. For information about which patch properties can be used with each major operating system, see <a>DescribePatchProperties</a>.</p>", 5981 "refs": { 5982 "PatchFilterList$member": null 5983 } 5984 }, 5985 "PatchFilterGroup": { 5986 "base": "<p>A set of patch filters, typically used for approval rules.</p>", 5987 "refs": { 5988 "BaselineOverride$GlobalFilters": null, 5989 "CreatePatchBaselineRequest$GlobalFilters": "<p>A set of global filters used to include patches in the baseline.</p>", 5990 "GetPatchBaselineResult$GlobalFilters": "<p>A set of global filters used to exclude patches from the baseline.</p>", 5991 "PatchRule$PatchFilterGroup": "<p>The patch filter group that defines the criteria for the rule.</p>", 5992 "UpdatePatchBaselineRequest$GlobalFilters": "<p>A set of global filters used to include patches in the baseline.</p>", 5993 "UpdatePatchBaselineResult$GlobalFilters": "<p>A set of global filters used to exclude patches from the baseline.</p>" 5994 } 5995 }, 5996 "PatchFilterKey": { 5997 "base": null, 5998 "refs": { 5999 "PatchFilter$Key": "<p>The key for the filter.</p> <p>Run the <a>DescribePatchProperties</a> command to view lists of valid keys for each operating system type.</p>" 6000 } 6001 }, 6002 "PatchFilterList": { 6003 "base": null, 6004 "refs": { 6005 "PatchFilterGroup$PatchFilters": "<p>The set of patch filters that make up the group.</p>" 6006 } 6007 }, 6008 "PatchFilterValue": { 6009 "base": null, 6010 "refs": { 6011 "PatchFilterValueList$member": null 6012 } 6013 }, 6014 "PatchFilterValueList": { 6015 "base": null, 6016 "refs": { 6017 "PatchFilter$Values": "<p>The value for the filter key.</p> <p>Run the <a>DescribePatchProperties</a> command to view lists of valid values for each key based on operating system type.</p>" 6018 } 6019 }, 6020 "PatchGroup": { 6021 "base": null, 6022 "refs": { 6023 "DeregisterPatchBaselineForPatchGroupRequest$PatchGroup": "<p>The name of the patch group that should be deregistered from the patch baseline.</p>", 6024 "DeregisterPatchBaselineForPatchGroupResult$PatchGroup": "<p>The name of the patch group deregistered from the patch baseline.</p>", 6025 "DescribeInstancePatchStatesForPatchGroupRequest$PatchGroup": "<p>The name of the patch group for which the patch state information should be retrieved.</p>", 6026 "DescribePatchGroupStateRequest$PatchGroup": "<p>The name of the patch group whose patch snapshot should be retrieved.</p>", 6027 "GetPatchBaselineForPatchGroupRequest$PatchGroup": "<p>The name of the patch group whose patch baseline should be retrieved.</p>", 6028 "GetPatchBaselineForPatchGroupResult$PatchGroup": "<p>The name of the patch group.</p>", 6029 "InstancePatchState$PatchGroup": "<p>The name of the patch group the managed instance belongs to.</p>", 6030 "PatchGroupList$member": null, 6031 "PatchGroupPatchBaselineMapping$PatchGroup": "<p>The name of the patch group registered with the patch baseline.</p>", 6032 "RegisterPatchBaselineForPatchGroupRequest$PatchGroup": "<p>The name of the patch group to be registered with the patch baseline.</p>", 6033 "RegisterPatchBaselineForPatchGroupResult$PatchGroup": "<p>The name of the patch group registered with the patch baseline.</p>" 6034 } 6035 }, 6036 "PatchGroupList": { 6037 "base": null, 6038 "refs": { 6039 "GetPatchBaselineResult$PatchGroups": "<p>Patch groups included in the patch baseline.</p>" 6040 } 6041 }, 6042 "PatchGroupPatchBaselineMapping": { 6043 "base": "<p>The mapping between a patch group and the patch baseline the patch group is registered with.</p>", 6044 "refs": { 6045 "PatchGroupPatchBaselineMappingList$member": null 6046 } 6047 }, 6048 "PatchGroupPatchBaselineMappingList": { 6049 "base": null, 6050 "refs": { 6051 "DescribePatchGroupsResult$Mappings": "<p>Each entry in the array contains:</p> <ul> <li> <p> <code>PatchGroup</code>: string (between 1 and 256 characters. Regex: <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$)</code> </p> </li> <li> <p> <code>PatchBaselineIdentity</code>: A <code>PatchBaselineIdentity</code> element.</p> </li> </ul>" 6052 } 6053 }, 6054 "PatchId": { 6055 "base": null, 6056 "refs": { 6057 "Patch$Id": "<p>The ID of the patch. Applies to Windows patches only.</p> <note> <p>This ID isn't the same as the Microsoft Knowledge Base ID.</p> </note>", 6058 "PatchIdList$member": null 6059 } 6060 }, 6061 "PatchIdList": { 6062 "base": null, 6063 "refs": { 6064 "BaselineOverride$ApprovedPatches": "<p>A list of explicitly approved patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 6065 "BaselineOverride$RejectedPatches": "<p>A list of explicitly rejected patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 6066 "CreatePatchBaselineRequest$ApprovedPatches": "<p>A list of explicitly approved patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 6067 "CreatePatchBaselineRequest$RejectedPatches": "<p>A list of explicitly rejected patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 6068 "GetPatchBaselineResult$ApprovedPatches": "<p>A list of explicitly approved patches for the baseline.</p>", 6069 "GetPatchBaselineResult$RejectedPatches": "<p>A list of explicitly rejected patches for the baseline.</p>", 6070 "UpdatePatchBaselineRequest$ApprovedPatches": "<p>A list of explicitly approved patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 6071 "UpdatePatchBaselineRequest$RejectedPatches": "<p>A list of explicitly rejected patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 6072 "UpdatePatchBaselineResult$ApprovedPatches": "<p>A list of explicitly approved patches for the baseline.</p>", 6073 "UpdatePatchBaselineResult$RejectedPatches": "<p>A list of explicitly rejected patches for the baseline.</p>" 6074 } 6075 }, 6076 "PatchInstalledCount": { 6077 "base": null, 6078 "refs": { 6079 "InstancePatchState$InstalledCount": "<p>The number of patches from the patch baseline that are installed on the instance.</p>" 6080 } 6081 }, 6082 "PatchInstalledOtherCount": { 6083 "base": null, 6084 "refs": { 6085 "InstancePatchState$InstalledOtherCount": "<p>The number of patches not specified in the patch baseline that are installed on the instance.</p>" 6086 } 6087 }, 6088 "PatchInstalledPendingRebootCount": { 6089 "base": null, 6090 "refs": { 6091 "InstancePatchState$InstalledPendingRebootCount": "<p>The number of patches installed by Patch Manager since the last time the instance was rebooted.</p>" 6092 } 6093 }, 6094 "PatchInstalledRejectedCount": { 6095 "base": null, 6096 "refs": { 6097 "InstancePatchState$InstalledRejectedCount": "<p>The number of patches installed on an instance that are specified in a <code>RejectedPatches</code> list. Patches with a status of <code>InstalledRejected</code> were typically installed before they were added to a <code>RejectedPatches</code> list.</p> <note> <p>If <code>ALLOW_AS_DEPENDENCY</code> is the specified option for <code>RejectedPatchesAction</code>, the value of <code>InstalledRejectedCount</code> will always be <code>0</code> (zero).</p> </note>" 6098 } 6099 }, 6100 "PatchKbNumber": { 6101 "base": null, 6102 "refs": { 6103 "Patch$KbNumber": "<p>The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.</p>", 6104 "PatchComplianceData$KBId": "<p>The operating system-specific ID of the patch.</p>" 6105 } 6106 }, 6107 "PatchLanguage": { 6108 "base": null, 6109 "refs": { 6110 "Patch$Language": "<p>The language of the patch if it's language-specific.</p>" 6111 } 6112 }, 6113 "PatchList": { 6114 "base": null, 6115 "refs": { 6116 "DescribeAvailablePatchesResult$Patches": "<p>An array of patches. Each entry in the array is a patch structure.</p>" 6117 } 6118 }, 6119 "PatchMissingCount": { 6120 "base": null, 6121 "refs": { 6122 "InstancePatchState$MissingCount": "<p>The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.</p>" 6123 } 6124 }, 6125 "PatchMsrcNumber": { 6126 "base": null, 6127 "refs": { 6128 "Patch$MsrcNumber": "<p>The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, <code>MS14-045</code>. Applies to Windows patches only.</p>" 6129 } 6130 }, 6131 "PatchMsrcSeverity": { 6132 "base": null, 6133 "refs": { 6134 "Patch$MsrcSeverity": "<p>The severity of the patch, such as <code>Critical</code>, <code>Important</code>, or <code>Moderate</code>. Applies to Windows patches only.</p>" 6135 } 6136 }, 6137 "PatchName": { 6138 "base": null, 6139 "refs": { 6140 "Patch$Name": "<p>The name of the patch. Applies to Linux-based instances only.</p>" 6141 } 6142 }, 6143 "PatchNotApplicableCount": { 6144 "base": null, 6145 "refs": { 6146 "InstancePatchState$NotApplicableCount": "<p>The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in <code>UnreportedNotApplicableCount</code>.</p>" 6147 } 6148 }, 6149 "PatchOperationType": { 6150 "base": null, 6151 "refs": { 6152 "InstancePatchState$Operation": "<p>The type of patching operation that was performed: or </p> <ul> <li> <p> <code>SCAN</code> assesses the patch compliance state.</p> </li> <li> <p> <code>INSTALL</code> installs missing patches.</p> </li> </ul>" 6153 } 6154 }, 6155 "PatchOrchestratorFilter": { 6156 "base": "<p>Defines a filter used in Patch Manager APIs. Supported filter keys depend on the API operation that includes the filter. Patch Manager API operations that use <code>PatchOrchestratorFilter</code> include the following:</p> <ul> <li> <p> <a>DescribeAvailablePatches</a> </p> </li> <li> <p> <a>DescribeInstancePatches</a> </p> </li> <li> <p> <a>DescribePatchBaselines</a> </p> </li> <li> <p> <a>DescribePatchGroups</a> </p> </li> </ul>", 6157 "refs": { 6158 "PatchOrchestratorFilterList$member": null 6159 } 6160 }, 6161 "PatchOrchestratorFilterKey": { 6162 "base": null, 6163 "refs": { 6164 "PatchOrchestratorFilter$Key": "<p>The key for the filter.</p>" 6165 } 6166 }, 6167 "PatchOrchestratorFilterList": { 6168 "base": null, 6169 "refs": { 6170 "DescribeAvailablePatchesRequest$Filters": "<p>Each element in the array is a structure containing a key-value pair.</p> <p> <b>Windows Server</b> </p> <p>Supported keys for Windows Server instance patches include the following:</p> <ul> <li> <p> <b> <code>PATCH_SET</code> </b> </p> <p>Sample values: <code>OS</code> | <code>APPLICATION</code> </p> </li> <li> <p> <b> <code>PRODUCT</code> </b> </p> <p>Sample values: <code>WindowsServer2012</code> | <code>Office 2010</code> | <code>MicrosoftDefenderAntivirus</code> </p> </li> <li> <p> <b> <code>PRODUCT_FAMILY</code> </b> </p> <p>Sample values: <code>Windows</code> | <code>Office</code> </p> </li> <li> <p> <b> <code>MSRC_SEVERITY</code> </b> </p> <p>Sample values: <code>ServicePacks</code> | <code>Important</code> | <code>Moderate</code> </p> </li> <li> <p> <b> <code>CLASSIFICATION</code> </b> </p> <p>Sample values: <code>ServicePacks</code> | <code>SecurityUpdates</code> | <code>DefinitionUpdates</code> </p> </li> <li> <p> <b> <code>PATCH_ID</code> </b> </p> <p>Sample values: <code>KB123456</code> | <code>KB4516046</code> </p> </li> </ul> <p> <b>Linux</b> </p> <important> <p>When specifying filters for Linux patches, you must specify a key-pair for <code>PRODUCT</code>. For example, using the Command Line Interface (CLI), the following command fails:</p> <p> <code>aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615</code> </p> <p>However, the following command succeeds:</p> <p> <code>aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615</code> </p> </important> <p>Supported keys for Linux instance patches include the following:</p> <ul> <li> <p> <b> <code>PRODUCT</code> </b> </p> <p>Sample values: <code>AmazonLinux2018.03</code> | <code>AmazonLinux2.0</code> </p> </li> <li> <p> <b> <code>NAME</code> </b> </p> <p>Sample values: <code>kernel-headers</code> | <code>samba-python</code> | <code>php</code> </p> </li> <li> <p> <b> <code>SEVERITY</code> </b> </p> <p>Sample values: <code>Critical</code> | <code>Important</code> | <code>Medium</code> | <code>Low</code> </p> </li> <li> <p> <b> <code>EPOCH</code> </b> </p> <p>Sample values: <code>0</code> | <code>1</code> </p> </li> <li> <p> <b> <code>VERSION</code> </b> </p> <p>Sample values: <code>78.6.1</code> | <code>4.10.16</code> </p> </li> <li> <p> <b> <code>RELEASE</code> </b> </p> <p>Sample values: <code>9.56.amzn1</code> | <code>1.amzn2</code> </p> </li> <li> <p> <b> <code>ARCH</code> </b> </p> <p>Sample values: <code>i686</code> | <code>x86_64</code> </p> </li> <li> <p> <b> <code>REPOSITORY</code> </b> </p> <p>Sample values: <code>Core</code> | <code>Updates</code> </p> </li> <li> <p> <b> <code>ADVISORY_ID</code> </b> </p> <p>Sample values: <code>ALAS-2018-1058</code> | <code>ALAS2-2021-1594</code> </p> </li> <li> <p> <b> <code>CVE_ID</code> </b> </p> <p>Sample values: <code>CVE-2018-3615</code> | <code>CVE-2020-1472</code> </p> </li> <li> <p> <b> <code>BUGZILLA_ID</code> </b> </p> <p>Sample values: <code>1463241</code> </p> </li> </ul>", 6171 "DescribeInstancePatchesRequest$Filters": "<p>Each element in the array is a structure containing a key-value pair.</p> <p>Supported keys for <code>DescribeInstancePatches</code>include the following:</p> <ul> <li> <p> <b> <code>Classification</code> </b> </p> <p>Sample values: <code>Security</code> | <code>SecurityUpdates</code> </p> </li> <li> <p> <b> <code>KBId</code> </b> </p> <p>Sample values: <code>KB4480056</code> | <code>java-1.7.0-openjdk.x86_64</code> </p> </li> <li> <p> <b> <code>Severity</code> </b> </p> <p>Sample values: <code>Important</code> | <code>Medium</code> | <code>Low</code> </p> </li> <li> <p> <b> <code>State</code> </b> </p> <p>Sample values: <code>Installed</code> | <code>InstalledOther</code> | <code>InstalledPendingReboot</code> </p> </li> </ul>", 6172 "DescribeMaintenanceWindowScheduleRequest$Filters": "<p>Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.</p>", 6173 "DescribePatchBaselinesRequest$Filters": "<p>Each element in the array is a structure containing a key-value pair.</p> <p>Supported keys for <code>DescribePatchBaselines</code> include the following:</p> <ul> <li> <p> <b> <code>NAME_PREFIX</code> </b> </p> <p>Sample values: <code>AWS-</code> | <code>My-</code> </p> </li> <li> <p> <b> <code>OWNER</code> </b> </p> <p>Sample values: <code>AWS</code> | <code>Self</code> </p> </li> <li> <p> <b> <code>OPERATING_SYSTEM</code> </b> </p> <p>Sample values: <code>AMAZON_LINUX</code> | <code>SUSE</code> | <code>WINDOWS</code> </p> </li> </ul>", 6174 "DescribePatchGroupsRequest$Filters": "<p>Each element in the array is a structure containing a key-value pair.</p> <p>Supported keys for <code>DescribePatchGroups</code> include the following:</p> <ul> <li> <p> <b> <code>NAME_PREFIX</code> </b> </p> <p>Sample values: <code>AWS-</code> | <code>My-</code>.</p> </li> <li> <p> <b> <code>OPERATING_SYSTEM</code> </b> </p> <p>Sample values: <code>AMAZON_LINUX</code> | <code>SUSE</code> | <code>WINDOWS</code> </p> </li> </ul>" 6175 } 6176 }, 6177 "PatchOrchestratorFilterValue": { 6178 "base": null, 6179 "refs": { 6180 "PatchOrchestratorFilterValues$member": null 6181 } 6182 }, 6183 "PatchOrchestratorFilterValues": { 6184 "base": null, 6185 "refs": { 6186 "PatchOrchestratorFilter$Values": "<p>The value for the filter.</p>" 6187 } 6188 }, 6189 "PatchOtherNonCompliantCount": { 6190 "base": null, 6191 "refs": { 6192 "InstancePatchState$OtherNonCompliantCount": "<p>The number of instances with patches installed that are specified as other than <code>Critical</code> or <code>Security</code> but aren't compliant with the patch baseline. The status of these instances is <code>NON_COMPLIANT</code>.</p>" 6193 } 6194 }, 6195 "PatchProduct": { 6196 "base": null, 6197 "refs": { 6198 "Patch$Product": "<p>The specific product the patch is applicable for. For example, <code>WindowsServer2016</code> or <code>AmazonLinux2018.03</code>.</p>" 6199 } 6200 }, 6201 "PatchProductFamily": { 6202 "base": null, 6203 "refs": { 6204 "Patch$ProductFamily": "<p>The product family the patch is applicable for. For example, <code>Windows</code> or <code>Amazon Linux 2</code>.</p>" 6205 } 6206 }, 6207 "PatchPropertiesList": { 6208 "base": null, 6209 "refs": { 6210 "DescribePatchPropertiesResult$Properties": "<p>A list of the properties for patches matching the filter request parameters.</p>" 6211 } 6212 }, 6213 "PatchProperty": { 6214 "base": null, 6215 "refs": { 6216 "DescribePatchPropertiesRequest$Property": "<p>The patch property for which you want to view patch details. </p>" 6217 } 6218 }, 6219 "PatchPropertyEntry": { 6220 "base": null, 6221 "refs": { 6222 "PatchPropertiesList$member": null 6223 } 6224 }, 6225 "PatchRelease": { 6226 "base": null, 6227 "refs": { 6228 "Patch$Release": "<p>The particular release of a patch. For example, in <code>pkg-example-EE-20180914-2.2.amzn1.noarch</code>, the release is <code>2.amaz1</code>. Applies to Linux-based instances only.</p>" 6229 } 6230 }, 6231 "PatchRepository": { 6232 "base": null, 6233 "refs": { 6234 "Patch$Repository": "<p>The source patch repository for the operating system and version, such as <code>trusty-security</code> for Ubuntu Server 14.04 LTE and <code>focal-security</code> for Ubuntu Server 20.04 LTE. Applies to Linux-based instances only.</p>" 6235 } 6236 }, 6237 "PatchRule": { 6238 "base": "<p>Defines an approval rule for a patch baseline.</p>", 6239 "refs": { 6240 "PatchRuleList$member": null 6241 } 6242 }, 6243 "PatchRuleGroup": { 6244 "base": "<p>A set of rules defining the approval rules for a patch baseline.</p>", 6245 "refs": { 6246 "BaselineOverride$ApprovalRules": null, 6247 "CreatePatchBaselineRequest$ApprovalRules": "<p>A set of rules used to include patches in the baseline.</p>", 6248 "GetPatchBaselineResult$ApprovalRules": "<p>A set of rules used to include patches in the baseline.</p>", 6249 "UpdatePatchBaselineRequest$ApprovalRules": "<p>A set of rules used to include patches in the baseline.</p>", 6250 "UpdatePatchBaselineResult$ApprovalRules": "<p>A set of rules used to include patches in the baseline.</p>" 6251 } 6252 }, 6253 "PatchRuleList": { 6254 "base": null, 6255 "refs": { 6256 "PatchRuleGroup$PatchRules": "<p>The rules that make up the rule group.</p>" 6257 } 6258 }, 6259 "PatchSecurityNonCompliantCount": { 6260 "base": null, 6261 "refs": { 6262 "InstancePatchState$SecurityNonCompliantCount": "<p>The number of instances where patches that are specified as <code>Security</code> in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required instance reboot. The status of these instances is <code>NON_COMPLIANT</code>.</p>" 6263 } 6264 }, 6265 "PatchSet": { 6266 "base": null, 6267 "refs": { 6268 "DescribePatchPropertiesRequest$PatchSet": "<p>Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.</p>" 6269 } 6270 }, 6271 "PatchSeverity": { 6272 "base": null, 6273 "refs": { 6274 "Patch$Severity": "<p>The severity level of the patch. For example, <code>CRITICAL</code> or <code>MODERATE</code>.</p>", 6275 "PatchComplianceData$Severity": "<p>The severity of the patchsuch as <code>Critical</code>, <code>Important</code>, and <code>Moderate</code>.</p>" 6276 } 6277 }, 6278 "PatchSource": { 6279 "base": "<p>Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.</p>", 6280 "refs": { 6281 "PatchSourceList$member": null 6282 } 6283 }, 6284 "PatchSourceConfiguration": { 6285 "base": null, 6286 "refs": { 6287 "PatchSource$Configuration": "<p>The value of the yum repo configuration. For example:</p> <p> <code>[main]</code> </p> <p> <code>name=MyCustomRepository</code> </p> <p> <code>baseurl=https://my-custom-repository</code> </p> <p> <code>enabled=1</code> </p> <note> <p>For information about other options available for your yum repository configuration, see <a href=\"https://man7.org/linux/man-pages/man5/dnf.conf.5.html\">dnf.conf(5)</a>.</p> </note>" 6288 } 6289 }, 6290 "PatchSourceList": { 6291 "base": null, 6292 "refs": { 6293 "BaselineOverride$Sources": "<p>Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.</p>", 6294 "CreatePatchBaselineRequest$Sources": "<p>Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.</p>", 6295 "GetPatchBaselineResult$Sources": "<p>Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.</p>", 6296 "UpdatePatchBaselineRequest$Sources": "<p>Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.</p>", 6297 "UpdatePatchBaselineResult$Sources": "<p>Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.</p>" 6298 } 6299 }, 6300 "PatchSourceName": { 6301 "base": null, 6302 "refs": { 6303 "PatchSource$Name": "<p>The name specified to identify the patch source.</p>" 6304 } 6305 }, 6306 "PatchSourceProduct": { 6307 "base": null, 6308 "refs": { 6309 "PatchSourceProductList$member": null 6310 } 6311 }, 6312 "PatchSourceProductList": { 6313 "base": null, 6314 "refs": { 6315 "PatchSource$Products": "<p>The specific operating system versions a patch repository applies to, such as \"Ubuntu16.04\", \"AmazonLinux2016.09\", \"RedhatEnterpriseLinux7.2\" or \"Suse12.7\". For lists of supported product values, see <a>PatchFilter</a>.</p>" 6316 } 6317 }, 6318 "PatchStatus": { 6319 "base": "<p>Information about the approval status of a patch.</p>", 6320 "refs": { 6321 "EffectivePatch$PatchStatus": "<p>The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.</p>" 6322 } 6323 }, 6324 "PatchStringDateTime": { 6325 "base": null, 6326 "refs": { 6327 "PatchRule$ApproveUntilDate": "<p>The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.</p> <p>Enter dates in the format <code>YYYY-MM-DD</code>. For example, <code>2021-12-31</code>.</p>" 6328 } 6329 }, 6330 "PatchTitle": { 6331 "base": null, 6332 "refs": { 6333 "Patch$Title": "<p>The title of the patch.</p>", 6334 "PatchComplianceData$Title": "<p>The title of the patch.</p>" 6335 } 6336 }, 6337 "PatchUnreportedNotApplicableCount": { 6338 "base": null, 6339 "refs": { 6340 "InstancePatchState$UnreportedNotApplicableCount": "<p>The number of patches beyond the supported limit of <code>NotApplicableCount</code> that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.</p>" 6341 } 6342 }, 6343 "PatchVendor": { 6344 "base": null, 6345 "refs": { 6346 "Patch$Vendor": "<p>The name of the vendor providing the patch.</p>" 6347 } 6348 }, 6349 "PatchVersion": { 6350 "base": null, 6351 "refs": { 6352 "Patch$Version": "<p>The version number of the patch. For example, in <code>example-pkg-1.710.10-2.7.abcd.x86_64</code>, the version number is indicated by <code>-1</code>. Applies to Linux-based instances only.</p>" 6353 } 6354 }, 6355 "PingStatus": { 6356 "base": null, 6357 "refs": { 6358 "InstanceInformation$PingStatus": "<p>Connection status of SSM Agent. </p> <note> <p>The status <code>Inactive</code> has been deprecated and is no longer in use.</p> </note>" 6359 } 6360 }, 6361 "PlatformType": { 6362 "base": null, 6363 "refs": { 6364 "InstanceInformation$PlatformType": "<p>The operating system platform type. </p>", 6365 "PlatformTypeList$member": null 6366 } 6367 }, 6368 "PlatformTypeList": { 6369 "base": null, 6370 "refs": { 6371 "DocumentDescription$PlatformTypes": "<p>The list of OS platforms compatible with this SSM document. </p>", 6372 "DocumentIdentifier$PlatformTypes": "<p>The operating system platform. </p>" 6373 } 6374 }, 6375 "PoliciesLimitExceededException": { 6376 "base": "<p>You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.</p>", 6377 "refs": { 6378 } 6379 }, 6380 "Product": { 6381 "base": null, 6382 "refs": { 6383 "GetDeployablePatchSnapshotForInstanceResult$Product": "<p>Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.</p>" 6384 } 6385 }, 6386 "ProgressCounters": { 6387 "base": "<p>An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.</p>", 6388 "refs": { 6389 "AutomationExecution$ProgressCounters": "<p>An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.</p>" 6390 } 6391 }, 6392 "PutComplianceItemsRequest": { 6393 "base": null, 6394 "refs": { 6395 } 6396 }, 6397 "PutComplianceItemsResult": { 6398 "base": null, 6399 "refs": { 6400 } 6401 }, 6402 "PutInventoryMessage": { 6403 "base": null, 6404 "refs": { 6405 "PutInventoryResult$Message": "<p>Information about the request.</p>" 6406 } 6407 }, 6408 "PutInventoryRequest": { 6409 "base": null, 6410 "refs": { 6411 } 6412 }, 6413 "PutInventoryResult": { 6414 "base": null, 6415 "refs": { 6416 } 6417 }, 6418 "PutParameterRequest": { 6419 "base": null, 6420 "refs": { 6421 } 6422 }, 6423 "PutParameterResult": { 6424 "base": null, 6425 "refs": { 6426 } 6427 }, 6428 "RebootOption": { 6429 "base": null, 6430 "refs": { 6431 "InstancePatchState$RebootOption": "<p>Indicates the reboot option specified in the patch baseline.</p> <note> <p>Reboot options apply to <code>Install</code> operations only. Reboots aren't attempted for Patch Manager <code>Scan</code> operations.</p> </note> <ul> <li> <p> <code>RebootIfNeeded</code>: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of <code>InstalledPendingReboot</code>.</p> </li> <li> <p> <code>NoReboot</code>: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of <code>InstalledPendingReboot</code>. These patches might not be in effect until a reboot is performed.</p> </li> </ul>" 6432 } 6433 }, 6434 "Region": { 6435 "base": null, 6436 "refs": { 6437 "Regions$member": null 6438 } 6439 }, 6440 "Regions": { 6441 "base": null, 6442 "refs": { 6443 "TargetLocation$Regions": "<p>The Amazon Web Services Regions targeted by the current Automation execution.</p>" 6444 } 6445 }, 6446 "RegisterDefaultPatchBaselineRequest": { 6447 "base": null, 6448 "refs": { 6449 } 6450 }, 6451 "RegisterDefaultPatchBaselineResult": { 6452 "base": null, 6453 "refs": { 6454 } 6455 }, 6456 "RegisterPatchBaselineForPatchGroupRequest": { 6457 "base": null, 6458 "refs": { 6459 } 6460 }, 6461 "RegisterPatchBaselineForPatchGroupResult": { 6462 "base": null, 6463 "refs": { 6464 } 6465 }, 6466 "RegisterTargetWithMaintenanceWindowRequest": { 6467 "base": null, 6468 "refs": { 6469 } 6470 }, 6471 "RegisterTargetWithMaintenanceWindowResult": { 6472 "base": null, 6473 "refs": { 6474 } 6475 }, 6476 "RegisterTaskWithMaintenanceWindowRequest": { 6477 "base": null, 6478 "refs": { 6479 } 6480 }, 6481 "RegisterTaskWithMaintenanceWindowResult": { 6482 "base": null, 6483 "refs": { 6484 } 6485 }, 6486 "RegistrationLimit": { 6487 "base": null, 6488 "refs": { 6489 "Activation$RegistrationLimit": "<p>The maximum number of managed instances that can be registered using this activation.</p>", 6490 "CreateActivationRequest$RegistrationLimit": "<p>Specify the maximum number of managed instances you want to register. The default value is <code>1</code>.</p>" 6491 } 6492 }, 6493 "RegistrationsCount": { 6494 "base": null, 6495 "refs": { 6496 "Activation$RegistrationsCount": "<p>The number of managed instances already registered with this activation.</p>" 6497 } 6498 }, 6499 "RelatedOpsItem": { 6500 "base": "<p>An OpsItems that shares something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.</p>", 6501 "refs": { 6502 "RelatedOpsItems$member": null 6503 } 6504 }, 6505 "RelatedOpsItems": { 6506 "base": null, 6507 "refs": { 6508 "CreateOpsItemRequest$RelatedOpsItems": "<p>One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.</p>", 6509 "OpsItem$RelatedOpsItems": "<p>One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.</p>", 6510 "UpdateOpsItemRequest$RelatedOpsItems": "<p>One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.</p>" 6511 } 6512 }, 6513 "RemainingCount": { 6514 "base": null, 6515 "refs": { 6516 "InventoryDeletionSummary$RemainingCount": "<p>Remaining number of items to delete.</p>", 6517 "InventoryDeletionSummaryItem$RemainingCount": "<p>The remaining number of items to delete.</p>" 6518 } 6519 }, 6520 "RemoveTagsFromResourceRequest": { 6521 "base": null, 6522 "refs": { 6523 } 6524 }, 6525 "RemoveTagsFromResourceResult": { 6526 "base": null, 6527 "refs": { 6528 } 6529 }, 6530 "ResetServiceSettingRequest": { 6531 "base": "<p>The request body of the ResetServiceSetting API operation.</p>", 6532 "refs": { 6533 } 6534 }, 6535 "ResetServiceSettingResult": { 6536 "base": "<p>The result body of the ResetServiceSetting API operation.</p>", 6537 "refs": { 6538 } 6539 }, 6540 "ResolvedTargets": { 6541 "base": "<p>Information about targets that resolved during the Automation execution.</p>", 6542 "refs": { 6543 "AutomationExecution$ResolvedTargets": "<p>A list of resolved targets in the rate control execution.</p>", 6544 "AutomationExecutionMetadata$ResolvedTargets": "<p>A list of targets that resolved during the execution.</p>" 6545 } 6546 }, 6547 "ResourceComplianceSummaryItem": { 6548 "base": "<p>Compliance summary information for a specific resource. </p>", 6549 "refs": { 6550 "ResourceComplianceSummaryItemList$member": null 6551 } 6552 }, 6553 "ResourceComplianceSummaryItemList": { 6554 "base": null, 6555 "refs": { 6556 "ListResourceComplianceSummariesResult$ResourceComplianceSummaryItems": "<p>A summary count for specified or targeted managed instances. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify. </p>" 6557 } 6558 }, 6559 "ResourceCount": { 6560 "base": null, 6561 "refs": { 6562 "InventoryDeletionSummaryItem$Count": "<p>A count of the number of deleted items.</p>" 6563 } 6564 }, 6565 "ResourceCountByStatus": { 6566 "base": null, 6567 "refs": { 6568 "AssociationExecution$ResourceCountByStatus": "<p>An aggregate status of the resources in the execution based on the status type.</p>" 6569 } 6570 }, 6571 "ResourceDataSyncAWSKMSKeyARN": { 6572 "base": null, 6573 "refs": { 6574 "ResourceDataSyncS3Destination$AWSKMSKeyARN": "<p>The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.</p>" 6575 } 6576 }, 6577 "ResourceDataSyncAlreadyExistsException": { 6578 "base": "<p>A sync configuration with the same name already exists.</p>", 6579 "refs": { 6580 } 6581 }, 6582 "ResourceDataSyncAwsOrganizationsSource": { 6583 "base": "<p>Information about the <code>AwsOrganizationsSource</code> resource data sync source. A sync source of this type can synchronize data from Organizations or, if an Amazon Web Services organization isn't present, from multiple Amazon Web Services Regions.</p>", 6584 "refs": { 6585 "ResourceDataSyncSource$AwsOrganizationsSource": "<p>Information about the <code>AwsOrganizationsSource</code> resource data sync source. A sync source of this type can synchronize data from Organizations.</p>", 6586 "ResourceDataSyncSourceWithState$AwsOrganizationsSource": "<p>The field name in <code>SyncSource</code> for the <code>ResourceDataSyncAwsOrganizationsSource</code> type.</p>" 6587 } 6588 }, 6589 "ResourceDataSyncConflictException": { 6590 "base": "<p>Another <code>UpdateResourceDataSync</code> request is being processed. Wait a few minutes and try again.</p>", 6591 "refs": { 6592 } 6593 }, 6594 "ResourceDataSyncCountExceededException": { 6595 "base": "<p>You have exceeded the allowed maximum sync configurations.</p>", 6596 "refs": { 6597 } 6598 }, 6599 "ResourceDataSyncCreatedTime": { 6600 "base": null, 6601 "refs": { 6602 "ResourceDataSyncItem$SyncCreatedTime": "<p>The date and time the configuration was created (UTC).</p>" 6603 } 6604 }, 6605 "ResourceDataSyncDestinationDataSharing": { 6606 "base": "<p>Synchronize Amazon Web Services Systems Manager Inventory data from multiple Amazon Web Services accounts defined in Organizations to a centralized Amazon S3 bucket. Data is synchronized to individual key prefixes in the central bucket. Each key prefix represents a different Amazon Web Services account ID.</p>", 6607 "refs": { 6608 "ResourceDataSyncS3Destination$DestinationDataSharing": "<p>Enables destination data sharing. By default, this field is <code>null</code>.</p>" 6609 } 6610 }, 6611 "ResourceDataSyncDestinationDataSharingType": { 6612 "base": null, 6613 "refs": { 6614 "ResourceDataSyncDestinationDataSharing$DestinationDataSharingType": "<p>The sharing data type. Only <code>Organization</code> is supported.</p>" 6615 } 6616 }, 6617 "ResourceDataSyncEnableAllOpsDataSources": { 6618 "base": null, 6619 "refs": { 6620 "ResourceDataSyncSource$EnableAllOpsDataSources": "<p>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html\">About multiple account and Region resource data syncs</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 6621 "ResourceDataSyncSourceWithState$EnableAllOpsDataSources": "<p>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html\">About multiple account and Region resource data syncs</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" 6622 } 6623 }, 6624 "ResourceDataSyncIncludeFutureRegions": { 6625 "base": null, 6626 "refs": { 6627 "ResourceDataSyncSource$IncludeFutureRegions": "<p>Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.</p>", 6628 "ResourceDataSyncSourceWithState$IncludeFutureRegions": "<p>Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.</p>" 6629 } 6630 }, 6631 "ResourceDataSyncInvalidConfigurationException": { 6632 "base": "<p>The specified sync configuration is invalid.</p>", 6633 "refs": { 6634 } 6635 }, 6636 "ResourceDataSyncItem": { 6637 "base": "<p>Information about a resource data sync configuration, including its current status and last successful sync.</p>", 6638 "refs": { 6639 "ResourceDataSyncItemList$member": null 6640 } 6641 }, 6642 "ResourceDataSyncItemList": { 6643 "base": null, 6644 "refs": { 6645 "ListResourceDataSyncResult$ResourceDataSyncItems": "<p>A list of your current resource data sync configurations and their statuses.</p>" 6646 } 6647 }, 6648 "ResourceDataSyncLastModifiedTime": { 6649 "base": null, 6650 "refs": { 6651 "ResourceDataSyncItem$SyncLastModifiedTime": "<p>The date and time the resource data sync was changed. </p>" 6652 } 6653 }, 6654 "ResourceDataSyncName": { 6655 "base": null, 6656 "refs": { 6657 "CreateResourceDataSyncRequest$SyncName": "<p>A name for the configuration.</p>", 6658 "DeleteResourceDataSyncRequest$SyncName": "<p>The name of the configuration to delete.</p>", 6659 "GetOpsSummaryRequest$SyncName": "<p>Specify the name of a resource data sync to get.</p>", 6660 "ResourceDataSyncAlreadyExistsException$SyncName": null, 6661 "ResourceDataSyncItem$SyncName": "<p>The name of the resource data sync.</p>", 6662 "ResourceDataSyncNotFoundException$SyncName": null, 6663 "UpdateResourceDataSyncRequest$SyncName": "<p>The name of the resource data sync you want to update.</p>" 6664 } 6665 }, 6666 "ResourceDataSyncNotFoundException": { 6667 "base": "<p>The specified sync name wasn't found.</p>", 6668 "refs": { 6669 } 6670 }, 6671 "ResourceDataSyncOrganizationSourceType": { 6672 "base": null, 6673 "refs": { 6674 "ResourceDataSyncAwsOrganizationsSource$OrganizationSourceType": "<p>If an Amazon Web Services organization is present, this is either <code>OrganizationalUnits</code> or <code>EntireOrganization</code>. For <code>OrganizationalUnits</code>, the data is aggregated from a set of organization units. For <code>EntireOrganization</code>, the data is aggregated from the entire Amazon Web Services organization.</p>" 6675 } 6676 }, 6677 "ResourceDataSyncOrganizationalUnit": { 6678 "base": "<p>The Organizations organizational unit data source for the sync.</p>", 6679 "refs": { 6680 "ResourceDataSyncOrganizationalUnitList$member": null 6681 } 6682 }, 6683 "ResourceDataSyncOrganizationalUnitId": { 6684 "base": null, 6685 "refs": { 6686 "ResourceDataSyncOrganizationalUnit$OrganizationalUnitId": "<p>The Organizations unit ID data source for the sync.</p>" 6687 } 6688 }, 6689 "ResourceDataSyncOrganizationalUnitList": { 6690 "base": null, 6691 "refs": { 6692 "ResourceDataSyncAwsOrganizationsSource$OrganizationalUnits": "<p>The Organizations organization units included in the sync.</p>" 6693 } 6694 }, 6695 "ResourceDataSyncS3BucketName": { 6696 "base": null, 6697 "refs": { 6698 "ResourceDataSyncS3Destination$BucketName": "<p>The name of the S3 bucket where the aggregated data is stored.</p>" 6699 } 6700 }, 6701 "ResourceDataSyncS3Destination": { 6702 "base": "<p>Information about the target S3 bucket for the resource data sync.</p>", 6703 "refs": { 6704 "CreateResourceDataSyncRequest$S3Destination": "<p>Amazon S3 configuration details for the sync. This parameter is required if the <code>SyncType</code> value is SyncToDestination.</p>", 6705 "ResourceDataSyncItem$S3Destination": "<p>Configuration information for the target S3 bucket.</p>" 6706 } 6707 }, 6708 "ResourceDataSyncS3Format": { 6709 "base": null, 6710 "refs": { 6711 "ResourceDataSyncS3Destination$SyncFormat": "<p>A supported sync format. The following format is currently supported: JsonSerDe</p>" 6712 } 6713 }, 6714 "ResourceDataSyncS3Prefix": { 6715 "base": null, 6716 "refs": { 6717 "ResourceDataSyncS3Destination$Prefix": "<p>An Amazon S3 prefix for the bucket.</p>" 6718 } 6719 }, 6720 "ResourceDataSyncS3Region": { 6721 "base": null, 6722 "refs": { 6723 "ResourceDataSyncS3Destination$Region": "<p>The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.</p>" 6724 } 6725 }, 6726 "ResourceDataSyncSource": { 6727 "base": "<p>Information about the source of the data included in the resource data sync.</p>", 6728 "refs": { 6729 "CreateResourceDataSyncRequest$SyncSource": "<p>Specify information about the data sources to synchronize. This parameter is required if the <code>SyncType</code> value is SyncFromSource.</p>", 6730 "UpdateResourceDataSyncRequest$SyncSource": "<p>Specify information about the data sources to synchronize.</p>" 6731 } 6732 }, 6733 "ResourceDataSyncSourceRegion": { 6734 "base": null, 6735 "refs": { 6736 "ResourceDataSyncSourceRegionList$member": null 6737 } 6738 }, 6739 "ResourceDataSyncSourceRegionList": { 6740 "base": null, 6741 "refs": { 6742 "ResourceDataSyncSource$SourceRegions": "<p>The <code>SyncSource</code> Amazon Web Services Regions included in the resource data sync.</p>", 6743 "ResourceDataSyncSourceWithState$SourceRegions": "<p>The <code>SyncSource</code> Amazon Web Services Regions included in the resource data sync.</p>" 6744 } 6745 }, 6746 "ResourceDataSyncSourceType": { 6747 "base": null, 6748 "refs": { 6749 "ResourceDataSyncSource$SourceType": "<p>The type of data source for the resource data sync. <code>SourceType</code> is either <code>AwsOrganizations</code> (if an organization is present in Organizations) or <code>SingleAccountMultiRegions</code>.</p>", 6750 "ResourceDataSyncSourceWithState$SourceType": "<p>The type of data source for the resource data sync. <code>SourceType</code> is either <code>AwsOrganizations</code> (if an organization is present in Organizations) or <code>singleAccountMultiRegions</code>.</p>" 6751 } 6752 }, 6753 "ResourceDataSyncSourceWithState": { 6754 "base": "<p>The data type name for including resource data sync state. There are four sync states:</p> <p> <code>OrganizationNotExists</code> (Your organization doesn't exist)</p> <p> <code>NoPermissions</code> (The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Amazon Web Services Systems Manager Explorer.)</p> <p> <code>InvalidOrganizationalUnit</code> (You specified or selected an invalid unit in the resource data sync configuration.)</p> <p> <code>TrustedAccessDisabled</code> (You disabled Systems Manager access in the organization in Organizations.)</p>", 6755 "refs": { 6756 "ResourceDataSyncItem$SyncSource": "<p>Information about the source where the data was synchronized. </p>" 6757 } 6758 }, 6759 "ResourceDataSyncState": { 6760 "base": null, 6761 "refs": { 6762 "ResourceDataSyncSourceWithState$State": "<p>The data type name for including resource data sync state. There are four sync states:</p> <p> <code>OrganizationNotExists</code>: Your organization doesn't exist.</p> <p> <code>NoPermissions</code>: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.</p> <p> <code>InvalidOrganizationalUnit</code>: You specified or selected an invalid unit in the resource data sync configuration.</p> <p> <code>TrustedAccessDisabled</code>: You disabled Systems Manager access in the organization in Organizations.</p>" 6763 } 6764 }, 6765 "ResourceDataSyncType": { 6766 "base": null, 6767 "refs": { 6768 "CreateResourceDataSyncRequest$SyncType": "<p>Specify <code>SyncToDestination</code> to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify <code>SyncToDestination</code>, you must provide a value for <code>S3Destination</code>. Specify <code>SyncFromSource</code> to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify <code>SyncFromSource</code>, you must provide a value for <code>SyncSource</code>. The default value is <code>SyncToDestination</code>.</p>", 6769 "DeleteResourceDataSyncRequest$SyncType": "<p>Specify the type of resource data sync to delete.</p>", 6770 "ListResourceDataSyncRequest$SyncType": "<p>View a list of resource data syncs according to the sync type. Specify <code>SyncToDestination</code> to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify <code>SyncFromSource</code> to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.</p>", 6771 "ResourceDataSyncItem$SyncType": "<p>The type of resource data sync. If <code>SyncType</code> is <code>SyncToDestination</code>, then the resource data sync synchronizes data to an S3 bucket. If the <code>SyncType</code> is <code>SyncFromSource</code> then the resource data sync synchronizes data from Organizations or from multiple Amazon Web Services Regions.</p>", 6772 "ResourceDataSyncNotFoundException$SyncType": null, 6773 "UpdateResourceDataSyncRequest$SyncType": "<p>The type of resource data sync. The supported <code>SyncType</code> is SyncFromSource.</p>" 6774 } 6775 }, 6776 "ResourceId": { 6777 "base": null, 6778 "refs": { 6779 "AddTagsToResourceRequest$ResourceId": "<p>The resource ID you want to tag.</p> <p>Use the ID of the resource. Here are some examples:</p> <p> <code>MaintenanceWindow</code>: <code>mw-012345abcde</code> </p> <p> <code>PatchBaseline</code>: <code>pb-012345abcde</code> </p> <p> <code>OpsMetadata</code> object: <code>ResourceID</code> for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code> has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or <code>/aws/ssm/MyGroup/appmanager</code>.</p> <p>For the <code>Document</code> and <code>Parameter</code> values, use the name of the resource.</p> <p> <code>ManagedInstance</code>: <code>mi-012345abcde</code> </p> <note> <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises managed instances. You must specify the name of the managed instance in the following format: <code>mi-<i>ID_number</i> </code>. For example, <code>mi-1a2b3c4d5e6f</code>.</p> </note>", 6780 "ListTagsForResourceRequest$ResourceId": "<p>The resource ID for which you want to see a list of tags.</p>", 6781 "RemoveTagsFromResourceRequest$ResourceId": "<p>The ID of the resource from which you want to remove tags. For example:</p> <p>ManagedInstance: mi-012345abcde</p> <p>MaintenanceWindow: mw-012345abcde</p> <p>PatchBaseline: pb-012345abcde</p> <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code> has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or <code>/aws/ssm/MyGroup/appmanager</code>.</p> <p>For the Document and Parameter values, use the name of the resource.</p> <note> <p>The ManagedInstance type for this API operation is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.</p> </note>" 6782 } 6783 }, 6784 "ResourceInUseException": { 6785 "base": "<p>Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.</p>", 6786 "refs": { 6787 } 6788 }, 6789 "ResourceLimitExceededException": { 6790 "base": "<p>Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.</p> <p>For information about resource quotas in Systems Manager, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm\">Systems Manager service quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>", 6791 "refs": { 6792 } 6793 }, 6794 "ResourceType": { 6795 "base": null, 6796 "refs": { 6797 "InstanceInformation$ResourceType": "<p>The type of instance. Instances are either EC2 instances or managed instances. </p>" 6798 } 6799 }, 6800 "ResourceTypeForTagging": { 6801 "base": null, 6802 "refs": { 6803 "AddTagsToResourceRequest$ResourceType": "<p>Specifies the type of resource you are tagging.</p> <note> <p>The <code>ManagedInstance</code> type for this API operation is for on-premises managed instances. You must specify the name of the managed instance in the following format: <code>mi-<i>ID_number</i> </code>. For example, <code>mi-1a2b3c4d5e6f</code>.</p> </note>", 6804 "ListTagsForResourceRequest$ResourceType": "<p>Returns a list of tags for a specific resource type.</p>", 6805 "RemoveTagsFromResourceRequest$ResourceType": "<p>The type of resource from which you want to remove a tag.</p> <note> <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises managed instances. Specify the name of the managed instance in the following format: <code>mi-<i>ID_number</i> </code>. For example, <code>mi-1a2b3c4d5e6f</code>.</p> </note>" 6806 } 6807 }, 6808 "ResponseCode": { 6809 "base": null, 6810 "refs": { 6811 "CommandPlugin$ResponseCode": "<p>A numeric response code generated after running the plugin. </p>", 6812 "GetCommandInvocationResult$ResponseCode": "<p>The error level response code for the plugin script. If the response code is <code>-1</code>, then the command hasn't started running on the instance, or it wasn't received by the instance.</p>" 6813 } 6814 }, 6815 "ResultAttribute": { 6816 "base": "<p>The inventory item result attribute.</p>", 6817 "refs": { 6818 "ResultAttributeList$member": null 6819 } 6820 }, 6821 "ResultAttributeList": { 6822 "base": null, 6823 "refs": { 6824 "GetInventoryRequest$ResultAttributes": "<p>The list of inventory item types to return.</p>" 6825 } 6826 }, 6827 "ResumeSessionRequest": { 6828 "base": null, 6829 "refs": { 6830 } 6831 }, 6832 "ResumeSessionResponse": { 6833 "base": null, 6834 "refs": { 6835 } 6836 }, 6837 "ReviewInformation": { 6838 "base": "<p>Information about the result of a document review request.</p>", 6839 "refs": { 6840 "ReviewInformationList$member": null 6841 } 6842 }, 6843 "ReviewInformationList": { 6844 "base": null, 6845 "refs": { 6846 "DocumentDescription$ReviewInformation": "<p>Details about the review of a document.</p>" 6847 } 6848 }, 6849 "ReviewStatus": { 6850 "base": null, 6851 "refs": { 6852 "DocumentDescription$ReviewStatus": "<p>The current status of the review.</p>", 6853 "DocumentIdentifier$ReviewStatus": "<p>The current status of a document review.</p>", 6854 "DocumentReviewerResponseSource$ReviewStatus": "<p>The current review status of a new custom SSM document created by a member of your organization, or of the latest version of an existing SSM document.</p> <p>Only one version of a document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.</p> <p>Only one version of a document can be in review, or PENDING, at a time.</p>", 6855 "DocumentVersionInfo$ReviewStatus": "<p>The current status of the approval review for the latest version of the document.</p>", 6856 "GetDocumentResult$ReviewStatus": "<p>The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.</p> <p>Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.</p> <p>Only one version of an SSM document can be in review, or PENDING, at a time.</p>", 6857 "ReviewInformation$Status": "<p>The current status of the document review request.</p>" 6858 } 6859 }, 6860 "Reviewer": { 6861 "base": null, 6862 "refs": { 6863 "DocumentReviewerResponseSource$Reviewer": "<p>The user in your organization assigned to review a document request.</p>", 6864 "ReviewInformation$Reviewer": "<p>The reviewer assigned to take action on the document review request.</p>" 6865 } 6866 }, 6867 "Runbook": { 6868 "base": "<p>Information about an Automation runbook used in a runbook workflow in Change Manager.</p> <note> <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p> </note>", 6869 "refs": { 6870 "Runbooks$member": null 6871 } 6872 }, 6873 "Runbooks": { 6874 "base": null, 6875 "refs": { 6876 "AutomationExecution$Runbooks": "<p>Information about the Automation runbooks that are run as part of a runbook workflow.</p> <note> <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p> </note>", 6877 "AutomationExecutionMetadata$Runbooks": "<p>Information about the Automation runbooks that are run during a runbook workflow in Change Manager.</p> <note> <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p> </note>", 6878 "StartChangeRequestExecutionRequest$Runbooks": "<p>Information about the Automation runbooks that are run during the runbook workflow.</p> <note> <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p> </note>" 6879 } 6880 }, 6881 "S3BucketName": { 6882 "base": null, 6883 "refs": { 6884 "Command$OutputS3BucketName": "<p>The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.</p>", 6885 "CommandPlugin$OutputS3BucketName": "<p>The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:</p> <p> <code>doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript</code> </p> <p> <code>doc-example-bucket</code> is the name of the S3 bucket;</p> <p> <code>ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix</code> is the name of the S3 prefix;</p> <p> <code>i-02573cafcfEXAMPLE</code> is the instance ID;</p> <p> <code>awsrunShellScript</code> is the name of the plugin.</p>", 6886 "LoggingInfo$S3BucketName": "<p>The name of an S3 bucket where execution logs are stored .</p>", 6887 "MaintenanceWindowRunCommandParameters$OutputS3BucketName": "<p>The name of the Amazon Simple Storage Service (Amazon S3) bucket.</p>", 6888 "S3OutputLocation$OutputS3BucketName": "<p>The name of the S3 bucket.</p>", 6889 "SendCommandRequest$OutputS3BucketName": "<p>The name of the S3 bucket where command execution responses should be stored.</p>" 6890 } 6891 }, 6892 "S3KeyPrefix": { 6893 "base": null, 6894 "refs": { 6895 "Command$OutputS3KeyPrefix": "<p>The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.</p>", 6896 "CommandPlugin$OutputS3KeyPrefix": "<p>The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:</p> <p> <code>doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript</code> </p> <p> <code>doc-example-bucket</code> is the name of the S3 bucket;</p> <p> <code>ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix</code> is the name of the S3 prefix;</p> <p> <code>i-02573cafcfEXAMPLE</code> is the instance ID;</p> <p> <code>awsrunShellScript</code> is the name of the plugin.</p>", 6897 "LoggingInfo$S3KeyPrefix": "<p>(Optional) The S3 bucket subfolder. </p>", 6898 "MaintenanceWindowRunCommandParameters$OutputS3KeyPrefix": "<p>The S3 bucket subfolder.</p>", 6899 "S3OutputLocation$OutputS3KeyPrefix": "<p>The S3 bucket subfolder.</p>", 6900 "SendCommandRequest$OutputS3KeyPrefix": "<p>The directory structure within the S3 bucket where the responses should be stored.</p>" 6901 } 6902 }, 6903 "S3OutputLocation": { 6904 "base": "<p>An S3 bucket where you want to store the results of this request.</p>", 6905 "refs": { 6906 "InstanceAssociationOutputLocation$S3Location": "<p>An S3 bucket where you want to store the results of this request.</p>" 6907 } 6908 }, 6909 "S3OutputUrl": { 6910 "base": "<p>A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket where you want to store the results of this request.</p>", 6911 "refs": { 6912 "InstanceAssociationOutputUrl$S3OutputUrl": "<p>The URL of S3 bucket where you want to store the results of this request.</p>" 6913 } 6914 }, 6915 "S3Region": { 6916 "base": null, 6917 "refs": { 6918 "Command$OutputS3Region": "<p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.</p>", 6919 "CommandPlugin$OutputS3Region": "<p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.</p>", 6920 "LoggingInfo$S3Region": "<p>The Amazon Web Services Region where the S3 bucket is located.</p>", 6921 "S3OutputLocation$OutputS3Region": "<p>The Amazon Web Services Region of the S3 bucket.</p>", 6922 "SendCommandRequest$OutputS3Region": "<p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.</p>" 6923 } 6924 }, 6925 "ScheduleExpression": { 6926 "base": null, 6927 "refs": { 6928 "Association$ScheduleExpression": "<p>A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).</p>", 6929 "AssociationDescription$ScheduleExpression": "<p>A cron expression that specifies a schedule when the association runs.</p>", 6930 "AssociationVersionInfo$ScheduleExpression": "<p>The cron or rate schedule specified for the association when the association version was created.</p>", 6931 "CreateAssociationBatchRequestEntry$ScheduleExpression": "<p>A cron expression that specifies a schedule when the association runs.</p>", 6932 "CreateAssociationRequest$ScheduleExpression": "<p>A cron expression when the association will be applied to the target(s).</p>", 6933 "UpdateAssociationRequest$ScheduleExpression": "<p>The cron expression used to schedule the association that you want to update.</p>" 6934 } 6935 }, 6936 "ScheduledWindowExecution": { 6937 "base": "<p>Information about a scheduled execution for a maintenance window.</p>", 6938 "refs": { 6939 "ScheduledWindowExecutionList$member": null 6940 } 6941 }, 6942 "ScheduledWindowExecutionList": { 6943 "base": null, 6944 "refs": { 6945 "DescribeMaintenanceWindowScheduleResult$ScheduledWindowExecutions": "<p>Information about maintenance window executions scheduled for the specified time range.</p>" 6946 } 6947 }, 6948 "SendAutomationSignalRequest": { 6949 "base": null, 6950 "refs": { 6951 } 6952 }, 6953 "SendAutomationSignalResult": { 6954 "base": null, 6955 "refs": { 6956 } 6957 }, 6958 "SendCommandRequest": { 6959 "base": null, 6960 "refs": { 6961 } 6962 }, 6963 "SendCommandResult": { 6964 "base": null, 6965 "refs": { 6966 } 6967 }, 6968 "ServiceRole": { 6969 "base": null, 6970 "refs": { 6971 "Command$ServiceRole": "<p>The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes. </p>", 6972 "CommandInvocation$ServiceRole": "<p>The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per instance basis.</p>", 6973 "GetMaintenanceWindowExecutionTaskResult$ServiceRole": "<p>The role that was assumed when running the task.</p>", 6974 "GetMaintenanceWindowTaskResult$ServiceRoleArn": "<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.</p>", 6975 "MaintenanceWindowRunCommandParameters$ServiceRoleArn": "<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.</p>", 6976 "MaintenanceWindowTask$ServiceRoleArn": "<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.</p>", 6977 "RegisterTaskWithMaintenanceWindowRequest$ServiceRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run <code>RegisterTaskWithMaintenanceWindow</code>.</p> <p>For more information, see the following topics in the in the <i>Amazon Web Services Systems Manager User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions\">Using service-linked roles for Systems Manager</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role\">Should I use a service-linked role or a custom service role to run maintenance window tasks? </a> </p> </li> </ul>", 6978 "SendCommandRequest$ServiceRoleArn": "<p>The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>", 6979 "UpdateMaintenanceWindowTaskRequest$ServiceRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run <code>RegisterTaskWithMaintenanceWindow</code>.</p> <p>For more information, see the following topics in the in the <i>Amazon Web Services Systems Manager User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions\">Using service-linked roles for Systems Manager</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role\">Should I use a service-linked role or a custom service role to run maintenance window tasks? </a> </p> </li> </ul>", 6980 "UpdateMaintenanceWindowTaskResult$ServiceRoleArn": "<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.</p>" 6981 } 6982 }, 6983 "ServiceSetting": { 6984 "base": "<p>The service setting data structure.</p> <p> <code>ServiceSetting</code> is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.</p> <p>Services map a <code>SettingId</code> object to a setting value. Amazon Web Services services teams define the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>, but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code> permission for the setting. Use the <a>UpdateServiceSetting</a> API operation to change the default setting. Or, use the <a>ResetServiceSetting</a> to change the value back to the original value defined by the Amazon Web Services service team.</p>", 6985 "refs": { 6986 "GetServiceSettingResult$ServiceSetting": "<p>The query result of the current service setting.</p>", 6987 "ResetServiceSettingResult$ServiceSetting": "<p>The current, effective service setting after calling the ResetServiceSetting API operation.</p>" 6988 } 6989 }, 6990 "ServiceSettingId": { 6991 "base": null, 6992 "refs": { 6993 "GetServiceSettingRequest$SettingId": "<p>The ID of the service setting to get. The setting ID can be one of the following.</p> <ul> <li> <p> <code>/ssm/automation/customer-script-log-destination</code> </p> </li> <li> <p> <code>/ssm/automation/customer-script-log-group-name</code> </p> </li> <li> <p> <code>/ssm/documents/console/public-sharing-permission</code> </p> </li> <li> <p> <code>/ssm/parameter-store/default-parameter-tier</code> </p> </li> <li> <p> <code>/ssm/parameter-store/high-throughput-enabled</code> </p> </li> <li> <p> <code>/ssm/managed-instance/activation-tier</code> </p> </li> </ul>", 6994 "ResetServiceSettingRequest$SettingId": "<p>The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.</p> <ul> <li> <p> <code>/ssm/automation/customer-script-log-destination</code> </p> </li> <li> <p> <code>/ssm/automation/customer-script-log-group-name</code> </p> </li> <li> <p> <code>/ssm/documents/console/public-sharing-permission</code> </p> </li> <li> <p> <code>/ssm/parameter-store/default-parameter-tier</code> </p> </li> <li> <p> <code>/ssm/parameter-store/high-throughput-enabled</code> </p> </li> <li> <p> <code>/ssm/managed-instance/activation-tier</code> </p> </li> </ul>", 6995 "ServiceSetting$SettingId": "<p>The ID of the service setting.</p>", 6996 "UpdateServiceSettingRequest$SettingId": "<p>The Amazon Resource Name (ARN) of the service setting to reset. For example, <code>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</code>. The setting ID can be one of the following.</p> <ul> <li> <p> <code>/ssm/automation/customer-script-log-destination</code> </p> </li> <li> <p> <code>/ssm/automation/customer-script-log-group-name</code> </p> </li> <li> <p> <code>/ssm/documents/console/public-sharing-permission</code> </p> </li> <li> <p> <code>/ssm/parameter-store/default-parameter-tier</code> </p> </li> <li> <p> <code>/ssm/parameter-store/high-throughput-enabled</code> </p> </li> <li> <p> <code>/ssm/managed-instance/activation-tier</code> </p> </li> </ul>" 6997 } 6998 }, 6999 "ServiceSettingNotFound": { 7000 "base": "<p>The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.</p>", 7001 "refs": { 7002 } 7003 }, 7004 "ServiceSettingValue": { 7005 "base": null, 7006 "refs": { 7007 "ServiceSetting$SettingValue": "<p>The value of the service setting.</p>", 7008 "UpdateServiceSettingRequest$SettingValue": "<p>The new value to specify for the service setting. The following list specifies the available values for each setting.</p> <ul> <li> <p> <code>/ssm/parameter-store/default-parameter-tier</code>: <code>Standard</code>, <code>Advanced</code>, <code>Intelligent-Tiering</code> </p> </li> <li> <p> <code>/ssm/parameter-store/high-throughput-enabled</code>: <code>true</code> or <code>false</code> </p> </li> <li> <p> <code>/ssm/managed-instance/activation-tier</code>: <code>true</code> or <code>false</code> </p> </li> <li> <p> <code>/ssm/automation/customer-script-log-destination</code>: <code>CloudWatch</code> </p> </li> <li> <p> <code>/ssm/automation/customer-script-log-group-name</code>: the name of an Amazon CloudWatch Logs log group</p> </li> <li> <p> <code>/ssm/documents/console/public-sharing-permission</code>: <code>Enable</code> or <code>Disable</code> </p> </li> <li> <p> <code>/ssm/managed-instance/activation-tier</code>: <code>standard</code> or <code>advanced</code> </p> </li> </ul>" 7009 } 7010 }, 7011 "Session": { 7012 "base": "<p>Information about a Session Manager connection to an instance.</p>", 7013 "refs": { 7014 "SessionList$member": null 7015 } 7016 }, 7017 "SessionDetails": { 7018 "base": null, 7019 "refs": { 7020 "Session$Details": "<p>Reserved for future use.</p>" 7021 } 7022 }, 7023 "SessionFilter": { 7024 "base": "<p>Describes a filter for Session Manager information.</p>", 7025 "refs": { 7026 "SessionFilterList$member": null 7027 } 7028 }, 7029 "SessionFilterKey": { 7030 "base": null, 7031 "refs": { 7032 "SessionFilter$key": "<p>The name of the filter.</p>" 7033 } 7034 }, 7035 "SessionFilterList": { 7036 "base": null, 7037 "refs": { 7038 "DescribeSessionsRequest$Filters": "<p>One or more filters to limit the type of sessions returned by the request.</p>" 7039 } 7040 }, 7041 "SessionFilterValue": { 7042 "base": null, 7043 "refs": { 7044 "SessionFilter$value": "<p>The filter value. Valid values for each filter key are as follows:</p> <ul> <li> <p>InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.</p> </li> <li> <p>InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.</p> </li> <li> <p>Target: Specify an instance to which session connections have been made.</p> </li> <li> <p>Owner: Specify an Amazon Web Services user account to see a list of sessions started by that user.</p> </li> <li> <p>Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:</p> <ul> <li> <p>Connected</p> </li> <li> <p>Connecting</p> </li> <li> <p>Disconnected</p> </li> <li> <p>Terminated</p> </li> <li> <p>Terminating</p> </li> <li> <p>Failed</p> </li> </ul> </li> <li> <p>SessionId: Specify a session ID to return details about the session.</p> </li> </ul>" 7045 } 7046 }, 7047 "SessionId": { 7048 "base": null, 7049 "refs": { 7050 "ResumeSessionRequest$SessionId": "<p>The ID of the disconnected session to resume.</p>", 7051 "ResumeSessionResponse$SessionId": "<p>The ID of the session.</p>", 7052 "Session$SessionId": "<p>The ID of the session.</p>", 7053 "StartSessionResponse$SessionId": "<p>The ID of the session.</p>", 7054 "TerminateSessionRequest$SessionId": "<p>The ID of the session to terminate.</p>", 7055 "TerminateSessionResponse$SessionId": "<p>The ID of the session that has been terminated.</p>" 7056 } 7057 }, 7058 "SessionList": { 7059 "base": null, 7060 "refs": { 7061 "DescribeSessionsResponse$Sessions": "<p>A list of sessions meeting the request parameters.</p>" 7062 } 7063 }, 7064 "SessionManagerCloudWatchOutputUrl": { 7065 "base": null, 7066 "refs": { 7067 "SessionManagerOutputUrl$CloudWatchOutputUrl": "<p>Reserved for future use.</p>" 7068 } 7069 }, 7070 "SessionManagerOutputUrl": { 7071 "base": "<p>Reserved for future use.</p>", 7072 "refs": { 7073 "Session$OutputUrl": "<p>Reserved for future use.</p>" 7074 } 7075 }, 7076 "SessionManagerParameterName": { 7077 "base": null, 7078 "refs": { 7079 "SessionManagerParameters$key": null 7080 } 7081 }, 7082 "SessionManagerParameterValue": { 7083 "base": null, 7084 "refs": { 7085 "SessionManagerParameterValueList$member": null 7086 } 7087 }, 7088 "SessionManagerParameterValueList": { 7089 "base": null, 7090 "refs": { 7091 "SessionManagerParameters$value": null 7092 } 7093 }, 7094 "SessionManagerParameters": { 7095 "base": null, 7096 "refs": { 7097 "StartSessionRequest$Parameters": "<p>Reserved for future use.</p>" 7098 } 7099 }, 7100 "SessionManagerS3OutputUrl": { 7101 "base": null, 7102 "refs": { 7103 "SessionManagerOutputUrl$S3OutputUrl": "<p>Reserved for future use.</p>" 7104 } 7105 }, 7106 "SessionMaxResults": { 7107 "base": null, 7108 "refs": { 7109 "DescribeSessionsRequest$MaxResults": "<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>" 7110 } 7111 }, 7112 "SessionOwner": { 7113 "base": null, 7114 "refs": { 7115 "Session$Owner": "<p>The ID of the Amazon Web Services user account that started the session.</p>" 7116 } 7117 }, 7118 "SessionState": { 7119 "base": null, 7120 "refs": { 7121 "DescribeSessionsRequest$State": "<p>The session status to retrieve a list of sessions for. For example, \"Active\".</p>" 7122 } 7123 }, 7124 "SessionStatus": { 7125 "base": null, 7126 "refs": { 7127 "Session$Status": "<p>The status of the session. For example, \"Connected\" or \"Terminated\".</p>" 7128 } 7129 }, 7130 "SessionTarget": { 7131 "base": null, 7132 "refs": { 7133 "GetConnectionStatusRequest$Target": "<p>The instance ID.</p>", 7134 "GetConnectionStatusResponse$Target": "<p>The ID of the instance to check connection status. </p>", 7135 "Session$Target": "<p>The instance that the Session Manager session connected to.</p>", 7136 "StartSessionRequest$Target": "<p>The instance to connect to for the session.</p>" 7137 } 7138 }, 7139 "SeveritySummary": { 7140 "base": "<p>The number of managed instances found for each patch severity level defined in the request filter.</p>", 7141 "refs": { 7142 "CompliantSummary$SeveritySummary": "<p>A summary of the compliance severity by compliance type.</p>", 7143 "NonCompliantSummary$SeveritySummary": "<p>A summary of the non-compliance severity by compliance type</p>" 7144 } 7145 }, 7146 "SharedDocumentVersion": { 7147 "base": "<p>The document version shared with other accounts. You can share <code>Latest</code>, <code>Default</code> or <code>All versions</code>.</p>", 7148 "refs": { 7149 "AccountSharingInfo$SharedDocumentVersion": "<p>The version of the current document shared with the account.</p>", 7150 "ModifyDocumentPermissionRequest$SharedDocumentVersion": "<p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p>" 7151 } 7152 }, 7153 "SignalType": { 7154 "base": null, 7155 "refs": { 7156 "SendAutomationSignalRequest$SignalType": "<p>The type of signal to send to an Automation execution. </p>" 7157 } 7158 }, 7159 "SnapshotDownloadUrl": { 7160 "base": null, 7161 "refs": { 7162 "GetDeployablePatchSnapshotForInstanceResult$SnapshotDownloadUrl": "<p>A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.</p>" 7163 } 7164 }, 7165 "SnapshotId": { 7166 "base": null, 7167 "refs": { 7168 "GetDeployablePatchSnapshotForInstanceRequest$SnapshotId": "<p>The snapshot ID provided by the user when running <code>AWS-RunPatchBaseline</code>.</p>", 7169 "GetDeployablePatchSnapshotForInstanceResult$SnapshotId": "<p>The user-defined snapshot ID.</p>", 7170 "InstancePatchState$SnapshotId": "<p>The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.</p>" 7171 } 7172 }, 7173 "StandardErrorContent": { 7174 "base": null, 7175 "refs": { 7176 "GetCommandInvocationResult$StandardErrorContent": "<p>The first 8,000 characters written by the plugin to <code>stderr</code>. If the command hasn't finished running, then this string is empty.</p>" 7177 } 7178 }, 7179 "StandardOutputContent": { 7180 "base": null, 7181 "refs": { 7182 "GetCommandInvocationResult$StandardOutputContent": "<p>The first 24,000 characters written by the plugin to <code>stdout</code>. If the command hasn't finished running, if <code>ExecutionStatus</code> is neither Succeeded nor Failed, then this string is empty.</p>" 7183 } 7184 }, 7185 "StartAssociationsOnceRequest": { 7186 "base": null, 7187 "refs": { 7188 } 7189 }, 7190 "StartAssociationsOnceResult": { 7191 "base": null, 7192 "refs": { 7193 } 7194 }, 7195 "StartAutomationExecutionRequest": { 7196 "base": null, 7197 "refs": { 7198 } 7199 }, 7200 "StartAutomationExecutionResult": { 7201 "base": null, 7202 "refs": { 7203 } 7204 }, 7205 "StartChangeRequestExecutionRequest": { 7206 "base": null, 7207 "refs": { 7208 } 7209 }, 7210 "StartChangeRequestExecutionResult": { 7211 "base": null, 7212 "refs": { 7213 } 7214 }, 7215 "StartSessionRequest": { 7216 "base": null, 7217 "refs": { 7218 } 7219 }, 7220 "StartSessionResponse": { 7221 "base": null, 7222 "refs": { 7223 } 7224 }, 7225 "StatusAdditionalInfo": { 7226 "base": null, 7227 "refs": { 7228 "AssociationStatus$AdditionalInfo": "<p>A user-defined string.</p>" 7229 } 7230 }, 7231 "StatusDetails": { 7232 "base": null, 7233 "refs": { 7234 "Command$StatusDetails": "<p>A detailed status of the command execution. <code>StatusDetails</code> includes more information than <code>Status</code> because it includes states resulting from error and concurrency control parameters. <code>StatusDetails</code> can show different results than Status. For more information about these statuses, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html\">Understanding command statuses</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. StatusDetails can be one of the following values:</p> <ul> <li> <p>Pending: The command hasn't been sent to any instances.</p> </li> <li> <p>In Progress: The command has been sent to at least one instance but hasn't reached a final state on all instances.</p> </li> <li> <p>Success: The command successfully ran on all invocations. This is a terminal state.</p> </li> <li> <p>Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.</p> </li> <li> <p>Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.</p> </li> <li> <p>Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.</p> </li> <li> <p>Incomplete: The command was attempted on all instances and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.</p> </li> <li> <p>Canceled: The command was terminated before it was completed. This is a terminal state.</p> </li> <li> <p>Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.</p> </li> </ul>", 7235 "CommandInvocation$StatusDetails": "<p>A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html\">Understanding command statuses</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. StatusDetails can be one of the following values:</p> <ul> <li> <p>Pending: The command hasn't been sent to the instance.</p> </li> <li> <p>In Progress: The command has been sent to the instance but hasn't reached a terminal state.</p> </li> <li> <p>Success: The execution of the command or plugin was successfully completed. This is a terminal state.</p> </li> <li> <p>Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's <code>MaxErrors</code> limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.</p> </li> <li> <p>Execution Timed Out: Command execution started on the instance, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p> </li> <li> <p>Failed: The command wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p> </li> <li> <p>Canceled: The command was terminated before it was completed. This is a terminal state.</p> </li> <li> <p>Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.</p> </li> <li> <p>Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.</p> </li> </ul>", 7236 "CommandPlugin$StatusDetails": "<p>A detailed status of the plugin execution. <code>StatusDetails</code> includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html\">Understanding command statuses</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. StatusDetails can be one of the following values:</p> <ul> <li> <p>Pending: The command hasn't been sent to the instance.</p> </li> <li> <p>In Progress: The command has been sent to the instance but hasn't reached a terminal state.</p> </li> <li> <p>Success: The execution of the command or plugin was successfully completed. This is a terminal state.</p> </li> <li> <p>Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's <code>MaxErrors</code> limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.</p> </li> <li> <p>Execution Timed Out: Command execution started on the instance, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p> </li> <li> <p>Failed: The command wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.</p> </li> <li> <p>Canceled: The command was terminated before it was completed. This is a terminal state.</p> </li> <li> <p>Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.</p> </li> <li> <p>Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.</p> </li> </ul>", 7237 "GetCommandInvocationResult$StatusDetails": "<p>A detailed status of the command execution for an invocation. <code>StatusDetails</code> includes more information than <code>Status</code> because it includes states resulting from error and concurrency control parameters. <code>StatusDetails</code> can show different results than <code>Status</code>. For more information about these statuses, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html\">Understanding command statuses</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. <code>StatusDetails</code> can be one of the following values:</p> <ul> <li> <p>Pending: The command hasn't been sent to the instance.</p> </li> <li> <p>In Progress: The command has been sent to the instance but hasn't reached a terminal state.</p> </li> <li> <p>Delayed: The system attempted to send the command to the target, but the target wasn't available. The instance might not be available because of network issues, because the instance was stopped, or for similar reasons. The system will try to send the command again.</p> </li> <li> <p>Success: The command or plugin ran successfully. This is a terminal state.</p> </li> <li> <p>Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's <code>MaxErrors</code> limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.</p> </li> <li> <p>Execution Timed Out: The command started to run on the instance, but the execution wasn't complete before the timeout expired. Execution timeouts count against the <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p> </li> <li> <p>Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p> </li> <li> <p>Canceled: The command was terminated before it was completed. This is a terminal state.</p> </li> <li> <p>Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's <code>MaxErrors</code> limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.</p> </li> <li> <p>Terminated: The parent command exceeded its <code>MaxErrors</code> limit and subsequent command invocations were canceled by the system. This is a terminal state.</p> </li> </ul>" 7238 } 7239 }, 7240 "StatusMessage": { 7241 "base": null, 7242 "refs": { 7243 "AssociationStatus$Message": "<p>The reason for the status.</p>" 7244 } 7245 }, 7246 "StatusName": { 7247 "base": null, 7248 "refs": { 7249 "AssociationExecution$Status": "<p>The status of the association execution.</p>", 7250 "AssociationExecution$DetailedStatus": "<p>Detailed status information about the execution.</p>", 7251 "AssociationExecutionTarget$Status": "<p>The association execution status.</p>", 7252 "AssociationExecutionTarget$DetailedStatus": "<p>Detailed information about the execution status.</p>", 7253 "AssociationOverview$Status": "<p>The status of the association. Status can be: Pending, Success, or Failed.</p>", 7254 "AssociationOverview$DetailedStatus": "<p>A detailed status of the association.</p>", 7255 "AssociationStatusAggregatedCount$key": null, 7256 "InstanceAggregatedAssociationOverview$DetailedStatus": "<p>Detailed status information about the aggregated associations.</p>", 7257 "InstanceAssociationStatusAggregatedCount$key": null, 7258 "InstanceAssociationStatusInfo$Status": "<p>Status information about the instance association.</p>", 7259 "InstanceAssociationStatusInfo$DetailedStatus": "<p>Detailed status information about the instance association.</p>", 7260 "InstanceInformation$AssociationStatus": "<p>The status of the association.</p>" 7261 } 7262 }, 7263 "StatusUnchanged": { 7264 "base": "<p>The updated status is the same as the current status.</p>", 7265 "refs": { 7266 } 7267 }, 7268 "StepExecution": { 7269 "base": "<p>Detailed information about an the execution state of an Automation step.</p>", 7270 "refs": { 7271 "StepExecutionList$member": null 7272 } 7273 }, 7274 "StepExecutionFilter": { 7275 "base": "<p>A filter to limit the amount of step execution information returned by the call.</p>", 7276 "refs": { 7277 "StepExecutionFilterList$member": null 7278 } 7279 }, 7280 "StepExecutionFilterKey": { 7281 "base": null, 7282 "refs": { 7283 "StepExecutionFilter$Key": "<p>One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.</p>" 7284 } 7285 }, 7286 "StepExecutionFilterList": { 7287 "base": null, 7288 "refs": { 7289 "DescribeAutomationStepExecutionsRequest$Filters": "<p>One or more filters to limit the number of step executions returned by the request.</p>" 7290 } 7291 }, 7292 "StepExecutionFilterValue": { 7293 "base": null, 7294 "refs": { 7295 "StepExecutionFilterValueList$member": null 7296 } 7297 }, 7298 "StepExecutionFilterValueList": { 7299 "base": null, 7300 "refs": { 7301 "StepExecutionFilter$Values": "<p>The values of the filter key.</p>" 7302 } 7303 }, 7304 "StepExecutionList": { 7305 "base": null, 7306 "refs": { 7307 "AutomationExecution$StepExecutions": "<p>A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.</p>", 7308 "DescribeAutomationStepExecutionsResult$StepExecutions": "<p>A list of details about the current state of all steps that make up an execution.</p>" 7309 } 7310 }, 7311 "StopAutomationExecutionRequest": { 7312 "base": null, 7313 "refs": { 7314 } 7315 }, 7316 "StopAutomationExecutionResult": { 7317 "base": null, 7318 "refs": { 7319 } 7320 }, 7321 "StopType": { 7322 "base": null, 7323 "refs": { 7324 "StopAutomationExecutionRequest$Type": "<p>The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.</p>" 7325 } 7326 }, 7327 "StreamUrl": { 7328 "base": null, 7329 "refs": { 7330 "ResumeSessionResponse$StreamUrl": "<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p> <p> <b>region</b> represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager service endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> <p> <b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>", 7331 "StartSessionResponse$StreamUrl": "<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code> </p> <p> <b>region</b> represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager service endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> <p> <b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>" 7332 } 7333 }, 7334 "String": { 7335 "base": null, 7336 "refs": { 7337 "AlreadyExistsException$Message": null, 7338 "AssociationDoesNotExist$Message": null, 7339 "AssociationExecutionDoesNotExist$Message": null, 7340 "AssociationVersionLimitExceeded$Message": null, 7341 "AutomationDefinitionNotApprovedException$Message": null, 7342 "AutomationDefinitionNotFoundException$Message": null, 7343 "AutomationDefinitionVersionNotFoundException$Message": null, 7344 "AutomationExecution$FailureMessage": "<p>A message describing why an execution has failed, if the status is set to Failed.</p>", 7345 "AutomationExecution$ExecutedBy": "<p>The Amazon Resource Name (ARN) of the user who ran the automation.</p>", 7346 "AutomationExecution$CurrentStepName": "<p>The name of the step that is currently running.</p>", 7347 "AutomationExecution$CurrentAction": "<p>The action of the step that is currently running.</p>", 7348 "AutomationExecution$Target": "<p>The target of the execution.</p>", 7349 "AutomationExecution$OpsItemId": "<p>The ID of an OpsItem that is created to represent a Change Manager change request.</p>", 7350 "AutomationExecution$AssociationId": "<p>The ID of a State Manager association used in the Automation operation.</p>", 7351 "AutomationExecutionLimitExceededException$Message": null, 7352 "AutomationExecutionMetadata$ExecutedBy": "<p>The IAM role ARN of the user who ran the automation.</p>", 7353 "AutomationExecutionMetadata$LogFile": "<p>An S3 bucket where execution information is stored.</p>", 7354 "AutomationExecutionMetadata$CurrentStepName": "<p>The name of the step that is currently running.</p>", 7355 "AutomationExecutionMetadata$CurrentAction": "<p>The action of the step that is currently running.</p>", 7356 "AutomationExecutionMetadata$FailureMessage": "<p>The list of execution outputs as defined in the Automation runbook.</p>", 7357 "AutomationExecutionMetadata$Target": "<p>The list of execution outputs as defined in the Automation runbook.</p>", 7358 "AutomationExecutionMetadata$OpsItemId": "<p>The ID of an OpsItem that is created to represent a Change Manager change request.</p>", 7359 "AutomationExecutionMetadata$AssociationId": "<p>The ID of a State Manager association used in the Automation operation.</p>", 7360 "AutomationExecutionNotFoundException$Message": null, 7361 "AutomationStepNotFoundException$Message": null, 7362 "ComplianceTypeCountLimitExceededException$Message": null, 7363 "CreateOpsItemResponse$OpsItemId": "<p>The ID of the OpsItem.</p>", 7364 "CustomSchemaCountLimitExceededException$Message": null, 7365 "DescribeOpsItemsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results.</p>", 7366 "DescribeOpsItemsResponse$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 7367 "DocumentAlreadyExists$Message": null, 7368 "DocumentLimitExceeded$Message": null, 7369 "DocumentPermissionLimit$Message": null, 7370 "DocumentVersionLimitExceeded$Message": null, 7371 "DoesNotExistException$Message": null, 7372 "DuplicateDocumentContent$Message": null, 7373 "DuplicateDocumentVersionName$Message": null, 7374 "FailureDetails$FailureStage": "<p>The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.</p>", 7375 "FailureDetails$FailureType": "<p>The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.</p>", 7376 "FeatureNotAvailableException$Message": null, 7377 "HierarchyLevelLimitExceededException$message": "<p>A hierarchy can have a maximum of 15 levels. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html\">Requirements and constraints for parameter names</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 7378 "HierarchyTypeMismatchException$message": "<p>Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a <code>String</code> type to a <code>SecureString</code> type. You must create a new, unique parameter.</p>", 7379 "IdempotentParameterMismatch$Message": null, 7380 "IncompatiblePolicyException$message": null, 7381 "InstanceInformation$PlatformName": "<p>The name of the operating system platform running on your instance. </p>", 7382 "InstanceInformation$PlatformVersion": "<p>The version of the OS platform running on your instance. </p>", 7383 "InstanceInformation$Name": "<p>The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the <code>DefaultInstanceName</code> property using the <a>CreateActivation</a> command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as explained in <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html\">Install SSM Agent for a hybrid environment (Linux)</a> and <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html\">Install SSM Agent for a hybrid environment (Windows)</a>. To retrieve the Name tag of an EC2 instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href=\"https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html\">describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>", 7384 "InternalServerError$Message": null, 7385 "InvalidActivation$Message": null, 7386 "InvalidActivationId$Message": null, 7387 "InvalidAggregatorException$Message": null, 7388 "InvalidAllowedPatternException$message": "<p>The request doesn't meet the regular expression requirement.</p>", 7389 "InvalidAssociation$Message": null, 7390 "InvalidAssociationVersion$Message": null, 7391 "InvalidAutomationExecutionParametersException$Message": null, 7392 "InvalidAutomationSignalException$Message": null, 7393 "InvalidAutomationStatusUpdateException$Message": null, 7394 "InvalidDeleteInventoryParametersException$Message": null, 7395 "InvalidDeletionIdException$Message": null, 7396 "InvalidDocument$Message": "<p>The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations. </p>", 7397 "InvalidDocumentContent$Message": "<p>A description of the validation error.</p>", 7398 "InvalidDocumentOperation$Message": null, 7399 "InvalidDocumentSchemaVersion$Message": null, 7400 "InvalidDocumentType$Message": null, 7401 "InvalidDocumentVersion$Message": null, 7402 "InvalidFilter$Message": null, 7403 "InvalidFilterOption$message": "<p>The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.</p>", 7404 "InvalidFilterValue$Message": null, 7405 "InvalidInstanceId$Message": null, 7406 "InvalidInstanceInformationFilterValue$message": null, 7407 "InvalidInventoryGroupException$Message": null, 7408 "InvalidInventoryItemContextException$Message": null, 7409 "InvalidInventoryRequestException$Message": null, 7410 "InvalidItemContentException$Message": null, 7411 "InvalidKeyId$message": null, 7412 "InvalidNextToken$Message": null, 7413 "InvalidNotificationConfig$Message": null, 7414 "InvalidOptionException$Message": null, 7415 "InvalidParameters$Message": null, 7416 "InvalidPermissionType$Message": null, 7417 "InvalidPolicyAttributeException$message": null, 7418 "InvalidPolicyTypeException$message": null, 7419 "InvalidResultAttributeException$Message": null, 7420 "InvalidRole$Message": null, 7421 "InvalidSchedule$Message": null, 7422 "InvalidTarget$Message": null, 7423 "InvalidTypeNameException$Message": null, 7424 "InvalidUpdate$Message": null, 7425 "ItemContentMismatchException$Message": null, 7426 "ItemSizeLimitExceededException$Message": null, 7427 "ListOpsItemEventsRequest$NextToken": "<p>A token to start the list. Use this token to get the next set of results. </p>", 7428 "ListOpsItemEventsResponse$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results. </p>", 7429 "ListOpsItemRelatedItemsRequest$NextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>", 7430 "ListOpsItemRelatedItemsResponse$NextToken": "<p>The token for the next set of items to return. Use this token to get the next set of results.</p>", 7431 "MaxDocumentSizeExceeded$Message": null, 7432 "NormalStringMap$key": null, 7433 "NormalStringMap$value": null, 7434 "OpsItem$CreatedBy": "<p>The ARN of the Amazon Web Services account that created the OpsItem.</p>", 7435 "OpsItem$LastModifiedBy": "<p>The ARN of the Amazon Web Services account that last updated the OpsItem.</p>", 7436 "OpsItem$Version": "<p>The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.</p>", 7437 "OpsItemAlreadyExistsException$Message": null, 7438 "OpsItemAlreadyExistsException$OpsItemId": null, 7439 "OpsItemEventSummary$OpsItemId": "<p>The ID of the OpsItem.</p>", 7440 "OpsItemEventSummary$EventId": "<p>The ID of the OpsItem event.</p>", 7441 "OpsItemEventSummary$Source": "<p>The source of the OpsItem event.</p>", 7442 "OpsItemEventSummary$DetailType": "<p>The type of information provided as a detail.</p>", 7443 "OpsItemEventSummary$Detail": "<p>Specific information about the OpsItem event.</p>", 7444 "OpsItemIdentity$Arn": "<p>The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.</p>", 7445 "OpsItemInvalidParameterException$Message": null, 7446 "OpsItemLimitExceededException$LimitType": null, 7447 "OpsItemLimitExceededException$Message": null, 7448 "OpsItemNotFoundException$Message": null, 7449 "OpsItemNotification$Arn": "<p>The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.</p>", 7450 "OpsItemOpsDataKeysList$member": null, 7451 "OpsItemParameterNamesList$member": null, 7452 "OpsItemRelatedItemAlreadyExistsException$Message": null, 7453 "OpsItemRelatedItemAssociationNotFoundException$Message": null, 7454 "OpsItemSummary$CreatedBy": "<p>The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.</p>", 7455 "OpsItemSummary$LastModifiedBy": "<p>The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.</p>", 7456 "OpsMetadata$LastModifiedUser": "<p>The user name who last updated the OpsMetadata object.</p>", 7457 "OpsMetadataAlreadyExistsException$message": null, 7458 "OpsMetadataInvalidArgumentException$message": null, 7459 "OpsMetadataKeyLimitExceededException$message": null, 7460 "OpsMetadataLimitExceededException$message": null, 7461 "OpsMetadataNotFoundException$message": null, 7462 "OpsMetadataTooManyUpdatesException$message": null, 7463 "Parameter$SourceResult": "<p>Applies to parameters that reference information in other Amazon Web Services services. <code>SourceResult</code> is the raw result or response from the source.</p>", 7464 "Parameter$ARN": "<p>The Amazon Resource Name (ARN) of the parameter.</p>", 7465 "ParameterAlreadyExists$message": null, 7466 "ParameterHistory$LastModifiedUser": "<p>Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.</p>", 7467 "ParameterInlinePolicy$PolicyText": "<p>The JSON text of the policy.</p>", 7468 "ParameterInlinePolicy$PolicyType": "<p>The type of policy. Parameter Store, a capablility of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification. </p>", 7469 "ParameterInlinePolicy$PolicyStatus": "<p>The status of the policy. Policies report the following statuses: Pending (the policy hasn't been enforced or applied yet), Finished (the policy was applied), Failed (the policy wasn't applied), or InProgress (the policy is being applied now). </p>", 7470 "ParameterLimitExceeded$message": null, 7471 "ParameterMaxVersionLimitExceeded$message": null, 7472 "ParameterMetadata$LastModifiedUser": "<p>Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.</p>", 7473 "ParameterNotFound$message": null, 7474 "ParameterPatternMismatchException$message": "<p>The parameter name isn't valid.</p>", 7475 "ParameterVersionLabelLimitExceeded$message": null, 7476 "ParameterVersionNotFound$message": null, 7477 "PoliciesLimitExceededException$message": null, 7478 "RelatedOpsItem$OpsItemId": "<p>The ID of an OpsItem related to the current OpsItem.</p>", 7479 "ResourceDataSyncConflictException$Message": null, 7480 "ResourceDataSyncCountExceededException$Message": null, 7481 "ResourceDataSyncInvalidConfigurationException$Message": null, 7482 "ResourceDataSyncNotFoundException$Message": null, 7483 "ResourceInUseException$Message": null, 7484 "ResourceLimitExceededException$Message": null, 7485 "ServiceSetting$LastModifiedUser": "<p>The ARN of the last modified user. This field is populated only if the setting value was overwritten.</p>", 7486 "ServiceSetting$ARN": "<p>The ARN of the service setting.</p>", 7487 "ServiceSetting$Status": "<p>The status of the service setting. The value can be Default, Customized or PendingUpdate.</p> <ul> <li> <p>Default: The current setting uses a default value provisioned by the Amazon Web Services service team.</p> </li> <li> <p>Customized: The current setting use a custom value specified by the customer.</p> </li> <li> <p>PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.</p> </li> </ul>", 7488 "ServiceSettingNotFound$Message": null, 7489 "StepExecution$StepName": "<p>The name of this execution step.</p>", 7490 "StepExecution$OnFailure": "<p>The action to take if the step fails. The default value is <code>Abort</code>.</p>", 7491 "StepExecution$ResponseCode": "<p>The response code returned by the execution of the step.</p>", 7492 "StepExecution$Response": "<p>A message associated with the response code for an execution.</p>", 7493 "StepExecution$FailureMessage": "<p>If a step failed, this message explains why the execution failed.</p>", 7494 "StepExecution$StepExecutionId": "<p>The unique ID of a step execution.</p>", 7495 "StepExecution$NextStep": "<p>The next step after the step succeeds.</p>", 7496 "StringList$member": null, 7497 "SubTypeCountLimitExceededException$Message": null, 7498 "TargetInUseException$Message": null, 7499 "TargetNotConnected$Message": null, 7500 "TooManyUpdates$Message": null, 7501 "TotalSizeLimitExceededException$Message": null, 7502 "UnsupportedCalendarException$Message": null, 7503 "UnsupportedFeatureRequiredException$Message": null, 7504 "UnsupportedInventoryItemContextException$Message": null, 7505 "UnsupportedInventorySchemaVersionException$Message": null, 7506 "UnsupportedOperatingSystem$Message": null, 7507 "UnsupportedParameterType$message": null, 7508 "UnsupportedPlatformType$Message": null 7509 } 7510 }, 7511 "StringDateTime": { 7512 "base": null, 7513 "refs": { 7514 "GetCommandInvocationResult$ExecutionStartDateTime": "<p>The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the <code>InvokedBefore</code> filter.</p> <p> <code>aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z</code> </p> <p>If the plugin hasn't started to run, the string is empty.</p>", 7515 "GetCommandInvocationResult$ExecutionElapsedTime": "<p>Duration since <code>ExecutionStartDateTime</code>.</p>", 7516 "GetCommandInvocationResult$ExecutionEndDateTime": "<p>The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the <code>InvokedAfter</code> filter.</p> <p> <code>aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z</code> </p> <p>If the plugin hasn't started to run, the string is empty.</p>" 7517 } 7518 }, 7519 "StringList": { 7520 "base": null, 7521 "refs": { 7522 "DescribeActivationsFilter$FilterValues": "<p>The filter values.</p>" 7523 } 7524 }, 7525 "SubTypeCountLimitExceededException": { 7526 "base": "<p>The sub-type count exceeded the limit for the inventory type.</p>", 7527 "refs": { 7528 } 7529 }, 7530 "Tag": { 7531 "base": "<p>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 instances, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.</p>", 7532 "refs": { 7533 "TagList$member": null 7534 } 7535 }, 7536 "TagKey": { 7537 "base": null, 7538 "refs": { 7539 "KeyList$member": null, 7540 "Tag$Key": "<p>The name of the tag.</p>" 7541 } 7542 }, 7543 "TagList": { 7544 "base": null, 7545 "refs": { 7546 "Activation$Tags": "<p>Tags assigned to the activation.</p>", 7547 "AddTagsToResourceRequest$Tags": "<p>One or more tags. The value parameter is required.</p> <important> <p>Don't enter personally identifiable information in this field.</p> </important>", 7548 "CreateActivationRequest$Tags": "<p>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 activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> </ul> <important> <p>When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.</p> </important> <p>You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with \"mi-\". For information about how to add tags to your managed instances, see <a>AddTagsToResource</a>. For information about how to remove tags from your managed instances, see <a>RemoveTagsFromResource</a>.</p>", 7549 "CreateDocumentRequest$Tags": "<p>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:</p> <ul> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> </ul> <note> <p>To add tags to an existing SSM document, use the <a>AddTagsToResource</a> operation.</p> </note>", 7550 "CreateMaintenanceWindowRequest$Tags": "<p>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 a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=TaskType,Value=AgentUpdate</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> </ul> <note> <p>To add tags to an existing maintenance window, use the <a>AddTagsToResource</a> operation.</p> </note>", 7551 "CreateOpsItemRequest$Tags": "<p>Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions\">Getting started with OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>Tags use a key-value pair. For example:</p> <p> <code>Key=Department,Value=Finance</code> </p> <important> <p>To add tags to a new OpsItem, a user must have IAM permissions for both the <code>ssm:CreateOpsItems</code> operation and the <code>ssm:AddTagsToResource</code> operation. To add tags to an existing OpsItem, use the <a>AddTagsToResource</a> operation.</p> </important>", 7552 "CreateOpsMetadataRequest$Tags": "<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. 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 OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> <li> <p> <code>Key=Region,Value=us-east-2</code> </p> </li> </ul>", 7553 "CreatePatchBaselineRequest$Tags": "<p>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 a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=PatchSeverity,Value=Critical</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> </ul> <note> <p>To add tags to an existing patch baseline, use the <a>AddTagsToResource</a> operation.</p> </note>", 7554 "DocumentDescription$Tags": "<p>The tags, or metadata, that have been applied to the document.</p>", 7555 "DocumentIdentifier$Tags": "<p>The tags, or metadata, that have been applied to the document.</p>", 7556 "ListTagsForResourceResult$TagList": "<p>A list of tags.</p>", 7557 "PutParameterRequest$Tags": "<p>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 a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=Resource,Value=S3bucket</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p> <code>Key=ParameterType,Value=LicenseKey</code> </p> </li> </ul> <note> <p>To add tags to an existing Systems Manager parameter, use the <a>AddTagsToResource</a> operation.</p> </note>", 7558 "StartAutomationExecutionRequest$Tags": "<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. 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 automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=environment,Value=test</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> </ul> <note> <p>To add tags to an existing patch baseline, use the <a>AddTagsToResource</a> operation.</p> </note>", 7559 "StartChangeRequestExecutionRequest$Tags": "<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> <li> <p> <code>Key=Region,Value=us-east-2</code> </p> </li> </ul>" 7560 } 7561 }, 7562 "TagValue": { 7563 "base": null, 7564 "refs": { 7565 "Tag$Value": "<p>The value of the tag.</p>" 7566 } 7567 }, 7568 "Target": { 7569 "base": "<p>An array of search criteria that targets instances using a key-value pair that you specify.</p> <note> <p> One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note> <p>Supported formats include the following.</p> <ul> <li> <p> <code>Key=InstanceIds,Values=<i>instance-id-1</i>,<i>instance-id-2</i>,<i>instance-id-3</i> </code> </p> </li> <li> <p> <code>Key=tag:<i>my-tag-key</i>,Values=<i>my-tag-value-1</i>,<i>my-tag-value-2</i> </code> </p> </li> <li> <p> <code>Key=tag-key,Values=<i>my-tag-key-1</i>,<i>my-tag-key-2</i> </code> </p> </li> <li> <p> <b>Run Command and Maintenance window targets only</b>: <code>Key=resource-groups:Name,Values=<i>resource-group-name</i> </code> </p> </li> <li> <p> <b>Maintenance window targets only</b>: <code>Key=resource-groups:ResourceTypeFilters,Values=<i>resource-type-1</i>,<i>resource-type-2</i> </code> </p> </li> <li> <p> <b>Automation targets only</b>: <code>Key=ResourceGroup;Values=<i>resource-group-name</i> </code> </p> </li> </ul> <p>For example:</p> <ul> <li> <p> <code>Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE</code> </p> </li> <li> <p> <code>Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3</code> </p> </li> <li> <p> <code>Key=tag-key,Values=Name,Instance-Type,CostCenter</code> </p> </li> <li> <p> <b>Run Command and Maintenance window targets only</b>: <code>Key=resource-groups:Name,Values=ProductionResourceGroup</code> </p> <p>This example demonstrates how to target all resources in the resource group <b>ProductionResourceGroup</b> in your maintenance window.</p> </li> <li> <p> <b>Maintenance window targets only</b>: <code>Key=resource-groups:ResourceTypeFilters,Values=<i>AWS::EC2::INSTANCE</i>,<i>AWS::EC2::VPC</i> </code> </p> <p>This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.</p> </li> <li> <p> <b>Automation targets only</b>: <code>Key=ResourceGroup,Values=MyResourceGroup</code> </p> </li> <li> <p> <b>State Manager association targets only</b>: <code>Key=InstanceIds,Values=<i>*</i> </code> </p> <p>This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.</p> </li> </ul> <p>For more information about how to send commands that target instances using <code>Key,Value</code> parameters, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting\">Targeting multiple instances</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 7570 "refs": { 7571 "Targets$member": null 7572 } 7573 }, 7574 "TargetCount": { 7575 "base": null, 7576 "refs": { 7577 "Command$TargetCount": "<p>The number of targets for the command.</p>" 7578 } 7579 }, 7580 "TargetInUseException": { 7581 "base": "<p>You specified the <code>Safe</code> option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.</p>", 7582 "refs": { 7583 } 7584 }, 7585 "TargetKey": { 7586 "base": null, 7587 "refs": { 7588 "Target$Key": "<p>User-defined criteria for sending commands that target instances that meet the criteria.</p>" 7589 } 7590 }, 7591 "TargetLocation": { 7592 "base": "<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.</p>", 7593 "refs": { 7594 "StepExecution$TargetLocation": "<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.</p>", 7595 "TargetLocations$member": null 7596 } 7597 }, 7598 "TargetLocations": { 7599 "base": null, 7600 "refs": { 7601 "AssociationDescription$TargetLocations": "<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.</p>", 7602 "AssociationVersionInfo$TargetLocations": "<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.</p>", 7603 "AutomationExecution$TargetLocations": "<p>The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.</p>", 7604 "CreateAssociationBatchRequestEntry$TargetLocations": "<p>Use this action to create an association in multiple Regions and multiple accounts.</p>", 7605 "CreateAssociationRequest$TargetLocations": "<p>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.</p>", 7606 "Runbook$TargetLocations": "<p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.</p>", 7607 "StartAutomationExecutionRequest$TargetLocations": "<p>A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html\">Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>", 7608 "UpdateAssociationRequest$TargetLocations": "<p>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.</p>" 7609 } 7610 }, 7611 "TargetMap": { 7612 "base": null, 7613 "refs": { 7614 "TargetMaps$member": null 7615 } 7616 }, 7617 "TargetMapKey": { 7618 "base": null, 7619 "refs": { 7620 "TargetMap$key": null 7621 } 7622 }, 7623 "TargetMapValue": { 7624 "base": null, 7625 "refs": { 7626 "TargetMapValueList$member": null 7627 } 7628 }, 7629 "TargetMapValueList": { 7630 "base": null, 7631 "refs": { 7632 "TargetMap$value": null 7633 } 7634 }, 7635 "TargetMaps": { 7636 "base": null, 7637 "refs": { 7638 "AutomationExecution$TargetMaps": "<p>The specified key-value mapping of document parameters to target resources.</p>", 7639 "AutomationExecutionMetadata$TargetMaps": "<p>The specified key-value mapping of document parameters to target resources.</p>", 7640 "StartAutomationExecutionRequest$TargetMaps": "<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>" 7641 } 7642 }, 7643 "TargetNotConnected": { 7644 "base": "<p>The specified target instance for the session isn't fully configured for use with Session Manager. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html\">Getting started with Session Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. This error is also returned if you attempt to start a session on an instance that is located in a different account or Region</p>", 7645 "refs": { 7646 } 7647 }, 7648 "TargetParameterList": { 7649 "base": null, 7650 "refs": { 7651 "ResolvedTargets$ParameterValues": "<p>A list of parameter values sent to targets that resolved during the Automation execution.</p>" 7652 } 7653 }, 7654 "TargetType": { 7655 "base": null, 7656 "refs": { 7657 "CreateDocumentRequest$TargetType": "<p>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: <code>/AWS::EC2::Instance</code>. 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 <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>. </p>", 7658 "DocumentDescription$TargetType": "<p>The target type which defines the kinds of resources the document can run on. For example, <code>/AWS::EC2::Instance</code>. For a list of valid resource types, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>. </p>", 7659 "DocumentIdentifier$TargetType": "<p>The target type which defines the kinds of resources the document can run on. For example, <code>/AWS::EC2::Instance</code>. For a list of valid resource types, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>. </p>", 7660 "UpdateDocumentRequest$TargetType": "<p>Specify a new target type for the document.</p>" 7661 } 7662 }, 7663 "TargetValue": { 7664 "base": null, 7665 "refs": { 7666 "TargetValues$member": null 7667 } 7668 }, 7669 "TargetValues": { 7670 "base": null, 7671 "refs": { 7672 "Target$Values": "<p>User-defined criteria that maps to <code>Key</code>. For example, if you specified <code>tag:ServerRole</code>, you could specify <code>value:WebServer</code> to run a command on instances that include EC2 tags of <code>ServerRole,WebServer</code>. </p> <p>Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.</p>" 7673 } 7674 }, 7675 "Targets": { 7676 "base": null, 7677 "refs": { 7678 "Association$Targets": "<p>The instances targeted by the request to create an association. You can target all instances in an Amazon Web Services account by specifying the <code>InstanceIds</code> key with a value of <code>*</code>.</p>", 7679 "AssociationDescription$Targets": "<p>The instances targeted by the request. </p>", 7680 "AssociationVersionInfo$Targets": "<p>The targets specified for the association when the association version was created. </p>", 7681 "AutomationExecution$Targets": "<p>The specified targets.</p>", 7682 "AutomationExecutionMetadata$Targets": "<p>The targets defined by the user when starting the automation.</p>", 7683 "Command$Targets": "<p>An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.</p>", 7684 "CreateAssociationBatchRequestEntry$Targets": "<p>The instances targeted by the request.</p>", 7685 "CreateAssociationRequest$Targets": "<p>The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. You can target all instances in an Amazon Web Services account by specifying the <code>InstanceIds</code> key with a value of <code>*</code>. For more information about choosing targets for an association, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html\">Using targets and rate controls with State Manager associations</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 7686 "DescribeMaintenanceWindowScheduleRequest$Targets": "<p>The instance ID or key-value pair to retrieve information about.</p>", 7687 "DescribeMaintenanceWindowsForTargetRequest$Targets": "<p>The instance ID or key-value pair to retrieve information about.</p>", 7688 "GetMaintenanceWindowTaskResult$Targets": "<p>The targets where the task should run.</p>", 7689 "MaintenanceWindowTarget$Targets": "<p>The targets, either instances or tags.</p> <p>Specify instances using the following format:</p> <p> <code>Key=instanceids,Values=<instanceid1>,<instanceid2></code> </p> <p>Tags are specified using the following format:</p> <p> <code>Key=<tag name>,Values=<tag value></code>.</p>", 7690 "MaintenanceWindowTask$Targets": "<p>The targets (either instances or tags). Instances are specified using <code>Key=instanceids,Values=<instanceid1>,<instanceid2></code>. Tags are specified using <code>Key=<tag name>,Values=<tag value></code>.</p>", 7691 "RegisterTargetWithMaintenanceWindowRequest$Targets": "<p>The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.</p> <note> <p>If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.</p> </note> <p>You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.</p> <p> <b>Example 1</b>: Specify instance IDs</p> <p> <code>Key=InstanceIds,Values=<i>instance-id-1</i>,<i>instance-id-2</i>,<i>instance-id-3</i> </code> </p> <p> <b>Example 2</b>: Use tag key-pairs applied to instances</p> <p> <code>Key=tag:<i>my-tag-key</i>,Values=<i>my-tag-value-1</i>,<i>my-tag-value-2</i> </code> </p> <p> <b>Example 3</b>: Use tag-keys applied to instances</p> <p> <code>Key=tag-key,Values=<i>my-tag-key-1</i>,<i>my-tag-key-2</i> </code> </p> <p> <b>Example 4</b>: Use resource group names</p> <p> <code>Key=resource-groups:Name,Values=<i>resource-group-name</i> </code> </p> <p> <b>Example 5</b>: Use filters for resource group types</p> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=<i>resource-type-1</i>,<i>resource-type-2</i> </code> </p> <note> <p>For <code>Key=resource-groups:ResourceTypeFilters</code>, specify resource types in the following format</p> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=<i>AWS::EC2::INSTANCE</i>,<i>AWS::EC2::VPC</i> </code> </p> </note> <p>For more information about these examples formats, including the best use case for each one, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html\">Examples: Register targets with a maintenance window</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 7692 "RegisterTaskWithMaintenanceWindowRequest$Targets": "<p>The targets (either instances or maintenance window targets).</p> <note> <p>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note> <p>Specify instances using the following format: </p> <p> <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2></code> </p> <p>Specify maintenance window targets using the following format:</p> <p> <code>Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2></code> </p>", 7693 "Runbook$Targets": "<p>A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify <code>TargetParameterName</code>.</p>", 7694 "SendCommandRequest$Targets": "<p>An array of search criteria that targets instances using a <code>Key,Value</code> combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using <code>Targets</code>, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.</p> <p>To send a command to a smaller number of instances, you can use the <code>InstanceIds</code> option instead.</p> <p>For more information about how to use targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html\">Sending commands to a fleet</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 7695 "StartAutomationExecutionRequest$Targets": "<p>A key-value mapping to target resources. Required if you specify TargetParameterName.</p>", 7696 "StepExecution$Targets": "<p>The targets for the step execution.</p>", 7697 "UpdateAssociationRequest$Targets": "<p>The targets of the association.</p>", 7698 "UpdateMaintenanceWindowTargetRequest$Targets": "<p>The targets to add or replace.</p>", 7699 "UpdateMaintenanceWindowTargetResult$Targets": "<p>The updated targets.</p>", 7700 "UpdateMaintenanceWindowTaskRequest$Targets": "<p>The targets (either instances or tags) to modify. Instances are specified using the format <code>Key=instanceids,Values=instanceID_1,instanceID_2</code>. Tags are specified using the format <code> Key=tag_name,Values=tag_value</code>. </p> <note> <p>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note>", 7701 "UpdateMaintenanceWindowTaskResult$Targets": "<p>The updated target values.</p>" 7702 } 7703 }, 7704 "TerminateSessionRequest": { 7705 "base": null, 7706 "refs": { 7707 } 7708 }, 7709 "TerminateSessionResponse": { 7710 "base": null, 7711 "refs": { 7712 } 7713 }, 7714 "TimeoutSeconds": { 7715 "base": null, 7716 "refs": { 7717 "Command$TimeoutSeconds": "<p>The <code>TimeoutSeconds</code> value specified for a command.</p>", 7718 "MaintenanceWindowRunCommandParameters$TimeoutSeconds": "<p>If this time is reached and the command hasn't already started running, it doesn't run.</p>", 7719 "SendCommandRequest$TimeoutSeconds": "<p>If this time is reached and the command hasn't already started running, it won't run.</p>" 7720 } 7721 }, 7722 "TokenValue": { 7723 "base": null, 7724 "refs": { 7725 "ResumeSessionResponse$TokenValue": "<p>An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.</p>", 7726 "StartSessionResponse$TokenValue": "<p>An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.</p>" 7727 } 7728 }, 7729 "TooManyTagsError": { 7730 "base": "<p>The <code>Targets</code> parameter includes too many tags. Remove one or more tags and try the command again.</p>", 7731 "refs": { 7732 } 7733 }, 7734 "TooManyUpdates": { 7735 "base": "<p>There are concurrent updates for a resource that supports one update at a time.</p>", 7736 "refs": { 7737 } 7738 }, 7739 "TotalCount": { 7740 "base": null, 7741 "refs": { 7742 "InventoryDeletionSummary$TotalCount": "<p>The total number of items to delete. This count doesn't change during the delete operation.</p>" 7743 } 7744 }, 7745 "TotalSizeLimitExceededException": { 7746 "base": "<p>The size of inventory data has exceeded the total size limit for the resource.</p>", 7747 "refs": { 7748 } 7749 }, 7750 "UUID": { 7751 "base": null, 7752 "refs": { 7753 "DeleteInventoryRequest$ClientToken": "<p>User-provided idempotency token.</p>", 7754 "DeleteInventoryResult$DeletionId": "<p>Every <code>DeleteInventory</code> operation is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other operations. </p>", 7755 "DescribeInventoryDeletionsRequest$DeletionId": "<p>Specify the delete inventory ID for which you want information. This ID was returned by the <code>DeleteInventory</code> operation.</p>", 7756 "InventoryDeletionStatusItem$DeletionId": "<p>The deletion ID returned by the <code>DeleteInventory</code> operation.</p>" 7757 } 7758 }, 7759 "UnlabelParameterVersionRequest": { 7760 "base": null, 7761 "refs": { 7762 } 7763 }, 7764 "UnlabelParameterVersionResult": { 7765 "base": null, 7766 "refs": { 7767 } 7768 }, 7769 "UnsupportedCalendarException": { 7770 "base": "<p>The calendar entry contained in the specified SSM document isn't supported.</p>", 7771 "refs": { 7772 } 7773 }, 7774 "UnsupportedFeatureRequiredException": { 7775 "base": "<p>Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html\">Enabling the advanced-instances tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>", 7776 "refs": { 7777 } 7778 }, 7779 "UnsupportedInventoryItemContextException": { 7780 "base": "<p>The <code>Context</code> attribute that you specified for the <code>InventoryItem</code> isn't allowed for this inventory type. You can only use the <code>Context</code> attribute with inventory types like <code>AWS:ComplianceItem</code>.</p>", 7781 "refs": { 7782 } 7783 }, 7784 "UnsupportedInventorySchemaVersionException": { 7785 "base": "<p>Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.</p>", 7786 "refs": { 7787 } 7788 }, 7789 "UnsupportedOperatingSystem": { 7790 "base": "<p>The operating systems you specified isn't supported, or the operation isn't supported for the operating system.</p>", 7791 "refs": { 7792 } 7793 }, 7794 "UnsupportedParameterType": { 7795 "base": "<p>The parameter type isn't supported.</p>", 7796 "refs": { 7797 } 7798 }, 7799 "UnsupportedPlatformType": { 7800 "base": "<p>The document doesn't support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.</p>", 7801 "refs": { 7802 } 7803 }, 7804 "UpdateAssociationRequest": { 7805 "base": null, 7806 "refs": { 7807 } 7808 }, 7809 "UpdateAssociationResult": { 7810 "base": null, 7811 "refs": { 7812 } 7813 }, 7814 "UpdateAssociationStatusRequest": { 7815 "base": null, 7816 "refs": { 7817 } 7818 }, 7819 "UpdateAssociationStatusResult": { 7820 "base": null, 7821 "refs": { 7822 } 7823 }, 7824 "UpdateDocumentDefaultVersionRequest": { 7825 "base": null, 7826 "refs": { 7827 } 7828 }, 7829 "UpdateDocumentDefaultVersionResult": { 7830 "base": null, 7831 "refs": { 7832 } 7833 }, 7834 "UpdateDocumentMetadataRequest": { 7835 "base": null, 7836 "refs": { 7837 } 7838 }, 7839 "UpdateDocumentMetadataResponse": { 7840 "base": null, 7841 "refs": { 7842 } 7843 }, 7844 "UpdateDocumentRequest": { 7845 "base": null, 7846 "refs": { 7847 } 7848 }, 7849 "UpdateDocumentResult": { 7850 "base": null, 7851 "refs": { 7852 } 7853 }, 7854 "UpdateMaintenanceWindowRequest": { 7855 "base": null, 7856 "refs": { 7857 } 7858 }, 7859 "UpdateMaintenanceWindowResult": { 7860 "base": null, 7861 "refs": { 7862 } 7863 }, 7864 "UpdateMaintenanceWindowTargetRequest": { 7865 "base": null, 7866 "refs": { 7867 } 7868 }, 7869 "UpdateMaintenanceWindowTargetResult": { 7870 "base": null, 7871 "refs": { 7872 } 7873 }, 7874 "UpdateMaintenanceWindowTaskRequest": { 7875 "base": null, 7876 "refs": { 7877 } 7878 }, 7879 "UpdateMaintenanceWindowTaskResult": { 7880 "base": null, 7881 "refs": { 7882 } 7883 }, 7884 "UpdateManagedInstanceRoleRequest": { 7885 "base": null, 7886 "refs": { 7887 } 7888 }, 7889 "UpdateManagedInstanceRoleResult": { 7890 "base": null, 7891 "refs": { 7892 } 7893 }, 7894 "UpdateOpsItemRequest": { 7895 "base": null, 7896 "refs": { 7897 } 7898 }, 7899 "UpdateOpsItemResponse": { 7900 "base": null, 7901 "refs": { 7902 } 7903 }, 7904 "UpdateOpsMetadataRequest": { 7905 "base": null, 7906 "refs": { 7907 } 7908 }, 7909 "UpdateOpsMetadataResult": { 7910 "base": null, 7911 "refs": { 7912 } 7913 }, 7914 "UpdatePatchBaselineRequest": { 7915 "base": null, 7916 "refs": { 7917 } 7918 }, 7919 "UpdatePatchBaselineResult": { 7920 "base": null, 7921 "refs": { 7922 } 7923 }, 7924 "UpdateResourceDataSyncRequest": { 7925 "base": null, 7926 "refs": { 7927 } 7928 }, 7929 "UpdateResourceDataSyncResult": { 7930 "base": null, 7931 "refs": { 7932 } 7933 }, 7934 "UpdateServiceSettingRequest": { 7935 "base": "<p>The request body of the UpdateServiceSetting API operation.</p>", 7936 "refs": { 7937 } 7938 }, 7939 "UpdateServiceSettingResult": { 7940 "base": "<p>The result body of the UpdateServiceSetting API operation.</p>", 7941 "refs": { 7942 } 7943 }, 7944 "Url": { 7945 "base": null, 7946 "refs": { 7947 "CommandInvocation$StandardOutputUrl": "<p>The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, <code>StandardOutputUrl</code> is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.</p>", 7948 "CommandInvocation$StandardErrorUrl": "<p>The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, <code>StandardErrorUrl</code> is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.</p>", 7949 "CommandPlugin$StandardOutputUrl": "<p>The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't specified, then this string is empty.</p>", 7950 "CommandPlugin$StandardErrorUrl": "<p>The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.</p>", 7951 "GetCommandInvocationResult$StandardOutputUrl": "<p>The URL for the complete text written by the plugin to <code>stdout</code> in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.</p>", 7952 "GetCommandInvocationResult$StandardErrorUrl": "<p>The URL for the complete text written by the plugin to <code>stderr</code>. If the command hasn't finished running, then this string is empty.</p>", 7953 "S3OutputUrl$OutputUrl": "<p>A URL for an S3 bucket where you want to store the results of this request.</p>" 7954 } 7955 }, 7956 "ValidNextStep": { 7957 "base": null, 7958 "refs": { 7959 "ValidNextStepList$member": null 7960 } 7961 }, 7962 "ValidNextStepList": { 7963 "base": null, 7964 "refs": { 7965 "StepExecution$ValidNextSteps": "<p>Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.</p>" 7966 } 7967 }, 7968 "Version": { 7969 "base": null, 7970 "refs": { 7971 "InstanceInformation$AgentVersion": "<p>The version of SSM Agent running on your Linux instance. </p>" 7972 } 7973 } 7974 } 7975 }