{ "version":"2.0", "metadata":{ "apiVersion":"2014-11-06", "endpointPrefix":"ssm", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon SSM", "serviceFullName":"Amazon Simple Systems Manager (SSM)", "serviceId":"SSM", "signatureVersion":"v4", "targetPrefix":"AmazonSSM", "uid":"ssm-2014-11-06" }, "operations":{ "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceRequest"}, "output":{"shape":"AddTagsToResourceResult"}, "errors":[ {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"}, {"shape":"TooManyTagsError"}, {"shape":"TooManyUpdates"} ], "documentation":"

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, 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 nodes that helps you track each node's owner and stack level. For example:

- `Key=Owner,Value=DbAdmin`

- `Key=Owner,Value=SysAdmin`

- `Key=Owner,Value=Dev`

- `Key=Stack,Value=Production`

- `Key=Stack,Value=Pre-Production`

- `Key=Stack,Value=Test`

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

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.

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.

" }, "AssociateOpsItemRelatedItem":{ "name":"AssociateOpsItemRelatedItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateOpsItemRelatedItemRequest"}, "output":{"shape":"AssociateOpsItemRelatedItemResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemNotFoundException"}, {"shape":"OpsItemLimitExceededException"}, {"shape":"OpsItemInvalidParameterException"}, {"shape":"OpsItemRelatedItemAlreadyExistsException"}, {"shape":"OpsItemConflictException"} ], "documentation":"

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.

" }, "CancelCommand":{ "name":"CancelCommand", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelCommandRequest"}, "output":{"shape":"CancelCommandResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"DuplicateInstanceId"} ], "documentation":"

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.

" }, "CancelMaintenanceWindowExecution":{ "name":"CancelMaintenanceWindowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelMaintenanceWindowExecutionRequest"}, "output":{"shape":"CancelMaintenanceWindowExecutionResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"DoesNotExistException"} ], "documentation":"

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.

" }, "CreateActivation":{ "name":"CreateActivation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateActivationRequest"}, "output":{"shape":"CreateActivationResult"}, "errors":[ {"shape":"InvalidParameters"}, {"shape":"InternalServerError"} ], "documentation":"

Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, 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 machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

" }, "CreateAssociation":{ "name":"CreateAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAssociationRequest"}, "output":{"shape":"CreateAssociationResult"}, "errors":[ {"shape":"AssociationAlreadyExists"}, {"shape":"AssociationLimitExceeded"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidInstanceId"}, {"shape":"UnsupportedPlatformType"}, {"shape":"InvalidOutputLocation"}, {"shape":"InvalidParameters"}, {"shape":"InvalidTarget"}, {"shape":"InvalidSchedule"}, {"shape":"InvalidTargetMaps"}, {"shape":"InvalidTag"} ], "documentation":"

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, 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 managed nodes 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.

" }, "CreateAssociationBatch":{ "name":"CreateAssociationBatch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAssociationBatchRequest"}, "output":{"shape":"CreateAssociationBatchResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidParameters"}, {"shape":"DuplicateInstanceId"}, {"shape":"AssociationLimitExceeded"}, {"shape":"UnsupportedPlatformType"}, {"shape":"InvalidOutputLocation"}, {"shape":"InvalidTarget"}, {"shape":"InvalidSchedule"}, {"shape":"InvalidTargetMaps"} ], "documentation":"

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.

When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.

If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.

" }, "CreateDocument":{ "name":"CreateDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDocumentRequest"}, "output":{"shape":"CreateDocumentResult"}, "errors":[ {"shape":"DocumentAlreadyExists"}, {"shape":"MaxDocumentSizeExceeded"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocumentContent"}, {"shape":"DocumentLimitExceeded"}, {"shape":"InvalidDocumentSchemaVersion"} ], "documentation":"

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

" }, "CreateMaintenanceWindow":{ "name":"CreateMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMaintenanceWindowRequest"}, "output":{"shape":"CreateMaintenanceWindowResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a new maintenance window.

The value you specify for `Duration` 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 `Cutoff`. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for `Cutoff` is one hour, no maintenance window tasks can start after 5 PM.

" }, "CreateOpsItem":{ "name":"CreateOpsItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateOpsItemRequest"}, "output":{"shape":"CreateOpsItemResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemAlreadyExistsException"}, {"shape":"OpsItemLimitExceededException"}, {"shape":"OpsItemInvalidParameterException"}, {"shape":"OpsItemAccessDeniedException"} ], "documentation":"

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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 Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

" }, "CreateOpsMetadata":{ "name":"CreateOpsMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateOpsMetadataRequest"}, "output":{"shape":"CreateOpsMetadataResult"}, "errors":[ {"shape":"OpsMetadataAlreadyExistsException"}, {"shape":"OpsMetadataTooManyUpdatesException"}, {"shape":"OpsMetadataInvalidArgumentException"}, {"shape":"OpsMetadataLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

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.

" }, "CreatePatchBaseline":{ "name":"CreatePatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePatchBaselineRequest"}, "output":{"shape":"CreatePatchBaselineResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a patch baseline.

For information about valid key-value pairs in `PatchFilters` for each supported operating system type, see PatchFilter.

" }, "CreateResourceDataSync":{ "name":"CreateResourceDataSync", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateResourceDataSyncRequest"}, "output":{"shape":"CreateResourceDataSyncResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ResourceDataSyncCountExceededException"}, {"shape":"ResourceDataSyncAlreadyExistsException"}, {"shape":"ResourceDataSyncInvalidConfigurationException"} ], "documentation":"

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: `SyncToDestination` and `SyncFromSource`.

You can configure Systems Manager Inventory to use the `SyncToDestination` 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 Configuring resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.

You can configure Systems Manager Explorer to use the `SyncFromSource` 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 `EntireOrganization` by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

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 ListResourceDataSync.

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.

" }, "DeleteActivation":{ "name":"DeleteActivation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteActivationRequest"}, "output":{"shape":"DeleteActivationResult"}, "errors":[ {"shape":"InvalidActivationId"}, {"shape":"InvalidActivation"}, {"shape":"InternalServerError"}, {"shape":"TooManyUpdates"} ], "documentation":"

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 nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.

" }, "DeleteAssociation":{ "name":"DeleteAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAssociationRequest"}, "output":{"shape":"DeleteAssociationResult"}, "errors":[ {"shape":"AssociationDoesNotExist"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidInstanceId"}, {"shape":"TooManyUpdates"} ], "documentation":"

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the `Targets` parameter, then you must delete the association by using the association ID.

When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.

" }, "DeleteDocument":{ "name":"DeleteDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDocumentRequest"}, "output":{"shape":"DeleteDocumentResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentOperation"}, {"shape":"AssociatedInstances"} ], "documentation":"

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.

" }, "DeleteInventory":{ "name":"DeleteInventory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInventoryRequest"}, "output":{"shape":"DeleteInventoryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidOptionException"}, {"shape":"InvalidDeleteInventoryParametersException"}, {"shape":"InvalidInventoryRequestException"} ], "documentation":"

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.

" }, "DeleteMaintenanceWindow":{ "name":"DeleteMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMaintenanceWindowRequest"}, "output":{"shape":"DeleteMaintenanceWindowResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Deletes a maintenance window.

" }, "DeleteOpsItem":{ "name":"DeleteOpsItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteOpsItemRequest"}, "output":{"shape":"DeleteOpsItemResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemInvalidParameterException"} ], "documentation":"

Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.

Note the following important information about this operation.

- Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.

- This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.

- This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.

- This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.

" }, "DeleteOpsMetadata":{ "name":"DeleteOpsMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteOpsMetadataRequest"}, "output":{"shape":"DeleteOpsMetadataResult"}, "errors":[ {"shape":"OpsMetadataNotFoundException"}, {"shape":"OpsMetadataInvalidArgumentException"}, {"shape":"InternalServerError"} ], "documentation":"

Delete OpsMetadata related to an application.

" }, "DeleteParameter":{ "name":"DeleteParameter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteParameterRequest"}, "output":{"shape":"DeleteParameterResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ParameterNotFound"} ], "documentation":"

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

" }, "DeleteParameters":{ "name":"DeleteParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteParametersRequest"}, "output":{"shape":"DeleteParametersResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

" }, "DeletePatchBaseline":{ "name":"DeletePatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePatchBaselineRequest"}, "output":{"shape":"DeletePatchBaselineResult"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes a patch baseline.

" }, "DeleteResourceDataSync":{ "name":"DeleteResourceDataSync", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteResourceDataSyncRequest"}, "output":{"shape":"DeleteResourceDataSyncResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ResourceDataSyncNotFoundException"}, {"shape":"ResourceDataSyncInvalidConfigurationException"} ], "documentation":"

Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.

" }, "DeleteResourcePolicy":{ "name":"DeleteResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteResourcePolicyRequest"}, "output":{"shape":"DeleteResourcePolicyResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ResourcePolicyInvalidParameterException"}, {"shape":"ResourcePolicyConflictException"} ], "documentation":"

Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, `OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

" }, "DeregisterManagedInstance":{ "name":"DeregisterManagedInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterManagedInstanceRequest"}, "output":{"shape":"DeregisterManagedInstanceResult"}, "errors":[ {"shape":"InvalidInstanceId"}, {"shape":"InternalServerError"} ], "documentation":"

Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.

" }, "DeregisterPatchBaselineForPatchGroup":{ "name":"DeregisterPatchBaselineForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterPatchBaselineForPatchGroupRequest"}, "output":{"shape":"DeregisterPatchBaselineForPatchGroupResult"}, "errors":[ {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"} ], "documentation":"

Removes a patch group from a patch baseline.

" }, "DeregisterTargetFromMaintenanceWindow":{ "name":"DeregisterTargetFromMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterTargetFromMaintenanceWindowRequest"}, "output":{"shape":"DeregisterTargetFromMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"}, {"shape":"TargetInUseException"} ], "documentation":"

Removes a target from a maintenance window.

" }, "DeregisterTaskFromMaintenanceWindow":{ "name":"DeregisterTaskFromMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterTaskFromMaintenanceWindowRequest"}, "output":{"shape":"DeregisterTaskFromMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Removes a task from a maintenance window.

" }, "DescribeActivations":{ "name":"DescribeActivations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeActivationsRequest"}, "output":{"shape":"DescribeActivationsResult"}, "errors":[ {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"}, {"shape":"InternalServerError"} ], "documentation":"

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 managed nodes in the activation, and the number of nodes registered by using this activation.

" }, "DescribeAssociation":{ "name":"DescribeAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssociationRequest"}, "output":{"shape":"DescribeAssociationResult"}, "errors":[ {"shape":"AssociationDoesNotExist"}, {"shape":"InvalidAssociationVersion"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidInstanceId"} ], "documentation":"

Describes the association for the specified target or managed node. If you created the association by using the `Targets` parameter, then you must retrieve the association by using the association ID.

" }, "DescribeAssociationExecutionTargets":{ "name":"DescribeAssociationExecutionTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssociationExecutionTargetsRequest"}, "output":{"shape":"DescribeAssociationExecutionTargetsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"AssociationDoesNotExist"}, {"shape":"InvalidNextToken"}, {"shape":"AssociationExecutionDoesNotExist"} ], "documentation":"

Views information about a specific execution of a specific association.

" }, "DescribeAssociationExecutions":{ "name":"DescribeAssociationExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssociationExecutionsRequest"}, "output":{"shape":"DescribeAssociationExecutionsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"AssociationDoesNotExist"}, {"shape":"InvalidNextToken"} ], "documentation":"

Views all executions for a specific association ID.

" }, "DescribeAutomationExecutions":{ "name":"DescribeAutomationExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAutomationExecutionsRequest"}, "output":{"shape":"DescribeAutomationExecutionsResult"}, "errors":[ {"shape":"InvalidFilterKey"}, {"shape":"InvalidFilterValue"}, {"shape":"InvalidNextToken"}, {"shape":"InternalServerError"} ], "documentation":"

Provides details about all active and terminated Automation executions.

" }, "DescribeAutomationStepExecutions":{ "name":"DescribeAutomationStepExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAutomationStepExecutionsRequest"}, "output":{"shape":"DescribeAutomationStepExecutionsResult"}, "errors":[ {"shape":"AutomationExecutionNotFoundException"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidFilterValue"}, {"shape":"InternalServerError"} ], "documentation":"

Information about all active and terminated step executions in an Automation workflow.

" }, "DescribeAvailablePatches":{ "name":"DescribeAvailablePatches", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailablePatchesRequest"}, "output":{"shape":"DescribeAvailablePatchesResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Lists all patches eligible to be included in a patch baseline.

" }, "DescribeDocument":{ "name":"DescribeDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDocumentRequest"}, "output":{"shape":"DescribeDocumentResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"} ], "documentation":"

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

" }, "DescribeDocumentPermission":{ "name":"DescribeDocumentPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDocumentPermissionRequest"}, "output":{"shape":"DescribeDocumentPermissionResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidPermissionType"}, {"shape":"InvalidDocumentOperation"} ], "documentation":"

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 (All).

" }, "DescribeEffectiveInstanceAssociations":{ "name":"DescribeEffectiveInstanceAssociations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEffectiveInstanceAssociationsRequest"}, "output":{"shape":"DescribeEffectiveInstanceAssociationsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidNextToken"} ], "documentation":"

All associations for the managed node(s).

" }, "DescribeEffectivePatchesForPatchBaseline":{ "name":"DescribeEffectivePatchesForPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEffectivePatchesForPatchBaselineRequest"}, "output":{"shape":"DescribeEffectivePatchesForPatchBaselineResult"}, "errors":[ {"shape":"InvalidResourceId"}, {"shape":"DoesNotExistException"}, {"shape":"UnsupportedOperatingSystem"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.

" }, "DescribeInstanceAssociationsStatus":{ "name":"DescribeInstanceAssociationsStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAssociationsStatusRequest"}, "output":{"shape":"DescribeInstanceAssociationsStatusResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidNextToken"} ], "documentation":"

The status of the associations for the managed node(s).

" }, "DescribeInstanceInformation":{ "name":"DescribeInstanceInformation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceInformationRequest"}, "output":{"shape":"DescribeInstanceInformationResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidInstanceInformationFilterValue"}, {"shape":"InvalidFilterKey"} ], "documentation":"

Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.

If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.

The `IamRole` field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.

" }, "DescribeInstancePatchStates":{ "name":"DescribeInstancePatchStates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancePatchStatesRequest"}, "output":{"shape":"DescribeInstancePatchStatesResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves the high-level patch state of one or more managed nodes.

" }, "DescribeInstancePatchStatesForPatchGroup":{ "name":"DescribeInstancePatchStatesForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancePatchStatesForPatchGroupRequest"}, "output":{"shape":"DescribeInstancePatchStatesForPatchGroupResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves the high-level patch state for the managed nodes in the specified patch group.

" }, "DescribeInstancePatches":{ "name":"DescribeInstancePatches", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancePatchesRequest"}, "output":{"shape":"DescribeInstancePatchesResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.

" }, "DescribeInventoryDeletions":{ "name":"DescribeInventoryDeletions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInventoryDeletionsRequest"}, "output":{"shape":"DescribeInventoryDeletionsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDeletionIdException"}, {"shape":"InvalidNextToken"} ], "documentation":"

Describes a specific delete inventory operation.

" }, "DescribeMaintenanceWindowExecutionTaskInvocations":{ "name":"DescribeMaintenanceWindowExecutionTaskInvocations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowExecutionTaskInvocationsRequest"}, "output":{"shape":"DescribeMaintenanceWindowExecutionTaskInvocationsResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

" }, "DescribeMaintenanceWindowExecutionTasks":{ "name":"DescribeMaintenanceWindowExecutionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowExecutionTasksRequest"}, "output":{"shape":"DescribeMaintenanceWindowExecutionTasksResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

For a given maintenance window execution, lists the tasks that were run.

" }, "DescribeMaintenanceWindowExecutions":{ "name":"DescribeMaintenanceWindowExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowExecutionsRequest"}, "output":{"shape":"DescribeMaintenanceWindowExecutionsResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

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.

" }, "DescribeMaintenanceWindowSchedule":{ "name":"DescribeMaintenanceWindowSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowScheduleRequest"}, "output":{"shape":"DescribeMaintenanceWindowScheduleResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"DoesNotExistException"} ], "documentation":"

Retrieves information about upcoming executions of a maintenance window.

" }, "DescribeMaintenanceWindowTargets":{ "name":"DescribeMaintenanceWindowTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowTargetsRequest"}, "output":{"shape":"DescribeMaintenanceWindowTargetsResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists the targets registered with the maintenance window.

" }, "DescribeMaintenanceWindowTasks":{ "name":"DescribeMaintenanceWindowTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowTasksRequest"}, "output":{"shape":"DescribeMaintenanceWindowTasksResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists the tasks in a maintenance window.

For maintenance window tasks without a specified target, you can't supply values for `--max-errors` and `--max-concurrency`. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

" }, "DescribeMaintenanceWindows":{ "name":"DescribeMaintenanceWindows", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowsRequest"}, "output":{"shape":"DescribeMaintenanceWindowsResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves the maintenance windows in an Amazon Web Services account.

" }, "DescribeMaintenanceWindowsForTarget":{ "name":"DescribeMaintenanceWindowsForTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowsForTargetRequest"}, "output":{"shape":"DescribeMaintenanceWindowsForTargetResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves information about the maintenance window targets or tasks that a managed node is associated with.

" }, "DescribeOpsItems":{ "name":"DescribeOpsItems", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeOpsItemsRequest"}, "output":{"shape":"DescribeOpsItemsResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

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 Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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 OpsCenter in the Amazon Web Services Systems Manager User Guide.

" }, "DescribeParameters":{ "name":"DescribeParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeParametersRequest"}, "output":{"shape":"DescribeParametersResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidFilterOption"}, {"shape":"InvalidFilterValue"}, {"shape":"InvalidNextToken"} ], "documentation":"

Get information about a parameter.

Request results are returned on a best-effort basis. If you specify `MaxResults` 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 `MaxResults`. 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 `NextToken`. You can specify the `NextToken` in a subsequent call to get the next set of results.

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, `DescribeParameters` retrieves whatever the original key alias was referencing.

" }, "DescribePatchBaselines":{ "name":"DescribePatchBaselines", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePatchBaselinesRequest"}, "output":{"shape":"DescribePatchBaselinesResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Lists the patch baselines in your Amazon Web Services account.

" }, "DescribePatchGroupState":{ "name":"DescribePatchGroupState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePatchGroupStateRequest"}, "output":{"shape":"DescribePatchGroupStateResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], "documentation":"

Returns high-level aggregated patch compliance state information for a patch group.

" }, "DescribePatchGroups":{ "name":"DescribePatchGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePatchGroupsRequest"}, "output":{"shape":"DescribePatchGroupsResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Lists all patch groups that have been registered with patch baselines.

" }, "DescribePatchProperties":{ "name":"DescribePatchProperties", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePatchPropertiesRequest"}, "output":{"shape":"DescribePatchPropertiesResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

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 CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON_LINUX

  Valid properties: `PRODUCT` | `CLASSIFICATION` | `SEVERITY`

AMAZON_LINUX_2

  Valid properties: `PRODUCT` | `CLASSIFICATION` | `SEVERITY`

CENTOS

  Valid properties: `PRODUCT` | `CLASSIFICATION` | `SEVERITY`

DEBIAN

  Valid properties: `PRODUCT` | `PRIORITY`

MACOS

  Valid properties: `PRODUCT` | `CLASSIFICATION`

ORACLE_LINUX

  Valid properties: `PRODUCT` | `CLASSIFICATION` | `SEVERITY`

REDHAT_ENTERPRISE_LINUX

  Valid properties: `PRODUCT` | `CLASSIFICATION` | `SEVERITY`

SUSE

  Valid properties: `PRODUCT` | `CLASSIFICATION` | `SEVERITY`

UBUNTU

  Valid properties: `PRODUCT` | `PRIORITY`

WINDOWS

  Valid properties: `PRODUCT` | `PRODUCT_FAMILY` | `CLASSIFICATION` | `MSRC_SEVERITY`

" }, "DescribeSessions":{ "name":"DescribeSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSessionsRequest"}, "output":{"shape":"DescribeSessionsResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

" }, "DisassociateOpsItemRelatedItem":{ "name":"DisassociateOpsItemRelatedItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateOpsItemRelatedItemRequest"}, "output":{"shape":"DisassociateOpsItemRelatedItemResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemRelatedItemAssociationNotFoundException"}, {"shape":"OpsItemNotFoundException"}, {"shape":"OpsItemInvalidParameterException"}, {"shape":"OpsItemConflictException"} ], "documentation":"

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.

" }, "GetAutomationExecution":{ "name":"GetAutomationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAutomationExecutionRequest"}, "output":{"shape":"GetAutomationExecutionResult"}, "errors":[ {"shape":"AutomationExecutionNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

Get detailed information about a particular Automation execution.

" }, "GetCalendarState":{ "name":"GetCalendarState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCalendarStateRequest"}, "output":{"shape":"GetCalendarStateResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentType"}, {"shape":"UnsupportedCalendarException"} ], "documentation":"

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, `GetCalendarState` 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, `GetCalendarState` uses the current time. Change Calendar entries have two possible states: `OPEN` or `CLOSED`.

If you specify more than one calendar in a request, the command returns the status of `OPEN` only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is `CLOSED`.

For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

" }, "GetCommandInvocation":{ "name":"GetCommandInvocation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCommandInvocationRequest"}, "output":{"shape":"GetCommandInvocationResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidPluginName"}, {"shape":"InvocationDoesNotExist"} ], "documentation":"

Returns detailed information about command execution for an invocation or plugin.

`GetCommandInvocation` only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

" }, "GetConnectionStatus":{ "name":"GetConnectionStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConnectionStatusRequest"}, "output":{"shape":"GetConnectionStatusResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

" }, "GetDefaultPatchBaseline":{ "name":"GetDefaultPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDefaultPatchBaselineRequest"}, "output":{"shape":"GetDefaultPatchBaselineResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

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.

If you don't specify an operating system value, the default patch baseline for Windows is returned.

" }, "GetDeployablePatchSnapshotForInstance":{ "name":"GetDeployablePatchSnapshotForInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeployablePatchSnapshotForInstanceRequest"}, "output":{"shape":"GetDeployablePatchSnapshotForInstanceResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"UnsupportedOperatingSystem"}, {"shape":"UnsupportedFeatureRequiredException"} ], "documentation":"

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the `AWS-RunPatchBaseline` Systems Manager document (SSM document).

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 a managed node with a script or command. For example, run the command using the `AWS-RunShellScript` document or the `AWS-RunPowerShellScript` document.

" }, "GetDocument":{ "name":"GetDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDocumentRequest"}, "output":{"shape":"GetDocumentResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"} ], "documentation":"

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

" }, "GetInventory":{ "name":"GetInventory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInventoryRequest"}, "output":{"shape":"GetInventoryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilter"}, {"shape":"InvalidInventoryGroupException"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidAggregatorException"}, {"shape":"InvalidResultAttributeException"} ], "documentation":"

Query inventory information. This includes managed node status, such as `Stopped` or `Terminated`.

" }, "GetInventorySchema":{ "name":"GetInventorySchema", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInventorySchemaRequest"}, "output":{"shape":"GetInventorySchemaResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidNextToken"} ], "documentation":"

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

" }, "GetMaintenanceWindow":{ "name":"GetMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowRequest"}, "output":{"shape":"GetMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves a maintenance window.

" }, "GetMaintenanceWindowExecution":{ "name":"GetMaintenanceWindowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowExecutionRequest"}, "output":{"shape":"GetMaintenanceWindowExecutionResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves details about a specific a maintenance window execution.

" }, "GetMaintenanceWindowExecutionTask":{ "name":"GetMaintenanceWindowExecutionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowExecutionTaskRequest"}, "output":{"shape":"GetMaintenanceWindowExecutionTaskResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the details about a specific task run as part of a maintenance window execution.

" }, "GetMaintenanceWindowExecutionTaskInvocation":{ "name":"GetMaintenanceWindowExecutionTaskInvocation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowExecutionTaskInvocationRequest"}, "output":{"shape":"GetMaintenanceWindowExecutionTaskInvocationResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves information about a specific task running on a specific target.

" }, "GetMaintenanceWindowTask":{ "name":"GetMaintenanceWindowTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowTaskRequest"}, "output":{"shape":"GetMaintenanceWindowTaskResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the details of a maintenance window task.

For maintenance window tasks without a specified target, you can't supply values for `--max-errors` and `--max-concurrency`. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

" }, "GetOpsItem":{ "name":"GetOpsItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOpsItemRequest"}, "output":{"shape":"GetOpsItemResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemNotFoundException"}, {"shape":"OpsItemAccessDeniedException"} ], "documentation":"

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 Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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 OpsCenter in the Amazon Web Services Systems Manager User Guide.

" }, "GetOpsMetadata":{ "name":"GetOpsMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOpsMetadataRequest"}, "output":{"shape":"GetOpsMetadataResult"}, "errors":[ {"shape":"OpsMetadataNotFoundException"}, {"shape":"OpsMetadataInvalidArgumentException"}, {"shape":"InternalServerError"} ], "documentation":"

View operational metadata related to an application in Application Manager.

" }, "GetOpsSummary":{ "name":"GetOpsSummary", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOpsSummaryRequest"}, "output":{"shape":"GetOpsSummaryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ResourceDataSyncNotFoundException"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidAggregatorException"} ], "documentation":"

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.

" }, "GetParameter":{ "name":"GetParameter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParameterRequest"}, "output":{"shape":"GetParameterResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidKeyId"}, {"shape":"ParameterNotFound"}, {"shape":"ParameterVersionNotFound"} ], "documentation":"

Get information about a single parameter by specifying the parameter name.

To get information about more than one parameter at a time, use the GetParameters operation.

" }, "GetParameterHistory":{ "name":"GetParameterHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParameterHistoryRequest"}, "output":{"shape":"GetParameterHistoryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ParameterNotFound"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidKeyId"} ], "documentation":"

Retrieves the history of all changes to a parameter.

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, `GetParameterHistory` retrieves whatever the original key alias was referencing.

" }, "GetParameters":{ "name":"GetParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParametersRequest"}, "output":{"shape":"GetParametersResult"}, "errors":[ {"shape":"InvalidKeyId"}, {"shape":"InternalServerError"} ], "documentation":"

Get information about one or more parameters by specifying multiple parameter names.

To get information about a single parameter, you can use the GetParameter operation instead.

" }, "GetParametersByPath":{ "name":"GetParametersByPath", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParametersByPathRequest"}, "output":{"shape":"GetParametersByPathResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidFilterOption"}, {"shape":"InvalidFilterValue"}, {"shape":"InvalidKeyId"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieve information about one or more parameters in a specific hierarchy.

Request results are returned on a best-effort basis. If you specify `MaxResults` 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 `MaxResults`. 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 `NextToken`. You can specify the `NextToken` in a subsequent call to get the next set of results.

" }, "GetPatchBaseline":{ "name":"GetPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPatchBaselineRequest"}, "output":{"shape":"GetPatchBaselineResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves information about a patch baseline.

" }, "GetPatchBaselineForPatchGroup":{ "name":"GetPatchBaselineForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPatchBaselineForPatchGroupRequest"}, "output":{"shape":"GetPatchBaselineForPatchGroupResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves the patch baseline that should be used for the specified patch group.

" }, "GetResourcePolicies":{ "name":"GetResourcePolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetResourcePoliciesRequest"}, "output":{"shape":"GetResourcePoliciesResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ResourcePolicyInvalidParameterException"} ], "documentation":"

Returns an array of the `Policy` object.

" }, "GetServiceSetting":{ "name":"GetServiceSetting", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetServiceSettingRequest"}, "output":{"shape":"GetServiceSettingResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ServiceSettingNotFound"} ], "documentation":"

`ServiceSetting` 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.

Services map a `SettingId` object to a setting value. Amazon Web Services services teams define the default value for a `SettingId`. You can't create a new `SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Query the current service setting for the Amazon Web Services account.

" }, "LabelParameterVersion":{ "name":"LabelParameterVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"LabelParameterVersionRequest"}, "output":{"shape":"LabelParameterVersionResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"TooManyUpdates"}, {"shape":"ParameterNotFound"}, {"shape":"ParameterVersionNotFound"}, {"shape":"ParameterVersionLabelLimitExceeded"} ], "documentation":"

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.

Parameter labels have the following requirements and restrictions.

- A version of a parameter can have a maximum of 10 labels.

- 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.

- You can move a label from one version of a parameter to another.

- You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

- 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.

- A label can have a maximum of 100 characters.

- Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

- Labels can't begin with a number, \"`aws`\" or \"`ssm`\" (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.

" }, "ListAssociationVersions":{ "name":"ListAssociationVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssociationVersionsRequest"}, "output":{"shape":"ListAssociationVersionsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"}, {"shape":"AssociationDoesNotExist"} ], "documentation":"

Retrieves all versions of an association for a specific association ID.

" }, "ListAssociations":{ "name":"ListAssociations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssociationsRequest"}, "output":{"shape":"ListAssociationsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], "documentation":"

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 managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

" }, "ListCommandInvocations":{ "name":"ListCommandInvocations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCommandInvocationsRequest"}, "output":{"shape":"ListCommandInvocationsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidNextToken"} ], "documentation":"

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs `SendCommand` against three managed nodes, then a command invocation is created for each requested managed node ID. `ListCommandInvocations` provide status about command execution.

" }, "ListCommands":{ "name":"ListCommands", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCommandsRequest"}, "output":{"shape":"ListCommandsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidNextToken"} ], "documentation":"

Lists the commands requested by users of the Amazon Web Services account.

" }, "ListComplianceItems":{ "name":"ListComplianceItems", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListComplianceItemsRequest"}, "output":{"shape":"ListComplianceItemsResult"}, "errors":[ {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"} ], "documentation":"

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.

" }, "ListComplianceSummaries":{ "name":"ListComplianceSummaries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListComplianceSummariesRequest"}, "output":{"shape":"ListComplianceSummariesResult"}, "errors":[ {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"}, {"shape":"InternalServerError"} ], "documentation":"

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.

" }, "ListDocumentMetadataHistory":{ "name":"ListDocumentMetadataHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDocumentMetadataHistoryRequest"}, "output":{"shape":"ListDocumentMetadataHistoryResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidNextToken"} ], "documentation":"

Information about approval reviews for a version of a change template in Change Manager.

" }, "ListDocumentVersions":{ "name":"ListDocumentVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDocumentVersionsRequest"}, "output":{"shape":"ListDocumentVersionsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidDocument"} ], "documentation":"

List all versions for a document.

" }, "ListDocuments":{ "name":"ListDocuments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDocumentsRequest"}, "output":{"shape":"ListDocumentsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidFilterKey"} ], "documentation":"

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.

" }, "ListInventoryEntries":{ "name":"ListInventoryEntries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInventoryEntriesRequest"}, "output":{"shape":"ListInventoryEntriesResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"} ], "documentation":"

A list of inventory items returned by the request.

" }, "ListOpsItemEvents":{ "name":"ListOpsItemEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOpsItemEventsRequest"}, "output":{"shape":"ListOpsItemEventsResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemNotFoundException"}, {"shape":"OpsItemLimitExceededException"}, {"shape":"OpsItemInvalidParameterException"} ], "documentation":"

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.

" }, "ListOpsItemRelatedItems":{ "name":"ListOpsItemRelatedItems", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOpsItemRelatedItemsRequest"}, "output":{"shape":"ListOpsItemRelatedItemsResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemInvalidParameterException"} ], "documentation":"

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.

" }, "ListOpsMetadata":{ "name":"ListOpsMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOpsMetadataRequest"}, "output":{"shape":"ListOpsMetadataResult"}, "errors":[ {"shape":"OpsMetadataInvalidArgumentException"}, {"shape":"InternalServerError"} ], "documentation":"

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

" }, "ListResourceComplianceSummaries":{ "name":"ListResourceComplianceSummaries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListResourceComplianceSummariesRequest"}, "output":{"shape":"ListResourceComplianceSummariesResult"}, "errors":[ {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"}, {"shape":"InternalServerError"} ], "documentation":"

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.

" }, "ListResourceDataSync":{ "name":"ListResourceDataSync", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListResourceDataSyncRequest"}, "output":{"shape":"ListResourceDataSyncResult"}, "errors":[ {"shape":"ResourceDataSyncInvalidConfigurationException"}, {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], "documentation":"

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.

The number of sync configurations might be too large to return using a single call to `ListResourceDataSync`. You can limit the number of sync configurations returned by using the `MaxResults` parameter. To determine whether there are more sync configurations to list, check the value of `NextToken` in the output. If there are more sync configurations to list, you can request them by specifying the `NextToken` returned in the call to the parameter of a subsequent call.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a list of the tags assigned to the specified resource.

For information about the ID format for each supported resource type, see AddTagsToResource.

" }, "ModifyDocumentPermission":{ "name":"ModifyDocumentPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDocumentPermissionRequest"}, "output":{"shape":"ModifyDocumentPermissionResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidPermissionType"}, {"shape":"DocumentPermissionLimit"}, {"shape":"DocumentLimitExceeded"} ], "documentation":"

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 IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

" }, "PutComplianceItems":{ "name":"PutComplianceItems", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutComplianceItemsRequest"}, "output":{"shape":"PutComplianceItemsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidItemContentException"}, {"shape":"TotalSizeLimitExceededException"}, {"shape":"ItemSizeLimitExceededException"}, {"shape":"ComplianceTypeCountLimitExceededException"}, {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"} ], "documentation":"

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.

ComplianceType can be one of the following:

- ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

- ExecutionType: Specify patch, association, or Custom:`string`.

- ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.

- Id: The patch, association, or custom compliance ID.

- Title: A title.

- Status: The status of the compliance item. For example, `approved` for patches, or `Failed` for associations.

- Severity: A patch severity. For example, `Critical`.

- DocumentName: An SSM document name. For example, `AWS-RunPatchBaseline`.

- DocumentVersion: An SSM document version number. For example, 4.

- Classification: A patch classification. For example, `security updates`.

- PatchBaselineId: A patch baseline ID.

- PatchSeverity: A patch severity. For example, `Critical`.

- PatchState: A patch state. For example, `InstancesWithFailedPatches`.

- PatchGroup: The name of a patch group.

- 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'

" }, "PutInventory":{ "name":"PutInventory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutInventoryRequest"}, "output":{"shape":"PutInventoryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidItemContentException"}, {"shape":"TotalSizeLimitExceededException"}, {"shape":"ItemSizeLimitExceededException"}, {"shape":"ItemContentMismatchException"}, {"shape":"CustomSchemaCountLimitExceededException"}, {"shape":"UnsupportedInventorySchemaVersionException"}, {"shape":"UnsupportedInventoryItemContextException"}, {"shape":"InvalidInventoryItemContextException"}, {"shape":"SubTypeCountLimitExceededException"} ], "documentation":"

Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

" }, "PutParameter":{ "name":"PutParameter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutParameterRequest"}, "output":{"shape":"PutParameterResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidKeyId"}, {"shape":"ParameterLimitExceeded"}, {"shape":"TooManyUpdates"}, {"shape":"ParameterAlreadyExists"}, {"shape":"HierarchyLevelLimitExceededException"}, {"shape":"HierarchyTypeMismatchException"}, {"shape":"InvalidAllowedPatternException"}, {"shape":"ParameterMaxVersionLimitExceeded"}, {"shape":"ParameterPatternMismatchException"}, {"shape":"UnsupportedParameterType"}, {"shape":"PoliciesLimitExceededException"}, {"shape":"InvalidPolicyTypeException"}, {"shape":"InvalidPolicyAttributeException"}, {"shape":"IncompatiblePolicyException"} ], "documentation":"

Add a parameter to the system.

" }, "PutResourcePolicy":{ "name":"PutResourcePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutResourcePolicyRequest"}, "output":{"shape":"PutResourcePolicyResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ResourcePolicyInvalidParameterException"}, {"shape":"ResourcePolicyLimitExceededException"}, {"shape":"ResourcePolicyConflictException"} ], "documentation":"

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, `OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

" }, "RegisterDefaultPatchBaseline":{ "name":"RegisterDefaultPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterDefaultPatchBaselineRequest"}, "output":{"shape":"RegisterDefaultPatchBaselineResult"}, "errors":[ {"shape":"InvalidResourceId"}, {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Defines the default patch baseline for the relevant operating system.

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 `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed` instead of `pb-0574b43a65ea646ed`.

" }, "RegisterPatchBaselineForPatchGroup":{ "name":"RegisterPatchBaselineForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterPatchBaselineForPatchGroupRequest"}, "output":{"shape":"RegisterPatchBaselineForPatchGroupResult"}, "errors":[ {"shape":"AlreadyExistsException"}, {"shape":"DoesNotExistException"}, {"shape":"InvalidResourceId"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Registers a patch baseline for a patch group.

" }, "RegisterTargetWithMaintenanceWindow":{ "name":"RegisterTargetWithMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterTargetWithMaintenanceWindowRequest"}, "output":{"shape":"RegisterTargetWithMaintenanceWindowResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"DoesNotExistException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Registers a target with a maintenance window.

" }, "RegisterTaskWithMaintenanceWindow":{ "name":"RegisterTaskWithMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterTaskWithMaintenanceWindowRequest"}, "output":{"shape":"RegisterTaskWithMaintenanceWindowResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"DoesNotExistException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"FeatureNotAvailableException"}, {"shape":"InternalServerError"} ], "documentation":"

Adds a new task to a maintenance window.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceRequest"}, "output":{"shape":"RemoveTagsFromResourceResult"}, "errors":[ {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"}, {"shape":"TooManyUpdates"} ], "documentation":"

Removes tag keys from the specified resource.

" }, "ResetServiceSetting":{ "name":"ResetServiceSetting", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetServiceSettingRequest"}, "output":{"shape":"ResetServiceSettingResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ServiceSettingNotFound"}, {"shape":"TooManyUpdates"} ], "documentation":"

`ServiceSetting` 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.

Services map a `SettingId` object to a setting value. Amazon Web Services services teams define the default value for a `SettingId`. You can't create a new `SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

" }, "ResumeSession":{ "name":"ResumeSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResumeSessionRequest"}, "output":{"shape":"ResumeSessionResponse"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

" }, "SendAutomationSignal":{ "name":"SendAutomationSignal", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendAutomationSignalRequest"}, "output":{"shape":"SendAutomationSignalResult"}, "errors":[ {"shape":"AutomationExecutionNotFoundException"}, {"shape":"AutomationStepNotFoundException"}, {"shape":"InvalidAutomationSignalException"}, {"shape":"InternalServerError"} ], "documentation":"

Sends a signal to an Automation execution to change the current behavior or status of the execution.

" }, "SendCommand":{ "name":"SendCommand", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendCommandRequest"}, "output":{"shape":"SendCommandResult"}, "errors":[ {"shape":"DuplicateInstanceId"}, {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidOutputFolder"}, {"shape":"InvalidParameters"}, {"shape":"UnsupportedPlatformType"}, {"shape":"MaxDocumentSizeExceeded"}, {"shape":"InvalidRole"}, {"shape":"InvalidNotificationConfig"} ], "documentation":"

Runs commands on one or more managed nodes.

" }, "StartAssociationsOnce":{ "name":"StartAssociationsOnce", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartAssociationsOnceRequest"}, "output":{"shape":"StartAssociationsOnceResult"}, "errors":[ {"shape":"InvalidAssociation"}, {"shape":"AssociationDoesNotExist"} ], "documentation":"

Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.

" }, "StartAutomationExecution":{ "name":"StartAutomationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartAutomationExecutionRequest"}, "output":{"shape":"StartAutomationExecutionResult"}, "errors":[ {"shape":"AutomationDefinitionNotFoundException"}, {"shape":"InvalidAutomationExecutionParametersException"}, {"shape":"AutomationExecutionLimitExceededException"}, {"shape":"AutomationDefinitionVersionNotFoundException"}, {"shape":"IdempotentParameterMismatch"}, {"shape":"InvalidTarget"}, {"shape":"InternalServerError"} ], "documentation":"

Initiates execution of an Automation runbook.

" }, "StartChangeRequestExecution":{ "name":"StartChangeRequestExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartChangeRequestExecutionRequest"}, "output":{"shape":"StartChangeRequestExecutionResult"}, "errors":[ {"shape":"AutomationDefinitionNotFoundException"}, {"shape":"InvalidAutomationExecutionParametersException"}, {"shape":"AutomationExecutionLimitExceededException"}, {"shape":"AutomationDefinitionVersionNotFoundException"}, {"shape":"IdempotentParameterMismatch"}, {"shape":"InternalServerError"}, {"shape":"AutomationDefinitionNotApprovedException"} ], "documentation":"

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.

" }, "StartSession":{ "name":"StartSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartSessionRequest"}, "output":{"shape":"StartSessionResponse"}, "errors":[ {"shape":"InvalidDocument"}, {"shape":"TargetNotConnected"}, {"shape":"InternalServerError"} ], "documentation":"

Initiates a connection to a target (for example, a managed node) 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.

Amazon Web Services CLI usage: `start-session` is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

" }, "StopAutomationExecution":{ "name":"StopAutomationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopAutomationExecutionRequest"}, "output":{"shape":"StopAutomationExecutionResult"}, "errors":[ {"shape":"AutomationExecutionNotFoundException"}, {"shape":"InvalidAutomationStatusUpdateException"}, {"shape":"InternalServerError"} ], "documentation":"

Stop an Automation that is currently running.

" }, "TerminateSession":{ "name":"TerminateSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateSessionRequest"}, "output":{"shape":"TerminateSessionResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.

" }, "UnlabelParameterVersion":{ "name":"UnlabelParameterVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnlabelParameterVersionRequest"}, "output":{"shape":"UnlabelParameterVersionResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"TooManyUpdates"}, {"shape":"ParameterNotFound"}, {"shape":"ParameterVersionNotFound"} ], "documentation":"

Remove a label or labels from a parameter.

" }, "UpdateAssociation":{ "name":"UpdateAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAssociationRequest"}, "output":{"shape":"UpdateAssociationResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidSchedule"}, {"shape":"InvalidParameters"}, {"shape":"InvalidOutputLocation"}, {"shape":"InvalidDocumentVersion"}, {"shape":"AssociationDoesNotExist"}, {"shape":"InvalidUpdate"}, {"shape":"TooManyUpdates"}, {"shape":"InvalidDocument"}, {"shape":"InvalidTarget"}, {"shape":"InvalidAssociationVersion"}, {"shape":"AssociationVersionLimitExceeded"}, {"shape":"InvalidTargetMaps"} ], "documentation":"

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call `UpdateAssociation`, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the `Name` parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your `UpdateAssociation` call.

In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. If you don't have permission to call `DescribeAssociation`, then you receive the following error: `An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>`

When you update an association, the association immediately runs against the specified targets. You can add the `ApplyOnlyAtCronInterval` parameter to run the association during the next schedule run.

" }, "UpdateAssociationStatus":{ "name":"UpdateAssociationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAssociationStatusRequest"}, "output":{"shape":"UpdateAssociationStatusResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidDocument"}, {"shape":"AssociationDoesNotExist"}, {"shape":"StatusUnchanged"}, {"shape":"TooManyUpdates"} ], "documentation":"

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.

`UpdateAssociationStatus` 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 `InstanceId` legacy parameter.

" }, "UpdateDocument":{ "name":"UpdateDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDocumentRequest"}, "output":{"shape":"UpdateDocumentResult"}, "errors":[ {"shape":"MaxDocumentSizeExceeded"}, {"shape":"DocumentVersionLimitExceeded"}, {"shape":"InternalServerError"}, {"shape":"DuplicateDocumentContent"}, {"shape":"DuplicateDocumentVersionName"}, {"shape":"InvalidDocumentContent"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidDocumentSchemaVersion"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentOperation"} ], "documentation":"

Updates one or more values for an SSM document.

" }, "UpdateDocumentDefaultVersion":{ "name":"UpdateDocumentDefaultVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDocumentDefaultVersionRequest"}, "output":{"shape":"UpdateDocumentDefaultVersionResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidDocumentSchemaVersion"} ], "documentation":"

Set the default version of a document.

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

" }, "UpdateDocumentMetadata":{ "name":"UpdateDocumentMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDocumentMetadataRequest"}, "output":{"shape":"UpdateDocumentMetadataResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentOperation"}, {"shape":"InvalidDocumentVersion"} ], "documentation":"

Updates information related to approval reviews for a specific version of a change template in Change Manager.

" }, "UpdateMaintenanceWindow":{ "name":"UpdateMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMaintenanceWindowRequest"}, "output":{"shape":"UpdateMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates an existing maintenance window. Only specified parameters are modified.

The value you specify for `Duration` 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 `Cutoff`. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for `Cutoff` is one hour, no maintenance window tasks can start after 5 PM.

" }, "UpdateMaintenanceWindowTarget":{ "name":"UpdateMaintenanceWindowTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMaintenanceWindowTargetRequest"}, "output":{"shape":"UpdateMaintenanceWindowTargetResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Modifies the target of an existing maintenance window. You can change the following:

- Name

- Description

- Owner

- IDs for an ID target

- Tags for a Tag target

- From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

If a parameter is null, then the corresponding field isn't modified.

" }, "UpdateMaintenanceWindowTask":{ "name":"UpdateMaintenanceWindowTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMaintenanceWindowTaskRequest"}, "output":{"shape":"UpdateMaintenanceWindowTaskResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:

- `TaskARN`. For example, you can change a `RUN_COMMAND` task from `AWS-RunPowerShellScript` to `AWS-RunShellScript`.

- `ServiceRoleArn`

- `TaskInvocationParameters`

- `Priority`

- `MaxConcurrency`

- `MaxErrors`

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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

If the value for a parameter in `UpdateMaintenanceWindowTask` is null, then the corresponding field isn't modified. If you set `Replace` to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null.

When you update a maintenance window task that has options specified in `TaskInvocationParameters`, you must provide again all the `TaskInvocationParameters` 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 `TaskInvocationParameters` values for `Comment`, `NotificationConfig`, and `OutputS3BucketName`. If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.

" }, "UpdateManagedInstanceRole":{ "name":"UpdateManagedInstanceRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateManagedInstanceRoleRequest"}, "output":{"shape":"UpdateManagedInstanceRoleResult"}, "errors":[ {"shape":"InvalidInstanceId"}, {"shape":"InternalServerError"} ], "documentation":"

Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.

" }, "UpdateOpsItem":{ "name":"UpdateOpsItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateOpsItemRequest"}, "output":{"shape":"UpdateOpsItemResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"OpsItemNotFoundException"}, {"shape":"OpsItemAlreadyExistsException"}, {"shape":"OpsItemLimitExceededException"}, {"shape":"OpsItemInvalidParameterException"}, {"shape":"OpsItemAccessDeniedException"}, {"shape":"OpsItemConflictException"} ], "documentation":"

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

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 OpsCenter in the Amazon Web Services Systems Manager User Guide.

" }, "UpdateOpsMetadata":{ "name":"UpdateOpsMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateOpsMetadataRequest"}, "output":{"shape":"UpdateOpsMetadataResult"}, "errors":[ {"shape":"OpsMetadataNotFoundException"}, {"shape":"OpsMetadataInvalidArgumentException"}, {"shape":"OpsMetadataKeyLimitExceededException"}, {"shape":"OpsMetadataTooManyUpdatesException"}, {"shape":"InternalServerError"} ], "documentation":"

Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

" }, "UpdatePatchBaseline":{ "name":"UpdatePatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePatchBaselineRequest"}, "output":{"shape":"UpdatePatchBaselineResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

For information about valid key-value pairs in `PatchFilters` for each supported operating system type, see PatchFilter.

" }, "UpdateResourceDataSync":{ "name":"UpdateResourceDataSync", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateResourceDataSyncRequest"}, "output":{"shape":"UpdateResourceDataSyncResult"}, "errors":[ {"shape":"ResourceDataSyncNotFoundException"}, {"shape":"ResourceDataSyncInvalidConfigurationException"}, {"shape":"ResourceDataSyncConflictException"}, {"shape":"InternalServerError"} ], "documentation":"

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 `Include only the current account` option, you can't edit that sync later and choose the `Include all accounts from my Organizations configuration` option. Instead, you must delete the first resource data sync, and create a new one.

This API operation only supports a resource data sync that was created with a SyncFromSource `SyncType`.

" }, "UpdateServiceSetting":{ "name":"UpdateServiceSetting", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServiceSettingRequest"}, "output":{"shape":"UpdateServiceSettingResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ServiceSettingNotFound"}, {"shape":"TooManyUpdates"} ], "documentation":"

`ServiceSetting` 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.

Services map a `SettingId` object to a setting value. Amazon Web Services services teams define the default value for a `SettingId`. You can't create a new `SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Update the service setting for the account.

" } }, "shapes":{ "Account":{"type":"string"}, "AccountId":{ "type":"string", "pattern":"(?i)all|[0-9]{12}" }, "AccountIdList":{ "type":"list", "member":{"shape":"AccountId"}, "max":20 }, "AccountSharingInfo":{ "type":"structure", "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID where the current document is shared.

" }, "SharedDocumentVersion":{ "shape":"SharedDocumentVersion", "documentation":"

The version of the current document shared with the account.

" } }, "documentation":"

Information includes the Amazon Web Services account ID where the current document is shared and the version shared with that account.

" }, "AccountSharingInfoList":{ "type":"list", "member":{"shape":"AccountSharingInfo"}, "documentation":"

A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

" }, "Accounts":{ "type":"list", "member":{"shape":"Account"}, "max":50, "min":1 }, "Activation":{ "type":"structure", "members":{ "ActivationId":{ "shape":"ActivationId", "documentation":"

The ID created by Systems Manager when you submitted the activation.

" }, "Description":{ "shape":"ActivationDescription", "documentation":"

A user defined description of the activation.

" }, "DefaultInstanceName":{ "shape":"DefaultInstanceName", "documentation":"

A name for the managed node when it is created.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The Identity and Access Management (IAM) role to assign to the managed node.

" }, "RegistrationLimit":{ "shape":"RegistrationLimit", "documentation":"

The maximum number of managed nodes that can be registered using this activation.

" }, "RegistrationsCount":{ "shape":"RegistrationsCount", "documentation":"

The number of managed nodes already registered with this activation.

" }, "ExpirationDate":{ "shape":"ExpirationDate", "documentation":"

The date when this activation can no longer be used to register managed nodes.

" }, "Expired":{ "shape":"Boolean", "documentation":"

Whether or not the activation is expired.

" }, "CreatedDate":{ "shape":"CreatedDate", "documentation":"

The date the activation was created.

" }, "Tags":{ "shape":"TagList", "documentation":"

Tags assigned to the activation.

" } }, "documentation":"

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 node.

" }, "ActivationCode":{ "type":"string", "max":250, "min":20 }, "ActivationDescription":{ "type":"string", "max":256, "min":0 }, "ActivationId":{ "type":"string", "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "ActivationList":{ "type":"list", "member":{"shape":"Activation"} }, "AddTagsToResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId", "Tags" ], "members":{ "ResourceType":{ "shape":"ResourceTypeForTagging", "documentation":"

Specifies the type of resource you are tagging.

The `ManagedInstance` type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: `mi-ID_number` . For example, `mi-1a2b3c4d5e6f`.

" }, "ResourceId":{ "shape":"ResourceId", "documentation":"

The resource ID you want to tag.

Use the ID of the resource. Here are some examples:

`MaintenanceWindow`: `mw-012345abcde`

`PatchBaseline`: `pb-012345abcde`

`Automation`: `example-c160-4567-8519-012345abcde`

`OpsMetadata` object: `ResourceID` for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, `ResourceID` is created from the strings that come after the word `opsmetadata` in the ARN. For example, an OpsMetadata object with an ARN of `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or `/aws/ssm/MyGroup/appmanager`.

For the `Document` and `Parameter` values, use the name of the resource. If you're tagging a shared document, you must use the full ARN of the document.

`ManagedInstance`: `mi-012345abcde`

The `ManagedInstance` type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: `mi-ID_number` . For example, `mi-1a2b3c4d5e6f`.

" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required.

Don't enter personally identifiable information in this field.

" } } }, "AddTagsToResourceResult":{ "type":"structure", "members":{ } }, "AgentErrorCode":{ "type":"string", "max":10 }, "AggregatorSchemaOnly":{"type":"boolean"}, "Alarm":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"AlarmName", "documentation":"

The name of your CloudWatch alarm.

" } }, "documentation":"

A CloudWatch alarm you apply to an automation or command.

" }, "AlarmConfiguration":{ "type":"structure", "required":["Alarms"], "members":{ "IgnorePollAlarmFailure":{ "shape":"Boolean", "documentation":"

When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

" }, "Alarms":{ "shape":"AlarmList", "documentation":"

The name of the CloudWatch alarm specified in the configuration.

" } }, "documentation":"

The details for the CloudWatch alarm you want to apply to an automation or command.

" }, "AlarmList":{ "type":"list", "member":{"shape":"Alarm"}, "max":1, "min":1 }, "AlarmName":{ "type":"string", "max":255, "min":1, "pattern":"^(?!\\s*$).+" }, "AlarmStateInformation":{ "type":"structure", "required":[ "Name", "State" ], "members":{ "Name":{ "shape":"AlarmName", "documentation":"

The name of your CloudWatch alarm.

" }, "State":{ "shape":"ExternalAlarmState", "documentation":"

The state of your CloudWatch alarm.

" } }, "documentation":"

The details about the state of your CloudWatch alarm.

" }, "AlarmStateInformationList":{ "type":"list", "member":{"shape":"AlarmStateInformation"}, "max":1, "min":1 }, "AllowedPattern":{ "type":"string", "max":1024, "min":0 }, "AlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "ApplyOnlyAtCronInterval":{"type":"boolean"}, "ApproveAfterDays":{ "type":"integer", "max":360, "min":0 }, "AssociateOpsItemRelatedItemRequest":{ "type":"structure", "required":[ "OpsItemId", "AssociationType", "ResourceType", "ResourceUri" ], "members":{ "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem to which you want to associate a resource as a related item.

" }, "AssociationType":{ "shape":"OpsItemRelatedItemAssociationType", "documentation":"

The type of association that you want to create between an OpsItem and a resource. OpsCenter supports `IsParentOf` and `RelatesTo` association types.

" }, "ResourceType":{ "shape":"OpsItemRelatedItemAssociationResourceType", "documentation":"

The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:

`AWS::SSMIncidents::IncidentRecord`: an Incident Manager incident.

`AWS::SSM::Document`: a Systems Manager (SSM) document.

" }, "ResourceUri":{ "shape":"OpsItemRelatedItemAssociationResourceUri", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.

" } } }, "AssociateOpsItemRelatedItemResponse":{ "type":"structure", "members":{ "AssociationId":{ "shape":"OpsItemRelatedItemAssociationId", "documentation":"

The association ID.

" } } }, "AssociatedInstances":{ "type":"structure", "members":{ }, "documentation":"

You must disassociate a document from all managed nodes before you can delete it.

", "exception":true }, "Association":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

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.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

The association version.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

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

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the `default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default`.

" }, "Targets":{ "shape":"Targets", "documentation":"

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the `InstanceIds` key with a value of `*`.

" }, "LastExecutionDate":{ "shape":"DateTime", "documentation":"

The date on which the association was last run.

" }, "Overview":{ "shape":"AssociationOverview", "documentation":"

Information about the association.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

" }, "AssociationName":{ "shape":"AssociationName", "documentation":"

The association name.

" }, "ScheduleOffset":{ "shape":"ScheduleOffset", "documentation":"

Number of days to wait after the scheduled day to run an association.

", "box":true }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

", "box":true } }, "documentation":"

Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

" }, "AssociationAlreadyExists":{ "type":"structure", "members":{ }, "documentation":"

The specified association already exists.

", "exception":true }, "AssociationComplianceSeverity":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "MEDIUM", "LOW", "UNSPECIFIED" ] }, "AssociationDescription":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

The association version.

" }, "Date":{ "shape":"DateTime", "documentation":"

The date when the association was made.

" }, "LastUpdateAssociationDate":{ "shape":"DateTime", "documentation":"

The date when the association was last updated.

" }, "Status":{ "shape":"AssociationStatus", "documentation":"

The association status.

" }, "Overview":{ "shape":"AssociationOverview", "documentation":"

Information about the association.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", "documentation":"

Choose the parameter that will define how your automation will branch out. 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.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A description of the parameters for a document.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "Targets":{ "shape":"Targets", "documentation":"

The managed nodes targeted by the request.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression that specifies a schedule when the association runs.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An S3 bucket where you want to store the output details of the request.

" }, "LastExecutionDate":{ "shape":"DateTime", "documentation":"

The date on which the association was last run.

" }, "LastSuccessfulExecutionDate":{ "shape":"DateTime", "documentation":"

The last date on which the association was successfully run.

" }, "AssociationName":{ "shape":"AssociationName", "documentation":"

The association name.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

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 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when `MaxErrors` 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 `MaxConcurrency` to 1 so that executions proceed one at a time.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

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.

If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.

" }, "ComplianceSeverity":{ "shape":"AssociationComplianceSeverity", "documentation":"

The severity level that is assigned to the association.

" }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", "documentation":"

The mode for generating association compliance. You can specify `AUTO` or `MANUAL`. In `AUTO` 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 `COMPLIANT`. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`.

In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use `AUTO` mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", "documentation":"

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.

" }, "CalendarNames":{ "shape":"CalendarNameOrARNList", "documentation":"

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 Amazon Web Services Systems Manager Change Calendar.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

" }, "ScheduleOffset":{ "shape":"ScheduleOffset", "documentation":"

Number of days to wait after the scheduled day to run an association.

", "box":true }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

", "box":true }, "AlarmConfiguration":{"shape":"AlarmConfiguration"}, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarm that was invoked during the association.

" } }, "documentation":"

Describes the parameters for a document.

" }, "AssociationDescriptionList":{ "type":"list", "member":{"shape":"AssociationDescription"} }, "AssociationDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified association doesn't exist.

", "exception":true }, "AssociationExecution":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

The association version.

" }, "ExecutionId":{ "shape":"AssociationExecutionId", "documentation":"

The execution ID for the association.

" }, "Status":{ "shape":"StatusName", "documentation":"

The status of the association execution.

" }, "DetailedStatus":{ "shape":"StatusName", "documentation":"

Detailed status information about the execution.

" }, "CreatedTime":{ "shape":"DateTime", "documentation":"

The time the execution started.

" }, "LastExecutionDate":{ "shape":"DateTime", "documentation":"

The date of the last execution.

" }, "ResourceCountByStatus":{ "shape":"ResourceCountByStatus", "documentation":"

An aggregate status of the resources in the execution based on the status type.

" }, "AlarmConfiguration":{"shape":"AlarmConfiguration"}, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarms that were invoked by the association.

" } }, "documentation":"

Includes information about the specified association.

" }, "AssociationExecutionDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified execution ID doesn't exist. Verify the ID number and try again.

", "exception":true }, "AssociationExecutionFilter":{ "type":"structure", "required":[ "Key", "Value", "Type" ], "members":{ "Key":{ "shape":"AssociationExecutionFilterKey", "documentation":"

The key value used in the request.

" }, "Value":{ "shape":"AssociationExecutionFilterValue", "documentation":"

The value specified for the key.

" }, "Type":{ "shape":"AssociationFilterOperatorType", "documentation":"

The filter type specified in the request.

" } }, "documentation":"

Filters used in the request.

" }, "AssociationExecutionFilterKey":{ "type":"string", "enum":[ "ExecutionId", "Status", "CreatedTime" ] }, "AssociationExecutionFilterList":{ "type":"list", "member":{"shape":"AssociationExecutionFilter"}, "min":1 }, "AssociationExecutionFilterValue":{ "type":"string", "min":1 }, "AssociationExecutionId":{ "type":"string", "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" }, "AssociationExecutionTarget":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

The association version.

" }, "ExecutionId":{ "shape":"AssociationExecutionId", "documentation":"

The execution ID.

" }, "ResourceId":{ "shape":"AssociationResourceId", "documentation":"

The resource ID, for example, the managed node ID where the association ran.

" }, "ResourceType":{ "shape":"AssociationResourceType", "documentation":"

The resource type, for example, EC2.

" }, "Status":{ "shape":"StatusName", "documentation":"

The association execution status.

" }, "DetailedStatus":{ "shape":"StatusName", "documentation":"

Detailed information about the execution status.

" }, "LastExecutionDate":{ "shape":"DateTime", "documentation":"

The date of the last execution.

" }, "OutputSource":{ "shape":"OutputSource", "documentation":"

The location where the association details are saved.

" } }, "documentation":"

Includes information about the specified association execution.

" }, "AssociationExecutionTargetsFilter":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"AssociationExecutionTargetsFilterKey", "documentation":"

The key value used in the request.

" }, "Value":{ "shape":"AssociationExecutionTargetsFilterValue", "documentation":"

The value specified for the key.

" } }, "documentation":"

Filters for the association execution.

" }, "AssociationExecutionTargetsFilterKey":{ "type":"string", "enum":[ "Status", "ResourceId", "ResourceType" ] }, "AssociationExecutionTargetsFilterList":{ "type":"list", "member":{"shape":"AssociationExecutionTargetsFilter"}, "min":1 }, "AssociationExecutionTargetsFilterValue":{ "type":"string", "min":1 }, "AssociationExecutionTargetsList":{ "type":"list", "member":{"shape":"AssociationExecutionTarget"} }, "AssociationExecutionsList":{ "type":"list", "member":{"shape":"AssociationExecution"} }, "AssociationFilter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"AssociationFilterKey", "documentation":"

The name of the filter.

`InstanceId` has been deprecated.

" }, "value":{ "shape":"AssociationFilterValue", "documentation":"

The filter value.

" } }, "documentation":"

Describes a filter.

" }, "AssociationFilterKey":{ "type":"string", "enum":[ "InstanceId", "Name", "AssociationId", "AssociationStatusName", "LastExecutedBefore", "LastExecutedAfter", "AssociationName", "ResourceGroupName" ] }, "AssociationFilterList":{ "type":"list", "member":{"shape":"AssociationFilter"}, "min":1 }, "AssociationFilterOperatorType":{ "type":"string", "enum":[ "EQUAL", "LESS_THAN", "GREATER_THAN" ] }, "AssociationFilterValue":{ "type":"string", "min":1 }, "AssociationId":{ "type":"string", "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" }, "AssociationIdList":{ "type":"list", "member":{"shape":"AssociationId"}, "max":10, "min":1 }, "AssociationLimitExceeded":{ "type":"structure", "members":{ }, "documentation":"

You can have at most 2,000 active associations.

", "exception":true }, "AssociationList":{ "type":"list", "member":{"shape":"Association"} }, "AssociationName":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "AssociationOverview":{ "type":"structure", "members":{ "Status":{ "shape":"StatusName", "documentation":"

The status of the association. Status can be: Pending, Success, or Failed.

" }, "DetailedStatus":{ "shape":"StatusName", "documentation":"

A detailed status of the association.

" }, "AssociationStatusAggregatedCount":{ "shape":"AssociationStatusAggregatedCount", "documentation":"

Returns the number of targets for the association status. For example, if you created an association with two managed nodes, and one of them was successful, this would return the count of managed nodes by status.

" } }, "documentation":"

Information about the association.

" }, "AssociationResourceId":{ "type":"string", "max":100, "min":1 }, "AssociationResourceType":{ "type":"string", "max":50, "min":1 }, "AssociationStatus":{ "type":"structure", "required":[ "Date", "Name", "Message" ], "members":{ "Date":{ "shape":"DateTime", "documentation":"

The date when the status changed.

" }, "Name":{ "shape":"AssociationStatusName", "documentation":"

The status.

" }, "Message":{ "shape":"StatusMessage", "documentation":"

The reason for the status.

" }, "AdditionalInfo":{ "shape":"StatusAdditionalInfo", "documentation":"

A user-defined string.

" } }, "documentation":"

Describes an association status.

" }, "AssociationStatusAggregatedCount":{ "type":"map", "key":{"shape":"StatusName"}, "value":{"shape":"InstanceCount"} }, "AssociationStatusName":{ "type":"string", "enum":[ "Pending", "Success", "Failed" ] }, "AssociationSyncCompliance":{ "type":"string", "enum":[ "AUTO", "MANUAL" ] }, "AssociationVersion":{ "type":"string", "pattern":"([$]LATEST)|([1-9][0-9]*)" }, "AssociationVersionInfo":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The ID created by the system when the association was created.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

The association version.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the association version was created.

" }, "Name":{ "shape":"DocumentARN", "documentation":"

The name specified when the association was created.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

Parameters specified when the association version was created.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets specified for the association when the association version was created.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The cron or rate schedule specified for the association when the association version was created.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

The location in Amazon S3 specified for the association when the association version was created.

" }, "AssociationName":{ "shape":"AssociationName", "documentation":"

The name specified for the association version when the association version was created.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

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 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when `MaxErrors` 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 `MaxConcurrency` to 1 so that executions proceed one at a time.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

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.

If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.

" }, "ComplianceSeverity":{ "shape":"AssociationComplianceSeverity", "documentation":"

The severity level that is assigned to the association.

" }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", "documentation":"

The mode for generating association compliance. You can specify `AUTO` or `MANUAL`. In `AUTO` 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 `COMPLIANT`. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`.

In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use `AUTO` mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", "documentation":"

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.

" }, "CalendarNames":{ "shape":"CalendarNameOrARNList", "documentation":"

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 Amazon Web Services Systems Manager Change Calendar.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

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.

" }, "ScheduleOffset":{ "shape":"ScheduleOffset", "documentation":"

Number of days to wait after the scheduled day to run an association.

", "box":true }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

", "box":true } }, "documentation":"

Information about the association version.

" }, "AssociationVersionLimitExceeded":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

", "exception":true }, "AssociationVersionList":{ "type":"list", "member":{"shape":"AssociationVersionInfo"}, "min":1 }, "AttachmentContent":{ "type":"structure", "members":{ "Name":{ "shape":"AttachmentName", "documentation":"

The name of an attachment.

" }, "Size":{ "shape":"ContentLength", "documentation":"

The size of an attachment in bytes.

" }, "Hash":{ "shape":"AttachmentHash", "documentation":"

The cryptographic hash value of the document content.

" }, "HashType":{ "shape":"AttachmentHashType", "documentation":"

The hash algorithm used to calculate the hash value.

" }, "Url":{ "shape":"AttachmentUrl", "documentation":"

The URL location of the attachment content.

" } }, "documentation":"

A structure that includes attributes that describe a document attachment.

" }, "AttachmentContentList":{ "type":"list", "member":{"shape":"AttachmentContent"} }, "AttachmentHash":{ "type":"string", "max":256 }, "AttachmentHashType":{ "type":"string", "enum":["Sha256"] }, "AttachmentIdentifier":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "AttachmentInformation":{ "type":"structure", "members":{ "Name":{ "shape":"AttachmentName", "documentation":"

The name of the attachment.

" } }, "documentation":"

An attribute of an attachment, such as the attachment name.

" }, "AttachmentInformationList":{ "type":"list", "member":{"shape":"AttachmentInformation"} }, "AttachmentName":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "AttachmentUrl":{"type":"string"}, "AttachmentsSource":{ "type":"structure", "members":{ "Key":{ "shape":"AttachmentsSourceKey", "documentation":"

The key of a key-value pair that identifies the location of an attachment to a document.

" }, "Values":{ "shape":"AttachmentsSourceValues", "documentation":"

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

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

  `\"Values\": [ \"s3://doc-example-bucket/my-folder\" ]`

- For the key S3FileUrl, the value is a file in an S3 bucket. For example:

  `\"Values\": [ \"s3://doc-example-bucket/my-folder/my-file.py\" ]`

- For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:

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

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

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

" }, "Name":{ "shape":"AttachmentIdentifier", "documentation":"

The name of the document attachment file.

" } }, "documentation":"

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.

" }, "AttachmentsSourceKey":{ "type":"string", "enum":[ "SourceUrl", "S3FileUrl", "AttachmentReference" ] }, "AttachmentsSourceList":{ "type":"list", "member":{"shape":"AttachmentsSource"}, "max":20, "min":0 }, "AttachmentsSourceValue":{ "type":"string", "max":1024, "min":1 }, "AttachmentsSourceValues":{ "type":"list", "member":{"shape":"AttachmentsSourceValue"}, "max":1, "min":1 }, "AttributeName":{ "type":"string", "max":64, "min":1 }, "AttributeValue":{ "type":"string", "max":4096, "min":0 }, "AutomationActionName":{ "type":"string", "pattern":"^aws:[a-zA-Z]{3,25}$" }, "AutomationDefinitionNotApprovedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.

", "exception":true }, "AutomationDefinitionNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An Automation runbook with the specified name couldn't be found.

", "exception":true }, "AutomationDefinitionVersionNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An Automation runbook with the specified name and version couldn't be found.

", "exception":true }, "AutomationExecution":{ "type":"structure", "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The execution ID.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the Automation runbook used during the execution.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the document to use during execution.

" }, "ExecutionStartTime":{ "shape":"DateTime", "documentation":"

The time the execution started.

" }, "ExecutionEndTime":{ "shape":"DateTime", "documentation":"

The time the execution finished.

" }, "AutomationExecutionStatus":{ "shape":"AutomationExecutionStatus", "documentation":"

The execution status of the Automation.

" }, "StepExecutions":{ "shape":"StepExecutionList", "documentation":"

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.

" }, "StepExecutionsTruncated":{ "shape":"Boolean", "documentation":"

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.

" }, "Parameters":{ "shape":"AutomationParameterMap", "documentation":"

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

" }, "Outputs":{ "shape":"AutomationParameterMap", "documentation":"

The list of execution outputs as defined in the Automation runbook.

" }, "FailureMessage":{ "shape":"String", "documentation":"

A message describing why an execution has failed, if the status is set to Failed.

" }, "Mode":{ "shape":"ExecutionMode", "documentation":"

The automation execution mode.

" }, "ParentAutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The AutomationExecutionId of the parent automation.

" }, "ExecutedBy":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the user who ran the automation.

" }, "CurrentStepName":{ "shape":"String", "documentation":"

The name of the step that is currently running.

" }, "CurrentAction":{ "shape":"String", "documentation":"

The action of the step that is currently running.

" }, "TargetParameterName":{ "shape":"AutomationParameterKey", "documentation":"

The parameter name.

" }, "Targets":{ "shape":"Targets", "documentation":"

The specified targets.

" }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

The specified key-value mapping of document parameters to target resources.

" }, "ResolvedTargets":{ "shape":"ResolvedTargets", "documentation":"

A list of resolved targets in the rate control execution.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The `MaxConcurrency` value specified by the user when the execution started.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The MaxErrors value specified by the user when the execution started.

" }, "Target":{ "shape":"String", "documentation":"

The target of the execution.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.

", "box":true }, "ProgressCounters":{ "shape":"ProgressCounters", "documentation":"

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm applied to your automation.

" }, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarm that was invoked by the automation.

" }, "AutomationSubtype":{ "shape":"AutomationSubtype", "documentation":"

The subtype of the Automation operation. Currently, the only supported value is `ChangeRequest`.

" }, "ScheduledTime":{ "shape":"DateTime", "documentation":"

The date and time the Automation operation is scheduled to start.

" }, "Runbooks":{ "shape":"Runbooks", "documentation":"

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

" }, "OpsItemId":{ "shape":"String", "documentation":"

The ID of an OpsItem that is created to represent a Change Manager change request.

" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of a State Manager association used in the Automation operation.

" }, "ChangeRequestName":{ "shape":"ChangeRequestName", "documentation":"

The name of the Change Manager change request.

" }, "Variables":{ "shape":"AutomationParameterMap", "documentation":"

Variables defined for the automation.

" } }, "documentation":"

Detailed information about the current state of an individual Automation execution.

" }, "AutomationExecutionFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"AutomationExecutionFilterKey", "documentation":"

One or more keys to limit the results.

" }, "Values":{ "shape":"AutomationExecutionFilterValueList", "documentation":"

The values used to limit the execution information associated with the filter's key.

" } }, "documentation":"

A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.

" }, "AutomationExecutionFilterKey":{ "type":"string", "enum":[ "DocumentNamePrefix", "ExecutionStatus", "ExecutionId", "ParentExecutionId", "CurrentAction", "StartTimeBefore", "StartTimeAfter", "AutomationType", "TagKey", "TargetResourceGroup", "AutomationSubtype", "OpsItemId" ] }, "AutomationExecutionFilterList":{ "type":"list", "member":{"shape":"AutomationExecutionFilter"}, "max":10, "min":1 }, "AutomationExecutionFilterValue":{ "type":"string", "max":150, "min":1 }, "AutomationExecutionFilterValueList":{ "type":"list", "member":{"shape":"AutomationExecutionFilterValue"}, "max":10, "min":1 }, "AutomationExecutionId":{ "type":"string", "max":36, "min":36 }, "AutomationExecutionLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The number of simultaneously running Automation executions exceeded the allowable limit.

", "exception":true }, "AutomationExecutionMetadata":{ "type":"structure", "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The execution ID.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the Automation runbook used during execution.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version used during the execution.

" }, "AutomationExecutionStatus":{ "shape":"AutomationExecutionStatus", "documentation":"

The status of the execution.

" }, "ExecutionStartTime":{ "shape":"DateTime", "documentation":"

The time the execution started.

" }, "ExecutionEndTime":{ "shape":"DateTime", "documentation":"

The time the execution finished. This isn't populated if the execution is still in progress.

" }, "ExecutedBy":{ "shape":"String", "documentation":"

The IAM role ARN of the user who ran the automation.

" }, "LogFile":{ "shape":"String", "documentation":"

An S3 bucket where execution information is stored.

" }, "Outputs":{ "shape":"AutomationParameterMap", "documentation":"

The list of execution outputs as defined in the Automation runbook.

" }, "Mode":{ "shape":"ExecutionMode", "documentation":"

The Automation execution mode.

" }, "ParentAutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The execution ID of the parent automation.

" }, "CurrentStepName":{ "shape":"String", "documentation":"

The name of the step that is currently running.

" }, "CurrentAction":{ "shape":"String", "documentation":"

The action of the step that is currently running.

" }, "FailureMessage":{ "shape":"String", "documentation":"

The list of execution outputs as defined in the Automation runbook.

" }, "TargetParameterName":{ "shape":"AutomationParameterKey", "documentation":"

The list of execution outputs as defined in the Automation runbook.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets defined by the user when starting the automation.

" }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

The specified key-value mapping of document parameters to target resources.

" }, "ResolvedTargets":{ "shape":"ResolvedTargets", "documentation":"

A list of targets that resolved during the execution.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The `MaxConcurrency` value specified by the user when starting the automation.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The `MaxErrors` value specified by the user when starting the automation.

" }, "Target":{ "shape":"String", "documentation":"

The list of execution outputs as defined in the Automation runbook.

" }, "AutomationType":{ "shape":"AutomationType", "documentation":"

Use this filter with DescribeAutomationExecutions. 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 Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm applied to your automation.

" }, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarm that was invoked by the automation.

" }, "AutomationSubtype":{ "shape":"AutomationSubtype", "documentation":"

The subtype of the Automation operation. Currently, the only supported value is `ChangeRequest`.

" }, "ScheduledTime":{ "shape":"DateTime", "documentation":"

The date and time the Automation operation is scheduled to start.

" }, "Runbooks":{ "shape":"Runbooks", "documentation":"

Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

" }, "OpsItemId":{ "shape":"String", "documentation":"

The ID of an OpsItem that is created to represent a Change Manager change request.

" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of a State Manager association used in the Automation operation.

" }, "ChangeRequestName":{ "shape":"ChangeRequestName", "documentation":"

The name of the Change Manager change request.

" } }, "documentation":"

Details about a specific Automation execution.

" }, "AutomationExecutionMetadataList":{ "type":"list", "member":{"shape":"AutomationExecutionMetadata"} }, "AutomationExecutionNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

There is no automation execution information for the requested automation execution ID.

", "exception":true }, "AutomationExecutionStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure", "Exited" ] }, "AutomationParameterKey":{ "type":"string", "max":50, "min":1 }, "AutomationParameterMap":{ "type":"map", "key":{"shape":"AutomationParameterKey"}, "value":{"shape":"AutomationParameterValueList"}, "max":200, "min":1 }, "AutomationParameterValue":{ "type":"string", "max":512, "min":1 }, "AutomationParameterValueList":{ "type":"list", "member":{"shape":"AutomationParameterValue"}, "max":50, "min":0 }, "AutomationStepNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified step name and execution ID don't exist. Verify the information and try again.

", "exception":true }, "AutomationSubtype":{ "type":"string", "enum":["ChangeRequest"] }, "AutomationTargetParameterName":{ "type":"string", "max":50, "min":1 }, "AutomationType":{ "type":"string", "enum":[ "CrossAccount", "Local" ] }, "BaselineDescription":{ "type":"string", "max":1024, "min":1 }, "BaselineId":{ "type":"string", "max":128, "min":20, "pattern":"^[a-zA-Z0-9_\\-:/]{20,128}$" }, "BaselineName":{ "type":"string", "max":128, "min":3, "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "BaselineOverride":{ "type":"structure", "members":{ "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

The operating system rule used by the patch baseline override.

" }, "GlobalFilters":{"shape":"PatchFilterGroup"}, "ApprovalRules":{"shape":"PatchRuleGroup"}, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

" }, "ApprovedPatchesComplianceLevel":{ "shape":"PatchComplianceLevel", "documentation":"

Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.

" }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

" }, "RejectedPatchesAction":{ "shape":"PatchAction", "documentation":"

The action for Patch Manager to take on patches included in the `RejectedPackages` 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.

" }, "ApprovedPatchesEnableNonSecurity":{ "shape":"Boolean", "documentation":"

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.

" }, "Sources":{ "shape":"PatchSourceList", "documentation":"

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

" } }, "documentation":"

Defines the basic information about a patch baseline override.

" }, "BatchErrorMessage":{"type":"string"}, "Boolean":{"type":"boolean"}, "CalendarNameOrARN":{"type":"string"}, "CalendarNameOrARNList":{ "type":"list", "member":{"shape":"CalendarNameOrARN"} }, "CalendarState":{ "type":"string", "enum":[ "OPEN", "CLOSED" ] }, "CancelCommandRequest":{ "type":"structure", "required":["CommandId"], "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

The ID of the command you want to cancel.

" }, "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

(Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.

" } }, "documentation":"

" }, "CancelCommandResult":{ "type":"structure", "members":{ }, "documentation":"

Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.

" }, "CancelMaintenanceWindowExecutionRequest":{ "type":"structure", "required":["WindowExecutionId"], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution to stop.

" } } }, "CancelMaintenanceWindowExecutionResult":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution that has been stopped.

" } } }, "Category":{ "type":"string", "max":128 }, "CategoryEnumList":{ "type":"list", "member":{"shape":"Category"}, "max":3, "min":0 }, "CategoryList":{ "type":"list", "member":{"shape":"Category"}, "max":3, "min":0 }, "ChangeDetailsValue":{ "type":"string", "max":32768, "min":1 }, "ChangeRequestName":{ "type":"string", "max":1024, "min":1 }, "ClientToken":{ "type":"string", "max":64, "min":1 }, "CloudWatchLogGroupName":{ "type":"string", "max":512, "min":1 }, "CloudWatchOutputConfig":{ "type":"structure", "members":{ "CloudWatchLogGroupName":{ "shape":"CloudWatchLogGroupName", "documentation":"

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:

`aws/ssm/SystemsManagerDocumentName`

" }, "CloudWatchOutputEnabled":{ "shape":"CloudWatchOutputEnabled", "documentation":"

Enables Systems Manager to send command output to CloudWatch Logs.

" } }, "documentation":"

Configuration options for sending command output to Amazon CloudWatch Logs.

" }, "CloudWatchOutputEnabled":{"type":"boolean"}, "Command":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

A unique identifier for this command.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the document requested for execution.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The Systems Manager document (SSM document) version.

" }, "Comment":{ "shape":"Comment", "documentation":"

User-specified information about the command, such as a brief description of what the command should do.

" }, "ExpiresAfter":{ "shape":"DateTime", "documentation":"

If a command expires, it changes status to `DeliveryTimedOut` for all invocations that have the status `InProgress`, `Pending`, or `Delayed`. `ExpiresAfter` is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The parameter values to be inserted in the document when running the command.

" }, "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

The managed node IDs against which this command was requested.

" }, "Targets":{ "shape":"Targets", "documentation":"

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

" }, "RequestedDateTime":{ "shape":"DateTime", "documentation":"

The date and time the command was requested.

" }, "Status":{ "shape":"CommandStatus", "documentation":"

The status of the command.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the command execution. `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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

- Pending: The command hasn't been sent to any managed nodes.

- In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.

- Success: The command successfully ran on all invocations. This is a terminal state.

- Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

- Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

- Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

- Incomplete: The command was attempted on all managed nodes 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.

- Cancelled: The command was terminated before it was completed. This is a terminal state.

- Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.

- Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

" }, "OutputS3Region":{ "shape":"S3Region", "documentation":"

(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.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use `MaxConcurrency`, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

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 `0`. For more information about how to use `MaxErrors`, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

" }, "TargetCount":{ "shape":"TargetCount", "documentation":"

The number of targets for the command.

" }, "CompletedCount":{ "shape":"CompletedCount", "documentation":"

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, Cancelled, Terminated, or Undeliverable.

" }, "ErrorCount":{ "shape":"ErrorCount", "documentation":"

The number of targets for which the status is Failed or Execution Timed Out.

" }, "DeliveryTimedOutCount":{ "shape":"DeliveryTimedOutCount", "documentation":"

The number of targets for which the status is Delivery Timed Out.

" }, "ServiceRole":{ "shape":"ServiceRole", "documentation":"

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.

" }, "NotificationConfig":{ "shape":"NotificationConfig", "documentation":"

Configurations for sending notifications about command status changes.

" }, "CloudWatchOutputConfig":{ "shape":"CloudWatchOutputConfig", "documentation":"

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

" }, "TimeoutSeconds":{ "shape":"TimeoutSeconds", "documentation":"

The `TimeoutSeconds` value specified for a command.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm applied to your command.

" }, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarm that was invoked by the command.

" } }, "documentation":"

Describes a command request.

" }, "CommandFilter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"CommandFilterKey", "documentation":"

The name of the filter.

The `ExecutionStage` filter can't be used with the `ListCommandInvocations` operation, only with `ListCommands`.

" }, "value":{ "shape":"CommandFilterValue", "documentation":"

The filter value. Valid values for each filter key are as follows:

- InvokedAfter: Specify a timestamp to limit your results. For example, specify `2021-07-07T00:00:00Z` to see a list of command executions occurring July 7, 2021, and later.

- InvokedBefore: Specify a timestamp to limit your results. For example, specify `2021-07-07T00:00:00Z` to see a list of command executions from before July 7, 2021.

- Status: 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.

  The status values you can specify for `ListCommands` are:

  - `Pending`

  - `InProgress`

  - `Success`

  - `Cancelled`

  - `Failed`

  - `TimedOut` (this includes both Delivery and Execution time outs)

  - `AccessDenied`

  - `DeliveryTimedOut`

  - `ExecutionTimedOut`

  - `Incomplete`

  - `NoInstancesInTag`

  - `LimitExceeded`

  The status values you can specify for `ListCommandInvocations` are:

  - `Pending`

  - `InProgress`

  - `Delayed`

  - `Success`

  - `Cancelled`

  - `Failed`

  - `TimedOut` (this includes both Delivery and Execution time outs)

  - `AccessDenied`

  - `DeliveryTimedOut`

  - `ExecutionTimedOut`

  - `Undeliverable`

  - `InvalidPlatform`

  - `Terminated`

- DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify `AWS-RunPatchBaseline` to see command executions that used this SSM document to perform security patching operations on managed nodes.

- ExecutionStage: Specify one of the following values (`ListCommands` operations only):

  - `Executing`: Returns a list of command executions that are currently still running.

  - `Complete`: Returns a list of command executions that have already completed.

" } }, "documentation":"

Describes a command filter.

A managed node ID can't be specified when a command status is `Pending` because the command hasn't run on the node yet.

" }, "CommandFilterKey":{ "type":"string", "enum":[ "InvokedAfter", "InvokedBefore", "Status", "ExecutionStage", "DocumentName" ] }, "CommandFilterList":{ "type":"list", "member":{"shape":"CommandFilter"}, "max":5, "min":1 }, "CommandFilterValue":{ "type":"string", "max":128, "min":1 }, "CommandId":{ "type":"string", "max":36, "min":36 }, "CommandInvocation":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

The command against which this invocation was requested.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID in which this invocation was requested.

" }, "InstanceName":{ "shape":"InstanceTagName", "documentation":"

The fully qualified host name of the managed node.

" }, "Comment":{ "shape":"Comment", "documentation":"

User-specified information about the command, such as a brief description of what the command should do.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The document name that was requested for execution.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The Systems Manager document (SSM document) version.

" }, "RequestedDateTime":{ "shape":"DateTime", "documentation":"

The time and date the request was sent to this managed node.

" }, "Status":{ "shape":"CommandInvocationStatus", "documentation":"

Whether or not the invocation succeeded, failed, or is pending.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the command execution for each invocation (each managed node 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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

- Pending: The command hasn't been sent to the managed node.

- In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

- Success: The execution of the command or plugin was successfully completed. This is a terminal state.

- Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's `MaxErrors` limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

- Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the `MaxErrors` limit of the parent command. This is a terminal state.

- Failed: The command wasn't successful on the managed node. 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.

- Cancelled: The command was terminated before it was completed. This is a terminal state.

- Undeliverable: The command can't be delivered to the managed node. The managed node 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.

- Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

- Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

" }, "TraceOutput":{ "shape":"InvocationTraceOutput", "documentation":"

Gets the trace output sent by the agent.

" }, "StandardOutputUrl":{ "shape":"Url", "documentation":"

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, `StandardOutputUrl` is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.

" }, "StandardErrorUrl":{ "shape":"Url", "documentation":"

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, `StandardErrorUrl` is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.

" }, "CommandPlugins":{ "shape":"CommandPluginList", "documentation":"

Plugins processed by the command.

" }, "ServiceRole":{ "shape":"ServiceRole", "documentation":"

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 managed node basis.

" }, "NotificationConfig":{ "shape":"NotificationConfig", "documentation":"

Configurations for sending notifications about command status changes on a per managed node basis.

" }, "CloudWatchOutputConfig":{ "shape":"CloudWatchOutputConfig", "documentation":"

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

" } }, "documentation":"

An invocation is a copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs `SendCommand` against three managed nodes, then a command invocation is created for each requested managed node ID. A command invocation returns status and detail information about a command you ran.

" }, "CommandInvocationList":{ "type":"list", "member":{"shape":"CommandInvocation"} }, "CommandInvocationStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Delayed", "Success", "Cancelled", "TimedOut", "Failed", "Cancelling" ] }, "CommandList":{ "type":"list", "member":{"shape":"Command"} }, "CommandMaxResults":{ "type":"integer", "max":50, "min":1 }, "CommandPlugin":{ "type":"structure", "members":{ "Name":{ "shape":"CommandPluginName", "documentation":"

The name of the plugin. Must be one of the following: `aws:updateAgent`, `aws:domainjoin`, `aws:applications`, `aws:runPowerShellScript`, `aws:psmodule`, `aws:cloudWatch`, `aws:runShellScript`, or `aws:updateSSMAgent`.

" }, "Status":{ "shape":"CommandPluginStatus", "documentation":"

The status of this plugin. You can run a document with multiple plugins.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the plugin execution. `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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

- Pending: The command hasn't been sent to the managed node.

- In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

- Success: The execution of the command or plugin was successfully completed. This is a terminal state.

- Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's `MaxErrors` limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

- Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the `MaxErrors` limit of the parent command. This is a terminal state.

- Failed: The command wasn't successful on the managed node. 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.

- Cancelled: The command was terminated before it was completed. This is a terminal state.

- Undeliverable: The command can't be delivered to the managed node. The managed node 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.

- Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

" }, "ResponseCode":{ "shape":"ResponseCode", "documentation":"

A numeric response code generated after running the plugin.

" }, "ResponseStartDateTime":{ "shape":"DateTime", "documentation":"

The time the plugin started running.

" }, "ResponseFinishDateTime":{ "shape":"DateTime", "documentation":"

The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.

" }, "Output":{ "shape":"CommandPluginOutput", "documentation":"

Output of the plugin execution.

" }, "StandardOutputUrl":{ "shape":"Url", "documentation":"

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.

" }, "StandardErrorUrl":{ "shape":"Url", "documentation":"

The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.

" }, "OutputS3Region":{ "shape":"S3Region", "documentation":"

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

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:

`doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript`

`doc-example-bucket` is the name of the S3 bucket;

`ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix` is the name of the S3 prefix;

`i-02573cafcfEXAMPLE` is the managed node ID;

`awsrunShellScript` is the name of the plugin.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

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:

`doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript`

`doc-example-bucket` is the name of the S3 bucket;

`ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix` is the name of the S3 prefix;

`i-02573cafcfEXAMPLE` is the managed node ID;

`awsrunShellScript` is the name of the plugin.

" } }, "documentation":"

Describes plugin details.

" }, "CommandPluginList":{ "type":"list", "member":{"shape":"CommandPlugin"} }, "CommandPluginName":{ "type":"string", "min":4 }, "CommandPluginOutput":{ "type":"string", "max":2500 }, "CommandPluginStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Success", "TimedOut", "Cancelled", "Failed" ] }, "CommandStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Success", "Cancelled", "Failed", "TimedOut", "Cancelling" ] }, "Comment":{ "type":"string", "max":100 }, "CompletedCount":{"type":"integer"}, "ComplianceExecutionId":{ "type":"string", "max":100 }, "ComplianceExecutionSummary":{ "type":"structure", "required":["ExecutionTime"], "members":{ "ExecutionTime":{ "shape":"DateTime", "documentation":"

The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

" }, "ExecutionId":{ "shape":"ComplianceExecutionId", "documentation":"

An ID created by the system when `PutComplianceItems` was called. For example, `CommandID` is a valid execution ID. You can use this ID in subsequent calls.

" }, "ExecutionType":{ "shape":"ComplianceExecutionType", "documentation":"

The type of execution. For example, `Command` is a valid execution type.

" } }, "documentation":"

A summary of the call execution that includes an execution ID, the type of execution (for example, `Command`), 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'.

" }, "ComplianceExecutionType":{ "type":"string", "max":50 }, "ComplianceFilterValue":{"type":"string"}, "ComplianceItem":{ "type":"structure", "members":{ "ComplianceType":{ "shape":"ComplianceTypeName", "documentation":"

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:`string` are all valid compliance types.

" }, "ResourceType":{ "shape":"ComplianceResourceType", "documentation":"

The type of resource. `ManagedInstance` is currently the only supported resource type.

" }, "ResourceId":{ "shape":"ComplianceResourceId", "documentation":"

An ID for the resource. For a managed node, this is the node ID.

" }, "Id":{ "shape":"ComplianceItemId", "documentation":"

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.

" }, "Title":{ "shape":"ComplianceItemTitle", "documentation":"

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.

" }, "Status":{ "shape":"ComplianceStatus", "documentation":"

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).

" }, "Severity":{ "shape":"ComplianceSeverity", "documentation":"

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

" }, "ExecutionSummary":{ "shape":"ComplianceExecutionSummary", "documentation":"

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

" }, "Details":{ "shape":"ComplianceItemDetails", "documentation":"

A \"Key\": \"Value\" tag combination for the compliance item.

" } }, "documentation":"

Information about the compliance as defined by the resource type. For example, for a patch resource type, `Items` includes information about the PatchSeverity, Classification, and so on.

" }, "ComplianceItemContentHash":{ "type":"string", "max":256 }, "ComplianceItemDetails":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "ComplianceItemEntry":{ "type":"structure", "required":[ "Severity", "Status" ], "members":{ "Id":{ "shape":"ComplianceItemId", "documentation":"

The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.

" }, "Title":{ "shape":"ComplianceItemTitle", "documentation":"

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.

" }, "Severity":{ "shape":"ComplianceSeverity", "documentation":"

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

" }, "Status":{ "shape":"ComplianceStatus", "documentation":"

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

" }, "Details":{ "shape":"ComplianceItemDetails", "documentation":"

A \"Key\": \"Value\" tag combination for the compliance item.

" } }, "documentation":"

Information about a compliance item.

" }, "ComplianceItemEntryList":{ "type":"list", "member":{"shape":"ComplianceItemEntry"}, "max":10000, "min":0 }, "ComplianceItemId":{"type":"string"}, "ComplianceItemList":{ "type":"list", "member":{"shape":"ComplianceItem"} }, "ComplianceItemTitle":{ "type":"string", "max":500 }, "ComplianceQueryOperatorType":{ "type":"string", "enum":[ "EQUAL", "NOT_EQUAL", "BEGIN_WITH", "LESS_THAN", "GREATER_THAN" ] }, "ComplianceResourceId":{ "type":"string", "max":100, "min":1 }, "ComplianceResourceIdList":{ "type":"list", "member":{"shape":"ComplianceResourceId"}, "min":1 }, "ComplianceResourceType":{ "type":"string", "max":50, "min":1 }, "ComplianceResourceTypeList":{ "type":"list", "member":{"shape":"ComplianceResourceType"}, "min":1 }, "ComplianceSeverity":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL", "UNSPECIFIED" ] }, "ComplianceStatus":{ "type":"string", "enum":[ "COMPLIANT", "NON_COMPLIANT" ] }, "ComplianceStringFilter":{ "type":"structure", "members":{ "Key":{ "shape":"ComplianceStringFilterKey", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"ComplianceStringFilterValueList", "documentation":"

The value for which to search.

" }, "Type":{ "shape":"ComplianceQueryOperatorType", "documentation":"

The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.

" } }, "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "ComplianceStringFilterKey":{ "type":"string", "max":200, "min":1 }, "ComplianceStringFilterList":{ "type":"list", "member":{"shape":"ComplianceStringFilter"} }, "ComplianceStringFilterValueList":{ "type":"list", "member":{"shape":"ComplianceFilterValue"}, "max":20, "min":1 }, "ComplianceSummaryCount":{"type":"integer"}, "ComplianceSummaryItem":{ "type":"structure", "members":{ "ComplianceType":{ "shape":"ComplianceTypeName", "documentation":"

The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.

" }, "CompliantSummary":{ "shape":"CompliantSummary", "documentation":"

A list of COMPLIANT items for the specified compliance type.

" }, "NonCompliantSummary":{ "shape":"NonCompliantSummary", "documentation":"

A list of NON_COMPLIANT items for the specified compliance type.

" } }, "documentation":"

A summary of compliance information by compliance type.

" }, "ComplianceSummaryItemList":{ "type":"list", "member":{"shape":"ComplianceSummaryItem"} }, "ComplianceTypeCountLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You specified too many custom compliance types. You can specify a maximum of 10 different types.

", "exception":true }, "ComplianceTypeName":{ "type":"string", "max":100, "min":1, "pattern":"[A-Za-z0-9_\\-]\\w+|Custom:[a-zA-Z0-9_\\-]\\w+" }, "ComplianceUploadType":{ "type":"string", "enum":[ "COMPLETE", "PARTIAL" ] }, "CompliantSummary":{ "type":"structure", "members":{ "CompliantCount":{ "shape":"ComplianceSummaryCount", "documentation":"

The total number of resources that are compliant.

" }, "SeveritySummary":{ "shape":"SeveritySummary", "documentation":"

A summary of the compliance severity by compliance type.

" } }, "documentation":"

A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.

" }, "ComputerName":{ "type":"string", "max":255, "min":1 }, "ConnectionStatus":{ "type":"string", "enum":[ "connected", "notconnected" ] }, "ContentLength":{"type":"long"}, "CreateActivationRequest":{ "type":"structure", "required":["IamRole"], "members":{ "Description":{ "shape":"ActivationDescription", "documentation":"

A user-defined description of the resource that you want to register with Systems Manager.

Don't enter personally identifiable information in this field.

" }, "DefaultInstanceName":{ "shape":"DefaultInstanceName", "documentation":"

The name of the registered, managed node 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.

Don't enter personally identifiable information in this field.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal `ssm.amazonaws.com`. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

" }, "RegistrationLimit":{ "shape":"RegistrationLimit", "documentation":"

Specify the maximum number of managed nodes you want to register. The default value is `1`.

", "box":true }, "ExpirationDate":{ "shape":"ExpirationDate", "documentation":"

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.

" }, "Tags":{ "shape":"TagList", "documentation":"

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:

- `Key=OS,Value=Windows`

- `Key=Environment,Value=Production`

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.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node 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 nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

" }, "RegistrationMetadata":{ "shape":"RegistrationMetadataList", "documentation":"

Reserved for internal use.

" } } }, "CreateActivationResult":{ "type":"structure", "members":{ "ActivationId":{ "shape":"ActivationId", "documentation":"

The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

" }, "ActivationCode":{ "shape":"ActivationCode", "documentation":"

The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

" } } }, "CreateAssociationBatchRequest":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"CreateAssociationBatchRequestEntries", "documentation":"

One or more associations.

" } } }, "CreateAssociationBatchRequestEntries":{ "type":"list", "member":{"shape":"CreateAssociationBatchRequestEntry"}, "min":1 }, "CreateAssociationBatchRequestEntry":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.

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:

`arn:aws:ssm:region:account-id:document/document-name`

For example:

`arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`

For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, `AWS-ApplyPatchBaseline` or `My-Document`.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

`InstanceId` has been deprecated. To specify a managed node ID for an association, use the `Targets` parameter. Requests that include the parameter `InstanceID` with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter `InstanceId`, you can't use the parameters `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use these parameters, you must use the `Targets` parameter.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A description of the parameters for a document.

" }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", "documentation":"

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.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "Targets":{ "shape":"Targets", "documentation":"

The managed nodes targeted by the request.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression that specifies a schedule when the association runs.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An S3 bucket where you want to store the results of this request.

" }, "AssociationName":{ "shape":"AssociationName", "documentation":"

Specify a descriptive name for the association.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

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 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when `MaxErrors` 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 `MaxConcurrency` to 1 so that executions proceed one at a time.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

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.

If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.

" }, "ComplianceSeverity":{ "shape":"AssociationComplianceSeverity", "documentation":"

The severity level to assign to the association.

" }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", "documentation":"

The mode for generating association compliance. You can specify `AUTO` or `MANUAL`. In `AUTO` 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 `COMPLIANT`. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`.

In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use `AUTO` mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", "documentation":"

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.

" }, "CalendarNames":{ "shape":"CalendarNameOrARNList", "documentation":"

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 Amazon Web Services Systems Manager Change Calendar.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

Use this action to create an association in multiple Regions and multiple accounts.

" }, "ScheduleOffset":{ "shape":"ScheduleOffset", "documentation":"

Number of days to wait after the scheduled day to run an association.

", "box":true }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

", "box":true }, "AlarmConfiguration":{"shape":"AlarmConfiguration"} }, "documentation":"

Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

" }, "CreateAssociationBatchResult":{ "type":"structure", "members":{ "Successful":{ "shape":"AssociationDescriptionList", "documentation":"

Information about the associations that succeeded.

" }, "Failed":{ "shape":"FailedCreateAssociationList", "documentation":"

Information about the associations that failed.

" } } }, "CreateAssociationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another Amazon Web Services account.

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:

`arn:partition:ssm:region:account-id:document/document-name`

For example:

`arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`

For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, `AWS-ApplyPatchBaseline` or `My-Document`.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version you want to associate with the target(s). Can be a specific version or the default version.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the `default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default`.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

`InstanceId` has been deprecated. To specify a managed node ID for an association, use the `Targets` parameter. Requests that include the parameter `InstanceID` with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter `InstanceId`, you can't use the parameters `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use these parameters, you must use the `Targets` parameter.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The parameters for the runtime configuration of the document.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the `InstanceIds` key with a value of `*`. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression when the association will be applied to the target(s).

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

" }, "AssociationName":{ "shape":"AssociationName", "documentation":"

Specify a descriptive name for the association.

" }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", "documentation":"

Choose the parameter that will define how your automation will branch out. 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.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

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 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when `MaxErrors` 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 `MaxConcurrency` to 1 so that executions proceed one at a time.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

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.

If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.

" }, "ComplianceSeverity":{ "shape":"AssociationComplianceSeverity", "documentation":"

The severity level to assign to the association.

" }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", "documentation":"

The mode for generating association compliance. You can specify `AUTO` or `MANUAL`. In `AUTO` 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 `COMPLIANT`. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`.

In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use `AUTO` mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", "documentation":"

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.

" }, "CalendarNames":{ "shape":"CalendarNameOrARNList", "documentation":"

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 Amazon Web Services Systems Manager Change Calendar.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

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.

" }, "ScheduleOffset":{ "shape":"ScheduleOffset", "documentation":"

Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of `cron(0 0 ? * THU#2 *)`, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

To use offsets, you must specify the `ApplyOnlyAtCronInterval` parameter. This option tells the system not to run an association immediately after you create it.

", "box":true }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

", "box":true }, "Tags":{ "shape":"TagList", "documentation":"

Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. 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.

", "box":true }, "AlarmConfiguration":{"shape":"AlarmConfiguration"} } }, "CreateAssociationResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

Information about the association.

" } } }, "CreateDocumentRequest":{ "type":"structure", "required":[ "Content", "Name" ], "members":{ "Content":{ "shape":"DocumentContent", "documentation":"

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

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

- Create an SSM document (Amazon Web Services API)

- Create an SSM document (Amazon Web Services CLI)

- Create an SSM document (API)

" }, "Requires":{ "shape":"DocumentRequiresList", "documentation":"

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

" }, "Attachments":{ "shape":"AttachmentsSourceList", "documentation":"

A list of key-value pairs that describe attachments to a version of a document.

" }, "Name":{ "shape":"DocumentName", "documentation":"

A name for the SSM document.

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

- `aws`

- `amazon`

- `amzn`

" }, "DisplayName":{ "shape":"DocumentDisplayName", "documentation":"

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

An optional field specifying the version of the artifact you are creating with the document. For example, `Release12.1`. This value is unique across all versions of a document, and can't be changed.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The type of document to create.

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

" }, "DocumentFormat":{ "shape":"DocumentFormat", "documentation":"

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

" }, "TargetType":{ "shape":"TargetType", "documentation":"

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

" }, "Tags":{ "shape":"TagList", "documentation":"

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

- `Key=OS,Value=Windows`

- `Key=Environment,Value=Production`

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

" } } }, "CreateDocumentResult":{ "type":"structure", "members":{ "DocumentDescription":{ "shape":"DocumentDescription", "documentation":"

Information about the SSM document.

" } } }, "CreateMaintenanceWindowRequest":{ "type":"structure", "required":[ "Name", "Schedule", "Duration", "Cutoff", "AllowUnassociatedTargets" ], "members":{ "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the maintenance window.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

" }, "StartDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. `StartDate` allows you to delay activation of the maintenance window until the specified future date.

" }, "EndDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. `EndDate` allows you to set a date and time in the future when the maintenance window will no longer run.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the maintenance window in the form of a cron or rate expression.

" }, "ScheduleTimezone":{ "shape":"MaintenanceWindowTimezone", "documentation":"

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 Time Zone Database on the IANA website.

" }, "ScheduleOffset":{ "shape":"MaintenanceWindowOffset", "documentation":"

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

`cron(30 23 ? * TUE#3 *)`

If the schedule offset is `2`, the maintenance window won't run until two days later.

", "box":true }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the maintenance window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

" }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true }, "Tags":{ "shape":"TagList", "documentation":"

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:

- `Key=TaskType,Value=AgentUpdate`

- `Key=OS,Value=Windows`

- `Key=Environment,Value=Production`

To add tags to an existing maintenance window, use the AddTagsToResource operation.

" } } }, "CreateMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the created maintenance window.

" } } }, "CreateOpsItemRequest":{ "type":"structure", "required":[ "Description", "Source", "Title" ], "members":{ "Description":{ "shape":"OpsItemDescription", "documentation":"

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.

" }, "OpsItemType":{ "shape":"OpsItemType", "documentation":"

The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

- `/aws/issue`

  This type of OpsItem is used for default OpsItems created by OpsCenter.

- `/aws/changerequest`

  This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

- `/aws/insight`

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

" }, "OperationalData":{ "shape":"OpsItemOperationalData", "documentation":"

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.

Operational data keys can't begin with the following: `amazon`, `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.

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 DescribeOpsItems 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 GetOpsItem API operation).

Use the `/aws/resources` key in OperationalData to specify a related resource in the request. Use the `/aws/automations` key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

" }, "Notifications":{ "shape":"OpsItemNotifications", "documentation":"

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

" }, "Priority":{ "shape":"OpsItemPriority", "documentation":"

The importance of this OpsItem in relation to other OpsItems in the system.

" }, "RelatedOpsItems":{ "shape":"RelatedOpsItems", "documentation":"

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.

" }, "Source":{ "shape":"OpsItemSource", "documentation":"

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

The source name can't contain the following strings: `aws`, `amazon`, and `amzn`.

" }, "Title":{ "shape":"OpsItemTitle", "documentation":"

A short heading that describes the nature of the OpsItem and the impacted resource.

" }, "Tags":{ "shape":"TagList", "documentation":"

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

`Key=Department,Value=Finance`

To add tags to a new OpsItem, a user must have IAM permissions for both the `ssm:CreateOpsItems` operation and the `ssm:AddTagsToResource` operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

" }, "Category":{ "shape":"OpsItemCategory", "documentation":"

Specify a category to assign to an OpsItem.

" }, "Severity":{ "shape":"OpsItemSeverity", "documentation":"

Specify a severity to assign to an OpsItem.

" }, "ActualStartTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow started. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "ActualEndTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow ended. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedStartTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedEndTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type `/aws/changerequest`.

" }, "AccountId":{ "shape":"OpsItemAccountId", "documentation":"

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

" } } }, "CreateOpsItemResponse":{ "type":"structure", "members":{ "OpsItemId":{ "shape":"String", "documentation":"

The ID of the OpsItem.

" }, "OpsItemArn":{ "shape":"OpsItemArn", "documentation":"

The OpsItem Amazon Resource Name (ARN).

" } } }, "CreateOpsMetadataRequest":{ "type":"structure", "required":["ResourceId"], "members":{ "ResourceId":{ "shape":"OpsMetadataResourceId", "documentation":"

A resource ID for a new Application Manager application.

" }, "Metadata":{ "shape":"MetadataMap", "documentation":"

Metadata for a new Application Manager application.

" }, "Tags":{ "shape":"TagList", "documentation":"

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:

- `Key=Environment,Value=Production`

- `Key=Region,Value=us-east-2`

" } } }, "CreateOpsMetadataResult":{ "type":"structure", "members":{ "OpsMetadataArn":{ "shape":"OpsMetadataArn", "documentation":"

The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.

" } } }, "CreatePatchBaselineRequest":{ "type":"structure", "required":["Name"], "members":{ "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Defines the operating system the patch baseline applies to. The default value is `WINDOWS`.

" }, "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to include patches in the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

" }, "ApprovedPatchesComplianceLevel":{ "shape":"PatchComplianceLevel", "documentation":"

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 `UNSPECIFIED`.

" }, "ApprovedPatchesEnableNonSecurity":{ "shape":"Boolean", "documentation":"

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.

", "box":true }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

" }, "RejectedPatchesAction":{ "shape":"PatchAction", "documentation":"

The action for Patch Manager to take on patches included in the `RejectedPackages` list.

- `ALLOW_AS_DEPENDENCY` : A package in the `Rejected` 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 `InstalledOther`. This is the default action if no option is specified.

- `BLOCK` : Packages in the `RejectedPatches` 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 `InstalledRejected`.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the patch baseline.

" }, "Sources":{ "shape":"PatchSourceList", "documentation":"

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true }, "Tags":{ "shape":"TagList", "documentation":"

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:

- `Key=PatchSeverity,Value=Critical`

- `Key=OS,Value=Windows`

To add tags to an existing patch baseline, use the AddTagsToResource operation.

" } } }, "CreatePatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the created patch baseline.

" } } }, "CreateResourceDataSyncRequest":{ "type":"structure", "required":["SyncName"], "members":{ "SyncName":{ "shape":"ResourceDataSyncName", "documentation":"

A name for the configuration.

" }, "S3Destination":{ "shape":"ResourceDataSyncS3Destination", "documentation":"

Amazon S3 configuration details for the sync. This parameter is required if the `SyncType` value is SyncToDestination.

" }, "SyncType":{ "shape":"ResourceDataSyncType", "documentation":"

Specify `SyncToDestination` to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify `SyncToDestination`, you must provide a value for `S3Destination`. Specify `SyncFromSource` 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 `SyncFromSource`, you must provide a value for `SyncSource`. The default value is `SyncToDestination`.

" }, "SyncSource":{ "shape":"ResourceDataSyncSource", "documentation":"

Specify information about the data sources to synchronize. This parameter is required if the `SyncType` value is SyncFromSource.

" } } }, "CreateResourceDataSyncResult":{ "type":"structure", "members":{ } }, "CreatedDate":{"type":"timestamp"}, "CustomSchemaCountLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

", "exception":true }, "DateTime":{"type":"timestamp"}, "DefaultBaseline":{"type":"boolean"}, "DefaultInstanceName":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "DeleteActivationRequest":{ "type":"structure", "required":["ActivationId"], "members":{ "ActivationId":{ "shape":"ActivationId", "documentation":"

The ID of the activation that you want to delete.

" } } }, "DeleteActivationResult":{ "type":"structure", "members":{ } }, "DeleteAssociationRequest":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

`InstanceId` has been deprecated. To specify a managed node ID for an association, use the `Targets` parameter. Requests that include the parameter `InstanceID` with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter `InstanceId`, you can't use the parameters `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use these parameters, you must use the `Targets` parameter.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID that you want to delete.

" } } }, "DeleteAssociationResult":{ "type":"structure", "members":{ } }, "DeleteDocumentRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

" }, "Force":{ "shape":"Boolean", "documentation":"

Some SSM document types require that you specify a `Force` flag before you can delete the document. For example, you must specify a `Force` flag to delete a document of type `ApplicationConfigurationSchema`. You can restrict access to the `Force` flag in an Identity and Access Management (IAM) policy.

" } } }, "DeleteDocumentResult":{ "type":"structure", "members":{ } }, "DeleteInventoryRequest":{ "type":"structure", "required":["TypeName"], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

" }, "SchemaDeleteOption":{ "shape":"InventorySchemaDeleteOption", "documentation":"

Use the `SchemaDeleteOption` 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:

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 `PutInventory` operation for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

" }, "DryRun":{ "shape":"DryRun", "documentation":"

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 `DryRun` option.

" }, "ClientToken":{ "shape":"UUID", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true } } }, "DeleteInventoryResult":{ "type":"structure", "members":{ "DeletionId":{ "shape":"UUID", "documentation":"

Every `DeleteInventory` 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.

" }, "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the inventory data type specified in the request.

" }, "DeletionSummary":{ "shape":"InventoryDeletionSummary", "documentation":"

A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.

" } } }, "DeleteMaintenanceWindowRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window to delete.

" } } }, "DeleteMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the deleted maintenance window.

" } } }, "DeleteOpsItemRequest":{ "type":"structure", "required":["OpsItemId"], "members":{ "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem that you want to delete.

" } } }, "DeleteOpsItemResponse":{ "type":"structure", "members":{ } }, "DeleteOpsMetadataRequest":{ "type":"structure", "required":["OpsMetadataArn"], "members":{ "OpsMetadataArn":{ "shape":"OpsMetadataArn", "documentation":"

The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.

" } } }, "DeleteOpsMetadataResult":{ "type":"structure", "members":{ } }, "DeleteParameterRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter to delete.

" } } }, "DeleteParameterResult":{ "type":"structure", "members":{ } }, "DeleteParametersRequest":{ "type":"structure", "required":["Names"], "members":{ "Names":{ "shape":"ParameterNameList", "documentation":"

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.

" } } }, "DeleteParametersResult":{ "type":"structure", "members":{ "DeletedParameters":{ "shape":"ParameterNameList", "documentation":"

The names of the deleted parameters.

" }, "InvalidParameters":{ "shape":"ParameterNameList", "documentation":"

The names of parameters that weren't deleted because the parameters aren't valid.

" } } }, "DeletePatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to delete.

" } } }, "DeletePatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the deleted patch baseline.

" } } }, "DeleteResourceDataSyncRequest":{ "type":"structure", "required":["SyncName"], "members":{ "SyncName":{ "shape":"ResourceDataSyncName", "documentation":"

The name of the configuration to delete.

" }, "SyncType":{ "shape":"ResourceDataSyncType", "documentation":"

Specify the type of resource data sync to delete.

" } } }, "DeleteResourceDataSyncResult":{ "type":"structure", "members":{ } }, "DeleteResourcePolicyRequest":{ "type":"structure", "required":[ "ResourceArn", "PolicyId", "PolicyHash" ], "members":{ "ResourceArn":{ "shape":"ResourceArnString", "documentation":"

Amazon Resource Name (ARN) of the resource to which the policies are attached.

" }, "PolicyId":{ "shape":"PolicyId", "documentation":"

The policy ID.

" }, "PolicyHash":{ "shape":"PolicyHash", "documentation":"

ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.

" } } }, "DeleteResourcePolicyResponse":{ "type":"structure", "members":{ } }, "DeliveryTimedOutCount":{"type":"integer"}, "DeregisterManagedInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"ManagedInstanceId", "documentation":"

The ID assigned to the managed node when you registered it using the activation process.

" } } }, "DeregisterManagedInstanceResult":{ "type":"structure", "members":{ } }, "DeregisterPatchBaselineForPatchGroupRequest":{ "type":"structure", "required":[ "BaselineId", "PatchGroup" ], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to deregister the patch group from.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group that should be deregistered from the patch baseline.

" } } }, "DeregisterPatchBaselineForPatchGroupResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline the patch group was deregistered from.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group deregistered from the patch baseline.

" } } }, "DeregisterTargetFromMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "WindowTargetId" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window the target should be removed from.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the target definition to remove.

" }, "Safe":{ "shape":"Boolean", "documentation":"

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.

", "box":true } } }, "DeregisterTargetFromMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window the target was removed from.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the removed target definition.

" } } }, "DeregisterTaskFromMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "WindowTaskId" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window the task should be removed from.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The ID of the task to remove from the maintenance window.

" } } }, "DeregisterTaskFromMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window the task was removed from.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The ID of the task removed from the maintenance window.

" } } }, "DescribeActivationsFilter":{ "type":"structure", "members":{ "FilterKey":{ "shape":"DescribeActivationsFilterKeys", "documentation":"

The name of the filter.

" }, "FilterValues":{ "shape":"StringList", "documentation":"

The filter values.

" } }, "documentation":"

Filter for the DescribeActivation API.

" }, "DescribeActivationsFilterKeys":{ "type":"string", "enum":[ "ActivationIds", "DefaultInstanceName", "IamRole" ] }, "DescribeActivationsFilterList":{ "type":"list", "member":{"shape":"DescribeActivationsFilter"} }, "DescribeActivationsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"DescribeActivationsFilterList", "documentation":"

A filter to view information about your activations.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "DescribeActivationsResult":{ "type":"structure", "members":{ "ActivationList":{ "shape":"ActivationList", "documentation":"

A list of activations for your Amazon Web Services account.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "DescribeAssociationExecutionTargetsRequest":{ "type":"structure", "required":[ "AssociationId", "ExecutionId" ], "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID that includes the execution for which you want to view details.

" }, "ExecutionId":{ "shape":"AssociationExecutionId", "documentation":"

The execution ID for which you want to view details.

" }, "Filters":{ "shape":"AssociationExecutionTargetsFilterList", "documentation":"

Filters for the request. You can specify the following filters and values.

Status (EQUAL)

ResourceId (EQUAL)

ResourceType (EQUAL)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "DescribeAssociationExecutionTargetsResult":{ "type":"structure", "members":{ "AssociationExecutionTargets":{ "shape":"AssociationExecutionTargetsList", "documentation":"

Information about the execution.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "DescribeAssociationExecutionsRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID for which you want to view execution history details.

" }, "Filters":{ "shape":"AssociationExecutionFilterList", "documentation":"

Filters for the request. You can specify the following filters and values.

ExecutionId (EQUAL)

Status (EQUAL)

CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "DescribeAssociationExecutionsResult":{ "type":"structure", "members":{ "AssociationExecutions":{ "shape":"AssociationExecutionsList", "documentation":"

A list of the executions for the specified association ID.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "DescribeAssociationRequest":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID for which you want information.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

Specify the association version to retrieve. To view the latest version, either specify `$LATEST` for this parameter, or omit this parameter. To view a list of all associations for a managed node, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

" } } }, "DescribeAssociationResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

Information about the association.

" } } }, "DescribeAutomationExecutionsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"AutomationExecutionFilterList", "documentation":"

Filters used to limit the scope of executions that are requested.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeAutomationExecutionsResult":{ "type":"structure", "members":{ "AutomationExecutionMetadataList":{ "shape":"AutomationExecutionMetadataList", "documentation":"

The list of details about each automation execution which has occurred which matches the filter specification, if any.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeAutomationStepExecutionsRequest":{ "type":"structure", "required":["AutomationExecutionId"], "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The Automation execution ID for which you want step execution descriptions.

" }, "Filters":{ "shape":"StepExecutionFilterList", "documentation":"

One or more filters to limit the number of step executions returned by the request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "ReverseOrder":{ "shape":"Boolean", "documentation":"

Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

", "box":true } } }, "DescribeAutomationStepExecutionsResult":{ "type":"structure", "members":{ "StepExecutions":{ "shape":"StepExecutionList", "documentation":"

A list of details about the current state of all steps that make up an execution.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeAvailablePatchesRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

Each element in the array is a structure containing a key-value pair.

Windows Server

Supported keys for Windows Server managed node patches include the following:

- `PATCH_SET`

  Sample values: `OS` | `APPLICATION`

- `PRODUCT`

  Sample values: `WindowsServer2012` | `Office 2010` | `MicrosoftDefenderAntivirus`

- `PRODUCT_FAMILY`

  Sample values: `Windows` | `Office`

- `MSRC_SEVERITY`

  Sample values: `ServicePacks` | `Important` | `Moderate`

- `CLASSIFICATION`

  Sample values: `ServicePacks` | `SecurityUpdates` | `DefinitionUpdates`

- `PATCH_ID`

  Sample values: `KB123456` | `KB4516046`

Linux

When specifying filters for Linux patches, you must specify a key-pair for `PRODUCT`. For example, using the Command Line Interface (CLI), the following command fails:

`aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615`

However, the following command succeeds:

`aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615`

Supported keys for Linux managed node patches include the following:

- `PRODUCT`

  Sample values: `AmazonLinux2018.03` | `AmazonLinux2.0`

- `NAME`

  Sample values: `kernel-headers` | `samba-python` | `php`

- `SEVERITY`

  Sample values: `Critical` | `Important` | `Medium` | `Low`

- `EPOCH`

  Sample values: `0` | `1`

- `VERSION`

  Sample values: `78.6.1` | `4.10.16`

- `RELEASE`

  Sample values: `9.56.amzn1` | `1.amzn2`

- `ARCH`

  Sample values: `i686` | `x86_64`

- `REPOSITORY`

  Sample values: `Core` | `Updates`

- `ADVISORY_ID`

  Sample values: `ALAS-2018-1058` | `ALAS2-2021-1594`

- `CVE_ID`

  Sample values: `CVE-2018-3615` | `CVE-2020-1472`

- `BUGZILLA_ID`

  Sample values: `1463241`

" }, "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeAvailablePatchesResult":{ "type":"structure", "members":{ "Patches":{ "shape":"PatchList", "documentation":"

An array of patches. Each entry in the array is a patch structure.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeDocumentPermissionRequest":{ "type":"structure", "required":[ "Name", "PermissionType" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document for which you are the owner.

" }, "PermissionType":{ "shape":"DocumentPermissionType", "documentation":"

The permission type for the document. The permission type can be Share.

" }, "MaxResults":{ "shape":"DocumentPermissionMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeDocumentPermissionResponse":{ "type":"structure", "members":{ "AccountIds":{ "shape":"AccountIdList", "documentation":"

The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.

" }, "AccountSharingInfoList":{ "shape":"AccountSharingInfoList", "documentation":"

A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "DescribeDocumentRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version for which you want information. Can be a specific version or the default version.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

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.

" } } }, "DescribeDocumentResult":{ "type":"structure", "members":{ "Document":{ "shape":"DocumentDescription", "documentation":"

Information about the SSM document.

" } } }, "DescribeEffectiveInstanceAssociationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID for which you want to view all associations.

" }, "MaxResults":{ "shape":"EffectiveInstanceAssociationMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeEffectiveInstanceAssociationsResult":{ "type":"structure", "members":{ "Associations":{ "shape":"InstanceAssociationList", "documentation":"

The associations for the requested managed node.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeEffectivePatchesForPatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to retrieve the effective patches for.

" }, "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeEffectivePatchesForPatchBaselineResult":{ "type":"structure", "members":{ "EffectivePatches":{ "shape":"EffectivePatchList", "documentation":"

An array of patches and patch status.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstanceAssociationsStatusRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node IDs for which you want association status information.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeInstanceAssociationsStatusResult":{ "type":"structure", "members":{ "InstanceAssociationStatusInfos":{ "shape":"InstanceAssociationStatusInfos", "documentation":"

Status information about the association.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstanceInformationRequest":{ "type":"structure", "members":{ "InstanceInformationFilterList":{ "shape":"InstanceInformationFilterList", "documentation":"

This is a legacy method. We recommend that you don't use this method. Instead, use the `Filters` data type. `Filters` enables you to return node information by filtering based on tags applied to managed nodes.

Attempting to use `InstanceInformationFilterList` and `Filters` leads to an exception error.

" }, "Filters":{ "shape":"InstanceInformationStringFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be combined with other filter types. Use this `Filters` data type instead of `InstanceInformationFilterList`, which is deprecated.

" }, "MaxResults":{ "shape":"MaxResultsEC2Compatible", "documentation":"

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. The default value is 10 items.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeInstanceInformationResult":{ "type":"structure", "members":{ "InstanceInformationList":{ "shape":"InstanceInformationList", "documentation":"

The managed node information list.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstancePatchStatesForPatchGroupRequest":{ "type":"structure", "required":["PatchGroup"], "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group for which the patch state information should be retrieved.

" }, "Filters":{ "shape":"InstancePatchStateFilterList", "documentation":"

Each entry in the array is a structure containing:

- Key (string between 1 and 200 characters)

- Values (array containing a single string)

- Type (string \"Equal\", \"NotEqual\", \"LessThan\", \"GreaterThan\")

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"PatchComplianceMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true } } }, "DescribeInstancePatchStatesForPatchGroupResult":{ "type":"structure", "members":{ "InstancePatchStates":{ "shape":"InstancePatchStatesList", "documentation":"

The high-level patch state for the requested managed nodes.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstancePatchStatesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

The ID of the managed node for which patch state information should be retrieved.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"PatchComplianceMaxResults", "documentation":"

The maximum number of managed nodes to return (per page).

", "box":true } } }, "DescribeInstancePatchStatesResult":{ "type":"structure", "members":{ "InstancePatchStates":{ "shape":"InstancePatchStateList", "documentation":"

The high-level patch state for the requested managed nodes.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstancePatchesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the managed node whose patch state information should be retrieved.

" }, "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

Each element in the array is a structure containing a key-value pair.

Supported keys for `DescribeInstancePatches`include the following:

- `Classification`

  Sample values: `Security` | `SecurityUpdates`

- `KBId`

  Sample values: `KB4480056` | `java-1.7.0-openjdk.x86_64`

- `Severity`

  Sample values: `Important` | `Medium` | `Low`

- `State`

  Sample values: `Installed` | `InstalledOther` | `InstalledPendingReboot`

  For lists of all `State` values, see Understanding patch compliance state values in the Amazon Web Services Systems Manager User Guide.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"PatchComplianceMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true } } }, "DescribeInstancePatchesResult":{ "type":"structure", "members":{ "Patches":{ "shape":"PatchComplianceDataList", "documentation":"

Each entry in the array is a structure containing:

- Title (string)

- KBId (string)

- Classification (string)

- Severity (string)

- State (string, such as \"INSTALLED\" or \"FAILED\")

- InstalledTime (DateTime)

- InstalledBy (string)

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInventoryDeletionsRequest":{ "type":"structure", "members":{ "DeletionId":{ "shape":"UUID", "documentation":"

Specify the delete inventory ID for which you want information. This ID was returned by the `DeleteInventory` operation.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "DescribeInventoryDeletionsResult":{ "type":"structure", "members":{ "InventoryDeletions":{ "shape":"InventoryDeletionsList", "documentation":"

A list of status items for deleted inventory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "DescribeMaintenanceWindowExecutionTaskInvocationsRequest":{ "type":"structure", "required":[ "WindowExecutionId", "TaskId" ], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution the task is part of.

" }, "TaskId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task in the maintenance window task that should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to scope down the returned task invocations. The supported filter key is `STATUS` with the corresponding values `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and `CANCELLED`.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowExecutionTaskInvocationsResult":{ "type":"structure", "members":{ "WindowExecutionTaskInvocationIdentities":{ "shape":"MaintenanceWindowExecutionTaskInvocationIdentityList", "documentation":"

Information about the task invocation results per invocation.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowExecutionTasksRequest":{ "type":"structure", "required":["WindowExecutionId"], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution whose task executions should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to scope down the returned tasks. The supported filter key is `STATUS` with the corresponding values `PENDING`, `IN_PROGRESS`, `SUCCESS`, `FAILED`, `TIMED_OUT`, `CANCELLING`, and `CANCELLED`.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowExecutionTasksResult":{ "type":"structure", "members":{ "WindowExecutionTaskIdentities":{ "shape":"MaintenanceWindowExecutionTaskIdentityList", "documentation":"

Information about the task executions.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowExecutionsRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window whose executions should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Each entry in the array is a structure containing:

- Key. A string between 1 and 128 characters. Supported keys include `ExecutedBefore` and `ExecutedAfter`.

- 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 `2021-11-04T05:00:00Z`.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowExecutionsResult":{ "type":"structure", "members":{ "WindowExecutions":{ "shape":"MaintenanceWindowExecutionList", "documentation":"

Information about the maintenance window executions.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowScheduleRequest":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window to retrieve information about.

" }, "Targets":{ "shape":"Targets", "documentation":"

The managed node ID or key-value pair to retrieve information about.

" }, "ResourceType":{ "shape":"MaintenanceWindowResourceType", "documentation":"

The type of resource you want to retrieve information about. For example, `INSTANCE`.

" }, "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaintenanceWindowSearchMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowScheduleResult":{ "type":"structure", "members":{ "ScheduledWindowExecutions":{ "shape":"ScheduledWindowExecutionList", "documentation":"

Information about maintenance window executions scheduled for the specified time range.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You use this token in the next call.)

" } } }, "DescribeMaintenanceWindowTargetsRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window whose targets should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are `Type`, `WindowTargetId`, and `OwnerInformation`.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowTargetsResult":{ "type":"structure", "members":{ "Targets":{ "shape":"MaintenanceWindowTargetList", "documentation":"

Information about the targets in the maintenance window.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowTasksRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window whose tasks should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are `WindowTaskId`, `TaskArn`, `Priority`, and `TaskType`.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowTasksResult":{ "type":"structure", "members":{ "Tasks":{ "shape":"MaintenanceWindowTaskList", "documentation":"

Information about the tasks in the maintenance window.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowsForTargetRequest":{ "type":"structure", "required":[ "Targets", "ResourceType" ], "members":{ "Targets":{ "shape":"Targets", "documentation":"

The managed node ID or key-value pair to retrieve information about.

" }, "ResourceType":{ "shape":"MaintenanceWindowResourceType", "documentation":"

The type of resource you want to retrieve information about. For example, `INSTANCE`.

" }, "MaxResults":{ "shape":"MaintenanceWindowSearchMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowsForTargetResult":{ "type":"structure", "members":{ "WindowIdentities":{ "shape":"MaintenanceWindowsForTargetList", "documentation":"

Information about the maintenance window targets and tasks a managed node is associated with.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You use this token in the next call.)

" } } }, "DescribeMaintenanceWindowsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are `Name` and `Enabled`. For example, `Name=MyMaintenanceWindow` and `Enabled=True`.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowsResult":{ "type":"structure", "members":{ "WindowIdentities":{ "shape":"MaintenanceWindowIdentityList", "documentation":"

Information about the maintenance windows.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeOpsItemsRequest":{ "type":"structure", "members":{ "OpsItemFilters":{ "shape":"OpsItemFilters", "documentation":"

One or more filters to limit the response.

- Key: CreatedTime

  Operations: GreaterThan, LessThan

- Key: LastModifiedBy

  Operations: Contains, Equals

- Key: LastModifiedTime

  Operations: GreaterThan, LessThan

- Key: Priority

  Operations: Equals

- Key: Source

  Operations: Contains, Equals

- Key: Status

  Operations: Equals

- Key: Title*

  Operations: Equals,Contains

- Key: OperationalData**

  Operations: Equals

- Key: OperationalDataKey

  Operations: Equals

- Key: OperationalDataValue

  Operations: Equals, Contains

- Key: OpsItemId

  Operations: Equals

- Key: ResourceId

  Operations: Contains

- Key: AutomationId

  Operations: Equals

- Key: AccountId

  Operations: Equals

*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.

**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\"}

" }, "MaxResults":{ "shape":"OpsItemMaxResults", "documentation":"

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.

" }, "NextToken":{ "shape":"String", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "DescribeOpsItemsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" }, "OpsItemSummaries":{ "shape":"OpsItemSummaries", "documentation":"

A list of OpsItems.

" } } }, "DescribeParametersRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"ParametersFilterList", "documentation":"

This data type is deprecated. Instead, use `ParameterFilters`.

" }, "ParameterFilters":{ "shape":"ParameterStringFilterList", "documentation":"

Filters to limit the request results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeParametersResult":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterMetadataList", "documentation":"

Parameters returned by the request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items.

" } } }, "DescribePatchBaselinesRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

Each element in the array is a structure containing a key-value pair.

Supported keys for `DescribePatchBaselines` include the following:

- `NAME_PREFIX`

  Sample values: `AWS-` | `My-`

- `OWNER`

  Sample values: `AWS` | `Self`

- `OPERATING_SYSTEM`

  Sample values: `AMAZON_LINUX` | `SUSE` | `WINDOWS`

" }, "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patch baselines to return (per page).

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribePatchBaselinesResult":{ "type":"structure", "members":{ "BaselineIdentities":{ "shape":"PatchBaselineIdentityList", "documentation":"

An array of `PatchBaselineIdentity` elements.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribePatchGroupStateRequest":{ "type":"structure", "required":["PatchGroup"], "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group whose patch snapshot should be retrieved.

" } } }, "DescribePatchGroupStateResult":{ "type":"structure", "members":{ "Instances":{ "shape":"Integer", "documentation":"

The number of managed nodes in the patch group.

" }, "InstancesWithInstalledPatches":{ "shape":"Integer", "documentation":"

The number of managed nodes with installed patches.

" }, "InstancesWithInstalledOtherPatches":{ "shape":"Integer", "documentation":"

The number of managed nodes with patches installed that aren't defined in the patch baseline.

" }, "InstancesWithInstalledPendingRebootPatches":{ "shape":"InstancesCount", "documentation":"

The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these managed nodes is `NON_COMPLIANT`.

", "box":true }, "InstancesWithInstalledRejectedPatches":{ "shape":"InstancesCount", "documentation":"

The number of managed nodes with patches installed that are specified in a `RejectedPatches` list. Patches with a status of `INSTALLED_REJECTED` were typically installed before they were added to a `RejectedPatches` list.

If `ALLOW_AS_DEPENDENCY` is the specified option for `RejectedPatchesAction`, the value of `InstancesWithInstalledRejectedPatches` will always be `0` (zero).

", "box":true }, "InstancesWithMissingPatches":{ "shape":"Integer", "documentation":"

The number of managed nodes with missing patches from the patch baseline.

" }, "InstancesWithFailedPatches":{ "shape":"Integer", "documentation":"

The number of managed nodes with patches from the patch baseline that failed to install.

" }, "InstancesWithNotApplicablePatches":{ "shape":"Integer", "documentation":"

The number of managed nodes with patches that aren't applicable.

" }, "InstancesWithUnreportedNotApplicablePatches":{ "shape":"Integer", "documentation":"

The number of managed nodes with `NotApplicable` patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

", "box":true }, "InstancesWithCriticalNonCompliantPatches":{ "shape":"InstancesCount", "documentation":"

The number of managed nodes where patches that are specified as `Critical` 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 managed node reboot. The status of these managed nodes is `NON_COMPLIANT`.

", "box":true }, "InstancesWithSecurityNonCompliantPatches":{ "shape":"InstancesCount", "documentation":"

The number of managed nodes where patches that are specified as `Security` in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is `NON_COMPLIANT`.

", "box":true }, "InstancesWithOtherNonCompliantPatches":{ "shape":"InstancesCount", "documentation":"

The number of managed nodes with patches installed that are specified as other than `Critical` or `Security` but aren't compliant with the patch baseline. The status of these managed nodes is `NON_COMPLIANT`.

", "box":true } } }, "DescribePatchGroupsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patch groups to return (per page).

", "box":true }, "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

Each element in the array is a structure containing a key-value pair.

Supported keys for `DescribePatchGroups` include the following:

- `NAME_PREFIX`

  Sample values: `AWS-` | `My-`.

- `OPERATING_SYSTEM`

  Sample values: `AMAZON_LINUX` | `SUSE` | `WINDOWS`

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribePatchGroupsResult":{ "type":"structure", "members":{ "Mappings":{ "shape":"PatchGroupPatchBaselineMappingList", "documentation":"

Each entry in the array contains:

- `PatchGroup`: string (between 1 and 256 characters. Regex: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$)`

- `PatchBaselineIdentity`: A `PatchBaselineIdentity` element.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribePatchPropertiesRequest":{ "type":"structure", "required":[ "OperatingSystem", "Property" ], "members":{ "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

The operating system type for which to list patches.

" }, "Property":{ "shape":"PatchProperty", "documentation":"

The patch property for which you want to view patch details.

" }, "PatchSet":{ "shape":"PatchSet", "documentation":"

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.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribePatchPropertiesResult":{ "type":"structure", "members":{ "Properties":{ "shape":"PatchPropertiesList", "documentation":"

A list of the properties for patches matching the filter request parameters.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You use this token in the next call.)

" } } }, "DescribeSessionsRequest":{ "type":"structure", "required":["State"], "members":{ "State":{ "shape":"SessionState", "documentation":"

The session status to retrieve a list of sessions for. For example, \"Active\".

" }, "MaxResults":{ "shape":"SessionMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "Filters":{ "shape":"SessionFilterList", "documentation":"

One or more filters to limit the type of sessions returned by the request.

" } } }, "DescribeSessionsResponse":{ "type":"structure", "members":{ "Sessions":{ "shape":"SessionList", "documentation":"

A list of sessions meeting the request parameters.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescriptionInDocument":{"type":"string"}, "DisassociateOpsItemRelatedItemRequest":{ "type":"structure", "required":[ "OpsItemId", "AssociationId" ], "members":{ "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.

" }, "AssociationId":{ "shape":"OpsItemRelatedItemAssociationId", "documentation":"

The ID of the association for which you want to delete an association between the OpsItem and a related item.

" } } }, "DisassociateOpsItemRelatedItemResponse":{ "type":"structure", "members":{ } }, "DocumentARN":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.:/]{3,128}$" }, "DocumentAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified document already exists.

", "exception":true }, "DocumentAuthor":{"type":"string"}, "DocumentContent":{ "type":"string", "min":1 }, "DocumentDefaultVersionDescription":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document.

" }, "DefaultVersion":{ "shape":"DocumentVersion", "documentation":"

The default version of the document.

" }, "DefaultVersionName":{ "shape":"DocumentVersionName", "documentation":"

The default version of the artifact associated with the document.

" } }, "documentation":"

A default version of a document.

" }, "DocumentDescription":{ "type":"structure", "members":{ "Sha1":{ "shape":"DocumentSha1", "documentation":"

The SHA1 hash of the document, which you can use for verification.

" }, "Hash":{ "shape":"DocumentHash", "documentation":"

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

" }, "HashType":{ "shape":"DocumentHashType", "documentation":"

The hash type of the document. Valid values include `Sha256` or `Sha1`.

Sha1 hashes have been deprecated.

" }, "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "DisplayName":{ "shape":"DocumentDisplayName", "documentation":"

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

The version of the artifact associated with the document.

" }, "Owner":{ "shape":"DocumentOwner", "documentation":"

The Amazon Web Services user that created the document.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date when the document was created.

" }, "Status":{ "shape":"DocumentStatus", "documentation":"

The status of the SSM document.

" }, "StatusInformation":{ "shape":"DocumentStatusInformation", "documentation":"

A message returned by Amazon Web Services Systems Manager that explains the `Status` value. For example, a `Failed` status might be explained by the `StatusInformation` message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "Description":{ "shape":"DescriptionInDocument", "documentation":"

A description of the document.

" }, "Parameters":{ "shape":"DocumentParameterList", "documentation":"

A description of the parameters for a document.

" }, "PlatformTypes":{ "shape":"PlatformTypeList", "documentation":"

The list of operating system (OS) platforms compatible with this SSM document.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The type of document.

" }, "SchemaVersion":{ "shape":"DocumentSchemaVersion", "documentation":"

The schema version.

" }, "LatestVersion":{ "shape":"DocumentVersion", "documentation":"

The latest version of the document.

" }, "DefaultVersion":{ "shape":"DocumentVersion", "documentation":"

The default version.

" }, "DocumentFormat":{ "shape":"DocumentFormat", "documentation":"

The document format, either JSON or YAML.

" }, "TargetType":{ "shape":"TargetType", "documentation":"

The target type which defines the kinds of resources the document can run on. For example, `/AWS::EC2::Instance`. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags, or metadata, that have been applied to the document.

" }, "AttachmentsInformation":{ "shape":"AttachmentInformationList", "documentation":"

Details about the document attachments, including names, locations, sizes, and so on.

" }, "Requires":{ "shape":"DocumentRequiresList", "documentation":"

A list of SSM documents required by a document. For example, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document.

" }, "Author":{ "shape":"DocumentAuthor", "documentation":"

The user in your organization who created the document.

" }, "ReviewInformation":{ "shape":"ReviewInformationList", "documentation":"

Details about the review of a document.

" }, "ApprovedVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the document currently approved for use in the organization.

" }, "PendingReviewVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the document that is currently under review.

" }, "ReviewStatus":{ "shape":"ReviewStatus", "documentation":"

The current status of the review.

" }, "Category":{ "shape":"CategoryList", "documentation":"

The classification of a document to help you identify and categorize its use.

" }, "CategoryEnum":{ "shape":"CategoryEnumList", "documentation":"

The value that identifies a document's category.

" } }, "documentation":"

Describes an Amazon Web Services Systems Manager document (SSM document).

" }, "DocumentDisplayName":{ "type":"string", "max":1024, "pattern":"^[\\w\\.\\-\\:\\/ ]*$" }, "DocumentFilter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"DocumentFilterKey", "documentation":"

The name of the filter.

" }, "value":{ "shape":"DocumentFilterValue", "documentation":"

The value of the filter.

" } }, "documentation":"

This data type is deprecated. Instead, use DocumentKeyValuesFilter.

" }, "DocumentFilterKey":{ "type":"string", "enum":[ "Name", "Owner", "PlatformTypes", "DocumentType" ] }, "DocumentFilterList":{ "type":"list", "member":{"shape":"DocumentFilter"}, "min":1 }, "DocumentFilterValue":{ "type":"string", "min":1 }, "DocumentFormat":{ "type":"string", "enum":[ "YAML", "JSON", "TEXT" ] }, "DocumentHash":{ "type":"string", "max":256 }, "DocumentHashType":{ "type":"string", "enum":[ "Sha256", "Sha1" ] }, "DocumentIdentifier":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the SSM document was created.

" }, "DisplayName":{ "shape":"DocumentDisplayName", "documentation":"

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 UpdateDocument.

" }, "Owner":{ "shape":"DocumentOwner", "documentation":"

The Amazon Web Services user that created the document.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

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.

" }, "PlatformTypes":{ "shape":"PlatformTypeList", "documentation":"

The operating system platform.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The document type.

" }, "SchemaVersion":{ "shape":"DocumentSchemaVersion", "documentation":"

The schema version.

" }, "DocumentFormat":{ "shape":"DocumentFormat", "documentation":"

The document format, either JSON or YAML.

" }, "TargetType":{ "shape":"TargetType", "documentation":"

The target type which defines the kinds of resources the document can run on. For example, `/AWS::EC2::Instance`. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags, or metadata, that have been applied to the document.

" }, "Requires":{ "shape":"DocumentRequiresList", "documentation":"

A list of SSM documents required by a document. For example, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document.

" }, "ReviewStatus":{ "shape":"ReviewStatus", "documentation":"

The current status of a document review.

" }, "Author":{ "shape":"DocumentAuthor", "documentation":"

The user in your organization who created the document.

" } }, "documentation":"

Describes the name of a SSM document.

" }, "DocumentIdentifierList":{ "type":"list", "member":{"shape":"DocumentIdentifier"} }, "DocumentKeyValuesFilter":{ "type":"structure", "members":{ "Key":{ "shape":"DocumentKeyValuesFilterKey", "documentation":"

The name of the filter key.

" }, "Values":{ "shape":"DocumentKeyValuesFilterValues", "documentation":"

The value for the filter key.

" } }, "documentation":"

One or more filters. Use a filter to return a more specific list of documents.

For keys, you can specify one or more tags that have been applied to a document.

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:

DocumentType

  - `ApplicationConfiguration`

  - `ApplicationConfigurationSchema`

  - `Automation`

  - `ChangeCalendar`

  - `Command`

  - `Package`

  - `Policy`

  - `Session`

Owner

  Note that only one `Owner` can be specified in a request. For example: `Key=Owner,Values=Self`.

  - `Amazon`

  - `Private`

  - `Public`

  - `Self`

  - `ThirdParty`

PlatformTypes

  - `Linux`

  - `Windows`

`Name` is another Amazon Web Services-provided key. If you use `Name` 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 `Te`, run the following command:

`aws ssm list-documents --filters Key=Name,Values=Te`

You can also use the `TargetType` Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

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.

To specify a custom key-value pair, use the format `Key=tag:tagName,Values=valueName`.

For example, if you created a key called region and are using the Amazon Web Services CLI to call the `list-documents` command:

`aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self`

" }, "DocumentKeyValuesFilterKey":{ "type":"string", "max":128, "min":1 }, "DocumentKeyValuesFilterList":{ "type":"list", "member":{"shape":"DocumentKeyValuesFilter"}, "max":6, "min":0 }, "DocumentKeyValuesFilterValue":{ "type":"string", "max":256, "min":1 }, "DocumentKeyValuesFilterValues":{ "type":"list", "member":{"shape":"DocumentKeyValuesFilterValue"} }, "DocumentLimitExceeded":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You can have at most 500 active SSM documents.

", "exception":true }, "DocumentMetadataEnum":{ "type":"string", "enum":["DocumentReviews"] }, "DocumentMetadataResponseInfo":{ "type":"structure", "members":{ "ReviewerResponse":{ "shape":"DocumentReviewerResponseList", "documentation":"

Details about a reviewer's response to a document review request.

" } }, "documentation":"

Details about the response to a document review request.

" }, "DocumentName":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "DocumentOwner":{"type":"string"}, "DocumentParameter":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentParameterName", "documentation":"

The name of the parameter.

" }, "Type":{ "shape":"DocumentParameterType", "documentation":"

The type of parameter. The type can be either String or StringList.

" }, "Description":{ "shape":"DocumentParameterDescrption", "documentation":"

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

" }, "DefaultValue":{ "shape":"DocumentParameterDefaultValue", "documentation":"

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

" } }, "documentation":"

Parameters specified in a Systems Manager document that run on the server when the command is run.

" }, "DocumentParameterDefaultValue":{"type":"string"}, "DocumentParameterDescrption":{"type":"string"}, "DocumentParameterList":{ "type":"list", "member":{"shape":"DocumentParameter"} }, "DocumentParameterName":{"type":"string"}, "DocumentParameterType":{ "type":"string", "enum":[ "String", "StringList" ] }, "DocumentPermissionLimit":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.

By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.

If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.

", "exception":true }, "DocumentPermissionMaxResults":{ "type":"integer", "max":200, "min":1 }, "DocumentPermissionType":{ "type":"string", "enum":["Share"] }, "DocumentRequires":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

" }, "Version":{ "shape":"DocumentVersion", "documentation":"

The document version required by the current document.

" }, "RequireType":{ "shape":"RequireType", "documentation":"

The document type of the required SSM document.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

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.

" } }, "documentation":"

An SSM document required by the current document.

" }, "DocumentRequiresList":{ "type":"list", "member":{"shape":"DocumentRequires"}, "min":1 }, "DocumentReviewAction":{ "type":"string", "enum":[ "SendForReview", "UpdateReview", "Approve", "Reject" ] }, "DocumentReviewComment":{ "type":"string", "max":1024, "min":1, "pattern":"^(?!\\s*$).+" }, "DocumentReviewCommentList":{ "type":"list", "member":{"shape":"DocumentReviewCommentSource"}, "max":1, "min":0 }, "DocumentReviewCommentSource":{ "type":"structure", "members":{ "Type":{ "shape":"DocumentReviewCommentType", "documentation":"

The type of information added to a review request. Currently, only the value `Comment` is supported.

" }, "Content":{ "shape":"DocumentReviewComment", "documentation":"

The content of a comment entered by a user who requests a review of a new document version, or who reviews the new version.

" } }, "documentation":"

Information about comments added to a document review request.

" }, "DocumentReviewCommentType":{ "type":"string", "enum":["Comment"] }, "DocumentReviewerResponseList":{ "type":"list", "member":{"shape":"DocumentReviewerResponseSource"} }, "DocumentReviewerResponseSource":{ "type":"structure", "members":{ "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time that a reviewer entered a response to a document review request.

" }, "UpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time that a reviewer last updated a response to a document review request.

" }, "ReviewStatus":{ "shape":"ReviewStatus", "documentation":"

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.

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.

Only one version of a document can be in review, or PENDING, at a time.

" }, "Comment":{ "shape":"DocumentReviewCommentList", "documentation":"

The comment entered by a reviewer as part of their document review response.

" }, "Reviewer":{ "shape":"Reviewer", "documentation":"

The user in your organization assigned to review a document request.

" } }, "documentation":"

Information about a reviewer's response to a document review request.

" }, "DocumentReviews":{ "type":"structure", "required":["Action"], "members":{ "Action":{ "shape":"DocumentReviewAction", "documentation":"

The action to take on a document approval review request.

" }, "Comment":{ "shape":"DocumentReviewCommentList", "documentation":"

A comment entered by a user in your organization about the document review request.

" } }, "documentation":"

Information about a document approval review.

" }, "DocumentSchemaVersion":{ "type":"string", "pattern":"([0-9]+)\\.([0-9]+)" }, "DocumentSha1":{"type":"string"}, "DocumentStatus":{ "type":"string", "documentation":"

The status of a document.

", "enum":[ "Creating", "Active", "Updating", "Deleting", "Failed" ] }, "DocumentStatusInformation":{"type":"string"}, "DocumentType":{ "type":"string", "enum":[ "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", "Automation.ChangeTemplate", "ProblemAnalysis", "ProblemAnalysisTemplate", "CloudFormation", "ConformancePackTemplate", "QuickSetup" ] }, "DocumentVersion":{ "type":"string", "pattern":"([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)" }, "DocumentVersionInfo":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The document name.

" }, "DisplayName":{ "shape":"DocumentDisplayName", "documentation":"

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

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.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the document was created.

" }, "IsDefaultVersion":{ "shape":"Boolean", "documentation":"

An identifier for the default version of the document.

" }, "DocumentFormat":{ "shape":"DocumentFormat", "documentation":"

The document format, either JSON or YAML.

" }, "Status":{ "shape":"DocumentStatus", "documentation":"

The status of the SSM document, such as `Creating`, `Active`, `Failed`, and `Deleting`.

" }, "StatusInformation":{ "shape":"DocumentStatusInformation", "documentation":"

A message returned by Amazon Web Services Systems Manager that explains the `Status` value. For example, a `Failed` status might be explained by the `StatusInformation` message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"

" }, "ReviewStatus":{ "shape":"ReviewStatus", "documentation":"

The current status of the approval review for the latest version of the document.

" } }, "documentation":"

Version information about the document.

" }, "DocumentVersionLimitExceeded":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document has too many versions. Delete one or more document versions and try again.

", "exception":true }, "DocumentVersionList":{ "type":"list", "member":{"shape":"DocumentVersionInfo"}, "min":1 }, "DocumentVersionName":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.]{1,128}$" }, "DocumentVersionNumber":{ "type":"string", "pattern":"(^[1-9][0-9]*$)" }, "DoesNotExistException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

", "exception":true }, "DryRun":{"type":"boolean"}, "DuplicateDocumentContent":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The content of the association document matches another document. Change the content of the document and try again.

", "exception":true }, "DuplicateDocumentVersionName":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The version name has already been used in this document. Specify a different version name, and then try again.

", "exception":true }, "DuplicateInstanceId":{ "type":"structure", "members":{ }, "documentation":"

You can't specify a managed node ID in more than one association.

", "exception":true }, "EffectiveInstanceAssociationMaxResults":{ "type":"integer", "max":5, "min":1 }, "EffectivePatch":{ "type":"structure", "members":{ "Patch":{ "shape":"Patch", "documentation":"

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.

" }, "PatchStatus":{ "shape":"PatchStatus", "documentation":"

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.

" } }, "documentation":"

The `EffectivePatch` 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.

" }, "EffectivePatchList":{ "type":"list", "member":{"shape":"EffectivePatch"} }, "ErrorCount":{"type":"integer"}, "ExecutionMode":{ "type":"string", "enum":[ "Auto", "Interactive" ] }, "ExecutionRoleName":{ "type":"string", "max":64, "min":1, "pattern":"[\\w+=,.@/-]+" }, "ExpirationDate":{"type":"timestamp"}, "ExternalAlarmState":{ "type":"string", "enum":[ "UNKNOWN", "ALARM" ] }, "FailedCreateAssociation":{ "type":"structure", "members":{ "Entry":{ "shape":"CreateAssociationBatchRequestEntry", "documentation":"

The association.

" }, "Message":{ "shape":"BatchErrorMessage", "documentation":"

A description of the failure.

" }, "Fault":{ "shape":"Fault", "documentation":"

The source of the failure.

" } }, "documentation":"

Describes a failed association.

" }, "FailedCreateAssociationList":{ "type":"list", "member":{"shape":"FailedCreateAssociation"} }, "FailureDetails":{ "type":"structure", "members":{ "FailureStage":{ "shape":"String", "documentation":"

The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

" }, "FailureType":{ "shape":"String", "documentation":"

The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

" }, "Details":{ "shape":"AutomationParameterMap", "documentation":"

Detailed information about the Automation step failure.

" } }, "documentation":"

Information about an Automation failure.

" }, "Fault":{ "type":"string", "enum":[ "Client", "Server", "Unknown" ] }, "FeatureNotAvailableException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You attempted to register a `LAMBDA` or `STEP_FUNCTIONS` task in a region where the corresponding service isn't available.

", "exception":true }, "GetAutomationExecutionRequest":{ "type":"structure", "required":["AutomationExecutionId"], "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

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.

" } } }, "GetAutomationExecutionResult":{ "type":"structure", "members":{ "AutomationExecution":{ "shape":"AutomationExecution", "documentation":"

Detailed information about the current state of an automation execution.

" } } }, "GetCalendarStateRequest":{ "type":"structure", "required":["CalendarNames"], "members":{ "CalendarNames":{ "shape":"CalendarNameOrARNList", "documentation":"

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.

" }, "AtTime":{ "shape":"ISO8601String", "documentation":"

(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or `AtTime`, the current time is used.

" } } }, "GetCalendarStateResponse":{ "type":"structure", "members":{ "State":{ "shape":"CalendarState", "documentation":"

The state of the calendar. An `OPEN` calendar indicates that actions are allowed to proceed, and a `CLOSED` calendar indicates that actions aren't allowed to proceed.

" }, "AtTime":{ "shape":"ISO8601String", "documentation":"

The time, as an ISO 8601 string, that you specified in your command. If you don't specify a time, `GetCalendarState` uses the current time.

" }, "NextTransitionTime":{ "shape":"ISO8601String", "documentation":"

The time, as an ISO 8601 string, that the calendar state will change. If the current calendar state is `OPEN`, `NextTransitionTime` indicates when the calendar state changes to `CLOSED`, and vice-versa.

" } } }, "GetCommandInvocationRequest":{ "type":"structure", "required":[ "CommandId", "InstanceId" ], "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

(Required) The parent command ID of the invocation plugin.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

(Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

" }, "PluginName":{ "shape":"CommandPluginName", "documentation":"

The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like `aws:RunShellScript`.

To find the `PluginName`, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the `CommandId` and `Details` parameters. The `PluginName` is the `Name` attribute of the `CommandPlugin` object in the `CommandPlugins` list.

" } } }, "GetCommandInvocationResult":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

The parent command ID of the invocation plugin.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

" }, "Comment":{ "shape":"Comment", "documentation":"

The comment text for the command.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the document that was run. For example, `AWS-RunShellScript`.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The Systems Manager document (SSM document) version used in the request.

" }, "PluginName":{ "shape":"CommandPluginName", "documentation":"

The name of the plugin, or step name, for which details are reported. For example, `aws:RunShellScript` is a plugin.

" }, "ResponseCode":{ "shape":"ResponseCode", "documentation":"

The error level response code for the plugin script. If the response code is `-1`, then the command hasn't started running on the managed node, or it wasn't received by the node.

" }, "ExecutionStartDateTime":{ "shape":"StringDateTime", "documentation":"

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 `InvokedBefore` filter.

`aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z`

If the plugin hasn't started to run, the string is empty.

" }, "ExecutionElapsedTime":{ "shape":"StringDateTime", "documentation":"

Duration since `ExecutionStartDateTime`.

" }, "ExecutionEndDateTime":{ "shape":"StringDateTime", "documentation":"

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 `InvokedAfter` filter.

`aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z`

If the plugin hasn't started to run, the string is empty.

" }, "Status":{ "shape":"CommandInvocationStatus", "documentation":"

The status of this invocation plugin. This status can be different than `StatusDetails`.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the command execution for an invocation. `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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. `StatusDetails` can be one of the following values:

- Pending: The command hasn't been sent to the managed node.

- In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

- Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.

- Success: The command or plugin ran successfully. This is a terminal state.

- Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's `MaxErrors` limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

- Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the `MaxErrors` limit of the parent command. This is a terminal state.

- Failed: The command wasn't run successfully on the managed node. 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.

- Cancelled: The command was terminated before it was completed. This is a terminal state.

- Undeliverable: The command can't be delivered to the managed node. The node 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.

- Terminated: The parent command exceeded its `MaxErrors` limit and subsequent command invocations were canceled by the system. This is a terminal state.

" }, "StandardOutputContent":{ "shape":"StandardOutputContent", "documentation":"

The first 24,000 characters written by the plugin to `stdout`. If the command hasn't finished running, if `ExecutionStatus` is neither Succeeded nor Failed, then this string is empty.

" }, "StandardOutputUrl":{ "shape":"Url", "documentation":"

The URL for the complete text written by the plugin to `stdout` in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.

" }, "StandardErrorContent":{ "shape":"StandardErrorContent", "documentation":"

The first 8,000 characters written by the plugin to `stderr`. If the command hasn't finished running, then this string is empty.

" }, "StandardErrorUrl":{ "shape":"Url", "documentation":"

The URL for the complete text written by the plugin to `stderr`. If the command hasn't finished running, then this string is empty.

" }, "CloudWatchOutputConfig":{ "shape":"CloudWatchOutputConfig", "documentation":"

Amazon CloudWatch Logs information where Systems Manager sent the command output.

" } } }, "GetConnectionStatusRequest":{ "type":"structure", "required":["Target"], "members":{ "Target":{ "shape":"SessionTarget", "documentation":"

The managed node ID.

" } } }, "GetConnectionStatusResponse":{ "type":"structure", "members":{ "Target":{ "shape":"SessionTarget", "documentation":"

The ID of the managed node to check connection status.

" }, "Status":{ "shape":"ConnectionStatus", "documentation":"

The status of the connection to the managed node. For example, 'Connected' or 'Not Connected'.

" } } }, "GetDefaultPatchBaselineRequest":{ "type":"structure", "members":{ "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Returns the default patch baseline for the specified operating system.

" } } }, "GetDefaultPatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the default patch baseline.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

The operating system for the returned patch baseline.

" } } }, "GetDeployablePatchSnapshotForInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "SnapshotId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the managed node for which the appropriate patch snapshot should be retrieved.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The snapshot ID provided by the user when running `AWS-RunPatchBaseline`.

" }, "BaselineOverride":{ "shape":"BaselineOverride", "documentation":"

Defines the basic information about a patch baseline override.

" } } }, "GetDeployablePatchSnapshotForInstanceResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The user-defined snapshot ID.

" }, "SnapshotDownloadUrl":{ "shape":"SnapshotDownloadUrl", "documentation":"

A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.

" }, "Product":{ "shape":"Product", "documentation":"

Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot.

" } } }, "GetDocumentRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

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.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version for which you want information.

" }, "DocumentFormat":{ "shape":"DocumentFormat", "documentation":"

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

" } } }, "GetDocumentResult":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the SSM document was created.

" }, "DisplayName":{ "shape":"DocumentDisplayName", "documentation":"

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

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.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "Status":{ "shape":"DocumentStatus", "documentation":"

The status of the SSM document, such as `Creating`, `Active`, `Updating`, `Failed`, and `Deleting`.

" }, "StatusInformation":{ "shape":"DocumentStatusInformation", "documentation":"

A message returned by Amazon Web Services Systems Manager that explains the `Status` value. For example, a `Failed` status might be explained by the `StatusInformation` message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\"

" }, "Content":{ "shape":"DocumentContent", "documentation":"

The contents of the SSM document.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The document type.

" }, "DocumentFormat":{ "shape":"DocumentFormat", "documentation":"

The document format, either JSON or YAML.

" }, "Requires":{ "shape":"DocumentRequiresList", "documentation":"

A list of SSM documents required by a document. For example, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document.

" }, "AttachmentsContent":{ "shape":"AttachmentContentList", "documentation":"

A description of the document attachments, including names, locations, sizes, and so on.

" }, "ReviewStatus":{ "shape":"ReviewStatus", "documentation":"

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.

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.

Only one version of an SSM document can be in review, or PENDING, at a time.

" } } }, "GetInventoryRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"InventoryFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "Aggregators":{ "shape":"InventoryAggregatorList", "documentation":"

Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the `AWS:InstanceInformation.PlatformType` type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.

" }, "ResultAttributes":{ "shape":"ResultAttributeList", "documentation":"

The list of inventory item types to return.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "GetInventoryResult":{ "type":"structure", "members":{ "Entities":{ "shape":"InventoryResultEntityList", "documentation":"

Collection of inventory entities such as a collection of managed node inventory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "GetInventorySchemaMaxResults":{ "type":"integer", "max":200, "min":50 }, "GetInventorySchemaRequest":{ "type":"structure", "members":{ "TypeName":{ "shape":"InventoryItemTypeNameFilter", "documentation":"

The type of inventory item to return.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"GetInventorySchemaMaxResults", "documentation":"

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.

", "box":true }, "Aggregator":{ "shape":"AggregatorSchemaOnly", "documentation":"

Returns inventory schemas that support aggregation. For example, this call returns the `AWS:InstanceInformation` type, because it supports aggregation based on the `PlatformName`, `PlatformType`, and `PlatformVersion` attributes.

" }, "SubType":{ "shape":"IsSubTypeSchema", "documentation":"

Returns the sub-type schema for a specified inventory type.

", "box":true } } }, "GetInventorySchemaResult":{ "type":"structure", "members":{ "Schemas":{ "shape":"InventoryItemSchemaResultList", "documentation":"

Inventory schemas returned by the request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "GetMaintenanceWindowExecutionRequest":{ "type":"structure", "required":["WindowExecutionId"], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution that includes the task.

" } } }, "GetMaintenanceWindowExecutionResult":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution.

" }, "TaskIds":{ "shape":"MaintenanceWindowExecutionTaskIdList", "documentation":"

The ID of the task executions from the maintenance window execution.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the maintenance window execution.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status. Not available for all status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the maintenance window started running.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the maintenance window finished running.

" } } }, "GetMaintenanceWindowExecutionTaskInvocationRequest":{ "type":"structure", "required":[ "WindowExecutionId", "TaskId", "InvocationId" ], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution for which the task is a part.

" }, "TaskId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task in the maintenance window task that should be retrieved.

" }, "InvocationId":{ "shape":"MaintenanceWindowExecutionTaskInvocationId", "documentation":"

The invocation ID to retrieve.

" } } }, "GetMaintenanceWindowExecutionTaskInvocationResult":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The maintenance window execution ID.

" }, "TaskExecutionId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The task execution ID.

" }, "InvocationId":{ "shape":"MaintenanceWindowExecutionTaskInvocationId", "documentation":"

The invocation ID.

" }, "ExecutionId":{ "shape":"MaintenanceWindowExecutionTaskExecutionId", "documentation":"

The execution ID.

" }, "TaskType":{ "shape":"MaintenanceWindowTaskType", "documentation":"

Retrieves the task type for a maintenance window.

" }, "Parameters":{ "shape":"MaintenanceWindowExecutionTaskInvocationParameters", "documentation":"

The parameters used at the time that the task ran.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The task status for an invocation.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status. Details are only available for certain status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time that the task started running on the target.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time that the task finished running on the target.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

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.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTaskTargetId", "documentation":"

The maintenance window target ID.

" } } }, "GetMaintenanceWindowExecutionTaskRequest":{ "type":"structure", "required":[ "WindowExecutionId", "TaskId" ], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution that includes the task.

" }, "TaskId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the maintenance window task that should be retrieved.

" } } }, "GetMaintenanceWindowExecutionTaskResult":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution that includes the task.

" }, "TaskExecutionId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the maintenance window task that was retrieved.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The Amazon Resource Name (ARN) of the task that ran.

" }, "ServiceRole":{ "shape":"ServiceRole", "documentation":"

The role that was assumed when running the task.

" }, "Type":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task that was run.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParametersList", "documentation":"

The parameters passed to the task when it was run.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

- `Key`: string, between 1 and 255 characters

- `Value`: an array of strings, each between 1 and 255 characters

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

The priority of the task.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The defined maximum number of task executions that could be run in parallel.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the task.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status. Not available for all status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the task execution started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the task execution completed.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm you applied to your maintenance window task.

" }, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarms that were invoked by the maintenance window task.

" } } }, "GetMaintenanceWindowRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window for which you want to retrieve information.

" } } }, "GetMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the created maintenance window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the maintenance window.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

The description of the maintenance window.

" }, "StartDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

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.

" }, "EndDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

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.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the maintenance window in the form of a cron or rate expression.

" }, "ScheduleTimezone":{ "shape":"MaintenanceWindowTimezone", "documentation":"

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 Time Zone Database on the IANA website.

" }, "ScheduleOffset":{ "shape":"MaintenanceWindowOffset", "documentation":"

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

", "box":true }, "NextExecutionTime":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

" }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the maintenance window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

" }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

" }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Indicates whether the maintenance window is enabled.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the maintenance window was created.

" }, "ModifiedDate":{ "shape":"DateTime", "documentation":"

The date the maintenance window was last modified.

" } } }, "GetMaintenanceWindowTaskRequest":{ "type":"structure", "required":[ "WindowId", "WindowTaskId" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The maintenance window ID that includes the task to retrieve.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The maintenance window task ID to retrieve.

" } } }, "GetMaintenanceWindowTaskResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The retrieved maintenance window ID.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The retrieved maintenance window task ID.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets where the task should run.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The resource that the task used during execution. For `RUN_COMMAND` and `AUTOMATION` task types, the value of `TaskArn` is the SSM document name/ARN. For `LAMBDA` tasks, the value is the function name/ARN. For `STEP_FUNCTIONS` tasks, the value is the state machine ARN.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

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.

" }, "TaskType":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task to run.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParameters", "documentation":"

The parameters to pass to the task when it runs.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "TaskInvocationParameters":{ "shape":"MaintenanceWindowTaskInvocationParameters", "documentation":"

The parameters to pass to the task when it runs.

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

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.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The maximum number of targets allowed to run this task in parallel.

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 `1`, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The maximum number of errors allowed before the task stops being scheduled.

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 `1`, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

" }, "LoggingInfo":{ "shape":"LoggingInfo", "documentation":"

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The retrieved task name.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

The retrieved task description.

" }, "CutoffBehavior":{ "shape":"MaintenanceWindowTaskCutoffBehavior", "documentation":"

The action to take on tasks when the maintenance window cutoff time is reached. `CONTINUE_TASK` means that tasks continue to run. For Automation, Lambda, Step Functions tasks, `CANCEL_TASK` means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, `CANCEL_TASK` means the system attempts to stop the task by sending a `CancelCommand` operation.

", "box":true }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm you applied to your maintenance window task.

" } } }, "GetOpsItemRequest":{ "type":"structure", "required":["OpsItemId"], "members":{ "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem that you want to get.

" }, "OpsItemArn":{ "shape":"OpsItemArn", "documentation":"

The OpsItem Amazon Resource Name (ARN).

" } } }, "GetOpsItemResponse":{ "type":"structure", "members":{ "OpsItem":{ "shape":"OpsItem", "documentation":"

The OpsItem.

" } } }, "GetOpsMetadataMaxResults":{ "type":"integer", "max":10, "min":1 }, "GetOpsMetadataRequest":{ "type":"structure", "required":["OpsMetadataArn"], "members":{ "OpsMetadataArn":{ "shape":"OpsMetadataArn", "documentation":"

The Amazon Resource Name (ARN) of an OpsMetadata Object to view.

" }, "MaxResults":{ "shape":"GetOpsMetadataMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "GetOpsMetadataResult":{ "type":"structure", "members":{ "ResourceId":{ "shape":"OpsMetadataResourceId", "documentation":"

The resource ID of the Application Manager application.

" }, "Metadata":{ "shape":"MetadataMap", "documentation":"

OpsMetadata for an Application Manager application.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "GetOpsSummaryRequest":{ "type":"structure", "members":{ "SyncName":{ "shape":"ResourceDataSyncName", "documentation":"

Specify the name of a resource data sync to get.

" }, "Filters":{ "shape":"OpsFilterList", "documentation":"

Optional filters used to scope down the returned OpsData.

" }, "Aggregators":{ "shape":"OpsAggregatorList", "documentation":"

Optional aggregators that return counts of OpsData based on one or more expressions.

" }, "ResultAttributes":{ "shape":"OpsResultAttributeList", "documentation":"

The OpsData data type to return.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "GetOpsSummaryResult":{ "type":"structure", "members":{ "Entities":{ "shape":"OpsEntityList", "documentation":"

The list of aggregated details and filtered OpsData.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "GetParameterHistoryRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter for which you want to review history.

" }, "WithDecryption":{ "shape":"Boolean", "documentation":"

Return decrypted values for secure string parameters. This flag is ignored for `String` and `StringList` parameter types.

", "box":true }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "GetParameterHistoryResult":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterHistoryList", "documentation":"

A list of parameters returned by the request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "GetParameterRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter you want to query.

To query by parameter label, use `\"Name\": \"name:label\"`. To query by parameter version, use `\"Name\": \"name:version\"`.

" }, "WithDecryption":{ "shape":"Boolean", "documentation":"

Return decrypted values for secure string parameters. This flag is ignored for `String` and `StringList` parameter types.

", "box":true } } }, "GetParameterResult":{ "type":"structure", "members":{ "Parameter":{ "shape":"Parameter", "documentation":"

Information about a parameter.

" } } }, "GetParametersByPathMaxResults":{ "type":"integer", "max":10, "min":1 }, "GetParametersByPathRequest":{ "type":"structure", "required":["Path"], "members":{ "Path":{ "shape":"PSParameterName", "documentation":"

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, 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: `/Finance/Prod/IAD/WinServ2016/license33`

" }, "Recursive":{ "shape":"Boolean", "documentation":"

Retrieve all parameters within a hierarchy.

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 `/a`, then the user can also access `/a/b`. Even if a user has explicitly been denied access in IAM for parameter `/a/b`, they can still call the GetParametersByPath API operation recursively for `/a` and view `/a/b`.

", "box":true }, "ParameterFilters":{ "shape":"ParameterStringFilterList", "documentation":"

Filters to limit the request results.

The following `Key` values are supported for `GetParametersByPath`: `Type`, `KeyId`, and `Label`.

The following `Key` values aren't supported for `GetParametersByPath`: `tag`, `DataType`, `Name`, `Path`, and `Tier`.

" }, "WithDecryption":{ "shape":"Boolean", "documentation":"

Retrieve all parameters in a hierarchy with their value decrypted.

", "box":true }, "MaxResults":{ "shape":"GetParametersByPathMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "GetParametersByPathResult":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterList", "documentation":"

A list of parameters found in the specified hierarchy.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "GetParametersRequest":{ "type":"structure", "required":["Names"], "members":{ "Names":{ "shape":"ParameterNameList", "documentation":"

Names of the parameters for which you want to query information.

To query by parameter label, use `\"Name\": \"name:label\"`. To query by parameter version, use `\"Name\": \"name:version\"`.

" }, "WithDecryption":{ "shape":"Boolean", "documentation":"

Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for `String` and `StringList` parameter types.

", "box":true } } }, "GetParametersResult":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterList", "documentation":"

A list of details for a parameter.

" }, "InvalidParameters":{ "shape":"ParameterNameList", "documentation":"

A list of parameters that aren't formatted correctly or don't run during an execution.

" } } }, "GetPatchBaselineForPatchGroupRequest":{ "type":"structure", "required":["PatchGroup"], "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group whose patch baseline should be retrieved.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Returns the operating system rule specified for patch groups using the patch baseline.

" } } }, "GetPatchBaselineForPatchGroupResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline that should be used for the patch group.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

The operating system rule specified for patch groups using the patch baseline.

" } } }, "GetPatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to retrieve.

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 `AWS-AmazonLinuxDefaultPatchBaseline`, specify `arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7` instead of `pb-0e392de35e7c563b7`.

" } } }, "GetPatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the retrieved patch baseline.

" }, "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Returns the operating system specified for the patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to exclude patches from the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

" }, "ApprovedPatchesComplianceLevel":{ "shape":"PatchComplianceLevel", "documentation":"

Returns the specified compliance severity level for approved patches in the patch baseline.

" }, "ApprovedPatchesEnableNonSecurity":{ "shape":"Boolean", "documentation":"

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.

", "box":true }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

" }, "RejectedPatchesAction":{ "shape":"PatchAction", "documentation":"

The action specified to take on patches included in the `RejectedPatches` 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.

" }, "PatchGroups":{ "shape":"PatchGroupList", "documentation":"

Patch groups included in the patch baseline.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the patch baseline was created.

" }, "ModifiedDate":{ "shape":"DateTime", "documentation":"

The date the patch baseline was last modified.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the patch baseline.

" }, "Sources":{ "shape":"PatchSourceList", "documentation":"

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

" } } }, "GetResourcePoliciesRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArnString", "documentation":"

Amazon Resource Name (ARN) of the resource to which the policies are attached.

" }, "NextToken":{ "shape":"String", "documentation":"

A token to start the list. Use this token to get the next set of results.

" }, "MaxResults":{ "shape":"ResourcePolicyMaxResults", "documentation":"

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.

" } } }, "GetResourcePoliciesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" }, "Policies":{ "shape":"GetResourcePoliciesResponseEntries", "documentation":"

An array of the `Policy` object.

" } } }, "GetResourcePoliciesResponseEntries":{ "type":"list", "member":{"shape":"GetResourcePoliciesResponseEntry"} }, "GetResourcePoliciesResponseEntry":{ "type":"structure", "members":{ "PolicyId":{ "shape":"PolicyId", "documentation":"

A policy ID.

" }, "PolicyHash":{ "shape":"PolicyHash", "documentation":"

ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.

" }, "Policy":{ "shape":"Policy", "documentation":"

A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, `OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

" } }, "documentation":"

A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, `OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

" }, "GetServiceSettingRequest":{ "type":"structure", "required":["SettingId"], "members":{ "SettingId":{ "shape":"ServiceSettingId", "documentation":"

The ID of the service setting to get. The setting ID can be one of the following.

- `/ssm/managed-instance/default-ec2-instance-management-role`

- `/ssm/automation/customer-script-log-destination`

- `/ssm/automation/customer-script-log-group-name`

- `/ssm/documents/console/public-sharing-permission`

- `/ssm/managed-instance/activation-tier`

- `/ssm/opsinsights/opscenter`

- `/ssm/parameter-store/default-parameter-tier`

- `/ssm/parameter-store/high-throughput-enabled`

" } }, "documentation":"

The request body of the GetServiceSetting API operation.

" }, "GetServiceSettingResult":{ "type":"structure", "members":{ "ServiceSetting":{ "shape":"ServiceSetting", "documentation":"

The query result of the current service setting.

" } }, "documentation":"

The query result body of the GetServiceSetting API operation.

" }, "HierarchyLevelLimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.

" } }, "documentation":"

A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.

", "exception":true }, "HierarchyTypeMismatchException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a `String` type to a `SecureString` type. You must create a new, unique parameter.

" } }, "documentation":"

Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a `String` type to a `SecureString` type. You must create a new, unique parameter.

", "exception":true }, "IPAddress":{ "type":"string", "max":46, "min":1 }, "ISO8601String":{"type":"string"}, "IamRole":{ "type":"string", "max":64 }, "IdempotencyToken":{ "type":"string", "max":36, "min":36, "pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" }, "IdempotentParameterMismatch":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "IncompatiblePolicyException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "InstallOverrideList":{ "type":"string", "max":256, "min":1, "pattern":"^https://.+$|^s3://([^/]+)/(.*?([^/]+))$" }, "InstanceAggregatedAssociationOverview":{ "type":"structure", "members":{ "DetailedStatus":{ "shape":"StatusName", "documentation":"

Detailed status information about the aggregated associations.

" }, "InstanceAssociationStatusAggregatedCount":{ "shape":"InstanceAssociationStatusAggregatedCount", "documentation":"

The number of associations for the managed node(s).

" } }, "documentation":"

Status information about the aggregated associations.

" }, "InstanceAssociation":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

" }, "Content":{ "shape":"DocumentContent", "documentation":"

The content of the association document for the managed node(s).

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

Version information for the association on the managed node.

" } }, "documentation":"

One or more association documents on the managed node.

" }, "InstanceAssociationExecutionSummary":{ "type":"string", "max":512, "min":1 }, "InstanceAssociationList":{ "type":"list", "member":{"shape":"InstanceAssociation"} }, "InstanceAssociationOutputLocation":{ "type":"structure", "members":{ "S3Location":{ "shape":"S3OutputLocation", "documentation":"

An S3 bucket where you want to store the results of this request.

" } }, "documentation":"

An S3 bucket where you want to store the results of this request.

For the minimal permissions required to enable Amazon S3 output for an association, see Creating associations in the Systems Manager User Guide.

" }, "InstanceAssociationOutputUrl":{ "type":"structure", "members":{ "S3OutputUrl":{ "shape":"S3OutputUrl", "documentation":"

The URL of S3 bucket where you want to store the results of this request.

" } }, "documentation":"

The URL of S3 bucket where you want to store the results of this request.

" }, "InstanceAssociationStatusAggregatedCount":{ "type":"map", "key":{"shape":"StatusName"}, "value":{"shape":"InstanceCount"} }, "InstanceAssociationStatusInfo":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "Name":{ "shape":"DocumentARN", "documentation":"

The name of the association.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The association document versions.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

The version of the association applied to the managed node.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID where the association was created.

" }, "ExecutionDate":{ "shape":"DateTime", "documentation":"

The date the association ran.

" }, "Status":{ "shape":"StatusName", "documentation":"

Status information about the association.

" }, "DetailedStatus":{ "shape":"StatusName", "documentation":"

Detailed status information about the association.

" }, "ExecutionSummary":{ "shape":"InstanceAssociationExecutionSummary", "documentation":"

Summary information about association execution.

" }, "ErrorCode":{ "shape":"AgentErrorCode", "documentation":"

An error code returned by the request to create the association.

" }, "OutputUrl":{ "shape":"InstanceAssociationOutputUrl", "documentation":"

A URL for an S3 bucket where you want to store the results of this request.

" }, "AssociationName":{ "shape":"AssociationName", "documentation":"

The name of the association applied to the managed node.

" } }, "documentation":"

Status information about the association.

" }, "InstanceAssociationStatusInfos":{ "type":"list", "member":{"shape":"InstanceAssociationStatusInfo"} }, "InstanceCount":{"type":"integer"}, "InstanceId":{ "type":"string", "pattern":"(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" }, "InstanceIdList":{ "type":"list", "member":{"shape":"InstanceId"}, "max":50, "min":0 }, "InstanceInformation":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

" }, "PingStatus":{ "shape":"PingStatus", "documentation":"

Connection status of SSM Agent.

The status `Inactive` has been deprecated and is no longer in use.

" }, "LastPingDateTime":{ "shape":"DateTime", "documentation":"

The date and time when the agent last pinged the Systems Manager service.

", "box":true }, "AgentVersion":{ "shape":"Version", "documentation":"

The version of SSM Agent running on your Linux managed node.

" }, "IsLatestVersion":{ "shape":"Boolean", "documentation":"

Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.

", "box":true }, "PlatformType":{ "shape":"PlatformType", "documentation":"

The operating system platform type.

" }, "PlatformName":{ "shape":"String", "documentation":"

The name of the operating system platform running on your managed node.

" }, "PlatformVersion":{ "shape":"String", "documentation":"

The version of the OS platform running on your managed node.

" }, "ActivationId":{ "shape":"ActivationId", "documentation":"

The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. 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 `DescribeInstances` operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

" }, "RegistrationDate":{ "shape":"DateTime", "documentation":"

The date the server or VM was registered with Amazon Web Services as a managed node.

", "box":true }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The type of instance. Instances are either EC2 instances or managed instances.

" }, "Name":{ "shape":"String", "documentation":"

The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the `DefaultInstanceName` property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the `Name` tag of an EC2 instance, use the Amazon EC2 `DescribeInstances` operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

" }, "IPAddress":{ "shape":"IPAddress", "documentation":"

The IP address of the managed node.

" }, "ComputerName":{ "shape":"ComputerName", "documentation":"

The fully qualified host name of the managed node.

" }, "AssociationStatus":{ "shape":"StatusName", "documentation":"

The status of the association.

" }, "LastAssociationExecutionDate":{ "shape":"DateTime", "documentation":"

The date the association was last run.

" }, "LastSuccessfulAssociationExecutionDate":{ "shape":"DateTime", "documentation":"

The last date the association was successfully run.

" }, "AssociationOverview":{ "shape":"InstanceAggregatedAssociationOverview", "documentation":"

Information about the association.

" }, "SourceId":{ "shape":"SourceId", "documentation":"

The ID of the source resource. For IoT Greengrass devices, `SourceId` is the Thing name.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

The type of the source resource. For IoT Greengrass devices, `SourceType` is `AWS::IoT::Thing`.

" } }, "documentation":"

Describes a filter for a specific list of managed nodes.

" }, "InstanceInformationFilter":{ "type":"structure", "required":[ "key", "valueSet" ], "members":{ "key":{ "shape":"InstanceInformationFilterKey", "documentation":"

The name of the filter.

" }, "valueSet":{ "shape":"InstanceInformationFilterValueSet", "documentation":"

The filter values.

" } }, "documentation":"

Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.

Use this operation instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The `InstanceInformationFilterList` method is a legacy method and doesn't support tags.

" }, "InstanceInformationFilterKey":{ "type":"string", "enum":[ "InstanceIds", "AgentVersion", "PingStatus", "PlatformTypes", "ActivationIds", "IamRole", "ResourceType", "AssociationStatus" ] }, "InstanceInformationFilterList":{ "type":"list", "member":{"shape":"InstanceInformationFilter"}, "min":0 }, "InstanceInformationFilterValue":{ "type":"string", "min":1 }, "InstanceInformationFilterValueSet":{ "type":"list", "member":{"shape":"InstanceInformationFilterValue"}, "max":100, "min":1 }, "InstanceInformationList":{ "type":"list", "member":{"shape":"InstanceInformation"} }, "InstanceInformationStringFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"InstanceInformationStringFilterKey", "documentation":"

The filter key name to describe your managed nodes.

Valid filter key values: ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds | PingStatus | PlatformTypes | ResourceType | SourceIds | SourceTypes | \"tag-key\" | \"tag:`{keyname}`

- Valid values for the `AssociationStatus` filter key: Success | Pending | Failed

- Valid values for the `PingStatus` filter key: Online | ConnectionLost | Inactive (deprecated)

- Valid values for the `PlatformType` filter key: Windows | Linux | MacOS

- Valid values for the `ResourceType` filter key: EC2Instance | ManagedInstance

- Valid values for the `SourceType` filter key: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing

- Valid tag examples: `Key=tag-key,Values=Purpose` | `Key=tag:Purpose,Values=Test`.

" }, "Values":{ "shape":"InstanceInformationFilterValueSet", "documentation":"

The filter values.

" } }, "documentation":"

The filters to describe or get information about your managed nodes.

" }, "InstanceInformationStringFilterKey":{ "type":"string", "min":1 }, "InstanceInformationStringFilterList":{ "type":"list", "member":{"shape":"InstanceInformationStringFilter"}, "min":0 }, "InstancePatchState":{ "type":"structure", "required":[ "InstanceId", "PatchGroup", "BaselineId", "OperationStartTime", "OperationEndTime", "Operation" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the managed node the high-level patch compliance information was collected for.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group the managed node belongs to.

" }, "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline used to patch the managed node.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

" }, "InstallOverrideList":{ "shape":"InstallOverrideList", "documentation":"

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 `AWS-RunPatchBaseline`, overrides the patches specified by the default patch baseline.

For more information about the `InstallOverrideList` parameter, see About the `AWS-RunPatchBaseline` SSM document in the Amazon Web Services Systems Manager User Guide.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

Placeholder information. This field will always be empty in the current release of the service.

" }, "InstalledCount":{ "shape":"PatchInstalledCount", "documentation":"

The number of patches from the patch baseline that are installed on the managed node.

" }, "InstalledOtherCount":{ "shape":"PatchInstalledOtherCount", "documentation":"

The number of patches not specified in the patch baseline that are installed on the managed node.

" }, "InstalledPendingRebootCount":{ "shape":"PatchInstalledPendingRebootCount", "documentation":"

The number of patches installed by Patch Manager since the last time the managed node was rebooted.

", "box":true }, "InstalledRejectedCount":{ "shape":"PatchInstalledRejectedCount", "documentation":"

The number of patches installed on a managed node that are specified in a `RejectedPatches` list. Patches with a status of `InstalledRejected` were typically installed before they were added to a `RejectedPatches` list.

If `ALLOW_AS_DEPENDENCY` is the specified option for `RejectedPatchesAction`, the value of `InstalledRejectedCount` will always be `0` (zero).

", "box":true }, "MissingCount":{ "shape":"PatchMissingCount", "documentation":"

The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.

" }, "FailedCount":{ "shape":"PatchFailedCount", "documentation":"

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

" }, "UnreportedNotApplicableCount":{ "shape":"PatchUnreportedNotApplicableCount", "documentation":"

The number of patches beyond the supported limit of `NotApplicableCount` that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

", "box":true }, "NotApplicableCount":{ "shape":"PatchNotApplicableCount", "documentation":"

The number of patches from the patch baseline that aren't applicable for the managed node and therefore aren't installed on the node. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in `UnreportedNotApplicableCount`.

" }, "OperationStartTime":{ "shape":"DateTime", "documentation":"

The time the most recent patching operation was started on the managed node.

" }, "OperationEndTime":{ "shape":"DateTime", "documentation":"

The time the most recent patching operation completed on the managed node.

" }, "Operation":{ "shape":"PatchOperationType", "documentation":"

The type of patching operation that was performed: or

- `SCAN` assesses the patch compliance state.

- `INSTALL` installs missing patches.

" }, "LastNoRebootInstallOperationTime":{ "shape":"DateTime", "documentation":"

The time of the last attempt to patch the managed node with `NoReboot` specified as the reboot option.

" }, "RebootOption":{ "shape":"RebootOption", "documentation":"

Indicates the reboot option specified in the patch baseline.

Reboot options apply to `Install` operations only. Reboots aren't attempted for Patch Manager `Scan` operations.

- `RebootIfNeeded`: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status of `InstalledPendingReboot`.

- `NoReboot`: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of `InstalledPendingReboot`. These patches might not be in effect until a reboot is performed.

" }, "CriticalNonCompliantCount":{ "shape":"PatchCriticalNonCompliantCount", "documentation":"

The number of patches per node that are specified as `Critical` 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 managed node reboot. The status of these managed nodes is `NON_COMPLIANT`.

", "box":true }, "SecurityNonCompliantCount":{ "shape":"PatchSecurityNonCompliantCount", "documentation":"

The number of patches per node that are specified as `Security` in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is `NON_COMPLIANT`.

", "box":true }, "OtherNonCompliantCount":{ "shape":"PatchOtherNonCompliantCount", "documentation":"

The number of patches per node that are specified as other than `Critical` or `Security` but aren't compliant with the patch baseline. The status of these managed nodes is `NON_COMPLIANT`.

", "box":true } }, "documentation":"

Defines the high-level patch compliance state for a managed node, 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 managed node.

" }, "InstancePatchStateFilter":{ "type":"structure", "required":[ "Key", "Values", "Type" ], "members":{ "Key":{ "shape":"InstancePatchStateFilterKey", "documentation":"

The key for the filter. Supported values include the following:

- `InstalledCount`

- `InstalledOtherCount`

- `InstalledPendingRebootCount`

- `InstalledRejectedCount`

- `MissingCount`

- `FailedCount`

- `UnreportedNotApplicableCount`

- `NotApplicableCount`

" }, "Values":{ "shape":"InstancePatchStateFilterValues", "documentation":"

The value for the filter. Must be an integer greater than or equal to 0.

" }, "Type":{ "shape":"InstancePatchStateOperatorType", "documentation":"

The type of comparison that should be performed for the value.

" } }, "documentation":"

Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down the information returned by the API.

Example: To filter for all managed nodes in a patch group having more than three patches with a `FailedCount` status, use the following for the filter:

- Value for `Key`: `FailedCount`

- Value for `Type`: `GreaterThan`

- Value for `Values`: `3`

" }, "InstancePatchStateFilterKey":{ "type":"string", "max":200, "min":1 }, "InstancePatchStateFilterList":{ "type":"list", "member":{"shape":"InstancePatchStateFilter"}, "max":4, "min":0 }, "InstancePatchStateFilterValue":{"type":"string"}, "InstancePatchStateFilterValues":{ "type":"list", "member":{"shape":"InstancePatchStateFilterValue"}, "max":1, "min":1 }, "InstancePatchStateList":{ "type":"list", "member":{"shape":"InstancePatchState"} }, "InstancePatchStateOperatorType":{ "type":"string", "enum":[ "Equal", "NotEqual", "LessThan", "GreaterThan" ] }, "InstancePatchStatesList":{ "type":"list", "member":{"shape":"InstancePatchState"}, "max":5, "min":1 }, "InstanceTagName":{ "type":"string", "max":255 }, "InstancesCount":{"type":"integer"}, "Integer":{"type":"integer"}, "InternalServerError":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An error occurred on the server side.

", "exception":true, "fault":true }, "InvalidActivation":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.

", "exception":true }, "InvalidActivationId":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.

", "exception":true }, "InvalidAggregatorException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as `AWS:Application` or `AWS:InstanceInformation`.

", "exception":true }, "InvalidAllowedPatternException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The request doesn't meet the regular expression requirement.

" } }, "documentation":"

The request doesn't meet the regular expression requirement.

", "exception":true }, "InvalidAssociation":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The association isn't valid or doesn't exist.

", "exception":true }, "InvalidAssociationVersion":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the `$LATEST` parameter to view the latest version of the association.

", "exception":true }, "InvalidAutomationExecutionParametersException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "InvalidAutomationSignalException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The signal isn't valid for the current Automation execution.

", "exception":true }, "InvalidAutomationStatusUpdateException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified update status operation isn't valid.

", "exception":true }, "InvalidCommandId":{ "type":"structure", "members":{ }, "documentation":"

The specified command ID isn't valid. Verify the ID and try again.

", "exception":true }, "InvalidDeleteInventoryParametersException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.

", "exception":true }, "InvalidDeletionIdException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.

", "exception":true }, "InvalidDocument":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations.

" } }, "documentation":"

The specified SSM document doesn't exist.

", "exception":true }, "InvalidDocumentContent":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

A description of the validation error.

" } }, "documentation":"

The content for the document isn't valid.

", "exception":true }, "InvalidDocumentOperation":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

", "exception":true }, "InvalidDocumentSchemaVersion":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The version of the document schema isn't supported.

", "exception":true }, "InvalidDocumentType":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The SSM document type isn't valid. Valid document types are described in the `DocumentType` property.

", "exception":true }, "InvalidDocumentVersion":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document version isn't valid or doesn't exist.

", "exception":true }, "InvalidFilter":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The filter name isn't valid. Verify the you entered the correct name and try again.

", "exception":true }, "InvalidFilterKey":{ "type":"structure", "members":{ }, "documentation":"

The specified key isn't valid.

", "exception":true }, "InvalidFilterOption":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

" } }, "documentation":"

The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

", "exception":true }, "InvalidFilterValue":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The filter value isn't valid. Verify the value and try again.

", "exception":true }, "InvalidInstanceId":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The following problems can cause this exception:

- You don't have permission to access the managed node.

- Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.

- SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

- The managed node isn't in valid state. Valid states are: `Running`, `Pending`, `Stopped`, and `Stopping`. Invalid states are: `Shutting-down` and `Terminated`.

", "exception":true }, "InvalidInstanceInformationFilterValue":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The specified filter value isn't valid.

", "exception":true }, "InvalidInventoryGroupException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified inventory group isn't valid.

", "exception":true }, "InvalidInventoryItemContextException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You specified invalid keys or values in the `Context` attribute for `InventoryItem`. Verify the keys and values, and try again.

", "exception":true }, "InvalidInventoryRequestException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The request isn't valid.

", "exception":true }, "InvalidItemContentException":{ "type":"structure", "members":{ "TypeName":{"shape":"InventoryItemTypeName"}, "Message":{"shape":"String"} }, "documentation":"

One or more content items isn't valid.

", "exception":true }, "InvalidKeyId":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The query key ID isn't valid.

", "exception":true }, "InvalidNextToken":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified token isn't valid.

", "exception":true }, "InvalidNotificationConfig":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "InvalidOptionException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The delete inventory option specified isn't valid. Verify the option and try again.

", "exception":true }, "InvalidOutputFolder":{ "type":"structure", "members":{ }, "documentation":"

The S3 bucket doesn't exist.

", "exception":true }, "InvalidOutputLocation":{ "type":"structure", "members":{ }, "documentation":"

The output location isn't valid or doesn't exist.

", "exception":true }, "InvalidParameters":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "InvalidPermissionType":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The permission type isn't supported. Share is the only supported permission type.

", "exception":true }, "InvalidPluginName":{ "type":"structure", "members":{ }, "documentation":"

The plugin name isn't valid.

", "exception":true }, "InvalidPolicyAttributeException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

A policy attribute or its value is invalid.

", "exception":true }, "InvalidPolicyTypeException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

", "exception":true }, "InvalidResourceId":{ "type":"structure", "members":{ }, "documentation":"

The resource ID isn't valid. Verify that you entered the correct ID and try again.

", "exception":true }, "InvalidResourceType":{ "type":"structure", "members":{ }, "documentation":"

The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.

", "exception":true }, "InvalidResultAttributeException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified inventory item result attribute isn't valid.

", "exception":true }, "InvalidRole":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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 Configuring Amazon SNS Notifications for Run Command in the Amazon Web Services Systems Manager User Guide.

", "exception":true }, "InvalidSchedule":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The schedule is invalid. Verify your cron or rate expression and try again.

", "exception":true }, "InvalidTag":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified tag key or value isn't valid.

", "exception":true }, "InvalidTarget":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "InvalidTargetMaps":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

TargetMap parameter isn't valid.

", "exception":true }, "InvalidTypeNameException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The parameter type name isn't valid.

", "exception":true }, "InvalidUpdate":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The update isn't valid.

", "exception":true }, "InventoryAggregator":{ "type":"structure", "members":{ "Expression":{ "shape":"InventoryAggregatorExpression", "documentation":"

The inventory type and attribute name for aggregation.

" }, "Aggregators":{ "shape":"InventoryAggregatorList", "documentation":"

Nested aggregators to further refine aggregation for an inventory type.

" }, "Groups":{ "shape":"InventoryGroupList", "documentation":"

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.

" } }, "documentation":"

Specifies the inventory type and attribute for the aggregation execution.

" }, "InventoryAggregatorExpression":{ "type":"string", "max":1000, "min":1 }, "InventoryAggregatorList":{ "type":"list", "member":{"shape":"InventoryAggregator"}, "max":10, "min":1 }, "InventoryAttributeDataType":{ "type":"string", "enum":[ "string", "number" ] }, "InventoryDeletionLastStatusMessage":{"type":"string"}, "InventoryDeletionLastStatusUpdateTime":{"type":"timestamp"}, "InventoryDeletionStartTime":{"type":"timestamp"}, "InventoryDeletionStatus":{ "type":"string", "enum":[ "InProgress", "Complete" ] }, "InventoryDeletionStatusItem":{ "type":"structure", "members":{ "DeletionId":{ "shape":"UUID", "documentation":"

The deletion ID returned by the `DeleteInventory` operation.

" }, "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the inventory data type.

" }, "DeletionStartTime":{ "shape":"InventoryDeletionStartTime", "documentation":"

The UTC timestamp when the delete operation started.

" }, "LastStatus":{ "shape":"InventoryDeletionStatus", "documentation":"

The status of the operation. Possible values are InProgress and Complete.

" }, "LastStatusMessage":{ "shape":"InventoryDeletionLastStatusMessage", "documentation":"

Information about the status.

" }, "DeletionSummary":{ "shape":"InventoryDeletionSummary", "documentation":"

Information about the delete operation. For more information about this summary, see Understanding the delete inventory summary in the Amazon Web Services Systems Manager User Guide.

" }, "LastStatusUpdateTime":{ "shape":"InventoryDeletionLastStatusUpdateTime", "documentation":"

The UTC timestamp of when the last status report.

" } }, "documentation":"

Status information returned by the `DeleteInventory` operation.

" }, "InventoryDeletionSummary":{ "type":"structure", "members":{ "TotalCount":{ "shape":"TotalCount", "documentation":"

The total number of items to delete. This count doesn't change during the delete operation.

" }, "RemainingCount":{ "shape":"RemainingCount", "documentation":"

Remaining number of items to delete.

" }, "SummaryItems":{ "shape":"InventoryDeletionSummaryItems", "documentation":"

A list of counts and versions for deleted items.

" } }, "documentation":"

Information about the delete operation.

" }, "InventoryDeletionSummaryItem":{ "type":"structure", "members":{ "Version":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The inventory type version.

" }, "Count":{ "shape":"ResourceCount", "documentation":"

A count of the number of deleted items.

" }, "RemainingCount":{ "shape":"RemainingCount", "documentation":"

The remaining number of items to delete.

" } }, "documentation":"

Either a count, remaining count, or a version number in a delete inventory summary.

" }, "InventoryDeletionSummaryItems":{ "type":"list", "member":{"shape":"InventoryDeletionSummaryItem"} }, "InventoryDeletionsList":{ "type":"list", "member":{"shape":"InventoryDeletionStatusItem"} }, "InventoryFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"InventoryFilterKey", "documentation":"

The name of the filter key.

" }, "Values":{ "shape":"InventoryFilterValueList", "documentation":"

Inventory filter values. Example: inventory filter where managed node IDs are specified as values `Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal`.

" }, "Type":{ "shape":"InventoryQueryOperatorType", "documentation":"

The type of filter.

The `Exists` filter must be used with aggregators. For more information, see Aggregating inventory data in the Amazon Web Services Systems Manager User Guide.

" } }, "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "InventoryFilterKey":{ "type":"string", "max":200, "min":1 }, "InventoryFilterList":{ "type":"list", "member":{"shape":"InventoryFilter"}, "max":5, "min":1 }, "InventoryFilterValue":{"type":"string"}, "InventoryFilterValueList":{ "type":"list", "member":{"shape":"InventoryFilterValue"}, "max":40, "min":1 }, "InventoryGroup":{ "type":"structure", "required":[ "Name", "Filters" ], "members":{ "Name":{ "shape":"InventoryGroupName", "documentation":"

The name of the group.

" }, "Filters":{ "shape":"InventoryFilterList", "documentation":"

Filters define the criteria for the group. The `matchingCount` field displays the number of resources that match the criteria. The `notMatchingCount` field displays the number of resources that don't match the criteria.

" } }, "documentation":"

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.

" }, "InventoryGroupList":{ "type":"list", "member":{"shape":"InventoryGroup"}, "max":15, "min":1 }, "InventoryGroupName":{ "type":"string", "max":200, "min":1 }, "InventoryItem":{ "type":"structure", "required":[ "TypeName", "SchemaVersion", "CaptureTime" ], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the inventory type. Default inventory item type names start with `AWS`. Custom inventory type names will start with Custom. Default inventory item types include the following: `AWS:AWSComponent`, `AWS:Application`, `AWS:InstanceInformation`, `AWS:Network`, and `AWS:WindowsUpdate`.

" }, "SchemaVersion":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The schema version for the inventory item.

" }, "CaptureTime":{ "shape":"InventoryItemCaptureTime", "documentation":"

The time the inventory information was collected.

" }, "ContentHash":{ "shape":"InventoryItemContentHash", "documentation":"

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.

" }, "Content":{ "shape":"InventoryItemEntryList", "documentation":"

The inventory data of the inventory type.

" }, "Context":{ "shape":"InventoryItemContentContext", "documentation":"

A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the `ExecutionId`, `ExecutionType`, `ComplianceType` properties of the `AWS:ComplianceItem` type.

" } }, "documentation":"

Information collected from managed nodes based on your inventory policy document

" }, "InventoryItemAttribute":{ "type":"structure", "required":[ "Name", "DataType" ], "members":{ "Name":{ "shape":"InventoryItemAttributeName", "documentation":"

Name of the inventory item attribute.

" }, "DataType":{ "shape":"InventoryAttributeDataType", "documentation":"

The data type of the inventory item attribute.

" } }, "documentation":"

Attributes are the entries within the inventory item content. It contains name and value.

" }, "InventoryItemAttributeList":{ "type":"list", "member":{"shape":"InventoryItemAttribute"}, "max":50, "min":1 }, "InventoryItemAttributeName":{"type":"string"}, "InventoryItemCaptureTime":{ "type":"string", "pattern":"^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$" }, "InventoryItemContentContext":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"}, "max":50, "min":0 }, "InventoryItemContentHash":{ "type":"string", "max":256 }, "InventoryItemEntry":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"}, "max":50, "min":0 }, "InventoryItemEntryList":{ "type":"list", "member":{"shape":"InventoryItemEntry"}, "max":10000, "min":0 }, "InventoryItemList":{ "type":"list", "member":{"shape":"InventoryItem"}, "max":30, "min":1 }, "InventoryItemSchema":{ "type":"structure", "required":[ "TypeName", "Attributes" ], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

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: `AWS:AWSComponent`, `AWS:Application`, `AWS:InstanceInformation`, `AWS:Network`, and `AWS:WindowsUpdate`.

" }, "Version":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The schema version for the inventory item.

" }, "Attributes":{ "shape":"InventoryItemAttributeList", "documentation":"

The schema attributes for inventory. This contains data type and attribute name.

" }, "DisplayName":{ "shape":"InventoryTypeDisplayName", "documentation":"

The alias name of the inventory type. The alias name is used for display purposes.

" } }, "documentation":"

The inventory item schema definition. Users can use this to compose inventory query filters.

" }, "InventoryItemSchemaResultList":{ "type":"list", "member":{"shape":"InventoryItemSchema"} }, "InventoryItemSchemaVersion":{ "type":"string", "pattern":"^([0-9]{1,6})(\\.[0-9]{1,6})$" }, "InventoryItemTypeName":{ "type":"string", "max":100, "min":1, "pattern":"^(AWS|Custom):.*$" }, "InventoryItemTypeNameFilter":{ "type":"string", "max":100, "min":0 }, "InventoryQueryOperatorType":{ "type":"string", "enum":[ "Equal", "NotEqual", "BeginWith", "LessThan", "GreaterThan", "Exists" ] }, "InventoryResultEntity":{ "type":"structure", "members":{ "Id":{ "shape":"InventoryResultEntityId", "documentation":"

ID of the inventory result entity. For example, for managed node inventory the result will be the managed node ID. For EC2 instance inventory, the result will be the instance ID.

" }, "Data":{ "shape":"InventoryResultItemMap", "documentation":"

The data section in the inventory result entity JSON.

" } }, "documentation":"

Inventory query results.

" }, "InventoryResultEntityId":{"type":"string"}, "InventoryResultEntityList":{ "type":"list", "member":{"shape":"InventoryResultEntity"} }, "InventoryResultItem":{ "type":"structure", "required":[ "TypeName", "SchemaVersion", "Content" ], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the inventory result item type.

" }, "SchemaVersion":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The schema version for the inventory result item/

" }, "CaptureTime":{ "shape":"InventoryItemCaptureTime", "documentation":"

The time inventory item data was captured.

" }, "ContentHash":{ "shape":"InventoryItemContentHash", "documentation":"

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.

" }, "Content":{ "shape":"InventoryItemEntryList", "documentation":"

Contains all the inventory data of the item type. Results include attribute names and values.

" } }, "documentation":"

The inventory result item.

" }, "InventoryResultItemKey":{"type":"string"}, "InventoryResultItemMap":{ "type":"map", "key":{"shape":"InventoryResultItemKey"}, "value":{"shape":"InventoryResultItem"} }, "InventorySchemaDeleteOption":{ "type":"string", "enum":[ "DisableSchema", "DeleteSchema" ] }, "InventoryTypeDisplayName":{"type":"string"}, "InvocationDoesNotExist":{ "type":"structure", "members":{ }, "documentation":"

The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again.

", "exception":true }, "InvocationTraceOutput":{ "type":"string", "max":2500 }, "IsSubTypeSchema":{"type":"boolean"}, "ItemContentMismatchException":{ "type":"structure", "members":{ "TypeName":{"shape":"InventoryItemTypeName"}, "Message":{"shape":"String"} }, "documentation":"

The inventory item has invalid content.

", "exception":true }, "ItemSizeLimitExceededException":{ "type":"structure", "members":{ "TypeName":{"shape":"InventoryItemTypeName"}, "Message":{"shape":"String"} }, "documentation":"

The inventory item size has exceeded the size limit.

", "exception":true }, "KeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "LabelParameterVersionRequest":{ "type":"structure", "required":[ "Name", "Labels" ], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The parameter name on which you want to attach one or more labels.

" }, "ParameterVersion":{ "shape":"PSParameterVersion", "documentation":"

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.

", "box":true }, "Labels":{ "shape":"ParameterLabelList", "documentation":"

One or more labels to attach to the specified parameter version.

" } } }, "LabelParameterVersionResult":{ "type":"structure", "members":{ "InvalidLabels":{ "shape":"ParameterLabelList", "documentation":"

The label doesn't meet the requirements. For information about parameter label requirements, see Labeling parameters in the Amazon Web Services Systems Manager User Guide.

" }, "ParameterVersion":{ "shape":"PSParameterVersion", "documentation":"

The version of the parameter that has been labeled.

" } } }, "LastResourceDataSyncMessage":{"type":"string"}, "LastResourceDataSyncStatus":{ "type":"string", "enum":[ "Successful", "Failed", "InProgress" ] }, "LastResourceDataSyncTime":{"type":"timestamp"}, "LastSuccessfulResourceDataSyncTime":{"type":"timestamp"}, "ListAssociationVersionsRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID for which you want to view all versions.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "ListAssociationVersionsResult":{ "type":"structure", "members":{ "AssociationVersions":{ "shape":"AssociationVersionList", "documentation":"

Information about all versions of the association for the specified association ID.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "ListAssociationsRequest":{ "type":"structure", "members":{ "AssociationFilterList":{ "shape":"AssociationFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

Filtering associations using the `InstanceID` attribute only returns legacy associations created using the `InstanceID` attribute. Associations targeting the managed node that are part of the Target Attributes `ResourceGroup` or `Tags` aren't returned.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListAssociationsResult":{ "type":"structure", "members":{ "Associations":{ "shape":"AssociationList", "documentation":"

The associations.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListCommandInvocationsRequest":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

(Optional) The invocations for a specific command ID.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

(Optional) The command execution details for a specific managed node ID.

" }, "MaxResults":{ "shape":"CommandMaxResults", "documentation":"

(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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" }, "Filters":{ "shape":"CommandFilterList", "documentation":"

(Optional) One or more filters. Use a filter to return a more specific list of results.

" }, "Details":{ "shape":"Boolean", "documentation":"

(Optional) If set this returns the response of the command executions and any command output. The default value is `false`.

" } } }, "ListCommandInvocationsResult":{ "type":"structure", "members":{ "CommandInvocations":{ "shape":"CommandInvocationList", "documentation":"

(Optional) A list of all invocations.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListCommandsRequest":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

(Optional) If provided, lists only the specified command.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

(Optional) Lists commands issued against this managed node ID.

You can't specify a managed node ID in the same command that you specify `Status` = `Pending`. This is because the command hasn't reached the managed node yet.

" }, "MaxResults":{ "shape":"CommandMaxResults", "documentation":"

(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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" }, "Filters":{ "shape":"CommandFilterList", "documentation":"

(Optional) One or more filters. Use a filter to return a more specific list of results.

" } } }, "ListCommandsResult":{ "type":"structure", "members":{ "Commands":{ "shape":"CommandList", "documentation":"

(Optional) The list of commands requested by the user.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListComplianceItemsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"ComplianceStringFilterList", "documentation":"

One or more compliance filters. Use a filter to return a more specific list of results.

" }, "ResourceIds":{ "shape":"ComplianceResourceIdList", "documentation":"

The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

" }, "ResourceTypes":{ "shape":"ComplianceResourceTypeList", "documentation":"

The type of resource from which to get compliance information. Currently, the only supported resource type is `ManagedInstance`.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "ListComplianceItemsResult":{ "type":"structure", "members":{ "ComplianceItems":{ "shape":"ComplianceItemList", "documentation":"

A list of compliance information for the specified resource ID.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "ListComplianceSummariesRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"ComplianceStringFilterList", "documentation":"

One or more compliance or inventory filters. Use a filter to return a more specific list of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "ListComplianceSummariesResult":{ "type":"structure", "members":{ "ComplianceSummaryItems":{ "shape":"ComplianceSummaryItemList", "documentation":"

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.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "ListDocumentMetadataHistoryRequest":{ "type":"structure", "required":[ "Name", "Metadata" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the change template.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the change template.

" }, "Metadata":{ "shape":"DocumentMetadataEnum", "documentation":"

The type of data for which details are being requested. Currently, the only supported value is `DocumentReviews`.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "ListDocumentMetadataHistoryResponse":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the change template.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the change template.

" }, "Author":{ "shape":"DocumentAuthor", "documentation":"

The user ID of the person in the organization who requested the review of the change template.

" }, "Metadata":{ "shape":"DocumentMetadataResponseInfo", "documentation":"

Information about the response to the change template approval request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "ListDocumentVersionsRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the document. You can specify an Amazon Resource Name (ARN).

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListDocumentVersionsResult":{ "type":"structure", "members":{ "DocumentVersions":{ "shape":"DocumentVersionList", "documentation":"

The document versions.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListDocumentsRequest":{ "type":"structure", "members":{ "DocumentFilterList":{ "shape":"DocumentFilterList", "documentation":"

This data type is deprecated. Instead, use `Filters`.

" }, "Filters":{ "shape":"DocumentKeyValuesFilterList", "documentation":"

One or more `DocumentKeyValuesFilter` 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 `Owner`, `Name`, `PlatformTypes`, `DocumentType`, and `TargetType`. For example, to return documents you own use `Key=Owner,Values=Self`. To specify a custom key-value pair, use the format `Key=tag:tagName,Values=valueName`.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: `Key=tag:tagName,Values=valueName1,valueName2`

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListDocumentsResult":{ "type":"structure", "members":{ "DocumentIdentifiers":{ "shape":"DocumentIdentifierList", "documentation":"

The names of the SSM documents.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListInventoryEntriesRequest":{ "type":"structure", "required":[ "InstanceId", "TypeName" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID for which you want inventory information.

" }, "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The type of inventory item for which you want information.

" }, "Filters":{ "shape":"InventoryFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "ListInventoryEntriesResult":{ "type":"structure", "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The type of inventory item returned by the request.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID targeted by the request to query inventory information.

" }, "SchemaVersion":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The inventory schema version used by the managed node(s).

" }, "CaptureTime":{ "shape":"InventoryItemCaptureTime", "documentation":"

The time that inventory information was collected for the managed node(s).

" }, "Entries":{ "shape":"InventoryItemEntryList", "documentation":"

A list of inventory items on the managed node(s).

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListOpsItemEventsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"OpsItemEventFilters", "documentation":"

One or more OpsItem filters. Use a filter to return a more specific list of results.

" }, "MaxResults":{ "shape":"OpsItemEventMaxResults", "documentation":"

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.

" }, "NextToken":{ "shape":"String", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "ListOpsItemEventsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" }, "Summaries":{ "shape":"OpsItemEventSummaries", "documentation":"

A list of event information for the specified OpsItems.

" } } }, "ListOpsItemRelatedItemsRequest":{ "type":"structure", "members":{ "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem for which you want to list all related-item resources.

" }, "Filters":{ "shape":"OpsItemRelatedItemsFilters", "documentation":"

One or more OpsItem filters. Use a filter to return a more specific list of results.

" }, "MaxResults":{ "shape":"OpsItemRelatedItemsMaxResults", "documentation":"

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.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListOpsItemRelatedItemsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" }, "Summaries":{ "shape":"OpsItemRelatedItemSummaries", "documentation":"

A list of related-item resources for the specified OpsItem.

" } } }, "ListOpsMetadataMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListOpsMetadataRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"OpsMetadataFilterList", "documentation":"

One or more filters to limit the number of OpsMetadata objects returned by the call.

" }, "MaxResults":{ "shape":"ListOpsMetadataMaxResults", "documentation":"

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.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "ListOpsMetadataResult":{ "type":"structure", "members":{ "OpsMetadataList":{ "shape":"OpsMetadataList", "documentation":"

Returns a list of OpsMetadata objects.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "ListResourceComplianceSummariesRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"ComplianceStringFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "ListResourceComplianceSummariesResult":{ "type":"structure", "members":{ "ResourceComplianceSummaryItems":{ "shape":"ResourceComplianceSummaryItemList", "documentation":"

A summary count for specified or targeted managed nodes. 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.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "ListResourceDataSyncRequest":{ "type":"structure", "members":{ "SyncType":{ "shape":"ResourceDataSyncType", "documentation":"

View a list of resource data syncs according to the sync type. Specify `SyncToDestination` to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify `SyncFromSource` to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "box":true } } }, "ListResourceDataSyncResult":{ "type":"structure", "members":{ "ResourceDataSyncItems":{ "shape":"ResourceDataSyncItemList", "documentation":"

A list of your current resource data sync configurations and their statuses.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId" ], "members":{ "ResourceType":{ "shape":"ResourceTypeForTagging", "documentation":"

Returns a list of tags for a specific resource type.

" }, "ResourceId":{ "shape":"ResourceId", "documentation":"

The resource ID for which you want to see a list of tags.

" } } }, "ListTagsForResourceResult":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

A list of tags.

" } } }, "LoggingInfo":{ "type":"structure", "required":[ "S3BucketName", "S3Region" ], "members":{ "S3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of an S3 bucket where execution logs are stored.

" }, "S3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

(Optional) The S3 bucket subfolder.

" }, "S3Region":{ "shape":"S3Region", "documentation":"

The Amazon Web Services Region where the S3 bucket is located.

" } }, "documentation":"

Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "Long":{"type":"long"}, "MaintenanceWindowAllowUnassociatedTargets":{"type":"boolean"}, "MaintenanceWindowAutomationParameters":{ "type":"structure", "members":{ "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of an Automation runbook to use during task execution.

" }, "Parameters":{ "shape":"AutomationParameterMap", "documentation":"

The parameters for the `AUTOMATION` task.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For `AUTOMATION` task types, Amazon Web Services Systems Manager ignores any values specified for these parameters.

" } }, "documentation":"

The parameters for an `AUTOMATION` task type.

" }, "MaintenanceWindowCutoff":{ "type":"integer", "max":23, "min":0 }, "MaintenanceWindowDescription":{ "type":"string", "max":128, "min":1, "sensitive":true }, "MaintenanceWindowDurationHours":{ "type":"integer", "max":24, "min":1 }, "MaintenanceWindowEnabled":{"type":"boolean"}, "MaintenanceWindowExecution":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window.

" }, "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the execution.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status. Not available for all status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the execution started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the execution finished.

" } }, "documentation":"

Describes the information about an execution of a maintenance window.

" }, "MaintenanceWindowExecutionId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowExecutionList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecution"} }, "MaintenanceWindowExecutionStatus":{ "type":"string", "enum":[ "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "TIMED_OUT", "CANCELLING", "CANCELLED", "SKIPPED_OVERLAPPING" ] }, "MaintenanceWindowExecutionStatusDetails":{ "type":"string", "max":250, "min":0 }, "MaintenanceWindowExecutionTaskExecutionId":{"type":"string"}, "MaintenanceWindowExecutionTaskId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowExecutionTaskIdList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecutionTaskId"} }, "MaintenanceWindowExecutionTaskIdentity":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution that ran the task.

" }, "TaskExecutionId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the maintenance window execution.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the task execution.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status of the task execution. Not available for all status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the task execution started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the task execution finished.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The Amazon Resource Name (ARN) of the task that ran.

" }, "TaskType":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task that ran.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm applied to your maintenance window task.

" }, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarm that was invoked by the maintenance window task.

" } }, "documentation":"

Information about a task execution performed as part of a maintenance window execution.

" }, "MaintenanceWindowExecutionTaskIdentityList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecutionTaskIdentity"} }, "MaintenanceWindowExecutionTaskInvocationId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowExecutionTaskInvocationIdentity":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the maintenance window execution that ran the task.

" }, "TaskExecutionId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the maintenance window execution.

" }, "InvocationId":{ "shape":"MaintenanceWindowExecutionTaskInvocationId", "documentation":"

The ID of the task invocation.

" }, "ExecutionId":{ "shape":"MaintenanceWindowExecutionTaskExecutionId", "documentation":"

The ID of the action performed in the service that actually handled the task invocation. If the task type is `RUN_COMMAND`, this value is the command ID.

" }, "TaskType":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The task type.

" }, "Parameters":{ "shape":"MaintenanceWindowExecutionTaskInvocationParameters", "documentation":"

The parameters that were provided for the invocation when it was run.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the task invocation.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status of the task invocation. Not available for all status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the invocation started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the invocation finished.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

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.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTaskTargetId", "documentation":"

The ID of the target definition in this maintenance window the invocation was performed for.

" } }, "documentation":"

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.

" }, "MaintenanceWindowExecutionTaskInvocationIdentityList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecutionTaskInvocationIdentity"} }, "MaintenanceWindowExecutionTaskInvocationParameters":{ "type":"string", "sensitive":true }, "MaintenanceWindowFilter":{ "type":"structure", "members":{ "Key":{ "shape":"MaintenanceWindowFilterKey", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"MaintenanceWindowFilterValues", "documentation":"

The filter values.

" } }, "documentation":"

Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use `MaintenanceWindowFilter>` include the following:

- DescribeMaintenanceWindowExecutions

- DescribeMaintenanceWindowExecutionTaskInvocations

- DescribeMaintenanceWindowExecutionTasks

- DescribeMaintenanceWindows

- DescribeMaintenanceWindowTargets

- DescribeMaintenanceWindowTasks

" }, "MaintenanceWindowFilterKey":{ "type":"string", "max":128, "min":1 }, "MaintenanceWindowFilterList":{ "type":"list", "member":{"shape":"MaintenanceWindowFilter"}, "max":5, "min":0 }, "MaintenanceWindowFilterValue":{ "type":"string", "max":256, "min":1 }, "MaintenanceWindowFilterValues":{ "type":"list", "member":{"shape":"MaintenanceWindowFilterValue"} }, "MaintenanceWindowId":{ "type":"string", "max":20, "min":20, "pattern":"^mw-[0-9a-f]{17}$" }, "MaintenanceWindowIdentity":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the maintenance window.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

A description of the maintenance window.

" }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Indicates whether the maintenance window is enabled.

" }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the maintenance window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the maintenance window in the form of a cron or rate expression.

" }, "ScheduleTimezone":{ "shape":"MaintenanceWindowTimezone", "documentation":"

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

" }, "ScheduleOffset":{ "shape":"MaintenanceWindowOffset", "documentation":"

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

", "box":true }, "EndDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

" }, "StartDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

" }, "NextExecutionTime":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

" } }, "documentation":"

Information about the maintenance window.

" }, "MaintenanceWindowIdentityForTarget":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the maintenance window.

" } }, "documentation":"

The maintenance window to which the specified target belongs.

" }, "MaintenanceWindowIdentityList":{ "type":"list", "member":{"shape":"MaintenanceWindowIdentity"} }, "MaintenanceWindowLambdaClientContext":{ "type":"string", "max":8000, "min":1 }, "MaintenanceWindowLambdaParameters":{ "type":"structure", "members":{ "ClientContext":{ "shape":"MaintenanceWindowLambdaClientContext", "documentation":"

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.

" }, "Qualifier":{ "shape":"MaintenanceWindowLambdaQualifier", "documentation":"

(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.

" }, "Payload":{ "shape":"MaintenanceWindowLambdaPayload", "documentation":"

JSON to provide to your Lambda function as input.

" } }, "documentation":"

The parameters for a `LAMBDA` task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

" }, "MaintenanceWindowLambdaPayload":{ "type":"blob", "max":4096, "sensitive":true }, "MaintenanceWindowLambdaQualifier":{ "type":"string", "max":128, "min":1 }, "MaintenanceWindowMaxResults":{ "type":"integer", "max":100, "min":10 }, "MaintenanceWindowName":{ "type":"string", "max":128, "min":3, "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "MaintenanceWindowOffset":{ "type":"integer", "max":6, "min":1 }, "MaintenanceWindowResourceType":{ "type":"string", "enum":[ "INSTANCE", "RESOURCE_GROUP" ] }, "MaintenanceWindowRunCommandParameters":{ "type":"structure", "members":{ "Comment":{ "shape":"Comment", "documentation":"

Information about the commands to run.

" }, "CloudWatchOutputConfig":{"shape":"CloudWatchOutputConfig"}, "DocumentHash":{ "shape":"DocumentHash", "documentation":"

The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

" }, "DocumentHashType":{ "shape":"DocumentHashType", "documentation":"

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The Amazon Web Services Systems Manager document (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 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:

`--document-version \"\\$DEFAULT\"`

`--document-version \"\\$LATEST\"`

`--document-version \"3\"`

" }, "NotificationConfig":{ "shape":"NotificationConfig", "documentation":"

Configurations for sending notifications about command status changes on a per-managed node basis.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the Amazon Simple Storage Service (Amazon S3) bucket.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The S3 bucket subfolder.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The parameters for the `RUN_COMMAND` task execution.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

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.

" }, "TimeoutSeconds":{ "shape":"TimeoutSeconds", "documentation":"

If this time is reached and the command hasn't already started running, it doesn't run.

", "box":true } }, "documentation":"

The parameters for a `RUN_COMMAND` task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For `RUN_COMMAND` tasks, Systems Manager uses specified values for `TaskParameters` and `LoggingInfo` only if no values are specified for `TaskInvocationParameters`.

" }, "MaintenanceWindowSchedule":{ "type":"string", "max":256, "min":1 }, "MaintenanceWindowSearchMaxResults":{ "type":"integer", "min":1 }, "MaintenanceWindowStepFunctionsInput":{ "type":"string", "max":4096, "sensitive":true }, "MaintenanceWindowStepFunctionsName":{ "type":"string", "max":80, "min":1 }, "MaintenanceWindowStepFunctionsParameters":{ "type":"structure", "members":{ "Input":{ "shape":"MaintenanceWindowStepFunctionsInput", "documentation":"

The inputs for the `STEP_FUNCTIONS` task.

" }, "Name":{ "shape":"MaintenanceWindowStepFunctionsName", "documentation":"

The name of the `STEP_FUNCTIONS` task.

" } }, "documentation":"

The parameters for a `STEP_FUNCTIONS` task.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For Step Functions tasks, Systems Manager ignores any values specified for `TaskParameters` and `LoggingInfo`.

" }, "MaintenanceWindowStringDateTime":{"type":"string"}, "MaintenanceWindowTarget":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window to register the target with.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the target.

" }, "ResourceType":{ "shape":"MaintenanceWindowResourceType", "documentation":"

The type of target that is being registered with the maintenance window.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets, either managed nodes or tags.

Specify managed nodes using the following format:

`Key=instanceids,Values=<instanceid1>,<instanceid2>`

Tags are specified using the following format:

`Key=<tag name>,Values=<tag value>`.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

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.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name for the maintenance window target.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

A description for the target.

" } }, "documentation":"

The target registered with the maintenance window.

" }, "MaintenanceWindowTargetId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowTargetList":{ "type":"list", "member":{"shape":"MaintenanceWindowTarget"} }, "MaintenanceWindowTask":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window where the task is registered.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The task ID.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The resource that the task uses during execution. For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the Amazon Web Services Systems Manager (SSM document) name or ARN. For `LAMBDA` tasks, it's the function name or ARN. For `STEP_FUNCTIONS` tasks, it's the state machine ARN.

" }, "Type":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either managed nodes or tags). Managed nodes are specified using `Key=instanceids,Values=<instanceid1>,<instanceid2>`. Tags are specified using `Key=<tag name>,Values=<tag value>`.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParameters", "documentation":"

The parameters that should be passed to the task when it is run.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

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.

" }, "LoggingInfo":{ "shape":"LoggingInfo", "documentation":"

Information about an S3 bucket to write task-level logs to.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

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.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The maximum number of targets this task can be run for, in parallel.

Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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 `1`. This value doesn't affect the running of your task.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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 `1`. This value doesn't affect the running of your task.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The task name.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

A description of the task.

" }, "CutoffBehavior":{ "shape":"MaintenanceWindowTaskCutoffBehavior", "documentation":"

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

", "box":true }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm applied to your maintenance window task.

" } }, "documentation":"

Information about a task defined for a maintenance window.

" }, "MaintenanceWindowTaskArn":{ "type":"string", "max":1600, "min":1 }, "MaintenanceWindowTaskCutoffBehavior":{ "type":"string", "enum":[ "CONTINUE_TASK", "CANCEL_TASK" ] }, "MaintenanceWindowTaskId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowTaskInvocationParameters":{ "type":"structure", "members":{ "RunCommand":{ "shape":"MaintenanceWindowRunCommandParameters", "documentation":"

The parameters for a `RUN_COMMAND` task type.

" }, "Automation":{ "shape":"MaintenanceWindowAutomationParameters", "documentation":"

The parameters for an `AUTOMATION` task type.

" }, "StepFunctions":{ "shape":"MaintenanceWindowStepFunctionsParameters", "documentation":"

The parameters for a `STEP_FUNCTIONS` task type.

" }, "Lambda":{ "shape":"MaintenanceWindowLambdaParameters", "documentation":"

The parameters for a `LAMBDA` task type.

" } }, "documentation":"

The parameters for task execution.

" }, "MaintenanceWindowTaskList":{ "type":"list", "member":{"shape":"MaintenanceWindowTask"} }, "MaintenanceWindowTaskParameterName":{ "type":"string", "max":255, "min":1 }, "MaintenanceWindowTaskParameterValue":{ "type":"string", "max":255, "min":1, "sensitive":true }, "MaintenanceWindowTaskParameterValueExpression":{ "type":"structure", "members":{ "Values":{ "shape":"MaintenanceWindowTaskParameterValueList", "documentation":"

This field contains an array of 0 or more strings, each 1 to 255 characters in length.

" } }, "documentation":"

Defines the values for a task parameter.

", "sensitive":true }, "MaintenanceWindowTaskParameterValueList":{ "type":"list", "member":{"shape":"MaintenanceWindowTaskParameterValue"}, "sensitive":true }, "MaintenanceWindowTaskParameters":{ "type":"map", "key":{"shape":"MaintenanceWindowTaskParameterName"}, "value":{"shape":"MaintenanceWindowTaskParameterValueExpression"}, "sensitive":true }, "MaintenanceWindowTaskParametersList":{ "type":"list", "member":{"shape":"MaintenanceWindowTaskParameters"}, "sensitive":true }, "MaintenanceWindowTaskPriority":{ "type":"integer", "min":0 }, "MaintenanceWindowTaskTargetId":{ "type":"string", "max":36 }, "MaintenanceWindowTaskType":{ "type":"string", "enum":[ "RUN_COMMAND", "AUTOMATION", "STEP_FUNCTIONS", "LAMBDA" ] }, "MaintenanceWindowTimezone":{"type":"string"}, "MaintenanceWindowsForTargetList":{ "type":"list", "member":{"shape":"MaintenanceWindowIdentityForTarget"} }, "ManagedInstanceId":{ "type":"string", "max":124, "min":20, "pattern":"(^mi-[0-9a-f]{17}$)|(^eks_c:[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}_\\w{17}$)" }, "MaxConcurrency":{ "type":"string", "max":7, "min":1, "pattern":"^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$" }, "MaxDocumentSizeExceeded":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The size limit of a document is 64 KB.

", "exception":true }, "MaxErrors":{ "type":"string", "max":7, "min":1, "pattern":"^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$" }, "MaxResults":{ "type":"integer", "max":50, "min":1 }, "MaxResultsEC2Compatible":{ "type":"integer", "max":50, "min":5 }, "MaxSessionDuration":{ "type":"string", "max":4, "min":1, "pattern":"^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1[0-4][0-3][0-9]|1440)$" }, "MetadataKey":{ "type":"string", "max":256, "min":1, "pattern":"^(?!\\s*$).+" }, "MetadataKeysToDeleteList":{ "type":"list", "member":{"shape":"MetadataKey"}, "max":10, "min":1 }, "MetadataMap":{ "type":"map", "key":{"shape":"MetadataKey"}, "value":{"shape":"MetadataValue"}, "max":5, "min":1 }, "MetadataValue":{ "type":"structure", "members":{ "Value":{ "shape":"MetadataValueString", "documentation":"

Metadata value to assign to an Application Manager application.

" } }, "documentation":"

Metadata to assign to an Application Manager application.

" }, "MetadataValueString":{ "type":"string", "max":4096, "min":1 }, "ModifyDocumentPermissionRequest":{ "type":"structure", "required":[ "Name", "PermissionType" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document that you want to share.

" }, "PermissionType":{ "shape":"DocumentPermissionType", "documentation":"

The permission type for the document. The permission type can be Share.

" }, "AccountIdsToAdd":{ "shape":"AccountIdList", "documentation":"

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

" }, "AccountIdsToRemove":{ "shape":"AccountIdList", "documentation":"

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

" }, "SharedDocumentVersion":{ "shape":"SharedDocumentVersion", "documentation":"

(Optional) The version of the document to share. If it isn't specified, the system choose the `Default` version to share.

" } } }, "ModifyDocumentPermissionResponse":{ "type":"structure", "members":{ } }, "NextToken":{"type":"string"}, "NonCompliantSummary":{ "type":"structure", "members":{ "NonCompliantCount":{ "shape":"ComplianceSummaryCount", "documentation":"

The total number of compliance items that aren't compliant.

" }, "SeveritySummary":{ "shape":"SeveritySummary", "documentation":"

A summary of the non-compliance severity by compliance type

" } }, "documentation":"

A summary of resources that aren't compliant. The summary is organized according to resource type.

" }, "NormalStringMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "NotificationArn":{"type":"string"}, "NotificationConfig":{ "type":"structure", "members":{ "NotificationArn":{ "shape":"NotificationArn", "documentation":"

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.

" }, "NotificationEvents":{ "shape":"NotificationEventList", "documentation":"

The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

" }, "NotificationType":{ "shape":"NotificationType", "documentation":"

The type of notification.

- `Command`: Receive notification when the status of a command changes.

- `Invocation`: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.

" } }, "documentation":"

Configurations for sending notifications.

" }, "NotificationEvent":{ "type":"string", "enum":[ "All", "InProgress", "Success", "TimedOut", "Cancelled", "Failed" ] }, "NotificationEventList":{ "type":"list", "member":{"shape":"NotificationEvent"} }, "NotificationType":{ "type":"string", "enum":[ "Command", "Invocation" ] }, "OperatingSystem":{ "type":"string", "enum":[ "WINDOWS", "AMAZON_LINUX", "AMAZON_LINUX_2", "AMAZON_LINUX_2022", "UBUNTU", "REDHAT_ENTERPRISE_LINUX", "SUSE", "CENTOS", "ORACLE_LINUX", "DEBIAN", "MACOS", "RASPBIAN", "ROCKY_LINUX", "ALMA_LINUX", "AMAZON_LINUX_2023" ] }, "OpsAggregator":{ "type":"structure", "members":{ "AggregatorType":{ "shape":"OpsAggregatorType", "documentation":"

Either a `Range` or `Count` aggregator for limiting an OpsData summary.

" }, "TypeName":{ "shape":"OpsDataTypeName", "documentation":"

The data type name to use for viewing counts of OpsData.

" }, "AttributeName":{ "shape":"OpsDataAttributeName", "documentation":"

The name of an OpsData attribute on which to limit the count of OpsData.

" }, "Values":{ "shape":"OpsAggregatorValueMap", "documentation":"

The aggregator value.

" }, "Filters":{ "shape":"OpsFilterList", "documentation":"

The aggregator filters.

" }, "Aggregators":{ "shape":"OpsAggregatorList", "documentation":"

A nested aggregator for viewing counts of OpsData.

" } }, "documentation":"

One or more aggregators for viewing counts of OpsData using different dimensions such as `Source`, `CreatedTime`, or `Source and CreatedTime`, to name a few.

" }, "OpsAggregatorList":{ "type":"list", "member":{"shape":"OpsAggregator"}, "max":12, "min":1 }, "OpsAggregatorType":{ "type":"string", "max":20, "min":1, "pattern":"^(range|count|sum)" }, "OpsAggregatorValue":{ "type":"string", "max":2048, "min":0 }, "OpsAggregatorValueKey":{ "type":"string", "max":32, "min":1 }, "OpsAggregatorValueMap":{ "type":"map", "key":{"shape":"OpsAggregatorValueKey"}, "value":{"shape":"OpsAggregatorValue"}, "max":5, "min":0 }, "OpsDataAttributeName":{ "type":"string", "max":128, "min":1 }, "OpsDataTypeName":{ "type":"string", "max":100, "min":1, "pattern":"^(AWS|Custom):.*$" }, "OpsEntity":{ "type":"structure", "members":{ "Id":{ "shape":"OpsEntityId", "documentation":"

The query ID.

" }, "Data":{ "shape":"OpsEntityItemMap", "documentation":"

The data returned by the query.

" } }, "documentation":"

The result of the query.

" }, "OpsEntityId":{"type":"string"}, "OpsEntityItem":{ "type":"structure", "members":{ "CaptureTime":{ "shape":"OpsEntityItemCaptureTime", "documentation":"

The time the OpsData was captured.

" }, "Content":{ "shape":"OpsEntityItemEntryList", "documentation":"

The details of an OpsData summary.

" } }, "documentation":"

The OpsData summary.

" }, "OpsEntityItemCaptureTime":{ "type":"string", "pattern":"^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$" }, "OpsEntityItemEntry":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"}, "max":50, "min":0 }, "OpsEntityItemEntryList":{ "type":"list", "member":{"shape":"OpsEntityItemEntry"}, "max":10000, "min":0 }, "OpsEntityItemKey":{"type":"string"}, "OpsEntityItemMap":{ "type":"map", "key":{"shape":"OpsEntityItemKey"}, "value":{"shape":"OpsEntityItem"} }, "OpsEntityList":{ "type":"list", "member":{"shape":"OpsEntity"} }, "OpsFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"OpsFilterKey", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"OpsFilterValueList", "documentation":"

The filter value.

" }, "Type":{ "shape":"OpsFilterOperatorType", "documentation":"

The type of filter.

" } }, "documentation":"

A filter for viewing OpsData summaries.

" }, "OpsFilterKey":{ "type":"string", "max":200, "min":1 }, "OpsFilterList":{ "type":"list", "member":{"shape":"OpsFilter"}, "max":5, "min":1 }, "OpsFilterOperatorType":{ "type":"string", "enum":[ "Equal", "NotEqual", "BeginWith", "LessThan", "GreaterThan", "Exists" ] }, "OpsFilterValue":{ "type":"string", "max":256, "min":0 }, "OpsFilterValueList":{ "type":"list", "member":{"shape":"OpsFilterValue"}, "max":40, "min":1 }, "OpsItem":{ "type":"structure", "members":{ "CreatedBy":{ "shape":"String", "documentation":"

The ARN of the Amazon Web Services account that created the OpsItem.

" }, "OpsItemType":{ "shape":"OpsItemType", "documentation":"

The type of OpsItem. Systems Manager supports the following types of OpsItems:

- `/aws/issue`

  This type of OpsItem is used for default OpsItems created by OpsCenter.

- `/aws/changerequest`

  This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

- `/aws/insight`

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

" }, "CreatedTime":{ "shape":"DateTime", "documentation":"

The date and time the OpsItem was created.

" }, "Description":{ "shape":"OpsItemDescription", "documentation":"

The OpsItem description.

" }, "LastModifiedBy":{ "shape":"String", "documentation":"

The ARN of the Amazon Web Services account that last updated the OpsItem.

" }, "LastModifiedTime":{ "shape":"DateTime", "documentation":"

The date and time the OpsItem was last updated.

" }, "Notifications":{ "shape":"OpsItemNotifications", "documentation":"

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.

" }, "Priority":{ "shape":"OpsItemPriority", "documentation":"

The importance of this OpsItem in relation to other OpsItems in the system.

" }, "RelatedOpsItems":{ "shape":"RelatedOpsItems", "documentation":"

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.

" }, "Status":{ "shape":"OpsItemStatus", "documentation":"

The OpsItem status. Status can be `Open`, `In Progress`, or `Resolved`. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

" }, "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem.

" }, "Version":{ "shape":"String", "documentation":"

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

" }, "Title":{ "shape":"OpsItemTitle", "documentation":"

A short heading that describes the nature of the OpsItem and the impacted resource.

" }, "Source":{ "shape":"OpsItemSource", "documentation":"

The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

" }, "OperationalData":{ "shape":"OpsItemOperationalData", "documentation":"

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.

Operational data keys can't begin with the following: `amazon`, `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.

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 DescribeOpsItems 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 GetOpsItem API operation).

Use the `/aws/resources` key in OperationalData to specify a related resource in the request. Use the `/aws/automations` key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

" }, "Category":{ "shape":"OpsItemCategory", "documentation":"

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

" }, "Severity":{ "shape":"OpsItemSeverity", "documentation":"

The severity of the OpsItem. Severity options range from 1 to 4.

" }, "ActualStartTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow started. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "ActualEndTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow ended. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedStartTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedEndTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type `/aws/changerequest`.

" }, "OpsItemArn":{ "shape":"OpsItemArn", "documentation":"

The OpsItem Amazon Resource Name (ARN).

" } }, "documentation":"

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.

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 OpsCenter in the Amazon Web Services Systems Manager User Guide.

" }, "OpsItemAccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.

", "exception":true }, "OpsItemAccountId":{ "type":"string", "pattern":"^[0-9]{12}$" }, "OpsItemAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"String"}, "OpsItemId":{"shape":"String"} }, "documentation":"

The OpsItem already exists.

", "exception":true }, "OpsItemArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\\.]{0,63}:[0-9]{12}:opsitem.*" }, "OpsItemCategory":{ "type":"string", "max":64, "min":1, "pattern":"^(?!\\s*$).+" }, "OpsItemConflictException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified OpsItem is in the process of being deleted.

", "exception":true }, "OpsItemDataKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!\\s*$).+" }, "OpsItemDataType":{ "type":"string", "enum":[ "SearchableString", "String" ] }, "OpsItemDataValue":{ "type":"structure", "members":{ "Value":{ "shape":"OpsItemDataValueString", "documentation":"

The value of the OperationalData key.

" }, "Type":{ "shape":"OpsItemDataType", "documentation":"

The type of key-value pair. Valid types include `SearchableString` and `String`.

" } }, "documentation":"

An object that defines the value of the key and its type in the OperationalData map.

" }, "OpsItemDataValueString":{ "type":"string", "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, "OpsItemDescription":{ "type":"string", "max":2048, "min":1, "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, "OpsItemEventFilter":{ "type":"structure", "required":[ "Key", "Values", "Operator" ], "members":{ "Key":{ "shape":"OpsItemEventFilterKey", "documentation":"

The name of the filter key. Currently, the only supported value is `OpsItemId`.

" }, "Values":{ "shape":"OpsItemEventFilterValues", "documentation":"

The values for the filter, consisting of one or more OpsItem IDs.

" }, "Operator":{ "shape":"OpsItemEventFilterOperator", "documentation":"

The operator used by the filter call. Currently, the only supported value is `Equal`.

" } }, "documentation":"

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.

" }, "OpsItemEventFilterKey":{ "type":"string", "enum":["OpsItemId"] }, "OpsItemEventFilterOperator":{ "type":"string", "enum":["Equal"] }, "OpsItemEventFilterValue":{ "type":"string", "max":15, "min":1, "pattern":"^(oi)-[0-9a-f]{12}$" }, "OpsItemEventFilterValues":{ "type":"list", "member":{"shape":"OpsItemEventFilterValue"} }, "OpsItemEventFilters":{ "type":"list", "member":{"shape":"OpsItemEventFilter"} }, "OpsItemEventMaxResults":{ "type":"integer", "max":50, "min":1 }, "OpsItemEventSummaries":{ "type":"list", "member":{"shape":"OpsItemEventSummary"} }, "OpsItemEventSummary":{ "type":"structure", "members":{ "OpsItemId":{ "shape":"String", "documentation":"

The ID of the OpsItem.

" }, "EventId":{ "shape":"String", "documentation":"

The ID of the OpsItem event.

" }, "Source":{ "shape":"String", "documentation":"

The source of the OpsItem event.

" }, "DetailType":{ "shape":"String", "documentation":"

The type of information provided as a detail.

" }, "Detail":{ "shape":"String", "documentation":"

Specific information about the OpsItem event.

" }, "CreatedBy":{ "shape":"OpsItemIdentity", "documentation":"

Information about the user or resource that created the OpsItem event.

" }, "CreatedTime":{ "shape":"DateTime", "documentation":"

The date and time the OpsItem event was created.

" } }, "documentation":"

Summary information about an OpsItem event or that associated an OpsItem with a related item.

" }, "OpsItemFilter":{ "type":"structure", "required":[ "Key", "Values", "Operator" ], "members":{ "Key":{ "shape":"OpsItemFilterKey", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"OpsItemFilterValues", "documentation":"

The filter value.

" }, "Operator":{ "shape":"OpsItemFilterOperator", "documentation":"

The operator used by the filter call.

" } }, "documentation":"

Describes an OpsItem filter.

" }, "OpsItemFilterKey":{ "type":"string", "enum":[ "Status", "CreatedBy", "Source", "Priority", "Title", "OpsItemId", "CreatedTime", "LastModifiedTime", "ActualStartTime", "ActualEndTime", "PlannedStartTime", "PlannedEndTime", "OperationalData", "OperationalDataKey", "OperationalDataValue", "ResourceId", "AutomationId", "Category", "Severity", "OpsItemType", "ChangeRequestByRequesterArn", "ChangeRequestByRequesterName", "ChangeRequestByApproverArn", "ChangeRequestByApproverName", "ChangeRequestByTemplate", "ChangeRequestByTargetsResourceGroup", "InsightByType", "AccountId" ] }, "OpsItemFilterOperator":{ "type":"string", "enum":[ "Equal", "Contains", "GreaterThan", "LessThan" ] }, "OpsItemFilterValue":{"type":"string"}, "OpsItemFilterValues":{ "type":"list", "member":{"shape":"OpsItemFilterValue"} }, "OpsItemFilters":{ "type":"list", "member":{"shape":"OpsItemFilter"} }, "OpsItemId":{ "type":"string", "pattern":"^(oi)-[0-9a-f]{12}$" }, "OpsItemIdentity":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.

" } }, "documentation":"

Information about the user or resource that created an OpsItem event.

" }, "OpsItemInvalidParameterException":{ "type":"structure", "members":{ "ParameterNames":{"shape":"OpsItemParameterNamesList"}, "Message":{"shape":"String"} }, "documentation":"

A specified parameter argument isn't valid. Verify the available arguments and try again.

", "exception":true }, "OpsItemLimitExceededException":{ "type":"structure", "members":{ "ResourceTypes":{"shape":"OpsItemParameterNamesList"}, "Limit":{"shape":"Integer"}, "LimitType":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

The request caused OpsItems to exceed one or more quotas.

", "exception":true }, "OpsItemMaxResults":{ "type":"integer", "max":50, "min":1 }, "OpsItemNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified OpsItem ID doesn't exist. Verify the ID and try again.

", "exception":true }, "OpsItemNotification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

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.

" } }, "documentation":"

A notification about the OpsItem.

" }, "OpsItemNotifications":{ "type":"list", "member":{"shape":"OpsItemNotification"} }, "OpsItemOperationalData":{ "type":"map", "key":{"shape":"OpsItemDataKey"}, "value":{"shape":"OpsItemDataValue"} }, "OpsItemOpsDataKeysList":{ "type":"list", "member":{"shape":"String"} }, "OpsItemParameterNamesList":{ "type":"list", "member":{"shape":"String"} }, "OpsItemPriority":{ "type":"integer", "max":5, "min":1 }, "OpsItemRelatedItemAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"String"}, "ResourceUri":{"shape":"OpsItemRelatedItemAssociationResourceUri"}, "OpsItemId":{"shape":"OpsItemId"} }, "documentation":"

The Amazon Resource Name (ARN) is already associated with the OpsItem.

", "exception":true }, "OpsItemRelatedItemAssociationId":{"type":"string"}, "OpsItemRelatedItemAssociationNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The association wasn't found using the parameters you specified in the call. Verify the information and try again.

", "exception":true }, "OpsItemRelatedItemAssociationResourceType":{"type":"string"}, "OpsItemRelatedItemAssociationResourceUri":{"type":"string"}, "OpsItemRelatedItemAssociationType":{"type":"string"}, "OpsItemRelatedItemSummaries":{ "type":"list", "member":{"shape":"OpsItemRelatedItemSummary"} }, "OpsItemRelatedItemSummary":{ "type":"structure", "members":{ "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The OpsItem ID.

" }, "AssociationId":{ "shape":"OpsItemRelatedItemAssociationId", "documentation":"

The association ID.

" }, "ResourceType":{ "shape":"OpsItemRelatedItemAssociationResourceType", "documentation":"

The resource type.

" }, "AssociationType":{ "shape":"OpsItemRelatedItemAssociationType", "documentation":"

The association type.

" }, "ResourceUri":{ "shape":"OpsItemRelatedItemAssociationResourceUri", "documentation":"

The Amazon Resource Name (ARN) of the related-item resource.

" }, "CreatedBy":{"shape":"OpsItemIdentity"}, "CreatedTime":{ "shape":"DateTime", "documentation":"

The time the related-item association was created.

" }, "LastModifiedBy":{"shape":"OpsItemIdentity"}, "LastModifiedTime":{ "shape":"DateTime", "documentation":"

The time the related-item association was last updated.

" } }, "documentation":"

Summary information about related-item resources for an OpsItem.

" }, "OpsItemRelatedItemsFilter":{ "type":"structure", "required":[ "Key", "Values", "Operator" ], "members":{ "Key":{ "shape":"OpsItemRelatedItemsFilterKey", "documentation":"

The name of the filter key. Supported values include `ResourceUri`, `ResourceType`, or `AssociationId`.

" }, "Values":{ "shape":"OpsItemRelatedItemsFilterValues", "documentation":"

The values for the filter.

" }, "Operator":{ "shape":"OpsItemRelatedItemsFilterOperator", "documentation":"

The operator used by the filter call. The only supported operator is `EQUAL`.

" } }, "documentation":"

Describes a filter for a specific list of related-item resources.

" }, "OpsItemRelatedItemsFilterKey":{ "type":"string", "enum":[ "ResourceType", "AssociationId", "ResourceUri" ] }, "OpsItemRelatedItemsFilterOperator":{ "type":"string", "enum":["Equal"] }, "OpsItemRelatedItemsFilterValue":{"type":"string"}, "OpsItemRelatedItemsFilterValues":{ "type":"list", "member":{"shape":"OpsItemRelatedItemsFilterValue"} }, "OpsItemRelatedItemsFilters":{ "type":"list", "member":{"shape":"OpsItemRelatedItemsFilter"} }, "OpsItemRelatedItemsMaxResults":{ "type":"integer", "max":50, "min":1 }, "OpsItemSeverity":{ "type":"string", "max":64, "min":1, "pattern":"^(?!\\s*$).+" }, "OpsItemSource":{ "type":"string", "max":128, "min":1, "pattern":"^(?!\\s*$).+" }, "OpsItemStatus":{ "type":"string", "enum":[ "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected", "Closed" ] }, "OpsItemSummaries":{ "type":"list", "member":{"shape":"OpsItemSummary"} }, "OpsItemSummary":{ "type":"structure", "members":{ "CreatedBy":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

" }, "CreatedTime":{ "shape":"DateTime", "documentation":"

The date and time the OpsItem was created.

" }, "LastModifiedBy":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

" }, "LastModifiedTime":{ "shape":"DateTime", "documentation":"

The date and time the OpsItem was last updated.

" }, "Priority":{ "shape":"OpsItemPriority", "documentation":"

The importance of this OpsItem in relation to other OpsItems in the system.

" }, "Source":{ "shape":"OpsItemSource", "documentation":"

The impacted Amazon Web Services resource.

" }, "Status":{ "shape":"OpsItemStatus", "documentation":"

The OpsItem status. Status can be `Open`, `In Progress`, or `Resolved`.

" }, "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem.

" }, "Title":{ "shape":"OpsItemTitle", "documentation":"

A short heading that describes the nature of the OpsItem and the impacted resource.

" }, "OperationalData":{ "shape":"OpsItemOperationalData", "documentation":"

Operational data is custom data that provides useful reference details about the OpsItem.

" }, "Category":{ "shape":"OpsItemCategory", "documentation":"

A list of OpsItems by category.

" }, "Severity":{ "shape":"OpsItemSeverity", "documentation":"

A list of OpsItems by severity.

" }, "OpsItemType":{ "shape":"OpsItemType", "documentation":"

The type of OpsItem. Systems Manager supports the following types of OpsItems:

- `/aws/issue`

  This type of OpsItem is used for default OpsItems created by OpsCenter.

- `/aws/changerequest`

  This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

- `/aws/insight`

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

" }, "ActualStartTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow started. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "ActualEndTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow ended. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedStartTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedEndTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type `/aws/changerequest`.

" } }, "documentation":"

A count of OpsItems.

" }, "OpsItemTitle":{ "type":"string", "max":1024, "min":1, "pattern":"^(?!\\s*$).+" }, "OpsItemType":{"type":"string"}, "OpsMetadata":{ "type":"structure", "members":{ "ResourceId":{ "shape":"OpsMetadataResourceId", "documentation":"

The ID of the Application Manager application.

" }, "OpsMetadataArn":{ "shape":"OpsMetadataArn", "documentation":"

The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.

" }, "LastModifiedDate":{ "shape":"DateTime", "documentation":"

The date the OpsMetadata object was last updated.

" }, "LastModifiedUser":{ "shape":"String", "documentation":"

The user name who last updated the OpsMetadata object.

" }, "CreationDate":{ "shape":"DateTime", "documentation":"

The date the OpsMetadata objects was created.

" } }, "documentation":"

Operational metadata for an application in Application Manager.

" }, "OpsMetadataAlreadyExistsException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

An OpsMetadata object already exists for the selected resource.

", "exception":true }, "OpsMetadataArn":{ "type":"string", "max":1011, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:opsmetadata\\/([a-zA-Z0-9-_\\.\\/]*)" }, "OpsMetadataFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"OpsMetadataFilterKey", "documentation":"

A filter key.

" }, "Values":{ "shape":"OpsMetadataFilterValueList", "documentation":"

A filter value.

" } }, "documentation":"

A filter to limit the number of OpsMetadata objects displayed.

" }, "OpsMetadataFilterKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!\\s*$).+" }, "OpsMetadataFilterList":{ "type":"list", "member":{"shape":"OpsMetadataFilter"}, "max":10, "min":0 }, "OpsMetadataFilterValue":{ "type":"string", "max":1024, "min":1 }, "OpsMetadataFilterValueList":{ "type":"list", "member":{"shape":"OpsMetadataFilterValue"}, "max":10, "min":1 }, "OpsMetadataInvalidArgumentException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

One of the arguments passed is invalid.

", "exception":true }, "OpsMetadataKeyLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.

", "exception":true }, "OpsMetadataLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "OpsMetadataList":{ "type":"list", "member":{"shape":"OpsMetadata"}, "max":50, "min":1 }, "OpsMetadataNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The OpsMetadata object doesn't exist.

", "exception":true }, "OpsMetadataResourceId":{ "type":"string", "max":1024, "min":1, "pattern":"^(?!\\s*$).+" }, "OpsMetadataTooManyUpdatesException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The system is processing too many concurrent updates. Wait a few moments and try again.

", "exception":true }, "OpsResultAttribute":{ "type":"structure", "required":["TypeName"], "members":{ "TypeName":{ "shape":"OpsDataTypeName", "documentation":"

Name of the data type. Valid value: `AWS:OpsItem`, `AWS:EC2InstanceInformation`, `AWS:OpsItemTrendline`, or `AWS:ComplianceSummary`.

" } }, "documentation":"

The OpsItem data type to return.

" }, "OpsResultAttributeList":{ "type":"list", "member":{"shape":"OpsResultAttribute"}, "min":1 }, "OutputSource":{ "type":"structure", "members":{ "OutputSourceId":{ "shape":"OutputSourceId", "documentation":"

The ID of the output source, for example the URL of an S3 bucket.

" }, "OutputSourceType":{ "shape":"OutputSourceType", "documentation":"

The type of source where the association execution details are stored, for example, Amazon S3.

" } }, "documentation":"

Information about the source where the association execution details are stored.

" }, "OutputSourceId":{ "type":"string", "max":36, "min":36 }, "OutputSourceType":{"type":"string"}, "OwnerInformation":{ "type":"string", "max":128, "min":1, "sensitive":true }, "PSParameterName":{ "type":"string", "max":2048, "min":1 }, "PSParameterSelector":{ "type":"string", "max":128, "min":0 }, "PSParameterValue":{ "type":"string", "sensitive":true }, "PSParameterVersion":{"type":"long"}, "Parameter":{ "type":"structure", "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter. Valid values include the following: `String`, `StringList`, and `SecureString`.

If type is `StringList`, the system returns a comma-separated string with no spaces between commas in the `Value` field.

" }, "Value":{ "shape":"PSParameterValue", "documentation":"

The parameter value.

If type is `StringList`, the system returns a comma-separated string with no spaces between commas in the `Value` field.

" }, "Version":{ "shape":"PSParameterVersion", "documentation":"

The parameter version.

" }, "Selector":{ "shape":"PSParameterSelector", "documentation":"

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

" }, "SourceResult":{ "shape":"String", "documentation":"

Applies to parameters that reference information in other Amazon Web Services services. `SourceResult` is the raw result or response from the source.

" }, "LastModifiedDate":{ "shape":"DateTime", "documentation":"

Date the parameter was last changed or updated and the parameter version was created.

" }, "ARN":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the parameter.

" }, "DataType":{ "shape":"ParameterDataType", "documentation":"

The data type of the parameter, such as `text` or `aws:ec2:image`. The default is `text`.

" } }, "documentation":"

An Amazon Web Services Systems Manager parameter in Parameter Store.

" }, "ParameterAlreadyExists":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The parameter already exists. You can't create duplicate parameters.

", "exception":true }, "ParameterDataType":{ "type":"string", "max":128, "min":0 }, "ParameterDescription":{ "type":"string", "max":1024, "min":0 }, "ParameterHistory":{ "type":"structure", "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter used.

" }, "KeyId":{ "shape":"ParameterKeyId", "documentation":"

The ID of the query key used for this parameter.

" }, "LastModifiedDate":{ "shape":"DateTime", "documentation":"

Date the parameter was last changed or updated.

" }, "LastModifiedUser":{ "shape":"String", "documentation":"

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

" }, "Description":{ "shape":"ParameterDescription", "documentation":"

Information about the parameter.

" }, "Value":{ "shape":"PSParameterValue", "documentation":"

The parameter value.

" }, "AllowedPattern":{ "shape":"AllowedPattern", "documentation":"

Parameter names can include the following letters and symbols.

a-zA-Z0-9_.-

" }, "Version":{ "shape":"PSParameterVersion", "documentation":"

The parameter version.

" }, "Labels":{ "shape":"ParameterLabelList", "documentation":"

Labels assigned to the parameter version.

" }, "Tier":{ "shape":"ParameterTier", "documentation":"

The parameter tier.

" }, "Policies":{ "shape":"ParameterPolicyList", "documentation":"

Information about the policies assigned to a parameter.

Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.

" }, "DataType":{ "shape":"ParameterDataType", "documentation":"

The data type of the parameter, such as `text` or `aws:ec2:image`. The default is `text`.

" } }, "documentation":"

Information about parameter usage.

" }, "ParameterHistoryList":{ "type":"list", "member":{"shape":"ParameterHistory"} }, "ParameterInlinePolicy":{ "type":"structure", "members":{ "PolicyText":{ "shape":"String", "documentation":"

The JSON text of the policy.

" }, "PolicyType":{ "shape":"String", "documentation":"

The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

" }, "PolicyStatus":{ "shape":"String", "documentation":"

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).

" } }, "documentation":"

One or more policies assigned to a parameter.

" }, "ParameterKeyId":{ "type":"string", "max":256, "min":1, "pattern":"^([a-zA-Z0-9:/_-]+)$" }, "ParameterLabel":{ "type":"string", "max":100, "min":1 }, "ParameterLabelList":{ "type":"list", "member":{"shape":"ParameterLabel"}, "max":10, "min":1 }, "ParameterLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more parameters and try again.

", "exception":true }, "ParameterList":{ "type":"list", "member":{"shape":"Parameter"} }, "ParameterMaxVersionLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

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 label attached to it, Parameter Store won't delete the version and instead presents this error message:

`An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, 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.`

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 Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.

", "exception":true }, "ParameterMetadata":{ "type":"structure", "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The parameter name.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter. Valid parameter types include the following: `String`, `StringList`, and `SecureString`.

" }, "KeyId":{ "shape":"ParameterKeyId", "documentation":"

The ID of the query key used for this parameter.

" }, "LastModifiedDate":{ "shape":"DateTime", "documentation":"

Date the parameter was last changed or updated.

" }, "LastModifiedUser":{ "shape":"String", "documentation":"

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

" }, "Description":{ "shape":"ParameterDescription", "documentation":"

Description of the parameter actions.

" }, "AllowedPattern":{ "shape":"AllowedPattern", "documentation":"

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

" }, "Version":{ "shape":"PSParameterVersion", "documentation":"

The parameter version.

" }, "Tier":{ "shape":"ParameterTier", "documentation":"

The parameter tier.

" }, "Policies":{ "shape":"ParameterPolicyList", "documentation":"

A list of policies associated with a parameter.

" }, "DataType":{ "shape":"ParameterDataType", "documentation":"

The data type of the parameter, such as `text` or `aws:ec2:image`. The default is `text`.

" } }, "documentation":"

Metadata includes information like the ARN of the last user and the date/time the parameter was last used.

" }, "ParameterMetadataList":{ "type":"list", "member":{"shape":"ParameterMetadata"} }, "ParameterName":{"type":"string"}, "ParameterNameList":{ "type":"list", "member":{"shape":"PSParameterName"}, "max":10, "min":1 }, "ParameterNotFound":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The parameter couldn't be found. Verify the name and try again.

", "exception":true }, "ParameterPatternMismatchException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The parameter name isn't valid.

" } }, "documentation":"

The parameter name isn't valid.

", "exception":true }, "ParameterPolicies":{ "type":"string", "max":4096, "min":1 }, "ParameterPolicyList":{ "type":"list", "member":{"shape":"ParameterInlinePolicy"} }, "ParameterStringFilter":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"ParameterStringFilterKey", "documentation":"

The name of the filter.

The `ParameterStringFilter` object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for `Key` can be used with both operations.

For `DescribeParameters`, all of the listed patterns are valid except `Label`.

For `GetParametersByPath`, the following patterns listed for `Key` aren't valid: `tag`, `DataType`, `Name`, `Path`, and `Tier`.

For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

" }, "Option":{ "shape":"ParameterStringQueryOption", "documentation":"

For all filters used with DescribeParameters, valid options include `Equals` and `BeginsWith`. The `Name` filter additionally supports the `Contains` option. (Exception: For filters using the key `Path`, valid options include `Recursive` and `OneLevel`.)

For filters used with GetParametersByPath, valid options include `Equals` and `BeginsWith`. (Exception: For filters using `Label` as the Key name, the only valid option is `Equals`.)

" }, "Values":{ "shape":"ParameterStringFilterValueList", "documentation":"

The value you want to search for.

" } }, "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "ParameterStringFilterKey":{ "type":"string", "max":132, "min":1, "pattern":"tag:.+|Name|Type|KeyId|Path|Label|Tier|DataType" }, "ParameterStringFilterList":{ "type":"list", "member":{"shape":"ParameterStringFilter"} }, "ParameterStringFilterValue":{ "type":"string", "max":1024, "min":1 }, "ParameterStringFilterValueList":{ "type":"list", "member":{"shape":"ParameterStringFilterValue"}, "max":50, "min":1 }, "ParameterStringQueryOption":{ "type":"string", "max":10, "min":1 }, "ParameterTier":{ "type":"string", "enum":[ "Standard", "Advanced", "Intelligent-Tiering" ] }, "ParameterType":{ "type":"string", "enum":[ "String", "StringList", "SecureString" ] }, "ParameterValue":{"type":"string"}, "ParameterValueList":{ "type":"list", "member":{"shape":"ParameterValue"} }, "ParameterVersionLabelLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

A parameter version can have a maximum of ten labels.

", "exception":true }, "ParameterVersionNotFound":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The specified parameter version wasn't found. Verify the parameter name and version, and try again.

", "exception":true }, "Parameters":{ "type":"map", "key":{"shape":"ParameterName"}, "value":{"shape":"ParameterValueList"}, "sensitive":true }, "ParametersFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"ParametersFilterKey", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"ParametersFilterValueList", "documentation":"

The filter values.

" } }, "documentation":"

This data type is deprecated. Instead, use ParameterStringFilter.

" }, "ParametersFilterKey":{ "type":"string", "enum":[ "Name", "Type", "KeyId" ] }, "ParametersFilterList":{ "type":"list", "member":{"shape":"ParametersFilter"} }, "ParametersFilterValue":{ "type":"string", "max":1024, "min":1 }, "ParametersFilterValueList":{ "type":"list", "member":{"shape":"ParametersFilterValue"}, "max":50, "min":1 }, "ParentStepDetails":{ "type":"structure", "members":{ "StepExecutionId":{ "shape":"String", "documentation":"

The unique ID of a step execution.

" }, "StepName":{ "shape":"String", "documentation":"

The name of the step.

" }, "Action":{ "shape":"AutomationActionName", "documentation":"

The name of the automation action.

" }, "Iteration":{ "shape":"Integer", "documentation":"

The current repetition of the loop represented by an integer.

", "box":true }, "IteratorValue":{ "shape":"String", "documentation":"

The current value of the specified iterator in the loop.

" } }, "documentation":"

A detailed status of the parent step.

" }, "Patch":{ "type":"structure", "members":{ "Id":{ "shape":"PatchId", "documentation":"

The ID of the patch. Applies to Windows patches only.

This ID isn't the same as the Microsoft Knowledge Base ID.

" }, "ReleaseDate":{ "shape":"DateTime", "documentation":"

The date the patch was released.

" }, "Title":{ "shape":"PatchTitle", "documentation":"

The title of the patch.

" }, "Description":{ "shape":"PatchDescription", "documentation":"

The description of the patch.

" }, "ContentUrl":{ "shape":"PatchContentUrl", "documentation":"

The URL where more information can be obtained about the patch.

" }, "Vendor":{ "shape":"PatchVendor", "documentation":"

The name of the vendor providing the patch.

" }, "ProductFamily":{ "shape":"PatchProductFamily", "documentation":"

The product family the patch is applicable for. For example, `Windows` or `Amazon Linux 2`.

" }, "Product":{ "shape":"PatchProduct", "documentation":"

The specific product the patch is applicable for. For example, `WindowsServer2016` or `AmazonLinux2018.03`.

" }, "Classification":{ "shape":"PatchClassification", "documentation":"

The classification of the patch. For example, `SecurityUpdates`, `Updates`, or `CriticalUpdates`.

" }, "MsrcSeverity":{ "shape":"PatchMsrcSeverity", "documentation":"

The severity of the patch, such as `Critical`, `Important`, or `Moderate`. Applies to Windows patches only.

" }, "KbNumber":{ "shape":"PatchKbNumber", "documentation":"

The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.

" }, "MsrcNumber":{ "shape":"PatchMsrcNumber", "documentation":"

The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, `MS14-045`. Applies to Windows patches only.

" }, "Language":{ "shape":"PatchLanguage", "documentation":"

The language of the patch if it's language-specific.

" }, "AdvisoryIds":{ "shape":"PatchAdvisoryIdList", "documentation":"

The Advisory ID of the patch. For example, `RHSA-2020:3779`. Applies to Linux-based managed nodes only.

" }, "BugzillaIds":{ "shape":"PatchBugzillaIdList", "documentation":"

The Bugzilla ID of the patch. For example, `1600646`. Applies to Linux-based managed nodes only.

" }, "CVEIds":{ "shape":"PatchCVEIdList", "documentation":"

The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, `CVE-2011-3192`. Applies to Linux-based managed nodes only.

" }, "Name":{ "shape":"PatchName", "documentation":"

The name of the patch. Applies to Linux-based managed nodes only.

" }, "Epoch":{ "shape":"PatchEpoch", "documentation":"

The epoch of the patch. For example in `pkg-example-EE-20180914-2.2.amzn1.noarch`, the epoch value is `20180914-2`. Applies to Linux-based managed nodes only.

" }, "Version":{ "shape":"PatchVersion", "documentation":"

The version number of the patch. For example, in `example-pkg-1.710.10-2.7.abcd.x86_64`, the version number is indicated by `-1`. Applies to Linux-based managed nodes only.

" }, "Release":{ "shape":"PatchRelease", "documentation":"

The particular release of a patch. For example, in `pkg-example-EE-20180914-2.2.amzn1.noarch`, the release is `2.amaz1`. Applies to Linux-based managed nodes only.

" }, "Arch":{ "shape":"PatchArch", "documentation":"

The architecture of the patch. For example, in `example-pkg-0.710.10-2.7.abcd.x86_64`, the architecture is indicated by `x86_64`. Applies to Linux-based managed nodes only.

" }, "Severity":{ "shape":"PatchSeverity", "documentation":"

The severity level of the patch. For example, `CRITICAL` or `MODERATE`.

" }, "Repository":{ "shape":"PatchRepository", "documentation":"

The source patch repository for the operating system and version, such as `trusty-security` for Ubuntu Server 14.04 LTE and `focal-security` for Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only.

" } }, "documentation":"

Represents metadata about a patch.

" }, "PatchAction":{ "type":"string", "enum":[ "ALLOW_AS_DEPENDENCY", "BLOCK" ] }, "PatchAdvisoryId":{"type":"string"}, "PatchAdvisoryIdList":{ "type":"list", "member":{"shape":"PatchAdvisoryId"} }, "PatchArch":{"type":"string"}, "PatchBaselineIdentity":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline.

" }, "BaselineName":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Defines the operating system the patch baseline applies to. The default value is `WINDOWS`.

" }, "BaselineDescription":{ "shape":"BaselineDescription", "documentation":"

The description of the patch baseline.

" }, "DefaultBaseline":{ "shape":"DefaultBaseline", "documentation":"

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.

" } }, "documentation":"

Defines the basic information about a patch baseline.

" }, "PatchBaselineIdentityList":{ "type":"list", "member":{"shape":"PatchBaselineIdentity"} }, "PatchBaselineMaxResults":{ "type":"integer", "max":100, "min":1 }, "PatchBugzillaId":{"type":"string"}, "PatchBugzillaIdList":{ "type":"list", "member":{"shape":"PatchBugzillaId"} }, "PatchCVEId":{"type":"string"}, "PatchCVEIdList":{ "type":"list", "member":{"shape":"PatchCVEId"} }, "PatchCVEIds":{"type":"string"}, "PatchClassification":{"type":"string"}, "PatchComplianceData":{ "type":"structure", "required":[ "Title", "KBId", "Classification", "Severity", "State", "InstalledTime" ], "members":{ "Title":{ "shape":"PatchTitle", "documentation":"

The title of the patch.

" }, "KBId":{ "shape":"PatchKbNumber", "documentation":"

The operating system-specific ID of the patch.

" }, "Classification":{ "shape":"PatchClassification", "documentation":"

The classification of the patch, such as `SecurityUpdates`, `Updates`, and `CriticalUpdates`.

" }, "Severity":{ "shape":"PatchSeverity", "documentation":"

The severity of the patch such as `Critical`, `Important`, and `Moderate`.

" }, "State":{ "shape":"PatchComplianceDataState", "documentation":"

The state of the patch on the managed node, such as INSTALLED or FAILED.

For descriptions of each patch state, see About patch compliance in the Amazon Web Services Systems Manager User Guide.

" }, "InstalledTime":{ "shape":"DateTime", "documentation":"

The date/time the patch was installed on the managed node. Not all operating systems provide this level of information.

" }, "CVEIds":{ "shape":"PatchCVEIds", "documentation":"

The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.

" } }, "documentation":"

Information about the state of a patch on a particular managed node as it relates to the patch baseline used to patch the node.

" }, "PatchComplianceDataList":{ "type":"list", "member":{"shape":"PatchComplianceData"} }, "PatchComplianceDataState":{ "type":"string", "enum":[ "INSTALLED", "INSTALLED_OTHER", "INSTALLED_PENDING_REBOOT", "INSTALLED_REJECTED", "MISSING", "NOT_APPLICABLE", "FAILED" ] }, "PatchComplianceLevel":{ "type":"string", "enum":[ "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFORMATIONAL", "UNSPECIFIED" ] }, "PatchComplianceMaxResults":{ "type":"integer", "max":100, "min":10 }, "PatchContentUrl":{"type":"string"}, "PatchCriticalNonCompliantCount":{"type":"integer"}, "PatchDeploymentStatus":{ "type":"string", "enum":[ "APPROVED", "PENDING_APPROVAL", "EXPLICIT_APPROVED", "EXPLICIT_REJECTED" ] }, "PatchDescription":{"type":"string"}, "PatchEpoch":{"type":"integer"}, "PatchFailedCount":{"type":"integer"}, "PatchFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"PatchFilterKey", "documentation":"

The key for the filter.

Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

" }, "Values":{ "shape":"PatchFilterValueList", "documentation":"

The value for the filter key.

Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

" } }, "documentation":"

Defines which patches should be included in a patch baseline.

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 `WINDOWS` are `PATCH_SET`, `PRODUCT`, `PRODUCT_FAMILY`, `CLASSIFICATION`, and `MSRC_SEVERITY`.

The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is `PRODUCT` and the filter values are `[\"Office 2013\", \"Office 2016\"]`, 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.

You can view lists of valid values for the patch properties by running the `DescribePatchProperties` command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.

" }, "PatchFilterGroup":{ "type":"structure", "required":["PatchFilters"], "members":{ "PatchFilters":{ "shape":"PatchFilterList", "documentation":"

The set of patch filters that make up the group.

" } }, "documentation":"

A set of patch filters, typically used for approval rules.

" }, "PatchFilterKey":{ "type":"string", "enum":[ "ARCH", "ADVISORY_ID", "BUGZILLA_ID", "PATCH_SET", "PRODUCT", "PRODUCT_FAMILY", "CLASSIFICATION", "CVE_ID", "EPOCH", "MSRC_SEVERITY", "NAME", "PATCH_ID", "SECTION", "PRIORITY", "REPOSITORY", "RELEASE", "SEVERITY", "SECURITY", "VERSION" ] }, "PatchFilterList":{ "type":"list", "member":{"shape":"PatchFilter"}, "max":4, "min":0 }, "PatchFilterValue":{ "type":"string", "max":64, "min":1 }, "PatchFilterValueList":{ "type":"list", "member":{"shape":"PatchFilterValue"}, "max":20, "min":1 }, "PatchGroup":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "PatchGroupList":{ "type":"list", "member":{"shape":"PatchGroup"} }, "PatchGroupPatchBaselineMapping":{ "type":"structure", "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group registered with the patch baseline.

" }, "BaselineIdentity":{ "shape":"PatchBaselineIdentity", "documentation":"

The patch baseline the patch group is registered with.

" } }, "documentation":"

The mapping between a patch group and the patch baseline the patch group is registered with.

" }, "PatchGroupPatchBaselineMappingList":{ "type":"list", "member":{"shape":"PatchGroupPatchBaselineMapping"} }, "PatchId":{ "type":"string", "max":100, "min":1 }, "PatchIdList":{ "type":"list", "member":{"shape":"PatchId"}, "max":50, "min":0 }, "PatchInstalledCount":{"type":"integer"}, "PatchInstalledOtherCount":{"type":"integer"}, "PatchInstalledPendingRebootCount":{"type":"integer"}, "PatchInstalledRejectedCount":{"type":"integer"}, "PatchKbNumber":{"type":"string"}, "PatchLanguage":{"type":"string"}, "PatchList":{ "type":"list", "member":{"shape":"Patch"} }, "PatchMissingCount":{"type":"integer"}, "PatchMsrcNumber":{"type":"string"}, "PatchMsrcSeverity":{"type":"string"}, "PatchName":{"type":"string"}, "PatchNotApplicableCount":{"type":"integer"}, "PatchOperationType":{ "type":"string", "enum":[ "Scan", "Install" ] }, "PatchOrchestratorFilter":{ "type":"structure", "members":{ "Key":{ "shape":"PatchOrchestratorFilterKey", "documentation":"

The key for the filter.

" }, "Values":{ "shape":"PatchOrchestratorFilterValues", "documentation":"

The value for the filter.

" } }, "documentation":"

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 `PatchOrchestratorFilter` include the following:

- DescribeAvailablePatches

- DescribeInstancePatches

- DescribePatchBaselines

- DescribePatchGroups

" }, "PatchOrchestratorFilterKey":{ "type":"string", "max":128, "min":1 }, "PatchOrchestratorFilterList":{ "type":"list", "member":{"shape":"PatchOrchestratorFilter"}, "max":5, "min":0 }, "PatchOrchestratorFilterValue":{ "type":"string", "max":256, "min":1 }, "PatchOrchestratorFilterValues":{ "type":"list", "member":{"shape":"PatchOrchestratorFilterValue"} }, "PatchOtherNonCompliantCount":{"type":"integer"}, "PatchProduct":{"type":"string"}, "PatchProductFamily":{"type":"string"}, "PatchPropertiesList":{ "type":"list", "member":{"shape":"PatchPropertyEntry"} }, "PatchProperty":{ "type":"string", "enum":[ "PRODUCT", "PRODUCT_FAMILY", "CLASSIFICATION", "MSRC_SEVERITY", "PRIORITY", "SEVERITY" ] }, "PatchPropertyEntry":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "PatchRelease":{"type":"string"}, "PatchRepository":{"type":"string"}, "PatchRule":{ "type":"structure", "required":["PatchFilterGroup"], "members":{ "PatchFilterGroup":{ "shape":"PatchFilterGroup", "documentation":"

The patch filter group that defines the criteria for the rule.

" }, "ComplianceLevel":{ "shape":"PatchComplianceLevel", "documentation":"

A compliance severity level for all approved patches in a patch baseline.

" }, "ApproveAfterDays":{ "shape":"ApproveAfterDays", "documentation":"

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 `7` means that patches are approved seven days after they are released. Not supported on Debian Server or Ubuntu Server.

", "box":true }, "ApproveUntilDate":{ "shape":"PatchStringDateTime", "documentation":"

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.

Enter dates in the format `YYYY-MM-DD`. For example, `2021-12-31`.

", "box":true }, "EnableNonSecurity":{ "shape":"Boolean", "documentation":"

For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is `false`. Applies to Linux managed nodes only.

", "box":true } }, "documentation":"

Defines an approval rule for a patch baseline.

" }, "PatchRuleGroup":{ "type":"structure", "required":["PatchRules"], "members":{ "PatchRules":{ "shape":"PatchRuleList", "documentation":"

The rules that make up the rule group.

" } }, "documentation":"

A set of rules defining the approval rules for a patch baseline.

" }, "PatchRuleList":{ "type":"list", "member":{"shape":"PatchRule"}, "max":10, "min":0 }, "PatchSecurityNonCompliantCount":{"type":"integer"}, "PatchSet":{ "type":"string", "enum":[ "OS", "APPLICATION" ] }, "PatchSeverity":{"type":"string"}, "PatchSource":{ "type":"structure", "required":[ "Name", "Products", "Configuration" ], "members":{ "Name":{ "shape":"PatchSourceName", "documentation":"

The name specified to identify the patch source.

" }, "Products":{ "shape":"PatchSourceProductList", "documentation":"

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 PatchFilter.

" }, "Configuration":{ "shape":"PatchSourceConfiguration", "documentation":"

The value of the yum repo configuration. For example:

`[main]`

`name=MyCustomRepository`

`baseurl=https://my-custom-repository`

`enabled=1`

For information about other options available for your yum repository configuration, see dnf.conf(5).

" } }, "documentation":"

Information about the patches to use to update the managed nodes, including target operating systems and source repository. Applies to Linux managed nodes only.

" }, "PatchSourceConfiguration":{ "type":"string", "max":1024, "min":1, "sensitive":true }, "PatchSourceList":{ "type":"list", "member":{"shape":"PatchSource"}, "max":20, "min":0 }, "PatchSourceName":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.]{3,50}$" }, "PatchSourceProduct":{ "type":"string", "max":128, "min":1 }, "PatchSourceProductList":{ "type":"list", "member":{"shape":"PatchSourceProduct"}, "max":20, "min":1 }, "PatchStatus":{ "type":"structure", "members":{ "DeploymentStatus":{ "shape":"PatchDeploymentStatus", "documentation":"

The approval status of a patch.

" }, "ComplianceLevel":{ "shape":"PatchComplianceLevel", "documentation":"

The compliance severity level for a patch.

" }, "ApprovalDate":{ "shape":"DateTime", "documentation":"

The date the patch was approved (or will be approved if the status is `PENDING_APPROVAL`).

" } }, "documentation":"

Information about the approval status of a patch.

" }, "PatchStringDateTime":{ "type":"string", "max":10, "min":1 }, "PatchTitle":{"type":"string"}, "PatchUnreportedNotApplicableCount":{"type":"integer"}, "PatchVendor":{"type":"string"}, "PatchVersion":{"type":"string"}, "PingStatus":{ "type":"string", "enum":[ "Online", "ConnectionLost", "Inactive" ] }, "PlatformType":{ "type":"string", "enum":[ "Windows", "Linux", "MacOS" ] }, "PlatformTypeList":{ "type":"list", "member":{"shape":"PlatformType"} }, "PoliciesLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.

", "exception":true }, "Policy":{ "type":"string", "pattern":"\\S+" }, "PolicyHash":{"type":"string"}, "PolicyId":{"type":"string"}, "Product":{"type":"string"}, "ProgressCounters":{ "type":"structure", "members":{ "TotalSteps":{ "shape":"Integer", "documentation":"

The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

" }, "SuccessSteps":{ "shape":"Integer", "documentation":"

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.

" }, "FailedSteps":{ "shape":"Integer", "documentation":"

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.

" }, "CancelledSteps":{ "shape":"Integer", "documentation":"

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.

" }, "TimedOutSteps":{ "shape":"Integer", "documentation":"

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.

" } }, "documentation":"

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

" }, "PutComplianceItemsRequest":{ "type":"structure", "required":[ "ResourceId", "ResourceType", "ComplianceType", "ExecutionSummary", "Items" ], "members":{ "ResourceId":{ "shape":"ComplianceResourceId", "documentation":"

Specify an ID for this resource. For a managed node, this is the node ID.

" }, "ResourceType":{ "shape":"ComplianceResourceType", "documentation":"

Specify the type of resource. `ManagedInstance` is currently the only supported resource type.

" }, "ComplianceType":{ "shape":"ComplianceTypeName", "documentation":"

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:`string`.

" }, "ExecutionSummary":{ "shape":"ComplianceExecutionSummary", "documentation":"

A summary of the call execution that includes an execution ID, the type of execution (for example, `Command`), 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'.

" }, "Items":{ "shape":"ComplianceItemEntryList", "documentation":"

Information about the compliance as defined by the resource type. For example, for a patch compliance type, `Items` includes information about the PatchSeverity, Classification, and so on.

" }, "ItemContentHash":{ "shape":"ComplianceItemContentHash", "documentation":"

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.

" }, "UploadType":{ "shape":"ComplianceUploadType", "documentation":"

The mode for uploading compliance items. You can specify `COMPLETE` or `PARTIAL`. In `COMPLETE` 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.

In `PARTIAL` mode, the system overwrites compliance information for a specific association. The association must be configured with `SyncCompliance` set to `MANUAL`. By default, all requests use `COMPLETE` mode.

This attribute is only valid for association compliance.

", "box":true } } }, "PutComplianceItemsResult":{ "type":"structure", "members":{ } }, "PutInventoryMessage":{"type":"string"}, "PutInventoryRequest":{ "type":"structure", "required":[ "InstanceId", "Items" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

An managed node ID where you want to add or update inventory items.

" }, "Items":{ "shape":"InventoryItemList", "documentation":"

The inventory items that you want to add or update on managed nodes.

" } } }, "PutInventoryResult":{ "type":"structure", "members":{ "Message":{ "shape":"PutInventoryMessage", "documentation":"

Information about the request.

" } } }, "PutParameterRequest":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

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: `/Dev/DBServer/MySQL/db-string13`

Naming Constraints:

- Parameter names are case sensitive.

- A parameter name must be unique within an Amazon Web Services Region

- A parameter name can't be prefixed with \"`aws`\" or \"`ssm`\" (case-insensitive).

- Parameter names can include only the following symbols and letters: `a-zA-Z0-9_.-`

  In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: `/Dev/Production/East/Project-ABC/MyParameter`

- A parameter name can't include spaces.

- Parameter hierarchies are limited to a maximum depth of fifteen levels.

For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

The maximum length constraint of 2048 characters listed below includes 1037 characters reserved for internal use by Systems Manager. The maximum length for a parameter name that you create is 1011 characters. This includes the characters in the ARN that precede the name you specify, such as `arn:aws:ssm:us-east-2:111122223333:parameter/`.

" }, "Description":{ "shape":"ParameterDescription", "documentation":"

Information about the parameter that you want to add to the system. Optional but recommended.

Don't enter personally identifiable information in this field.

" }, "Value":{ "shape":"PSParameterValue", "documentation":"

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.

Parameters can't be referenced or nested in the values of other parameters. You can't include `{{}}` or `{{ssm:parameter-name}}` in a parameter value.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter that you want to add to the system.

`SecureString` isn't currently supported for CloudFormation templates.

Items in a `StringList` 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 `String` data type.

Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.

" }, "KeyId":{ "shape":"ParameterKeyId", "documentation":"

The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the `SecureString` data type.

If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account which is not as secure as using a custom key.

- To use a custom KMS key, choose the `SecureString` data type with the `Key ID` parameter.

" }, "Overwrite":{ "shape":"Boolean", "documentation":"

Overwrite an existing parameter. The default value is `false`.

", "box":true }, "AllowedPattern":{ "shape":"AllowedPattern", "documentation":"

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+$

" }, "Tags":{ "shape":"TagList", "documentation":"

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:

- `Key=Resource,Value=S3bucket`

- `Key=OS,Value=Windows`

- `Key=ParameterType,Value=LicenseKey`

To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.

" }, "Tier":{ "shape":"ParameterTier", "documentation":"

The parameter tier to assign to a parameter.

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.

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 Standard and advanced parameter tiers in the Amazon Web Services Systems Manager User Guide.

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.

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.

Using the Default Tier Configuration

In `PutParameter` 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.

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:

- Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.

- Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.

  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.

  This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.

Options that require an advanced parameter include the following:

- The content size of the parameter is more than 4 KB.

- The parameter uses a parameter policy.

- More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.

For more information about configuring the default tier option, see Specifying a default parameter tier in the Amazon Web Services Systems Manager User Guide.

" }, "Policies":{ "shape":"ParameterPolicies", "documentation":"

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:

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 parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy initiates 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.

NoChangeNotification: This policy initiates 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.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

" }, "DataType":{ "shape":"ParameterDataType", "documentation":"

The data type for a `String` parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.

The following data type values are supported.

- `text`

- `aws:ec2:image`

- `aws:ssm:integration`

When you create a `String` parameter and specify `aws:ec2:image`, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as `ami-12345abcdeEXAMPLE`, and that the specified AMI is available in your Amazon Web Services account.

If the action is successful, the service sends back an HTTP 200 response which indicates a successful `PutParameter` call for all cases except for data type `aws:ec2:image`. If you call `PutParameter` with `aws:ec2:image` data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The `aws:ec2:image` value is validated asynchronously, and the `PutParameter` call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your `aws:ec2:image` parameters are created successfully, see Setting up notifications or trigger actions based on Parameter Store events. For more information about AMI format validation , see Native parameter support for Amazon Machine Image (AMI) IDs.

" } } }, "PutParameterResult":{ "type":"structure", "members":{ "Version":{ "shape":"PSParameterVersion", "documentation":"

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.

" }, "Tier":{ "shape":"ParameterTier", "documentation":"

The tier assigned to the parameter.

" } } }, "PutResourcePolicyRequest":{ "type":"structure", "required":[ "ResourceArn", "Policy" ], "members":{ "ResourceArn":{ "shape":"ResourceArnString", "documentation":"

Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

" }, "Policy":{ "shape":"Policy", "documentation":"

A policy you want to associate with a resource.

" }, "PolicyId":{ "shape":"PolicyId", "documentation":"

The policy ID.

" }, "PolicyHash":{ "shape":"PolicyHash", "documentation":"

ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.

" } } }, "PutResourcePolicyResponse":{ "type":"structure", "members":{ "PolicyId":{ "shape":"PolicyId", "documentation":"

The policy ID. To update a policy, you must specify `PolicyId` and `PolicyHash`.

" }, "PolicyHash":{ "shape":"PolicyHash", "documentation":"

ID of the current policy version.

" } } }, "RebootOption":{ "type":"string", "enum":[ "RebootIfNeeded", "NoReboot" ] }, "Region":{"type":"string"}, "Regions":{ "type":"list", "member":{"shape":"Region"}, "max":50, "min":1 }, "RegisterDefaultPatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline that should be the default patch baseline.

" } } }, "RegisterDefaultPatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the default patch baseline.

" } } }, "RegisterPatchBaselineForPatchGroupRequest":{ "type":"structure", "required":[ "BaselineId", "PatchGroup" ], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to register with the patch group.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group to be registered with the patch baseline.

" } } }, "RegisterPatchBaselineForPatchGroupResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline the patch group was registered with.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group registered with the patch baseline.

" } } }, "RegisterTargetWithMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "ResourceType", "Targets" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window the target should be registered with.

" }, "ResourceType":{ "shape":"MaintenanceWindowResourceType", "documentation":"

The type of target being registered with the maintenance window.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

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.

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

Example 1: Specify managed node IDs

`Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`

Example 2: Use tag key-pairs applied to managed nodes

`Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`

Example 3: Use tag-keys applied to managed nodes

`Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`

Example 4: Use resource group names

`Key=resource-groups:Name,Values=<resource-group-name>`

Example 5: Use filters for resource group types

`Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>`

For `Key=resource-groups:ResourceTypeFilters`, specify resource types in the following format

`Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC`

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

An optional name for the target.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

An optional description for the target.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true } } }, "RegisterTargetWithMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the target definition in this maintenance window.

" } } }, "RegisterTaskWithMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "TaskArn", "TaskType" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window the task should be added to.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either managed nodes or maintenance window targets).

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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

`Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>`

Specify maintenance window targets using the following format:

`Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>`

", "box":true }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The ARN of the task to run.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

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 `RegisterTaskWithMaintenanceWindow`.

For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:

- Using service-linked roles for Systems Manager

- Should I use a service-linked role or a custom service role to run maintenance window tasks?

" }, "TaskType":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task being registered.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParameters", "documentation":"

The parameters that should be passed to the task when it is run.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "TaskInvocationParameters":{ "shape":"MaintenanceWindowTaskInvocationParameters", "documentation":"

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

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.

", "box":true }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The maximum number of targets this task can be run for, in parallel.

Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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 `1`. This value doesn't affect the running of your task.

", "box":true }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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 `1`. This value doesn't affect the running of your task.

", "box":true }, "LoggingInfo":{ "shape":"LoggingInfo", "documentation":"

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

An optional name for the task.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

An optional description for the task.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true }, "CutoffBehavior":{ "shape":"MaintenanceWindowTaskCutoffBehavior", "documentation":"

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

- `CONTINUE_TASK`: When the cutoff time is reached, any tasks that are running continue. The default value.

- `CANCEL_TASK`:

  - 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.

  - For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand 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.

  The status for tasks that are not completed is `TIMED_OUT`.

", "box":true }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The CloudWatch alarm you want to apply to your maintenance window task.

" } } }, "RegisterTaskWithMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The ID of the task in the maintenance window.

" } } }, "RegistrationLimit":{ "type":"integer", "max":1000, "min":1 }, "RegistrationMetadataItem":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"RegistrationMetadataKey", "documentation":"

Reserved for internal use.

" }, "Value":{ "shape":"RegistrationMetadataValue", "documentation":"

Reserved for internal use.

" } }, "documentation":"

Reserved for internal use.

" }, "RegistrationMetadataKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!\\s*$).+" }, "RegistrationMetadataList":{ "type":"list", "member":{"shape":"RegistrationMetadataItem"} }, "RegistrationMetadataValue":{ "type":"string", "max":2048, "min":1, "pattern":"^(?!\\s*$).+" }, "RegistrationsCount":{ "type":"integer", "max":1000, "min":1 }, "RelatedOpsItem":{ "type":"structure", "required":["OpsItemId"], "members":{ "OpsItemId":{ "shape":"String", "documentation":"

The ID of an OpsItem related to the current OpsItem.

" } }, "documentation":"

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.

" }, "RelatedOpsItems":{ "type":"list", "member":{"shape":"RelatedOpsItem"} }, "RemainingCount":{"type":"integer"}, "RemoveTagsFromResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId", "TagKeys" ], "members":{ "ResourceType":{ "shape":"ResourceTypeForTagging", "documentation":"

The type of resource from which you want to remove a tag.

The `ManagedInstance` type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: `mi-ID_number` . For example, `mi-1a2b3c4d5e6f`.

" }, "ResourceId":{ "shape":"ResourceId", "documentation":"

The ID of the resource from which you want to remove tags. For example:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

`Automation`: `example-c160-4567-8519-012345abcde`

PatchBaseline: pb-012345abcde

OpsMetadata object: `ResourceID` for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, `ResourceID` is created from the strings that come after the word `opsmetadata` in the ARN. For example, an OpsMetadata object with an ARN of `arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager` has a `ResourceID` of either `aws/ssm/MyGroup/appmanager` or `/aws/ssm/MyGroup/appmanager`.

For the Document and Parameter values, use the name of the resource.

The `ManagedInstance` type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

" }, "TagKeys":{ "shape":"KeyList", "documentation":"

Tag keys that you want to remove from the specified resource.

" } } }, "RemoveTagsFromResourceResult":{ "type":"structure", "members":{ } }, "RequireType":{ "type":"string", "max":128, "pattern":"^[a-zA-Z0-9_\\-.]{1,128}$" }, "ResetServiceSettingRequest":{ "type":"structure", "required":["SettingId"], "members":{ "SettingId":{ "shape":"ServiceSettingId", "documentation":"

The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.

- `/ssm/managed-instance/default-ec2-instance-management-role`

- `/ssm/automation/customer-script-log-destination`

- `/ssm/automation/customer-script-log-group-name`

- `/ssm/documents/console/public-sharing-permission`

- `/ssm/managed-instance/activation-tier`

- `/ssm/opsinsights/opscenter`

- `/ssm/parameter-store/default-parameter-tier`

- `/ssm/parameter-store/high-throughput-enabled`

" } }, "documentation":"

The request body of the ResetServiceSetting API operation.

" }, "ResetServiceSettingResult":{ "type":"structure", "members":{ "ServiceSetting":{ "shape":"ServiceSetting", "documentation":"

The current, effective service setting after calling the ResetServiceSetting API operation.

" } }, "documentation":"

The result body of the ResetServiceSetting API operation.

" }, "ResolvedTargets":{ "type":"structure", "members":{ "ParameterValues":{ "shape":"TargetParameterList", "documentation":"

A list of parameter values sent to targets that resolved during the Automation execution.

" }, "Truncated":{ "shape":"Boolean", "documentation":"

A boolean value indicating whether the resolved target list is truncated.

" } }, "documentation":"

Information about targets that resolved during the Automation execution.

" }, "ResourceArnString":{ "type":"string", "max":2048, "min":20 }, "ResourceComplianceSummaryItem":{ "type":"structure", "members":{ "ComplianceType":{ "shape":"ComplianceTypeName", "documentation":"

The compliance type.

" }, "ResourceType":{ "shape":"ComplianceResourceType", "documentation":"

The resource type.

" }, "ResourceId":{ "shape":"ComplianceResourceId", "documentation":"

The resource ID.

" }, "Status":{ "shape":"ComplianceStatus", "documentation":"

The compliance status for the resource.

" }, "OverallSeverity":{ "shape":"ComplianceSeverity", "documentation":"

The highest severity item found for the resource. The resource is compliant for this item.

" }, "ExecutionSummary":{ "shape":"ComplianceExecutionSummary", "documentation":"

Information about the execution.

" }, "CompliantSummary":{ "shape":"CompliantSummary", "documentation":"

A list of items that are compliant for the resource.

" }, "NonCompliantSummary":{ "shape":"NonCompliantSummary", "documentation":"

A list of items that aren't compliant for the resource.

" } }, "documentation":"

Compliance summary information for a specific resource.

" }, "ResourceComplianceSummaryItemList":{ "type":"list", "member":{"shape":"ResourceComplianceSummaryItem"} }, "ResourceCount":{"type":"integer"}, "ResourceCountByStatus":{"type":"string"}, "ResourceDataSyncAWSKMSKeyARN":{ "type":"string", "max":512, "min":1, "pattern":"arn:.*" }, "ResourceDataSyncAlreadyExistsException":{ "type":"structure", "members":{ "SyncName":{"shape":"ResourceDataSyncName"} }, "documentation":"

A sync configuration with the same name already exists.

", "exception":true }, "ResourceDataSyncAwsOrganizationsSource":{ "type":"structure", "required":["OrganizationSourceType"], "members":{ "OrganizationSourceType":{ "shape":"ResourceDataSyncOrganizationSourceType", "documentation":"

If an Amazon Web Services organization is present, this is either `OrganizationalUnits` or `EntireOrganization`. For `OrganizationalUnits`, the data is aggregated from a set of organization units. For `EntireOrganization`, the data is aggregated from the entire Amazon Web Services organization.

" }, "OrganizationalUnits":{ "shape":"ResourceDataSyncOrganizationalUnitList", "documentation":"

The Organizations organization units included in the sync.

" } }, "documentation":"

Information about the `AwsOrganizationsSource` 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.

" }, "ResourceDataSyncConflictException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Another `UpdateResourceDataSync` request is being processed. Wait a few minutes and try again.

", "exception":true }, "ResourceDataSyncCountExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You have exceeded the allowed maximum sync configurations.

", "exception":true }, "ResourceDataSyncCreatedTime":{"type":"timestamp"}, "ResourceDataSyncDestinationDataSharing":{ "type":"structure", "members":{ "DestinationDataSharingType":{ "shape":"ResourceDataSyncDestinationDataSharingType", "documentation":"

The sharing data type. Only `Organization` is supported.

" } }, "documentation":"

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.

" }, "ResourceDataSyncDestinationDataSharingType":{ "type":"string", "max":64, "min":1 }, "ResourceDataSyncEnableAllOpsDataSources":{"type":"boolean"}, "ResourceDataSyncIncludeFutureRegions":{"type":"boolean"}, "ResourceDataSyncInvalidConfigurationException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified sync configuration is invalid.

", "exception":true }, "ResourceDataSyncItem":{ "type":"structure", "members":{ "SyncName":{ "shape":"ResourceDataSyncName", "documentation":"

The name of the resource data sync.

" }, "SyncType":{ "shape":"ResourceDataSyncType", "documentation":"

The type of resource data sync. If `SyncType` is `SyncToDestination`, then the resource data sync synchronizes data to an S3 bucket. If the `SyncType` is `SyncFromSource` then the resource data sync synchronizes data from Organizations or from multiple Amazon Web Services Regions.

" }, "SyncSource":{ "shape":"ResourceDataSyncSourceWithState", "documentation":"

Information about the source where the data was synchronized.

" }, "S3Destination":{ "shape":"ResourceDataSyncS3Destination", "documentation":"

Configuration information for the target S3 bucket.

" }, "LastSyncTime":{ "shape":"LastResourceDataSyncTime", "documentation":"

The last time the configuration attempted to sync (UTC).

" }, "LastSuccessfulSyncTime":{ "shape":"LastSuccessfulResourceDataSyncTime", "documentation":"

The last time the sync operations returned a status of `SUCCESSFUL` (UTC).

" }, "SyncLastModifiedTime":{ "shape":"ResourceDataSyncLastModifiedTime", "documentation":"

The date and time the resource data sync was changed.

" }, "LastStatus":{ "shape":"LastResourceDataSyncStatus", "documentation":"

The status reported by the last sync.

" }, "SyncCreatedTime":{ "shape":"ResourceDataSyncCreatedTime", "documentation":"

The date and time the configuration was created (UTC).

" }, "LastSyncStatusMessage":{ "shape":"LastResourceDataSyncMessage", "documentation":"

The status message details reported by the last sync.

" } }, "documentation":"

Information about a resource data sync configuration, including its current status and last successful sync.

" }, "ResourceDataSyncItemList":{ "type":"list", "member":{"shape":"ResourceDataSyncItem"} }, "ResourceDataSyncLastModifiedTime":{"type":"timestamp"}, "ResourceDataSyncName":{ "type":"string", "max":64, "min":1 }, "ResourceDataSyncNotFoundException":{ "type":"structure", "members":{ "SyncName":{"shape":"ResourceDataSyncName"}, "SyncType":{"shape":"ResourceDataSyncType"}, "Message":{"shape":"String"} }, "documentation":"

The specified sync name wasn't found.

", "exception":true }, "ResourceDataSyncOrganizationSourceType":{ "type":"string", "max":64, "min":1 }, "ResourceDataSyncOrganizationalUnit":{ "type":"structure", "members":{ "OrganizationalUnitId":{ "shape":"ResourceDataSyncOrganizationalUnitId", "documentation":"

The Organizations unit ID data source for the sync.

" } }, "documentation":"

The Organizations organizational unit data source for the sync.

" }, "ResourceDataSyncOrganizationalUnitId":{ "type":"string", "max":128, "min":1, "pattern":"^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" }, "ResourceDataSyncOrganizationalUnitList":{ "type":"list", "member":{"shape":"ResourceDataSyncOrganizationalUnit"}, "max":1000, "min":1 }, "ResourceDataSyncS3BucketName":{ "type":"string", "max":2048, "min":1 }, "ResourceDataSyncS3Destination":{ "type":"structure", "required":[ "BucketName", "SyncFormat", "Region" ], "members":{ "BucketName":{ "shape":"ResourceDataSyncS3BucketName", "documentation":"

The name of the S3 bucket where the aggregated data is stored.

" }, "Prefix":{ "shape":"ResourceDataSyncS3Prefix", "documentation":"

An Amazon S3 prefix for the bucket.

" }, "SyncFormat":{ "shape":"ResourceDataSyncS3Format", "documentation":"

A supported sync format. The following format is currently supported: JsonSerDe

" }, "Region":{ "shape":"ResourceDataSyncS3Region", "documentation":"

The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.

" }, "AWSKMSKeyARN":{ "shape":"ResourceDataSyncAWSKMSKeyARN", "documentation":"

The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.

" }, "DestinationDataSharing":{ "shape":"ResourceDataSyncDestinationDataSharing", "documentation":"

Enables destination data sharing. By default, this field is `null`.

" } }, "documentation":"

Information about the target S3 bucket for the resource data sync.

" }, "ResourceDataSyncS3Format":{ "type":"string", "enum":["JsonSerDe"] }, "ResourceDataSyncS3Prefix":{ "type":"string", "max":256, "min":1 }, "ResourceDataSyncS3Region":{ "type":"string", "max":64, "min":1 }, "ResourceDataSyncSource":{ "type":"structure", "required":[ "SourceType", "SourceRegions" ], "members":{ "SourceType":{ "shape":"ResourceDataSyncSourceType", "documentation":"

The type of data source for the resource data sync. `SourceType` is either `AwsOrganizations` (if an organization is present in Organizations) or `SingleAccountMultiRegions`.

" }, "AwsOrganizationsSource":{ "shape":"ResourceDataSyncAwsOrganizationsSource", "documentation":"

Information about the `AwsOrganizationsSource` resource data sync source. A sync source of this type can synchronize data from Organizations.

" }, "SourceRegions":{ "shape":"ResourceDataSyncSourceRegionList", "documentation":"

The `SyncSource` Amazon Web Services Regions included in the resource data sync.

" }, "IncludeFutureRegions":{ "shape":"ResourceDataSyncIncludeFutureRegions", "documentation":"

Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

" }, "EnableAllOpsDataSources":{ "shape":"ResourceDataSyncEnableAllOpsDataSources", "documentation":"

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 About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.

" } }, "documentation":"

Information about the source of the data included in the resource data sync.

" }, "ResourceDataSyncSourceRegion":{ "type":"string", "max":64, "min":1 }, "ResourceDataSyncSourceRegionList":{ "type":"list", "member":{"shape":"ResourceDataSyncSourceRegion"} }, "ResourceDataSyncSourceType":{ "type":"string", "max":64, "min":1 }, "ResourceDataSyncSourceWithState":{ "type":"structure", "members":{ "SourceType":{ "shape":"ResourceDataSyncSourceType", "documentation":"

The type of data source for the resource data sync. `SourceType` is either `AwsOrganizations` (if an organization is present in Organizations) or `singleAccountMultiRegions`.

" }, "AwsOrganizationsSource":{ "shape":"ResourceDataSyncAwsOrganizationsSource", "documentation":"

The field name in `SyncSource` for the `ResourceDataSyncAwsOrganizationsSource` type.

" }, "SourceRegions":{ "shape":"ResourceDataSyncSourceRegionList", "documentation":"

The `SyncSource` Amazon Web Services Regions included in the resource data sync.

" }, "IncludeFutureRegions":{ "shape":"ResourceDataSyncIncludeFutureRegions", "documentation":"

Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.

" }, "State":{ "shape":"ResourceDataSyncState", "documentation":"

The data type name for including resource data sync state. There are four sync states:

`OrganizationNotExists`: Your organization doesn't exist.

`NoPermissions`: The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer.

`InvalidOrganizationalUnit`: You specified or selected an invalid unit in the resource data sync configuration.

`TrustedAccessDisabled`: You disabled Systems Manager access in the organization in Organizations.

" }, "EnableAllOpsDataSources":{ "shape":"ResourceDataSyncEnableAllOpsDataSources", "documentation":"

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 About multiple account and Region resource data syncs in the Amazon Web Services Systems Manager User Guide.

" } }, "documentation":"

The data type name for including resource data sync state. There are four sync states:

`OrganizationNotExists` (Your organization doesn't exist)

`NoPermissions` (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.)

`InvalidOrganizationalUnit` (You specified or selected an invalid unit in the resource data sync configuration.)

`TrustedAccessDisabled` (You disabled Systems Manager access in the organization in Organizations.)

" }, "ResourceDataSyncState":{ "type":"string", "max":64, "min":1 }, "ResourceDataSyncType":{ "type":"string", "max":64, "min":1 }, "ResourceId":{"type":"string"}, "ResourceInUseException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.

", "exception":true }, "ResourceLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

", "exception":true }, "ResourcePolicyConflictException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.

", "exception":true }, "ResourcePolicyInvalidParameterException":{ "type":"structure", "members":{ "ParameterNames":{"shape":"ResourcePolicyParameterNamesList"}, "Message":{"shape":"String"} }, "documentation":"

One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.

", "exception":true }, "ResourcePolicyLimitExceededException":{ "type":"structure", "members":{ "Limit":{"shape":"Integer"}, "LimitType":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to `OpsItemGroup`. Verify these limits and try again.

", "exception":true }, "ResourcePolicyMaxResults":{ "type":"integer", "max":50, "min":1 }, "ResourcePolicyParameterNamesList":{ "type":"list", "member":{"shape":"String"} }, "ResourceType":{ "type":"string", "enum":[ "ManagedInstance", "EC2Instance" ] }, "ResourceTypeForTagging":{ "type":"string", "enum":[ "Document", "ManagedInstance", "MaintenanceWindow", "Parameter", "PatchBaseline", "OpsItem", "OpsMetadata", "Automation", "Association" ] }, "ResponseCode":{"type":"integer"}, "ResultAttribute":{ "type":"structure", "required":["TypeName"], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

Name of the inventory item type. Valid value: `AWS:InstanceInformation`. Default Value: `AWS:InstanceInformation`.

" } }, "documentation":"

The inventory item result attribute.

" }, "ResultAttributeList":{ "type":"list", "member":{"shape":"ResultAttribute"}, "max":1, "min":1 }, "ResumeSessionRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The ID of the disconnected session to resume.

" } } }, "ResumeSessionResponse":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The ID of the session.

" }, "TokenValue":{ "shape":"TokenValue", "documentation":"

An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.

" }, "StreamUrl":{ "shape":"StreamUrl", "documentation":"

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`.

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as `us-east-2` for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as `1a2b3c4dEXAMPLE`.

" } } }, "ReviewInformation":{ "type":"structure", "members":{ "ReviewedTime":{ "shape":"DateTime", "documentation":"

The time that the reviewer took action on the document review request.

" }, "Status":{ "shape":"ReviewStatus", "documentation":"

The current status of the document review request.

" }, "Reviewer":{ "shape":"Reviewer", "documentation":"

The reviewer assigned to take action on the document review request.

" } }, "documentation":"

Information about the result of a document review request.

" }, "ReviewInformationList":{ "type":"list", "member":{"shape":"ReviewInformation"}, "min":1 }, "ReviewStatus":{ "type":"string", "enum":[ "APPROVED", "NOT_REVIEWED", "PENDING", "REJECTED" ] }, "Reviewer":{ "type":"string", "max":50, "pattern":"^[a-zA-Z0-9_\\-.]{1,128}$" }, "Runbook":{ "type":"structure", "required":["DocumentName"], "members":{ "DocumentName":{ "shape":"DocumentARN", "documentation":"

The name of the Automation runbook used in a runbook workflow.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the Automation runbook used in a runbook workflow.

", "box":true }, "Parameters":{ "shape":"AutomationParameterMap", "documentation":"

The key-value map of execution parameters, which were supplied when calling `StartChangeRequestExecution`.

" }, "TargetParameterName":{ "shape":"AutomationParameterKey", "documentation":"

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify `Targets`.

" }, "Targets":{ "shape":"Targets", "documentation":"

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify `TargetParameterName`.

" }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The `MaxConcurrency` 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.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The `MaxErrors` 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.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

", "box":true } }, "documentation":"

Information about an Automation runbook used in a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

" }, "Runbooks":{ "type":"list", "member":{"shape":"Runbook"}, "max":1, "min":1 }, "S3BucketName":{ "type":"string", "max":63, "min":3 }, "S3KeyPrefix":{ "type":"string", "max":500 }, "S3OutputLocation":{ "type":"structure", "members":{ "OutputS3Region":{ "shape":"S3Region", "documentation":"

The Amazon Web Services Region of the S3 bucket.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the S3 bucket.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The S3 bucket subfolder.

" } }, "documentation":"

An S3 bucket where you want to store the results of this request.

" }, "S3OutputUrl":{ "type":"structure", "members":{ "OutputUrl":{ "shape":"Url", "documentation":"

A URL for an S3 bucket where you want to store the results of this request.

" } }, "documentation":"

A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket where you want to store the results of this request.

" }, "S3Region":{ "type":"string", "max":20, "min":3 }, "ScheduleExpression":{ "type":"string", "max":256, "min":1 }, "ScheduleOffset":{ "type":"integer", "max":6, "min":1 }, "ScheduledWindowExecution":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window to be run.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the maintenance window to be run.

" }, "ExecutionTime":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.

" } }, "documentation":"

Information about a scheduled execution for a maintenance window.

" }, "ScheduledWindowExecutionList":{ "type":"list", "member":{"shape":"ScheduledWindowExecution"} }, "SendAutomationSignalRequest":{ "type":"structure", "required":[ "AutomationExecutionId", "SignalType" ], "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The unique identifier for an existing Automation execution that you want to send the signal to.

" }, "SignalType":{ "shape":"SignalType", "documentation":"

The type of signal to send to an Automation execution.

" }, "Payload":{ "shape":"AutomationParameterMap", "documentation":"

The data sent with the signal. The data schema depends on the type of signal used in the request.

For `Approve` and `Reject` signal types, the payload is an optional comment that you can send with the signal type. For example:

`Comment=\"Looks good\"`

For `StartStep` and `Resume` signal types, you must send the name of the Automation step to start or resume as the payload. For example:

`StepName=\"step1\"`

For the `StopStep` signal type, you must send the step execution ID as the payload. For example:

`StepExecutionId=\"97fff367-fc5a-4299-aed8-0123456789ab\"`

" } } }, "SendAutomationSignalResult":{ "type":"structure", "members":{ } }, "SendCommandRequest":{ "type":"structure", "required":["DocumentName"], "members":{ "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.

To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the `Targets` option instead. Using `Targets`, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

" }, "Targets":{ "shape":"Targets", "documentation":"

An array of search criteria that targets managed nodes using a `Key,Value` combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using `Targets`, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.

To send a command to a smaller number of managed nodes, you can use the `InstanceIds` option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

" }, "DocumentName":{ "shape":"DocumentARN", "documentation":"

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 Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

If you specify a document name or ARN that hasn't been shared with your account, you receive an `InvalidDocument` error.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

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:

--document-version \"\\$DEFAULT\"

--document-version \"\\$LATEST\"

--document-version \"3\"

" }, "DocumentHash":{ "shape":"DocumentHash", "documentation":"

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

" }, "DocumentHashType":{ "shape":"DocumentHashType", "documentation":"

Sha256 or Sha1.

Sha1 hashes have been deprecated.

" }, "TimeoutSeconds":{ "shape":"TimeoutSeconds", "documentation":"

If this time is reached and the command hasn't already started running, it won't run.

", "box":true }, "Comment":{ "shape":"Comment", "documentation":"

User-specified information about the command, such as a brief description of what the command should do.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The required and optional parameters specified in the document being run.

" }, "OutputS3Region":{ "shape":"S3Region", "documentation":"

(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.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the S3 bucket where command execution responses should be stored.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The directory structure within the S3 bucket where the responses should be stored.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

(Optional) The maximum number of managed nodes 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 `50`. For more information about how to use `MaxConcurrency`, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of `MaxErrors`, 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 `0`. For more information about how to use `MaxErrors`, see Using error controls in the Amazon Web Services Systems Manager User Guide.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

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.

This role must provide the `sns:Publish` permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

" }, "NotificationConfig":{ "shape":"NotificationConfig", "documentation":"

Configurations for sending notifications.

" }, "CloudWatchOutputConfig":{ "shape":"CloudWatchOutputConfig", "documentation":"

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.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The CloudWatch alarm you want to apply to your command.

" } } }, "SendCommandResult":{ "type":"structure", "members":{ "Command":{ "shape":"Command", "documentation":"

The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

" } } }, "ServiceRole":{"type":"string"}, "ServiceSetting":{ "type":"structure", "members":{ "SettingId":{ "shape":"ServiceSettingId", "documentation":"

The ID of the service setting.

" }, "SettingValue":{ "shape":"ServiceSettingValue", "documentation":"

The value of the service setting.

" }, "LastModifiedDate":{ "shape":"DateTime", "documentation":"

The last time the service setting was modified.

" }, "LastModifiedUser":{ "shape":"String", "documentation":"

The ARN of the last modified user. This field is populated only if the setting value was overwritten.

" }, "ARN":{ "shape":"String", "documentation":"

The ARN of the service setting.

" }, "Status":{ "shape":"String", "documentation":"

The status of the service setting. The value can be Default, Customized or PendingUpdate.

- Default: The current setting uses a default value provisioned by the Amazon Web Services service team.

- Customized: The current setting use a custom value specified by the customer.

- PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

" } }, "documentation":"

The service setting data structure.

`ServiceSetting` 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.

Services map a `SettingId` object to a setting value. Amazon Web Services services teams define the default value for a `SettingId`. You can't create a new `SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

" }, "ServiceSettingId":{ "type":"string", "max":1000, "min":1 }, "ServiceSettingNotFound":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "ServiceSettingValue":{ "type":"string", "max":4096, "min":1 }, "Session":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The ID of the session.

" }, "Target":{ "shape":"SessionTarget", "documentation":"

The managed node that the Session Manager session connected to.

" }, "Status":{ "shape":"SessionStatus", "documentation":"

The status of the session. For example, \"Connected\" or \"Terminated\".

" }, "StartDate":{ "shape":"DateTime", "documentation":"

The date and time, in ISO-8601 Extended format, when the session began.

" }, "EndDate":{ "shape":"DateTime", "documentation":"

The date and time, in ISO-8601 Extended format, when the session was terminated.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, `SSM-SessionManagerRunShell`.

" }, "Owner":{ "shape":"SessionOwner", "documentation":"

The ID of the Amazon Web Services user that started the session.

" }, "Reason":{ "shape":"SessionReason", "documentation":"

The reason for connecting to the instance.

" }, "Details":{ "shape":"SessionDetails", "documentation":"

Reserved for future use.

" }, "OutputUrl":{ "shape":"SessionManagerOutputUrl", "documentation":"

Reserved for future use.

" }, "MaxSessionDuration":{ "shape":"MaxSessionDuration", "documentation":"

The maximum duration of a session before it terminates.

" } }, "documentation":"

Information about a Session Manager connection to a managed node.

" }, "SessionDetails":{ "type":"string", "max":1024, "min":1 }, "SessionFilter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"SessionFilterKey", "documentation":"

The name of the filter.

" }, "value":{ "shape":"SessionFilterValue", "documentation":"

The filter value. Valid values for each filter key are as follows:

- 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.

- 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.

- Target: Specify a managed node to which session connections have been made.

- Owner: Specify an Amazon Web Services user to see a list of sessions started by that user.

- Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:

  - Connected

  - Connecting

  - Disconnected

  - Terminated

  - Terminating

  - Failed

- SessionId: Specify a session ID to return details about the session.

" } }, "documentation":"

Describes a filter for Session Manager information.

" }, "SessionFilterKey":{ "type":"string", "enum":[ "InvokedAfter", "InvokedBefore", "Target", "Owner", "Status", "SessionId" ] }, "SessionFilterList":{ "type":"list", "member":{"shape":"SessionFilter"}, "max":6, "min":1 }, "SessionFilterValue":{ "type":"string", "max":400, "min":1 }, "SessionId":{ "type":"string", "max":96, "min":1 }, "SessionList":{ "type":"list", "member":{"shape":"Session"} }, "SessionManagerCloudWatchOutputUrl":{ "type":"string", "max":2083, "min":1 }, "SessionManagerOutputUrl":{ "type":"structure", "members":{ "S3OutputUrl":{ "shape":"SessionManagerS3OutputUrl", "documentation":"

Reserved for future use.

" }, "CloudWatchOutputUrl":{ "shape":"SessionManagerCloudWatchOutputUrl", "documentation":"

Reserved for future use.

" } }, "documentation":"

Reserved for future use.

" }, "SessionManagerParameterName":{ "type":"string", "max":255, "min":1 }, "SessionManagerParameterValue":{ "type":"string", "max":65535, "min":1 }, "SessionManagerParameterValueList":{ "type":"list", "member":{"shape":"SessionManagerParameterValue"} }, "SessionManagerParameters":{ "type":"map", "key":{"shape":"SessionManagerParameterName"}, "value":{"shape":"SessionManagerParameterValueList"} }, "SessionManagerS3OutputUrl":{ "type":"string", "max":2083, "min":1 }, "SessionMaxResults":{ "type":"integer", "max":200, "min":1 }, "SessionOwner":{ "type":"string", "max":256, "min":1 }, "SessionReason":{ "type":"string", "max":256, "min":1, "pattern":"^.{1,256}$" }, "SessionState":{ "type":"string", "enum":[ "Active", "History" ] }, "SessionStatus":{ "type":"string", "enum":[ "Connected", "Connecting", "Disconnected", "Terminated", "Terminating", "Failed" ] }, "SessionTarget":{ "type":"string", "max":400, "min":1 }, "SeveritySummary":{ "type":"structure", "members":{ "CriticalCount":{ "shape":"ComplianceSummaryCount", "documentation":"

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.

" }, "HighCount":{ "shape":"ComplianceSummaryCount", "documentation":"

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.

" }, "MediumCount":{ "shape":"ComplianceSummaryCount", "documentation":"

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.

" }, "LowCount":{ "shape":"ComplianceSummaryCount", "documentation":"

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.

" }, "InformationalCount":{ "shape":"ComplianceSummaryCount", "documentation":"

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.

" }, "UnspecifiedCount":{ "shape":"ComplianceSummaryCount", "documentation":"

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.

" } }, "documentation":"

The number of managed nodes found for each patch severity level defined in the request filter.

" }, "SharedDocumentVersion":{ "type":"string", "documentation":"

The document version shared with other Amazon Web Services accounts. You can share `Latest`, `Default` or `All versions`.

", "max":8, "pattern":"([$]LATEST|[$]DEFAULT|[$]ALL)" }, "SignalType":{ "type":"string", "enum":[ "Approve", "Reject", "StartStep", "StopStep", "Resume" ] }, "SnapshotDownloadUrl":{"type":"string"}, "SnapshotId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "SourceId":{ "type":"string", "max":128, "min":0, "pattern":"^[a-zA-Z0-9:_-]*$" }, "SourceType":{ "type":"string", "enum":[ "AWS::EC2::Instance", "AWS::IoT::Thing", "AWS::SSM::ManagedInstance" ] }, "StandardErrorContent":{ "type":"string", "max":8000 }, "StandardOutputContent":{ "type":"string", "max":24000 }, "StartAssociationsOnceRequest":{ "type":"structure", "required":["AssociationIds"], "members":{ "AssociationIds":{ "shape":"AssociationIdList", "documentation":"

The association IDs that you want to run immediately and only one time.

" } } }, "StartAssociationsOnceResult":{ "type":"structure", "members":{ } }, "StartAutomationExecutionRequest":{ "type":"structure", "required":["DocumentName"], "members":{ "DocumentName":{ "shape":"DocumentARN", "documentation":"

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 Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the Automation runbook to use for this execution.

", "box":true }, "Parameters":{ "shape":"AutomationParameterMap", "documentation":"

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

" }, "ClientToken":{ "shape":"IdempotencyToken", "documentation":"

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

" }, "Mode":{ "shape":"ExecutionMode", "documentation":"

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

" }, "TargetParameterName":{ "shape":"AutomationParameterKey", "documentation":"

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

" }, "Targets":{ "shape":"Targets", "documentation":"

A key-value mapping to target resources. Required if you specify TargetParameterName.

" }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

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 `10`.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

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.

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.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

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 Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.

", "box":true }, "Tags":{ "shape":"TagList", "documentation":"

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:

- `Key=environment,Value=test`

- `Key=OS,Value=Windows`

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

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The CloudWatch alarm you want to apply to your automation.

" } } }, "StartAutomationExecutionResult":{ "type":"structure", "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The unique ID of a newly scheduled automation execution.

" } } }, "StartChangeRequestExecutionRequest":{ "type":"structure", "required":[ "DocumentName", "Runbooks" ], "members":{ "ScheduledTime":{ "shape":"DateTime", "documentation":"

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

" }, "DocumentName":{ "shape":"DocumentARN", "documentation":"

The name of the change template document to run during the runbook workflow.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the change template document to run during the runbook workflow.

", "box":true }, "Parameters":{ "shape":"AutomationParameterMap", "documentation":"

A key-value map of parameters that match the declared parameters in the change template document.

" }, "ChangeRequestName":{ "shape":"ChangeRequestName", "documentation":"

The name of the change request associated with the runbook workflow to be run.

" }, "ClientToken":{ "shape":"IdempotencyToken", "documentation":"

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

" }, "AutoApprove":{ "shape":"Boolean", "documentation":"

Indicates whether the change request can be approved automatically without the need for manual approvals.

If `AutoApprovable` is enabled in a change template, then setting `AutoApprove` to `true` in `StartChangeRequestExecution` creates a change request that bypasses approver review.

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is `CLOSED`, 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 `OPEN`.

" }, "Runbooks":{ "shape":"Runbooks", "documentation":"

Information about the Automation runbooks that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

" }, "Tags":{ "shape":"TagList", "documentation":"

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:

- `Key=Environment,Value=Production`

- `Key=Region,Value=us-east-2`

" }, "ScheduledEndTime":{ "shape":"DateTime", "documentation":"

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.

" }, "ChangeDetails":{ "shape":"ChangeDetailsValue", "documentation":"

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

" } } }, "StartChangeRequestExecutionResult":{ "type":"structure", "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)

" } } }, "StartSessionRequest":{ "type":"structure", "required":["Target"], "members":{ "Target":{ "shape":"SessionTarget", "documentation":"

The managed node to connect to for the session.

" }, "DocumentName":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, `SSM-SessionManagerRunShell`. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

" }, "Reason":{ "shape":"SessionReason", "documentation":"

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

" }, "Parameters":{ "shape":"SessionManagerParameters", "documentation":"

The values you want to specify for the parameters defined in the Session document.

" } } }, "StartSessionResponse":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The ID of the session.

" }, "TokenValue":{ "shape":"TokenValue", "documentation":"

An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.

" }, "StreamUrl":{ "shape":"StreamUrl", "documentation":"

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: `wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)`

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as `us-east-2` for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as `1a2b3c4dEXAMPLE`.

" } } }, "StatusAdditionalInfo":{ "type":"string", "max":1024 }, "StatusDetails":{ "type":"string", "max":100, "min":0 }, "StatusMessage":{ "type":"string", "max":1024, "min":1 }, "StatusName":{"type":"string"}, "StatusUnchanged":{ "type":"structure", "members":{ }, "documentation":"

The updated status is the same as the current status.

", "exception":true }, "StepExecution":{ "type":"structure", "members":{ "StepName":{ "shape":"String", "documentation":"

The name of this execution step.

" }, "Action":{ "shape":"AutomationActionName", "documentation":"

The action this step performs. The action determines the behavior of the step.

" }, "TimeoutSeconds":{ "shape":"Long", "documentation":"

The timeout seconds of the step.

", "box":true }, "OnFailure":{ "shape":"String", "documentation":"

The action to take if the step fails. The default value is `Abort`.

" }, "MaxAttempts":{ "shape":"Integer", "documentation":"

The maximum number of tries to run the action of the step. The default value is `1`.

", "box":true }, "ExecutionStartTime":{ "shape":"DateTime", "documentation":"

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.

" }, "ExecutionEndTime":{ "shape":"DateTime", "documentation":"

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.

" }, "StepStatus":{ "shape":"AutomationExecutionStatus", "documentation":"

The execution status for this step.

" }, "ResponseCode":{ "shape":"String", "documentation":"

The response code returned by the execution of the step.

" }, "Inputs":{ "shape":"NormalStringMap", "documentation":"

Fully-resolved values passed into the step before execution.

" }, "Outputs":{ "shape":"AutomationParameterMap", "documentation":"

Returned values from the execution of the step.

" }, "Response":{ "shape":"String", "documentation":"

A message associated with the response code for an execution.

" }, "FailureMessage":{ "shape":"String", "documentation":"

If a step failed, this message explains why the execution failed.

" }, "FailureDetails":{ "shape":"FailureDetails", "documentation":"

Information about the Automation failure.

" }, "StepExecutionId":{ "shape":"String", "documentation":"

The unique ID of a step execution.

" }, "OverriddenParameters":{ "shape":"AutomationParameterMap", "documentation":"

A user-specified list of parameters to override when running a step.

" }, "IsEnd":{ "shape":"Boolean", "documentation":"

The flag which can be used to end automation no matter whether the step succeeds or fails.

", "box":true }, "NextStep":{ "shape":"String", "documentation":"

The next step after the step succeeds.

", "box":true }, "IsCritical":{ "shape":"Boolean", "documentation":"

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

", "box":true }, "ValidNextSteps":{ "shape":"ValidNextStepList", "documentation":"

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.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets for the step execution.

", "box":true }, "TargetLocation":{ "shape":"TargetLocation", "documentation":"

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

", "box":true }, "TriggeredAlarms":{ "shape":"AlarmStateInformationList", "documentation":"

The CloudWatch alarms that were invoked by the automation.

" }, "ParentStepDetails":{ "shape":"ParentStepDetails", "documentation":"

Information about the parent step.

" } }, "documentation":"

Detailed information about an the execution state of an Automation step.

" }, "StepExecutionFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"StepExecutionFilterKey", "documentation":"

One or more keys to limit the results.

" }, "Values":{ "shape":"StepExecutionFilterValueList", "documentation":"

The values of the filter key.

" } }, "documentation":"

A filter to limit the amount of step execution information returned by the call.

" }, "StepExecutionFilterKey":{ "type":"string", "enum":[ "StartTimeBefore", "StartTimeAfter", "StepExecutionStatus", "StepExecutionId", "StepName", "Action", "ParentStepExecutionId", "ParentStepIteration", "ParentStepIteratorValue" ] }, "StepExecutionFilterList":{ "type":"list", "member":{"shape":"StepExecutionFilter"}, "max":6, "min":1 }, "StepExecutionFilterValue":{ "type":"string", "max":150, "min":1 }, "StepExecutionFilterValueList":{ "type":"list", "member":{"shape":"StepExecutionFilterValue"}, "max":10, "min":1 }, "StepExecutionList":{ "type":"list", "member":{"shape":"StepExecution"} }, "StopAutomationExecutionRequest":{ "type":"structure", "required":["AutomationExecutionId"], "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The execution ID of the Automation to stop.

" }, "Type":{ "shape":"StopType", "documentation":"

The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.

" } } }, "StopAutomationExecutionResult":{ "type":"structure", "members":{ } }, "StopType":{ "type":"string", "enum":[ "Complete", "Cancel" ] }, "StreamUrl":{"type":"string"}, "String":{"type":"string"}, "StringDateTime":{ "type":"string", "pattern":"^([\\-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d(?!:))?)?(\\17[0-5]\\d([\\.,]\\d)?)?([zZ]|([\\-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" }, "StringList":{ "type":"list", "member":{"shape":"String"} }, "SubTypeCountLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The sub-type count exceeded the limit for the inventory type.

", "exception":true }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The name of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":1000 }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Target":{ "type":"structure", "members":{ "Key":{ "shape":"TargetKey", "documentation":"

User-defined criteria for sending commands that target managed nodes that meet the criteria.

" }, "Values":{ "shape":"TargetValues", "documentation":"

User-defined criteria that maps to `Key`. For example, if you specified `tag:ServerRole`, you could specify `value:WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer`.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

" } }, "documentation":"

An array of search criteria that targets managed nodes using a key-value pair that you specify.

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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Supported formats include the following.

- `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`

- `Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>`

- `Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`

- Run Command and Maintenance window targets only: `Key=resource-groups:Name,Values=<resource-group-name>`

- Maintenance window targets only: `Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>`

- Automation targets only: `Key=ResourceGroup;Values=<resource-group-name>`

For example:

- `Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE`

- `Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3`

- `Key=tag-key,Values=Name,Instance-Type,CostCenter`

- Run Command and Maintenance window targets only: `Key=resource-groups:Name,Values=ProductionResourceGroup`

  This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

- Maintenance window targets only: `Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC`

  This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.

- Automation targets only: `Key=ResourceGroup,Values=MyResourceGroup`

- State Manager association targets only: `Key=InstanceIds,Values=*`

  This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.

For more information about how to send commands that target managed nodes using `Key,Value` parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.

" }, "TargetCount":{"type":"integer"}, "TargetInUseException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You specified the `Safe` option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

", "exception":true }, "TargetKey":{ "type":"string", "max":163, "min":1, "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$|resource-groups:ResourceTypeFilters|resource-groups:Name" }, "TargetLocation":{ "type":"structure", "members":{ "Accounts":{ "shape":"Accounts", "documentation":"

The Amazon Web Services accounts targeted by the current Automation execution.

" }, "Regions":{ "shape":"Regions", "documentation":"

The Amazon Web Services Regions targeted by the current Automation execution.

" }, "TargetLocationMaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

", "box":true }, "TargetLocationMaxErrors":{ "shape":"MaxErrors", "documentation":"

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

", "box":true }, "ExecutionRoleName":{ "shape":"ExecutionRoleName", "documentation":"

The Automation execution role used by the currently running Automation. If not specified, the default value is `AWS-SystemsManager-AutomationExecutionRole`.

", "box":true }, "TargetLocationAlarmConfiguration":{ "shape":"AlarmConfiguration", "box":true } }, "documentation":"

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

" }, "TargetLocations":{ "type":"list", "member":{"shape":"TargetLocation"}, "max":100, "min":1 }, "TargetMap":{ "type":"map", "key":{"shape":"TargetMapKey"}, "value":{"shape":"TargetMapValueList"}, "max":20, "min":1 }, "TargetMapKey":{ "type":"string", "max":50, "min":1 }, "TargetMapValue":{ "type":"string", "max":50, "min":1 }, "TargetMapValueList":{ "type":"list", "member":{"shape":"TargetMapValue"}, "max":25, "min":0 }, "TargetMaps":{ "type":"list", "member":{"shape":"TargetMap"}, "max":300, "min":0 }, "TargetNotConnected":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Getting started with Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on a managed node that is located in a different account or Region

", "exception":true }, "TargetParameterList":{ "type":"list", "member":{"shape":"ParameterValue"} }, "TargetType":{ "type":"string", "max":200, "pattern":"^\\/[\\w\\.\\-\\:\\/]*$" }, "TargetValue":{"type":"string"}, "TargetValues":{ "type":"list", "member":{"shape":"TargetValue"}, "max":50, "min":0 }, "Targets":{ "type":"list", "member":{"shape":"Target"}, "max":5, "min":0 }, "TerminateSessionRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The ID of the session to terminate.

" } } }, "TerminateSessionResponse":{ "type":"structure", "members":{ "SessionId":{ "shape":"SessionId", "documentation":"

The ID of the session that has been terminated.

" } } }, "TimeoutSeconds":{ "type":"integer", "max":2592000, "min":30 }, "TokenValue":{ "type":"string", "max":300, "min":0 }, "TooManyTagsError":{ "type":"structure", "members":{ }, "documentation":"

The `Targets` parameter includes too many tags. Remove one or more tags and try the command again.

", "exception":true }, "TooManyUpdates":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

There are concurrent updates for a resource that supports one update at a time.

", "exception":true }, "TotalCount":{"type":"integer"}, "TotalSizeLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The size of inventory data has exceeded the total size limit for the resource.

", "exception":true }, "UUID":{ "type":"string", "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "UnlabelParameterVersionRequest":{ "type":"structure", "required":[ "Name", "ParameterVersion", "Labels" ], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter from which you want to delete one or more labels.

" }, "ParameterVersion":{ "shape":"PSParameterVersion", "documentation":"

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.

", "box":true }, "Labels":{ "shape":"ParameterLabelList", "documentation":"

One or more labels to delete from the specified parameter version.

" } } }, "UnlabelParameterVersionResult":{ "type":"structure", "members":{ "RemovedLabels":{ "shape":"ParameterLabelList", "documentation":"

A list of all labels deleted from the parameter.

" }, "InvalidLabels":{ "shape":"ParameterLabelList", "documentation":"

The labels that aren't attached to the given parameter version.

" } } }, "UnsupportedCalendarException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The calendar entry contained in the specified SSM document isn't supported.

", "exception":true }, "UnsupportedFeatureRequiredException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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 Enabling the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.

", "exception":true }, "UnsupportedInventoryItemContextException":{ "type":"structure", "members":{ "TypeName":{"shape":"InventoryItemTypeName"}, "Message":{"shape":"String"} }, "documentation":"

The `Context` attribute that you specified for the `InventoryItem` isn't allowed for this inventory type. You can only use the `Context` attribute with inventory types like `AWS:ComplianceItem`.

", "exception":true }, "UnsupportedInventorySchemaVersionException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

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.

", "exception":true }, "UnsupportedOperatingSystem":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The operating systems you specified isn't supported, or the operation isn't supported for the operating system.

", "exception":true }, "UnsupportedParameterType":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The parameter type isn't supported.

", "exception":true }, "UnsupportedPlatformType":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.

", "exception":true }, "UpdateAssociationRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The ID of the association you want to update.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

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 `{{ssm:parameter-name}}`.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version you want update for the association.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the `default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default`.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The cron expression used to schedule the association that you want to update.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An S3 bucket where you want to store the results of this request.

" }, "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.

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:

`arn:aws:ssm:region:account-id:document/document-name`

For example:

`arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`

For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, `AWS-ApplyPatchBaseline` or `My-Document`.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets of the association.

" }, "AssociationName":{ "shape":"AssociationName", "documentation":"

The name of the association that you want to update.

" }, "AssociationVersion":{ "shape":"AssociationVersion", "documentation":"

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 `$LATEST`, or omit this parameter.

" }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", "documentation":"

Choose the parameter that will define how your automation will branch out. 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.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

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 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when `MaxErrors` 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 `MaxConcurrency` to 1 so that executions proceed one at a time.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

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.

If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.

" }, "ComplianceSeverity":{ "shape":"AssociationComplianceSeverity", "documentation":"

The severity level to assign to the association.

" }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", "documentation":"

The mode for generating association compliance. You can specify `AUTO` or `MANUAL`. In `AUTO` 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 `COMPLIANT`. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`.

In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use `AUTO` mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", "documentation":"

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.

If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the `Latest` version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association.

You can reset this option. To do so, specify the `no-apply-only-at-cron-interval` 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.

" }, "CalendarNames":{ "shape":"CalendarNameOrARNList", "documentation":"

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 Amazon Web Services Systems Manager Change Calendar.

" }, "TargetLocations":{ "shape":"TargetLocations", "documentation":"

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.

" }, "ScheduleOffset":{ "shape":"ScheduleOffset", "documentation":"

Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of `cron(0 0 ? * THU#2 *)`, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

To use offsets, you must specify the `ApplyOnlyAtCronInterval` parameter. This option tells the system not to run an association immediately after you create it.

", "box":true }, "TargetMaps":{ "shape":"TargetMaps", "documentation":"

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

", "box":true }, "AlarmConfiguration":{"shape":"AlarmConfiguration"} } }, "UpdateAssociationResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

The description of the association that was updated.

" } } }, "UpdateAssociationStatusRequest":{ "type":"structure", "required":[ "Name", "InstanceId", "AssociationStatus" ], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The managed node ID.

" }, "AssociationStatus":{ "shape":"AssociationStatus", "documentation":"

The association status.

" } } }, "UpdateAssociationStatusResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

Information about the association.

" } } }, "UpdateDocumentDefaultVersionRequest":{ "type":"structure", "required":[ "Name", "DocumentVersion" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

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

" }, "DocumentVersion":{ "shape":"DocumentVersionNumber", "documentation":"

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

" } } }, "UpdateDocumentDefaultVersionResult":{ "type":"structure", "members":{ "Description":{ "shape":"DocumentDefaultVersionDescription", "documentation":"

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

" } } }, "UpdateDocumentMetadataRequest":{ "type":"structure", "required":[ "Name", "DocumentReviews" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the change template for which a version's metadata is to be updated.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of a change template in which to update approval metadata.

" }, "DocumentReviews":{ "shape":"DocumentReviews", "documentation":"

The change template review details to update.

" } } }, "UpdateDocumentMetadataResponse":{ "type":"structure", "members":{ } }, "UpdateDocumentRequest":{ "type":"structure", "required":[ "Content", "Name" ], "members":{ "Content":{ "shape":"DocumentContent", "documentation":"

A valid JSON or YAML string.

" }, "Attachments":{ "shape":"AttachmentsSourceList", "documentation":"

A list of key-value pairs that describe attachments to a version of a document.

" }, "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document that you want to update.

" }, "DisplayName":{ "shape":"DocumentDisplayName", "documentation":"

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.

" }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"

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.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

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 `$LATEST` variable.

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

" }, "DocumentFormat":{ "shape":"DocumentFormat", "documentation":"

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

" }, "TargetType":{ "shape":"TargetType", "documentation":"

Specify a new target type for the document.

" } } }, "UpdateDocumentResult":{ "type":"structure", "members":{ "DocumentDescription":{ "shape":"DocumentDescription", "documentation":"

A description of the document that was updated.

" } } }, "UpdateMaintenanceWindowRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window to update.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the maintenance window.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

An optional description for the update request.

" }, "StartDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. `StartDate` allows you to delay activation of the maintenance window until the specified future date.

" }, "EndDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. `EndDate` allows you to set a date and time in the future when the maintenance window will no longer run.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the maintenance window in the form of a cron or rate expression.

" }, "ScheduleTimezone":{ "shape":"MaintenanceWindowTimezone", "documentation":"

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 Time Zone Database on the IANA website.

" }, "ScheduleOffset":{ "shape":"MaintenanceWindowOffset", "documentation":"

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

`cron(30 23 ? * TUE#3 *)`

If the schedule offset is `2`, the maintenance window won't run until two days later.

", "box":true }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the maintenance window in hours.

", "box":true }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

", "box":true }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

", "box":true }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Whether the maintenance window is enabled.

", "box":true }, "Replace":{ "shape":"Boolean", "documentation":"

If `True`, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

", "box":true } } }, "UpdateMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the created maintenance window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the maintenance window.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

An optional description of the update.

" }, "StartDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

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.

" }, "EndDate":{ "shape":"MaintenanceWindowStringDateTime", "documentation":"

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.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the maintenance window in the form of a cron or rate expression.

" }, "ScheduleTimezone":{ "shape":"MaintenanceWindowTimezone", "documentation":"

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 Time Zone Database on the IANA website.

" }, "ScheduleOffset":{ "shape":"MaintenanceWindowOffset", "documentation":"

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

", "box":true }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the maintenance window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

" }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

" }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Whether the maintenance window is enabled.

" } } }, "UpdateMaintenanceWindowTargetRequest":{ "type":"structure", "required":[ "WindowId", "WindowTargetId" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The maintenance window ID with which to modify the target.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The target ID to modify.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets to add or replace.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

A name for the update.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

An optional description for the update.

" }, "Replace":{ "shape":"Boolean", "documentation":"

If `True`, then all fields that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

", "box":true } } }, "UpdateMaintenanceWindowTargetResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The maintenance window ID specified in the update request.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The target ID specified in the update request.

" }, "Targets":{ "shape":"Targets", "documentation":"

The updated targets.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

The updated owner.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The updated name.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

The updated description.

" } } }, "UpdateMaintenanceWindowTaskRequest":{ "type":"structure", "required":[ "WindowId", "WindowTaskId" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The maintenance window ID that contains the task to modify.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The task ID to modify.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format `Key=instanceids,Values=instanceID_1,instanceID_2`. Tags are specified using the format `Key=tag_name,Values=tag_value`.

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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The task ARN to modify.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

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 `RegisterTaskWithMaintenanceWindow`.

For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:

- Using service-linked roles for Systems Manager

- Should I use a service-linked role or a custom service role to run maintenance window tasks?

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParameters", "documentation":"

The parameters to modify.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

" }, "TaskInvocationParameters":{ "shape":"MaintenanceWindowTaskInvocationParameters", "documentation":"

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in `TaskInvocationParameters`, you must provide again all the `TaskInvocationParameters` 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 `TaskInvocationParameters` values for `Comment`, `NotificationConfig`, and `OutputS3BucketName`. If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

", "box":true }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The new `MaxConcurrency` value you want to specify. `MaxConcurrency` is the number of targets that are allowed to run this task, in parallel.

Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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 `1`. This value doesn't affect the running of your task.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The new `MaxErrors` value to specify. `MaxErrors` is the maximum number of errors that are allowed before the task stops being scheduled.

Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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 `1`. This value doesn't affect the running of your task.

" }, "LoggingInfo":{ "shape":"LoggingInfo", "documentation":"

The new logging location in Amazon S3 to specify.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The new task name to specify.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

The new task description to specify.

" }, "Replace":{ "shape":"Boolean", "documentation":"

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

", "box":true }, "CutoffBehavior":{ "shape":"MaintenanceWindowTaskCutoffBehavior", "documentation":"

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

- `CONTINUE_TASK`: When the cutoff time is reached, any tasks that are running continue. The default value.

- `CANCEL_TASK`:

  - 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.

  - For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand 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.

  The status for tasks that are not completed is `TIMED_OUT`.

", "box":true }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The CloudWatch alarm you want to apply to your maintenance window task.

" } } }, "UpdateMaintenanceWindowTaskResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the maintenance window that was updated.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The task ID of the maintenance window that was updated.

" }, "Targets":{ "shape":"Targets", "documentation":"

The updated target values.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The updated task ARN value.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

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.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParameters", "documentation":"

The updated parameter values.

`TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "TaskInvocationParameters":{ "shape":"MaintenanceWindowTaskInvocationParameters", "documentation":"

The updated parameter values.

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

The updated priority value.

" }, "MaxConcurrency":{ "shape":"MaxConcurrency", "documentation":"

The updated `MaxConcurrency` value.

" }, "MaxErrors":{ "shape":"MaxErrors", "documentation":"

The updated `MaxErrors` value.

" }, "LoggingInfo":{ "shape":"LoggingInfo", "documentation":"

The updated logging information in Amazon S3.

`LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The updated task name.

" }, "Description":{ "shape":"MaintenanceWindowDescription", "documentation":"

The updated task description.

" }, "CutoffBehavior":{ "shape":"MaintenanceWindowTaskCutoffBehavior", "documentation":"

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

", "box":true }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

The details for the CloudWatch alarm you applied to your maintenance window task.

" } } }, "UpdateManagedInstanceRoleRequest":{ "type":"structure", "required":[ "InstanceId", "IamRole" ], "members":{ "InstanceId":{ "shape":"ManagedInstanceId", "documentation":"

The ID of the managed node where you want to update the role.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal `ssm.amazonaws.com`. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

" } } }, "UpdateManagedInstanceRoleResult":{ "type":"structure", "members":{ } }, "UpdateOpsItemRequest":{ "type":"structure", "required":["OpsItemId"], "members":{ "Description":{ "shape":"OpsItemDescription", "documentation":"

User-defined text that contains information about the OpsItem, in Markdown format.

" }, "OperationalData":{ "shape":"OpsItemOperationalData", "documentation":"

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

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.

Operational data keys can't begin with the following: `amazon`, `aws`, `amzn`, `ssm`, `/amazon`, `/aws`, `/amzn`, `/ssm`.

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 DescribeOpsItems 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 GetOpsItem API operation).

Use the `/aws/resources` key in OperationalData to specify a related resource in the request. Use the `/aws/automations` key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

" }, "OperationalDataToDelete":{ "shape":"OpsItemOpsDataKeysList", "documentation":"

Keys that you want to remove from the OperationalData map.

" }, "Notifications":{ "shape":"OpsItemNotifications", "documentation":"

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

" }, "Priority":{ "shape":"OpsItemPriority", "documentation":"

The importance of this OpsItem in relation to other OpsItems in the system.

" }, "RelatedOpsItems":{ "shape":"RelatedOpsItems", "documentation":"

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.

" }, "Status":{ "shape":"OpsItemStatus", "documentation":"

The OpsItem status. Status can be `Open`, `In Progress`, or `Resolved`. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

" }, "OpsItemId":{ "shape":"OpsItemId", "documentation":"

The ID of the OpsItem.

" }, "Title":{ "shape":"OpsItemTitle", "documentation":"

A short heading that describes the nature of the OpsItem and the impacted resource.

" }, "Category":{ "shape":"OpsItemCategory", "documentation":"

Specify a new category for an OpsItem.

" }, "Severity":{ "shape":"OpsItemSeverity", "documentation":"

Specify a new severity for an OpsItem.

" }, "ActualStartTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow started. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "ActualEndTime":{ "shape":"DateTime", "documentation":"

The time a runbook workflow ended. Currently reported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedStartTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type `/aws/changerequest`.

" }, "PlannedEndTime":{ "shape":"DateTime", "documentation":"

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type `/aws/changerequest`.

" }, "OpsItemArn":{ "shape":"OpsItemArn", "documentation":"

The OpsItem Amazon Resource Name (ARN).

" } } }, "UpdateOpsItemResponse":{ "type":"structure", "members":{ } }, "UpdateOpsMetadataRequest":{ "type":"structure", "required":["OpsMetadataArn"], "members":{ "OpsMetadataArn":{ "shape":"OpsMetadataArn", "documentation":"

The Amazon Resource Name (ARN) of the OpsMetadata Object to update.

" }, "MetadataToUpdate":{ "shape":"MetadataMap", "documentation":"

Metadata to add to an OpsMetadata object.

" }, "KeysToDelete":{ "shape":"MetadataKeysToDeleteList", "documentation":"

The metadata keys to delete from the OpsMetadata object.

" } } }, "UpdateOpsMetadataResult":{ "type":"structure", "members":{ "OpsMetadataArn":{ "shape":"OpsMetadataArn", "documentation":"

The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.

" } } }, "UpdatePatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to update.

" }, "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to include patches in the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

" }, "ApprovedPatchesComplianceLevel":{ "shape":"PatchComplianceLevel", "documentation":"

Assigns a new compliance severity level to an existing patch baseline.

" }, "ApprovedPatchesEnableNonSecurity":{ "shape":"Boolean", "documentation":"

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.

", "box":true }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

" }, "RejectedPatchesAction":{ "shape":"PatchAction", "documentation":"

The action for Patch Manager to take on patches included in the `RejectedPackages` list.

- `ALLOW_AS_DEPENDENCY` : A package in the `Rejected` 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 `InstalledOther`. This is the default action if no option is specified.

- `BLOCK` : Packages in the `RejectedPatches` 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 `InstalledRejected`.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the patch baseline.

" }, "Sources":{ "shape":"PatchSourceList", "documentation":"

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

" }, "Replace":{ "shape":"Boolean", "documentation":"

If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

", "box":true } } }, "UpdatePatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the deleted patch baseline.

" }, "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

The operating system rule used by the updated patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to exclude patches from the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

" }, "ApprovedPatchesComplianceLevel":{ "shape":"PatchComplianceLevel", "documentation":"

The compliance severity level assigned to the patch baseline after the update completed.

" }, "ApprovedPatchesEnableNonSecurity":{ "shape":"Boolean", "documentation":"

Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is `false`. Applies to Linux managed nodes only.

", "box":true }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

" }, "RejectedPatchesAction":{ "shape":"PatchAction", "documentation":"

The action specified to take on patches included in the `RejectedPatches` 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.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date when the patch baseline was created.

" }, "ModifiedDate":{ "shape":"DateTime", "documentation":"

The date when the patch baseline was last modified.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the patch baseline.

" }, "Sources":{ "shape":"PatchSourceList", "documentation":"

Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

" } } }, "UpdateResourceDataSyncRequest":{ "type":"structure", "required":[ "SyncName", "SyncType", "SyncSource" ], "members":{ "SyncName":{ "shape":"ResourceDataSyncName", "documentation":"

The name of the resource data sync you want to update.

" }, "SyncType":{ "shape":"ResourceDataSyncType", "documentation":"

The type of resource data sync. The supported `SyncType` is SyncFromSource.

" }, "SyncSource":{ "shape":"ResourceDataSyncSource", "documentation":"

Specify information about the data sources to synchronize.

" } } }, "UpdateResourceDataSyncResult":{ "type":"structure", "members":{ } }, "UpdateServiceSettingRequest":{ "type":"structure", "required":[ "SettingId", "SettingValue" ], "members":{ "SettingId":{ "shape":"ServiceSettingId", "documentation":"

The Amazon Resource Name (ARN) of the service setting to update. For example, `arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled`. The setting ID can be one of the following.

- `/ssm/managed-instance/default-ec2-instance-management-role`

- `/ssm/automation/customer-script-log-destination`

- `/ssm/automation/customer-script-log-group-name`

- `/ssm/documents/console/public-sharing-permission`

- `/ssm/managed-instance/activation-tier`

- `/ssm/opsinsights/opscenter`

- `/ssm/parameter-store/default-parameter-tier`

- `/ssm/parameter-store/high-throughput-enabled`

Permissions to update the `/ssm/managed-instance/default-ec2-instance-management-role` setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.

" }, "SettingValue":{ "shape":"ServiceSettingValue", "documentation":"

The new value to specify for the service setting. The following list specifies the available values for each setting.

- For `/ssm/managed-instance/default-ec2-instance-management-role`, enter the name of an IAM role.

- For `/ssm/automation/customer-script-log-destination`, enter `CloudWatch`.

- For `/ssm/automation/customer-script-log-group-name`, enter the name of an Amazon CloudWatch Logs log group.

- For `/ssm/documents/console/public-sharing-permission`, enter `Enable` or `Disable`.

- For `/ssm/managed-instance/activation-tier`, enter `standard` or `advanced`.

- For `/ssm/opsinsights/opscenter`, enter `Enabled` or `Disabled`.

- For `/ssm/parameter-store/default-parameter-tier`, enter `Standard`, `Advanced`, or `Intelligent-Tiering`

- For `/ssm/parameter-store/high-throughput-enabled`, enter `true` or `false`.

" } }, "documentation":"

The request body of the UpdateServiceSetting API operation.

" }, "UpdateServiceSettingResult":{ "type":"structure", "members":{ }, "documentation":"

The result body of the UpdateServiceSetting API operation.

" }, "Url":{"type":"string"}, "ValidNextStep":{ "type":"string", "max":65535, "min":1 }, "ValidNextStepList":{ "type":"list", "member":{"shape":"ValidNextStep"} }, "Version":{ "type":"string", "pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" } }, "documentation":"

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

Related resources

- For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.

- For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .

- For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .

- For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .

" }