Types (smaws-clients.Smaws_Client

type nonrec version = string

type nonrec string_ = string

type nonrec validation_exception = {

reason_code : string_ option;
(*
The reason code for the invalid request.
*)
message : string_ option;

}

The request isn't valid. Verify that you entered valid contents for the command and try again.

type nonrec valid_next_step = string

type nonrec valid_next_step_list = valid_next_step list

type nonrec url = string

type nonrec update_service_setting_result = unit

type nonrec service_setting_id = string

type nonrec service_setting_value = string

type nonrec update_service_setting_request = {

setting_value : service_setting_value;
(*
The new value to specify for the service setting. The following list specifies the available values for each setting.
- For /ssm/appmanager/appmanager-enabled, enter True or False.
- 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/managed-instance/default-ec2-instance-management-role, enter the name of an IAM role.
- 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.
*)
setting_id : service_setting_id;
(*
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/appmanager/appmanager-enabled
- /ssm/automation/customer-script-log-destination
- /ssm/automation/customer-script-log-group-name
- /ssm/automation/enable-adaptive-concurrency
- /ssm/documents/console/public-sharing-permission
- /ssm/managed-instance/activation-tier
- /ssm/managed-instance/default-ec2-instance-management-role
- /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.
*)

}

The request body of the UpdateServiceSetting API operation.

type nonrec too_many_updates = {

message : string_ option;

}

There are concurrent updates for a resource that supports one update at a time.

type nonrec service_setting_not_found = {

message : string_ option;

}

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.

type nonrec internal_server_error = {

message : string_ option;

}

An error occurred on the server side.

type nonrec update_resource_data_sync_result = unit

type nonrec resource_data_sync_name = string

type nonrec resource_data_sync_type = string

type nonrec resource_data_sync_source_type = string

type nonrec resource_data_sync_organization_source_type = string

type nonrec resource_data_sync_organizational_unit_id = string

type nonrec resource_data_sync_organizational_unit = {

organizational_unit_id : resource_data_sync_organizational_unit_id option;
(*
The Organizations unit ID data source for the sync.
*)

}

The Organizations organizational unit data source for the sync.

type nonrec resource_data_sync_organizational_unit_list =
  resource_data_sync_organizational_unit list

type nonrec resource_data_sync_aws_organizations_source = {

organizational_units : resource_data_sync_organizational_unit_list option;
(*
The Organizations organization units included in the sync.
*)
organization_source_type : resource_data_sync_organization_source_type;
(*
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.
*)

}

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.

type nonrec resource_data_sync_source_region = string

type nonrec resource_data_sync_source_region_list =
  resource_data_sync_source_region list

type nonrec resource_data_sync_include_future_regions = bool

type nonrec resource_data_sync_enable_all_ops_data_sources = bool

type nonrec resource_data_sync_source = {

enable_all_ops_data_sources : resource_data_sync_enable_all_ops_data_sources option;
(*
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 Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.
*)
include_future_regions : resource_data_sync_include_future_regions option;
(*
Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.
*)
source_regions : resource_data_sync_source_region_list;
(*
The SyncSource Amazon Web Services Regions included in the resource data sync.
*)
aws_organizations_source : resource_data_sync_aws_organizations_source option;
(*
Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations.
*)
source_type : resource_data_sync_source_type;
(*
The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or SingleAccountMultiRegions.
*)

}

Information about the source of the data included in the resource data sync.

type nonrec update_resource_data_sync_request = {

sync_source : resource_data_sync_source;
(*
Specify information about the data sources to synchronize.
*)
sync_type : resource_data_sync_type;
(*
The type of resource data sync. The supported SyncType is SyncFromSource.
*)
sync_name : resource_data_sync_name;
(*
The name of the resource data sync you want to update.
*)

}

type nonrec resource_data_sync_not_found_exception = {

message : string_ option;
sync_type : resource_data_sync_type option;
sync_name : resource_data_sync_name option;

}

The specified sync name wasn't found.

type nonrec resource_data_sync_invalid_configuration_exception = {

message : string_ option;

}

The specified sync configuration is invalid.

type nonrec resource_data_sync_conflict_exception = {

message : string_ option;

}

Another UpdateResourceDataSync request is being processed. Wait a few minutes and try again.

type nonrec baseline_id = string

type nonrec baseline_name = string

type nonrec operating_system =

| AmazonLinux2023
| AlmaLinux
| Rocky_Linux
| Raspbian
| MacOS
| Debian
| OracleLinux
| CentOS
| Suse
| RedhatEnterpriseLinux
| Ubuntu
| AmazonLinux2022
| AmazonLinux2
| AmazonLinux
| Windows

type nonrec patch_filter_key =

| Version
| Security
| Severity
| Release
| Repository
| Priority
| Section
| PatchId
| Name
| MsrcSeverity
| Epoch
| CVEId
| Classification
| ProductFamily
| Product
| PatchSet
| BugzillaId
| AdvisoryId
| Arch

type nonrec patch_filter_value = string

type nonrec patch_filter_value_list = patch_filter_value list

type nonrec patch_filter = {

values : patch_filter_value_list;
(*
The value for the filter key.
Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.
*)
key : patch_filter_key;
(*
The key for the filter.
Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
*)

}

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.

type nonrec patch_filter_list = patch_filter list

type nonrec patch_filter_group = {

patch_filters : patch_filter_list;
(*
The set of patch filters that make up the group.
*)

}

A set of patch filters, typically used for approval rules.

type nonrec patch_compliance_level =

| Unspecified
| Informational
| Low
| Medium
| High
| Critical

type nonrec approve_after_days = int

type nonrec patch_string_date_time = string

type nonrec boolean_ = bool

type nonrec patch_rule = {

enable_non_security : boolean_ option;
(*
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.
*)
approve_until_date : patch_string_date_time option;
(*
The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically.
Enter dates in the format YYYY-MM-DD. For example, 2024-12-31.
This parameter is marked as Required: No, but your request must include a value for either ApproveUntilDate or ApproveAfterDays.
Not supported for Debian Server or Ubuntu Server.
Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.
*)
approve_after_days : approve_after_days option;
(*
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.
This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate.
Not supported for Debian Server or Ubuntu Server.
Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.
*)
compliance_level : patch_compliance_level option;
(*
A compliance severity level for all approved patches in a patch baseline.
*)
patch_filter_group : patch_filter_group;
(*
The patch filter group that defines the criteria for the rule.
*)

}

Defines an approval rule for a patch baseline.

type nonrec patch_rule_list = patch_rule list

type nonrec patch_rule_group = {

patch_rules : patch_rule_list;
(*
The rules that make up the rule group.
*)

}

A set of rules defining the approval rules for a patch baseline.

type nonrec patch_id = string

type nonrec patch_id_list = patch_id list

type nonrec patch_action =

| Block
| AllowAsDependency

type nonrec date_time = Smaws_Lib.CoreTypes.Timestamp.t

type nonrec baseline_description = string

type nonrec patch_source_name = string

type nonrec patch_source_product = string

type nonrec patch_source_product_list = patch_source_product list

type nonrec patch_source_configuration = string

type nonrec patch_source = {

configuration : patch_source_configuration;
(*
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).
*)
products : patch_source_product_list;
(*
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.
*)
name : patch_source_name;
(*
The name specified to identify the patch source.
*)

}

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

type nonrec patch_source_list = patch_source list

type nonrec patch_compliance_status =

| NonCompliant
| Compliant

type nonrec update_patch_baseline_result = {

available_security_updates_compliance_status : patch_compliance_status option;
(*
Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. This preference is specified when the CreatePatchBaseline or UpdatePatchBaseline commands are run.
Applies to Windows Server managed nodes only.
*)
sources : patch_source_list option;
(*
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
*)
description : baseline_description option;
(*
A description of the patch baseline.
*)
modified_date : date_time option;
(*
The date when the patch baseline was last modified.
*)
created_date : date_time option;
(*
The date when the patch baseline was created.
*)
rejected_patches_action : patch_action option;
(*
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.
*)
rejected_patches : patch_id_list option;
(*
A list of explicitly rejected patches for the baseline.
*)
approved_patches_enable_non_security : boolean_ option;
(*
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.
*)
approved_patches_compliance_level : patch_compliance_level option;
(*
The compliance severity level assigned to the patch baseline after the update completed.
*)
approved_patches : patch_id_list option;
(*
A list of explicitly approved patches for the baseline.
*)
approval_rules : patch_rule_group option;
(*
A set of rules used to include patches in the baseline.
*)
global_filters : patch_filter_group option;
(*
A set of global filters used to exclude patches from the baseline.
*)
operating_system : operating_system option;
(*
The operating system rule used by the updated patch baseline.
*)
name : baseline_name option;
(*
The name of the patch baseline.
*)
baseline_id : baseline_id option;
(*
The ID of the deleted patch baseline.
*)

}

type nonrec update_patch_baseline_request = {

replace : boolean_ option;
(*
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.
*)
available_security_updates_compliance_status : patch_compliance_status option;
(*
Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.
Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.
Supported for Windows Server managed nodes only.
*)
sources : patch_source_list option;
(*
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
*)
description : baseline_description option;
(*
A description of the patch baseline.
*)
rejected_patches_action : patch_action option;
(*
The action for Patch Manager to take on patches included in the RejectedPackages list.
ALLOW_AS_DEPENDENCY Linux and macOS: 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 INSTALLED_OTHER. This is the default action if no option is specified.
Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.
BLOCK All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED.
*)
rejected_patches : patch_id_list option;
(*
A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
*)
approved_patches_enable_non_security : boolean_ option;
(*
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.
*)
approved_patches_compliance_level : patch_compliance_level option;
(*
Assigns a new compliance severity level to an existing patch baseline.
*)
approved_patches : patch_id_list option;
(*
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
*)
approval_rules : patch_rule_group option;
(*
A set of rules used to include patches in the baseline.
*)
global_filters : patch_filter_group option;
(*
A set of global filters used to include patches in the baseline.
The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.
*)
name : baseline_name option;
(*
The name of the patch baseline.
*)
baseline_id : baseline_id;
(*
The ID of the patch baseline to update.
*)

}

type nonrec does_not_exist_exception = {

message : string_ option;

}

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.

type nonrec ops_metadata_arn = string

type nonrec update_ops_metadata_result = {

ops_metadata_arn : ops_metadata_arn option;
(*
The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.
*)

}

type nonrec metadata_value_string = string

type nonrec metadata_value = {

value : metadata_value_string option;
(*
Metadata value to assign to an Application Manager application.
*)

}

Metadata to assign to an Application Manager application.

type nonrec metadata_key = string

type nonrec metadata_map = (metadata_key * metadata_value) list

type nonrec metadata_keys_to_delete_list = metadata_key list

type nonrec update_ops_metadata_request = {

keys_to_delete : metadata_keys_to_delete_list option;
(*
The metadata keys to delete from the OpsMetadata object.
*)
metadata_to_update : metadata_map option;
(*
Metadata to add to an OpsMetadata object.
*)
ops_metadata_arn : ops_metadata_arn;
(*
The Amazon Resource Name (ARN) of the OpsMetadata Object to update.
*)

}

type nonrec ops_metadata_too_many_updates_exception = {

message : string_ option;

}

The system is processing too many concurrent updates. Wait a few moments and try again.

type nonrec ops_metadata_not_found_exception = {

message : string_ option;

}

The OpsMetadata object doesn't exist.

type nonrec ops_metadata_key_limit_exceeded_exception = {

message : string_ option;

}

The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.

type nonrec ops_metadata_invalid_argument_exception = {

message : string_ option;

}

One of the arguments passed is invalid.

type nonrec update_ops_item_response = unit

type nonrec ops_item_description = string

type nonrec ops_item_data_value_string = string

type nonrec ops_item_data_type =

| STRING
| SEARCHABLE_STRING

type nonrec ops_item_data_value = {

type_ : ops_item_data_type option;
(*
The type of key-value pair. Valid types include SearchableString and String.
*)
value : ops_item_data_value_string option;
(*
The value of the OperationalData key.
*)

}

An object that defines the value of the key and its type in the OperationalData map.

type nonrec ops_item_data_key = string

type nonrec ops_item_operational_data =
  (ops_item_data_key * ops_item_data_value) list

type nonrec ops_item_ops_data_keys_list = string_ list

type nonrec ops_item_notification = {

arn : string_ option;
(*
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.
*)

}

A notification about the OpsItem.

type nonrec ops_item_notifications = ops_item_notification list

type nonrec ops_item_priority = int

type nonrec related_ops_item = {

ops_item_id : string_;
(*
The ID of an OpsItem related to the current OpsItem.
*)

}

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.

type nonrec related_ops_items = related_ops_item list

type nonrec ops_item_status =

| CLOSED
| REJECTED
| REVOKED
| APPROVED
| PENDING_APPROVAL
| CHANGE_CALENDAR_OVERRIDE_REJECTED
| CHANGE_CALENDAR_OVERRIDE_APPROVED
| PENDING_CHANGE_CALENDAR_OVERRIDE
| RUNBOOK_IN_PROGRESS
| SCHEDULED
| COMPLETED_WITH_FAILURE
| COMPLETED_WITH_SUCCESS
| FAILED
| CANCELLED
| CANCELLING
| TIMED_OUT
| PENDING
| RESOLVED
| IN_PROGRESS
| OPEN

type nonrec ops_item_id = string

type nonrec ops_item_title = string

type nonrec ops_item_category = string

type nonrec ops_item_severity = string

type nonrec ops_item_arn = string

type nonrec update_ops_item_request = {

ops_item_arn : ops_item_arn option;
(*
The OpsItem Amazon Resource Name (ARN).
*)
planned_end_time : date_time option;
(*
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
*)
planned_start_time : date_time option;
(*
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
*)
actual_end_time : date_time option;
(*
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
*)
actual_start_time : date_time option;
(*
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
*)
severity : ops_item_severity option;
(*
Specify a new severity for an OpsItem.
*)
category : ops_item_category option;
(*
Specify a new category for an OpsItem.
*)
title : ops_item_title option;
(*
A short heading that describes the nature of the OpsItem and the impacted resource.
*)
ops_item_id : ops_item_id;
(*
The ID of the OpsItem.
*)
status : ops_item_status option;
(*
The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
*)
related_ops_items : related_ops_items option;
(*
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.
*)
priority : ops_item_priority option;
(*
The importance of this OpsItem in relation to other OpsItems in the system.
*)
notifications : ops_item_notifications option;
(*
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
*)
operational_data_to_delete : ops_item_ops_data_keys_list option;
(*
Keys that you want to remove from the OperationalData map.
*)
operational_data : ops_item_operational_data option;
(*
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.
*)
description : ops_item_description option;
(*
User-defined text that contains information about the OpsItem, in Markdown format.
*)

}

type nonrec ops_item_not_found_exception = {

message : string_ option;

}

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

type nonrec ops_item_parameter_names_list = string_ list

type nonrec integer = int

type nonrec ops_item_limit_exceeded_exception = {

message : string_ option;
limit_type : string_ option;
limit : integer option;
resource_types : ops_item_parameter_names_list option;

}

The request caused OpsItems to exceed one or more quotas.

type nonrec ops_item_invalid_parameter_exception = {

message : string_ option;
parameter_names : ops_item_parameter_names_list option;

}

A specified parameter argument isn't valid. Verify the available arguments and try again.

type nonrec ops_item_conflict_exception = {

message : string_ option;

}

The specified OpsItem is in the process of being deleted.

type nonrec ops_item_already_exists_exception = {

ops_item_id : string_ option;
message : string_ option;

}

The OpsItem already exists.

type nonrec ops_item_access_denied_exception = {

message : string_ option;

}

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.

type nonrec update_managed_instance_role_result = unit

type nonrec managed_instance_id = string

type nonrec iam_role = string

type nonrec update_managed_instance_role_request = {

iam_role : iam_role;
(*
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 the IAM service role required for Systems Manager in hybrid and multicloud environments 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.
*)
instance_id : managed_instance_id;
(*
The ID of the managed node where you want to update the role.
*)

}

type nonrec invalid_instance_id = {

message : string_ option;

}

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 a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

type nonrec maintenance_window_id = string

type nonrec maintenance_window_task_id = string

type nonrec target_key = string

type nonrec target_value = string

type nonrec target_values = target_value list

type nonrec target = {

values : target_values option;
(*
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.
*)
key : target_key option;
(*
User-defined criteria for sending commands that target managed nodes that meet the criteria.
*)

}

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.

For all Systems Manager tools:

Key=tag-key,Values=tag-value-1,tag-value-2

For Automation and Change Manager:

Key=tag:tag-key,Values=tag-value
Key=ResourceGroup,Values=resource-group-name
Key=ParameterValues,Values=value-1,value-2,value-3
To target all instances in the Amazon Web Services Region:
- Key=AWS::EC2::Instance,Values=*
- Key=InstanceIds,Values=*

For Run Command and Maintenance Windows:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Key=resource-groups:Name,Values=resource-group-name
Additionally, Maintenance Windows support targeting resource types:
- Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For State Manager:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
To target all instances in the Amazon Web Services Region:
- Key=InstanceIds,Values=*

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

type nonrec targets = target list

type nonrec maintenance_window_task_arn = string

type nonrec service_role = string

type nonrec maintenance_window_task_parameter_value = string

type nonrec maintenance_window_task_parameter_value_list =
  maintenance_window_task_parameter_value list

type nonrec maintenance_window_task_parameter_value_expression = {

values : maintenance_window_task_parameter_value_list option;
(*
This field contains an array of 0 or more strings, each 1 to 255 characters in length.
*)

}

Defines the values for a task parameter.

type nonrec maintenance_window_task_parameter_name = string

type nonrec maintenance_window_task_parameters =
  (maintenance_window_task_parameter_name
   * maintenance_window_task_parameter_value_expression)
    list

type nonrec comment = string

type nonrec cloud_watch_log_group_name = string

type nonrec cloud_watch_output_enabled = bool

type nonrec cloud_watch_output_config = {

cloud_watch_output_enabled : cloud_watch_output_enabled option;
(*
Enables Systems Manager to send command output to CloudWatch Logs.
*)
cloud_watch_log_group_name : cloud_watch_log_group_name option;
(*
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/{i SystemsManagerDocumentName} 
```
*)

}

Configuration options for sending command output to Amazon CloudWatch Logs.

type nonrec document_hash = string

type nonrec document_hash_type =

| SHA1
| SHA256

type nonrec document_version = string

type nonrec notification_arn = string

type nonrec notification_event =

| FAILED
| CANCELLED
| TIMED_OUT
| SUCCESS
| IN_PROGRESS
| ALL

type nonrec notification_event_list = notification_event list

type nonrec notification_type =

| Invocation
| Command

type nonrec notification_config = {

notification_type : notification_type option;
(*
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.
*)
notification_events : notification_event_list option;
(*
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.
*)
notification_arn : notification_arn option;
(*
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.
*)

}

Configurations for sending notifications.

type nonrec s3_bucket_name = string

type nonrec s3_key_prefix = string

type nonrec parameter_value = string

type nonrec parameter_value_list = parameter_value list

type nonrec parameter_name = string

type nonrec parameters = (parameter_name * parameter_value_list) list

type nonrec timeout_seconds = int

type nonrec maintenance_window_run_command_parameters = {

timeout_seconds : timeout_seconds option;
(*
If this time is reached and the command hasn't already started running, it doesn't run.
*)
service_role_arn : service_role option;
(*
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.
*)
parameters : parameters option;
(*
The parameters for the RUN_COMMAND task execution.
*)
output_s3_key_prefix : s3_key_prefix option;
(*
The S3 bucket subfolder.
*)
output_s3_bucket_name : s3_bucket_name option;
(*
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
*)
notification_config : notification_config option;
(*
Configurations for sending notifications about command status changes on a per-managed node basis.
*)
document_version : document_version option;
(*
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"
*)
document_hash_type : document_hash_type option;
(*
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
*)
document_hash : document_hash option;
(*
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
*)
cloud_watch_output_config : cloud_watch_output_config option;
comment : comment option;
(*
Information about the commands to run.
*)

}

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.

type nonrec automation_parameter_value = string

type nonrec automation_parameter_value_list = automation_parameter_value list

type nonrec automation_parameter_key = string

type nonrec automation_parameter_map =
  (automation_parameter_key * automation_parameter_value_list) list

type nonrec maintenance_window_automation_parameters = {

parameters : automation_parameter_map option;
(*
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.
*)
document_version : document_version option;
(*
The version of an Automation runbook to use during task execution.
*)

}

The parameters for an AUTOMATION task type.

type nonrec maintenance_window_step_functions_input = string

type nonrec maintenance_window_step_functions_name = string

type nonrec maintenance_window_step_functions_parameters = {

name : maintenance_window_step_functions_name option;
(*
The name of the STEP_FUNCTIONS task.
*)
input : maintenance_window_step_functions_input option;
(*
The inputs for the STEP_FUNCTIONS task.
*)

}

The parameters for a STEP_FUNCTIONS task.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

For Step Functions tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

type nonrec maintenance_window_lambda_client_context = string

type nonrec maintenance_window_lambda_qualifier = string

type nonrec maintenance_window_lambda_payload = bytes

type nonrec maintenance_window_lambda_parameters = {

payload : maintenance_window_lambda_payload option;
(*
JSON to provide to your Lambda function as input.
*)
qualifier : maintenance_window_lambda_qualifier option;
(*
(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.
*)
client_context : maintenance_window_lambda_client_context option;
(*
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.
*)

}

The parameters for a LAMBDA task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

type nonrec maintenance_window_task_invocation_parameters = {

lambda : maintenance_window_lambda_parameters option;
(*
The parameters for a LAMBDA task type.
*)
step_functions : maintenance_window_step_functions_parameters option;
(*
The parameters for a STEP_FUNCTIONS task type.
*)
automation : maintenance_window_automation_parameters option;
(*
The parameters for an AUTOMATION task type.
*)
run_command : maintenance_window_run_command_parameters option;
(*
The parameters for a RUN_COMMAND task type.
*)

}

The parameters for task execution.

type nonrec maintenance_window_task_priority = int

type nonrec max_concurrency = string

type nonrec max_errors = string

type nonrec s3_region = string

type nonrec logging_info = {

s3_region : s3_region;
(*
The Amazon Web Services Region where the S3 bucket is located.
*)
s3_key_prefix : s3_key_prefix option;
(*
(Optional) The S3 bucket subfolder.
*)
s3_bucket_name : s3_bucket_name;
(*
The name of an S3 bucket where execution logs are stored.
*)

}

Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

type nonrec maintenance_window_name = string

type nonrec maintenance_window_description = string

type nonrec maintenance_window_task_cutoff_behavior =

| CancelTask
| ContinueTask

type nonrec alarm_name = string

type nonrec alarm = {

name : alarm_name;
(*
The name of your CloudWatch alarm.
*)

}

A CloudWatch alarm you apply to an automation or command.

type nonrec alarm_list = alarm list

type nonrec alarm_configuration = {

alarms : alarm_list;
(*
The name of the CloudWatch alarm specified in the configuration.
*)
ignore_poll_alarm_failure : boolean_ option;
(*
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.
*)

}

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

type nonrec update_maintenance_window_task_result = {

alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm you applied to your maintenance window task.
*)
cutoff_behavior : maintenance_window_task_cutoff_behavior option;
(*
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
*)
description : maintenance_window_description option;
(*
The updated task description.
*)
name : maintenance_window_name option;
(*
The updated task name.
*)
logging_info : logging_info option;
(*
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.
*)
max_errors : max_errors option;
(*
The updated MaxErrors value.
*)
max_concurrency : max_concurrency option;
(*
The updated MaxConcurrency value.
*)
priority : maintenance_window_task_priority option;
(*
The updated priority value.
*)
task_invocation_parameters : maintenance_window_task_invocation_parameters option;
(*
The updated parameter values.
*)
task_parameters : maintenance_window_task_parameters option;
(*
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.
*)
service_role_arn : service_role option;
(*
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.
*)
task_arn : maintenance_window_task_arn option;
(*
The updated task ARN value.
*)
targets : targets option;
(*
The updated target values.
*)
window_task_id : maintenance_window_task_id option;
(*
The task ID of the maintenance window that was updated.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window that was updated.
*)

}

type nonrec update_maintenance_window_task_request = {

alarm_configuration : alarm_configuration option;
(*
The CloudWatch alarm you want to apply to your maintenance window task.
*)
cutoff_behavior : maintenance_window_task_cutoff_behavior option;
(*
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.
*)
replace : boolean_ option;
(*
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.
*)
description : maintenance_window_description option;
(*
The new task description to specify.
*)
name : maintenance_window_name option;
(*
The new task name to specify.
*)
logging_info : logging_info option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
priority : maintenance_window_task_priority option;
(*
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
*)
task_invocation_parameters : maintenance_window_task_invocation_parameters option;
(*
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.
*)
task_parameters : maintenance_window_task_parameters option;
(*
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
*)
service_role_arn : service_role option;
(*
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.
*)
task_arn : maintenance_window_task_arn option;
(*
The task ARN to modify.
*)
targets : targets option;
(*
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.
*)
window_task_id : maintenance_window_task_id;
(*
The task ID to modify.
*)
window_id : maintenance_window_id;
(*
The maintenance window ID that contains the task to modify.
*)

}

type nonrec maintenance_window_target_id = string

type nonrec owner_information = string

type nonrec update_maintenance_window_target_result = {

description : maintenance_window_description option;
(*
The updated description.
*)
name : maintenance_window_name option;
(*
The updated name.
*)
owner_information : owner_information option;
(*
The updated owner.
*)
targets : targets option;
(*
The updated targets.
*)
window_target_id : maintenance_window_target_id option;
(*
The target ID specified in the update request.
*)
window_id : maintenance_window_id option;
(*
The maintenance window ID specified in the update request.
*)

}

type nonrec update_maintenance_window_target_request = {

replace : boolean_ option;
(*
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.
*)
description : maintenance_window_description option;
(*
An optional description for the update.
*)
name : maintenance_window_name option;
(*
A name for the update.
*)
owner_information : owner_information option;
(*
User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
*)
targets : targets option;
(*
The targets to add or replace.
*)
window_target_id : maintenance_window_target_id;
(*
The target ID to modify.
*)
window_id : maintenance_window_id;
(*
The maintenance window ID with which to modify the target.
*)

}

type nonrec maintenance_window_string_date_time = string

type nonrec maintenance_window_schedule = string

type nonrec maintenance_window_timezone = string

type nonrec maintenance_window_offset = int

type nonrec maintenance_window_duration_hours = int

type nonrec maintenance_window_cutoff = int

type nonrec maintenance_window_allow_unassociated_targets = bool

type nonrec maintenance_window_enabled = bool

type nonrec update_maintenance_window_result = {

enabled : maintenance_window_enabled option;
(*
Whether the maintenance window is enabled.
*)
allow_unassociated_targets : maintenance_window_allow_unassociated_targets option;
(*
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
*)
cutoff : maintenance_window_cutoff option;
(*
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
*)
duration : maintenance_window_duration_hours option;
(*
The duration of the maintenance window in hours.
*)
schedule_offset : maintenance_window_offset option;
(*
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
*)
schedule_timezone : maintenance_window_timezone option;
(*
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.
*)
schedule : maintenance_window_schedule option;
(*
The schedule of the maintenance window in the form of a cron or rate expression.
*)
end_date : maintenance_window_string_date_time option;
(*
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.
*)
start_date : maintenance_window_string_date_time option;
(*
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.
*)
description : maintenance_window_description option;
(*
An optional description of the update.
*)
name : maintenance_window_name option;
(*
The name of the maintenance window.
*)
window_id : maintenance_window_id option;
(*
The ID of the created maintenance window.
*)

}

type nonrec update_maintenance_window_request = {

replace : boolean_ option;
(*
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.
*)
enabled : maintenance_window_enabled option;
(*
Whether the maintenance window is enabled.
*)
allow_unassociated_targets : maintenance_window_allow_unassociated_targets option;
(*
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
*)
cutoff : maintenance_window_cutoff option;
(*
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
*)
duration : maintenance_window_duration_hours option;
(*
The duration of the maintenance window in hours.
*)
schedule_offset : maintenance_window_offset option;
(*
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.
*)
schedule_timezone : maintenance_window_timezone option;
(*
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.
*)
schedule : maintenance_window_schedule option;
(*
The schedule of the maintenance window in the form of a cron or rate expression.
*)
end_date : maintenance_window_string_date_time option;
(*
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.
*)
start_date : maintenance_window_string_date_time option;
(*
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.
When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.
*)
description : maintenance_window_description option;
(*
An optional description for the update request.
*)
name : maintenance_window_name option;
(*
The name of the maintenance window.
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window to update.
*)

}

type nonrec document_sha1 = string

type nonrec document_ar_n = string

type nonrec document_display_name = string

type nonrec document_version_name = string

type nonrec document_owner = string

type nonrec document_status =

| Failed
| Deleting
| Updating
| Active
| Creating

The status of a document.

type nonrec document_status_information = string

type nonrec description_in_document = string

type nonrec document_parameter_name = string

type nonrec document_parameter_type =

| StringList
| String

type nonrec document_parameter_descrption = string

type nonrec document_parameter_default_value = string

type nonrec document_parameter = {

default_value : document_parameter_default_value option;
(*
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
*)
description : document_parameter_descrption option;
(*
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
*)
type_ : document_parameter_type option;
(*
The type of parameter. The type can be either String or StringList.
*)
name : document_parameter_name option;
(*
The name of the parameter.
*)

}

Parameters specified in a Systems Manager document that run on the server when the command is run.

type nonrec document_parameter_list = document_parameter list

type nonrec platform_type =

| MACOS
| LINUX
| WINDOWS

type nonrec platform_type_list = platform_type list

type nonrec document_type =

| AutoApprovalPolicy
| ManualApprovalPolicy
| QuickSetup
| ConformancePackTemplate
| CloudFormation
| ProblemAnalysisTemplate
| ProblemAnalysis
| ChangeTemplate
| ChangeCalendar
| DeploymentStrategy
| ApplicationConfigurationSchema
| ApplicationConfiguration
| Package
| Session
| Automation
| Policy
| Command

type nonrec document_schema_version = string

type nonrec document_format =

| TEXT
| JSON
| YAML

type nonrec target_type = string

type nonrec tag_key = string

type nonrec tag_value = string

type nonrec tag = {

value : tag_value;
(*
The value of the tag.
*)
key : tag_key;
(*
The name of the tag.
*)

}

Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

type nonrec tag_list = tag list

type nonrec attachment_name = string

type nonrec attachment_information = {

name : attachment_name option;
(*
The name of the attachment.
*)

}

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

type nonrec attachment_information_list = attachment_information list

type nonrec require_type = string

type nonrec document_requires = {

version_name : document_version_name option;
(*
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
*)
require_type : require_type option;
(*
The document type of the required SSM document.
*)
version : document_version option;
(*
The document version required by the current document.
*)
name : document_ar_n;
(*
The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
*)

}

An SSM document required by the current document.

type nonrec document_requires_list = document_requires list

type nonrec document_author = string

type nonrec review_status =

| REJECTED
| PENDING
| NOT_REVIEWED
| APPROVED

type nonrec reviewer = string

type nonrec review_information = {

reviewer : reviewer option;
(*
The reviewer assigned to take action on the document review request.
*)
status : review_status option;
(*
The current status of the document review request.
*)
reviewed_time : date_time option;
(*
The time that the reviewer took action on the document review request.
*)

}

Information about the result of a document review request.

type nonrec review_information_list = review_information list

type nonrec category = string

type nonrec category_list = category list

type nonrec category_enum_list = category list

type nonrec document_description = {

category_enum : category_enum_list option;
(*
The value that identifies a document's category.
*)
category : category_list option;
(*
The classification of a document to help you identify and categorize its use.
*)
review_status : review_status option;
(*
The current status of the review.
*)
pending_review_version : document_version option;
(*
The version of the document that is currently under review.
*)
approved_version : document_version option;
(*
The version of the document currently approved for use in the organization.
*)
review_information : review_information_list option;
(*
Details about the review of a document.
*)
author : document_author option;
(*
The user in your organization who created the document.
*)
requires : document_requires_list option;
(*
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
*)
attachments_information : attachment_information_list option;
(*
Details about the document attachments, including names, locations, sizes, and so on.
*)
tags : tag_list option;
(*
The tags, or metadata, that have been applied to the document.
*)
target_type : target_type option;
(*
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.
*)
document_format : document_format option;
(*
The document format, either JSON or YAML.
*)
default_version : document_version option;
(*
The default version.
*)
latest_version : document_version option;
(*
The latest version of the document.
*)
schema_version : document_schema_version option;
(*
The schema version.
*)
document_type : document_type option;
(*
The type of document.
*)
platform_types : platform_type_list option;
(*
The list of operating system (OS) platforms compatible with this SSM document.
*)
parameters : document_parameter_list option;
(*
A description of the parameters for a document.
*)
description : description_in_document option;
(*
A description of the document.
*)
document_version : document_version option;
(*
The document version.
*)
status_information : document_status_information option;
(*
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."
*)
status : document_status option;
(*
The status of the SSM document.
*)
created_date : date_time option;
(*
The date when the document was created.
*)
owner : document_owner option;
(*
The Amazon Web Services user that created the document.
*)
version_name : document_version_name option;
(*
The version of the artifact associated with the document.
*)
display_name : document_display_name option;
(*
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.
*)
name : document_ar_n option;
(*
The name of the SSM document.
*)
hash_type : document_hash_type option;
(*
The hash type of the document. Valid values include Sha256 or Sha1.
Sha1 hashes have been deprecated.
*)
hash : document_hash option;
(*
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
*)
sha1 : document_sha1 option;
(*
The SHA1 hash of the document, which you can use for verification.
*)

}

Describes an Amazon Web Services Systems Manager document (SSM document).

type nonrec update_document_result = {

document_description : document_description option;
(*
A description of the document that was updated.
*)

}

type nonrec document_content = string

type nonrec attachments_source_key =

| AttachmentReference
| S3FileUrl
| SourceUrl

type nonrec attachments_source_value = string

type nonrec attachments_source_values = attachments_source_value list

type nonrec attachment_identifier = string

type nonrec attachments_source = {

name : attachment_identifier option;
(*
The name of the document attachment file.
*)
values : attachments_source_values option;
(*
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://amzn-s3-demo-bucket/my-prefix" ]
- For the key S3FileUrl, the value is a file in an S3 bucket. For example:
  "Values": [ "s3://amzn-s3-demo-bucket/my-prefix/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" ]
*)
key : attachments_source_key option;
(*
The key of a key-value pair that identifies the location of an attachment to a document.
*)

}

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.

type nonrec attachments_source_list = attachments_source list

type nonrec document_name = string

type nonrec update_document_request = {

target_type : target_type option;
(*
Specify a new target type for the document.
*)
document_format : document_format option;
(*
Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
*)
document_version : document_version option;
(*
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.
*)
version_name : document_version_name option;
(*
An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
*)
display_name : document_display_name option;
(*
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.
*)
name : document_name;
(*
The name of the SSM document that you want to update.
*)
attachments : attachments_source_list option;
(*
A list of key-value pairs that describe attachments to a version of a document.
*)
content : document_content;
(*
A valid JSON or YAML string.
*)

}

type nonrec update_document_metadata_response = unit

type nonrec document_review_action =

| Reject
| Approve
| UpdateReview
| SendForReview

type nonrec document_review_comment_type =

| Comment

type nonrec document_review_comment = string

type nonrec document_review_comment_source = {

content : document_review_comment option;
(*
The content of a comment entered by a user who requests a review of a new document version, or who reviews the new version.
*)
type_ : document_review_comment_type option;
(*
The type of information added to a review request. Currently, only the value Comment is supported.
*)

}

Information about comments added to a document review request.

type nonrec document_review_comment_list = document_review_comment_source list

type nonrec document_reviews = {

comment : document_review_comment_list option;
(*
A comment entered by a user in your organization about the document review request.
*)
action : document_review_action;
(*
The action to take on a document approval review request.
*)

}

Information about a document approval review.

type nonrec update_document_metadata_request = {

document_reviews : document_reviews;
(*
The change template review details to update.
*)
document_version : document_version option;
(*
The version of a change template in which to update approval metadata.
*)
name : document_name;
(*
The name of the change template for which a version's metadata is to be updated.
*)

}

type nonrec invalid_document_version = {

message : string_ option;

}

The document version isn't valid or doesn't exist.

type nonrec invalid_document_operation = {

message : string_ option;

}

You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

type nonrec invalid_document = {

message : string_ option;
(*
The SSM document doesn't exist or the document isn't available to the user. This exception can be issued by various API operations.
*)

}

The specified SSM document doesn't exist.

type nonrec document_default_version_description = {

default_version_name : document_version_name option;
(*
The default version of the artifact associated with the document.
*)
default_version : document_version option;
(*
The default version of the document.
*)
name : document_name option;
(*
The name of the document.
*)

}

A default version of a document.

type nonrec update_document_default_version_result = {

description : document_default_version_description option;
(*
The description of a custom document that you want to set as the default version.
*)

}

type nonrec document_version_number = string

type nonrec update_document_default_version_request = {

document_version : document_version_number;
(*
The version of a custom document that you want to set as the default version.
*)
name : document_name;
(*
The name of a custom document that you want to set as the default version.
*)

}

type nonrec invalid_document_schema_version = {

message : string_ option;

}

The version of the document schema isn't supported.

type nonrec max_document_size_exceeded = {

message : string_ option;

}

The size limit of a document is 64 KB.

type nonrec invalid_document_content = {

message : string_ option;
(*
A description of the validation error.
*)

}

The content for the document isn't valid.

type nonrec duplicate_document_version_name = {

message : string_ option;

}

The version name has already been used in this document. Specify a different version name, and then try again.

type nonrec duplicate_document_content = {

message : string_ option;

}

The content of the association document matches another document. Change the content of the document and try again.

type nonrec document_version_limit_exceeded = {

message : string_ option;

}

The document has too many versions. Delete one or more document versions and try again.

type nonrec instance_id = string

type nonrec association_version = string

type nonrec association_status_name =

| Failed
| Success
| Pending

type nonrec status_message = string

type nonrec status_additional_info = string

type nonrec association_status = {

additional_info : status_additional_info option;
(*
A user-defined string.
*)
message : status_message;
(*
The reason for the status.
*)
name : association_status_name;
(*
The status.
*)
date : date_time;
(*
The date when the status changed.
*)

}

Describes an association status.

type nonrec status_name = string

type nonrec instance_count = int

type nonrec association_status_aggregated_count =
  (status_name * instance_count) list

type nonrec association_overview = {

association_status_aggregated_count : association_status_aggregated_count option;
(*
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.
*)
detailed_status : status_name option;
(*
A detailed status of the association.
*)
status : status_name option;
(*
The status of the association. Status can be: Pending, Success, or Failed.
*)

}

Information about the association.

type nonrec automation_target_parameter_name = string

type nonrec association_id = string

type nonrec schedule_expression = string

type nonrec s3_output_location = {

output_s3_key_prefix : s3_key_prefix option;
(*
The S3 bucket subfolder.
*)
output_s3_bucket_name : s3_bucket_name option;
(*
The name of the S3 bucket.
*)
output_s3_region : s3_region option;
(*
The Amazon Web Services Region of the S3 bucket.
*)

}

An S3 bucket where you want to store the results of this request.

type nonrec instance_association_output_location = {

s3_location : s3_output_location option;
(*
An S3 bucket where you want to store the results of this request.
*)

}

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 Create an association (console) in the Systems Manager User Guide.

type nonrec association_name = string

type nonrec association_compliance_severity =

| Unspecified
| Low
| Medium
| High
| Critical

type nonrec association_sync_compliance =

| Manual
| Auto

type nonrec apply_only_at_cron_interval = bool

type nonrec calendar_name_or_ar_n = string

type nonrec calendar_name_or_arn_list = calendar_name_or_ar_n list

type nonrec account = string

type nonrec accounts = account list

type nonrec region = string

type nonrec regions = region list

type nonrec execution_role_name = string

type nonrec exclude_account = string

type nonrec exclude_accounts = exclude_account list

type nonrec target_location = {

targets_max_errors : max_errors option;
(*
The maximum number of errors that are allowed before the system stops running the automation on additional targets. This TargetsMaxErrors parameter takes precedence over the StartAutomationExecution:MaxErrors parameter if both are supplied.
*)
targets_max_concurrency : max_concurrency option;
(*
The maximum number of targets allowed to run this task in parallel. This TargetsMaxConcurrency takes precedence over the StartAutomationExecution:MaxConcurrency parameter if both are supplied.
*)
targets : targets option;
(*
A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.
This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.
*)
exclude_accounts : exclude_accounts option;
(*
Amazon Web Services accounts or organizational units to exclude as expanded targets.
*)
include_child_organization_units : boolean_ option;
(*
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is false.
*)
target_location_alarm_configuration : alarm_configuration option;
execution_role_name : execution_role_name option;
(*
The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.
*)
target_location_max_errors : max_errors option;
(*
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
*)
target_location_max_concurrency : max_concurrency option;
(*
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
*)
regions : regions option;
(*
The Amazon Web Services Regions targeted by the current Automation execution.
*)
accounts : accounts option;
(*
The Amazon Web Services accounts targeted by the current Automation execution.
*)

}

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

type nonrec target_locations = target_location list

type nonrec schedule_offset = int

type nonrec duration = int

type nonrec target_map_value = string

type nonrec target_map_value_list = target_map_value list

type nonrec target_map_key = string

type nonrec target_map = (target_map_key * target_map_value_list) list

type nonrec target_maps = target_map list

type nonrec external_alarm_state =

| ALARM
| UNKNOWN

type nonrec alarm_state_information = {

state : external_alarm_state;
(*
The state of your CloudWatch alarm.
*)
name : alarm_name;
(*
The name of your CloudWatch alarm.
*)

}

The details about the state of your CloudWatch alarm.

type nonrec alarm_state_information_list = alarm_state_information list

type nonrec association_description = {

triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarm that was invoked during the association.
*)
alarm_configuration : alarm_configuration option;
target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
duration : duration option;
(*
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
*)
schedule_offset : schedule_offset option;
(*
Number of days to wait after the scheduled day to run an association.
*)
target_locations : target_locations option;
(*
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
*)
calendar_names : calendar_name_or_arn_list option;
(*
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 in the Amazon Web Services Systems Manager User Guide.
*)
apply_only_at_cron_interval : apply_only_at_cron_interval option;
(*
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.
*)
sync_compliance : association_sync_compliance option;
(*
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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
*)
compliance_severity : association_compliance_severity option;
(*
The severity level that is assigned to the association.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
association_name : association_name option;
(*
The association name.
*)
last_successful_execution_date : date_time option;
(*
The last date on which the association was successfully run.
*)
last_execution_date : date_time option;
(*
The date on which the association was last run.
*)
output_location : instance_association_output_location option;
(*
An S3 bucket where you want to store the output details of the request.
*)
schedule_expression : schedule_expression option;
(*
A cron expression that specifies a schedule when the association runs.
*)
targets : targets option;
(*
The managed nodes targeted by the request.
*)
association_id : association_id option;
(*
The association ID.
*)
parameters : parameters option;
(*
A description of the parameters for a document.
*)
automation_target_parameter_name : automation_target_parameter_name option;
(*
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 tool in Amazon Web Services Systems Manager.
*)
document_version : document_version option;
(*
The document version.
*)
overview : association_overview option;
(*
Information about the association.
*)
status : association_status option;
(*
The association status.
*)
last_update_association_date : date_time option;
(*
The date when the association was last updated.
*)
date : date_time option;
(*
The date when the association was made.
*)
association_version : association_version option;
(*
The association version.
*)
instance_id : instance_id option;
(*
The managed node ID.
*)
name : document_ar_n option;
(*
The name of the SSM document.
*)

}

Describes the parameters for a document.

type nonrec update_association_status_result = {

association_description : association_description option;
(*
Information about the association.
*)

}

type nonrec update_association_status_request = {

association_status : association_status;
(*
The association status.
*)
instance_id : instance_id;
(*
The managed node ID.
*)
name : document_ar_n;
(*
The name of the SSM document.
*)

}

type nonrec status_unchanged = unit

type nonrec association_does_not_exist = {

message : string_ option;

}

The specified association doesn't exist.

type nonrec update_association_result = {

association_description : association_description option;
(*
The description of the association that was updated.
*)

}

type nonrec update_association_request = {

alarm_configuration : alarm_configuration option;
target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
duration : duration option;
(*
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration parameter applies only when both these conditions are true:
- The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
- The command specifies the
```
 {{:https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_UpdateAssociation.html#systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval}ApplyOnlyAtCronInterval} 
```
  parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.
*)
schedule_offset : schedule_offset option;
(*
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.
*)
target_locations : target_locations option;
(*
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.
*)
calendar_names : calendar_name_or_arn_list option;
(*
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 in the Amazon Web Services Systems Manager User Guide.
*)
apply_only_at_cron_interval : apply_only_at_cron_interval option;
(*
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 true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you specified.
If you chose this option when you created an association and later you edit that association or you make changes to the Automation runbook or SSM document on which that association is based, 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 set ApplyOnlyAtCronInterval to true. If this option wasn't selected, State Manager immediately runs the association.
For more information, see Understanding when associations are applied to resources and About target updates with Automation runbooks in the Amazon Web Services Systems Manager User Guide.
This parameter isn't supported for rate expressions.
You can reset this parameter. 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.
*)
sync_compliance : association_sync_compliance option;
(*
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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
*)
compliance_severity : association_compliance_severity option;
(*
The severity level to assign to the association.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
automation_target_parameter_name : automation_target_parameter_name option;
(*
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 tool in Amazon Web Services Systems Manager.
*)
association_version : association_version option;
(*
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.
*)
association_name : association_name option;
(*
The name of the association that you want to update.
*)
targets : targets option;
(*
The targets of the association.
*)
name : document_ar_n option;
(*
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:{i region}:{i account-id}:document/{i 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.
*)
output_location : instance_association_output_location option;
(*
An S3 bucket where you want to store the results of this request.
*)
schedule_expression : schedule_expression option;
(*
The cron expression used to schedule the association that you want to update.
*)
document_version : document_version option;
(*
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.
*)
parameters : parameters option;
(*
The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.
*)
association_id : association_id;
(*
The ID of the association you want to update.
*)

}

type nonrec invalid_update = {

message : string_ option;

}

The update isn't valid.

type nonrec invalid_target_maps = {

message : string_ option;

}

TargetMap parameter isn't valid.

type nonrec invalid_target = {

message : string_ option;

}

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.

type nonrec invalid_schedule = {

message : string_ option;

}

The schedule is invalid. Verify your cron or rate expression and try again.

type nonrec invalid_parameters = {

message : string_ option;

}

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.

type nonrec invalid_output_location = unit

type nonrec invalid_association_version = {

message : string_ option;

}

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.

type nonrec association_version_limit_exceeded = {

message : string_ option;

}

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

type nonrec unsupported_platform_type = {

message : string_ option;

}

The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.

type nonrec unsupported_parameter_type = {

message : string_ option;

}

The parameter type isn't supported.

type nonrec unsupported_operation_exception = {

message : string_ option;

}

This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account.

type nonrec unsupported_operating_system = {

message : string_ option;

}

The operating systems you specified isn't supported, or the operation isn't supported for the operating system.

type nonrec unsupported_inventory_schema_version_exception = {

message : string_ option;

}

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.

type nonrec inventory_item_type_name = string

type nonrec unsupported_inventory_item_context_exception = {

message : string_ option;
type_name : inventory_item_type_name option;

}

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.

type nonrec unsupported_feature_required_exception = {

message : string_ option;

}

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 Turning on the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.

type nonrec unsupported_calendar_exception = {

message : string_ option;

}

The calendar entry contained in the specified SSM document isn't supported.

type nonrec parameter_label = string

type nonrec parameter_label_list = parameter_label list

type nonrec unlabel_parameter_version_result = {

invalid_labels : parameter_label_list option;
(*
The labels that aren't attached to the given parameter version.
*)
removed_labels : parameter_label_list option;
(*
A list of all labels deleted from the parameter.
*)

}

type nonrec ps_parameter_name = string

type nonrec ps_parameter_version = int

type nonrec unlabel_parameter_version_request = {

labels : parameter_label_list;
(*
One or more labels to delete from the specified parameter version.
*)
parameter_version : ps_parameter_version;
(*
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.
*)
name : ps_parameter_name;
(*
The name of the parameter from which you want to delete one or more labels.
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
*)

}

type nonrec parameter_version_not_found = {

message : string_ option;

}

The specified parameter version wasn't found. Verify the parameter name and version, and try again.

type nonrec parameter_not_found = {

message : string_ option;

}

The parameter couldn't be found. Verify the name and try again.

For the DeleteParameter and GetParameter actions, if the specified parameter doesn't exist, the ParameterNotFound exception is not recorded in CloudTrail event logs.

type nonrec uui_d = string

type nonrec total_size_limit_exceeded_exception = {

message : string_ option;

}

The size of inventory data has exceeded the total size limit for the resource.

type nonrec total_count = int

type nonrec too_many_tags_error = unit

type nonrec token_value = string

type nonrec throttling_exception = {

service_code : string_ option;
(*
The code for the Amazon Web Services service that owns the quota.
*)
quota_code : string_ option;
(*
The quota code recognized by the Amazon Web Services Service Quotas service.
*)
message : string_;

}

The request or operation couldn't be performed because the service is throttling requests.

type nonrec session_id = string

type nonrec terminate_session_response = {

session_id : session_id option;
(*
The ID of the session that has been terminated.
*)

}

type nonrec terminate_session_request = {

session_id : session_id;
(*
The ID of the session to terminate.
*)

}

type nonrec target_preview = {

target_type : string_ option;
(*
A type of resource that was included in the execution preview.
*)
count : integer option;
(*
The number of resources of a certain type included in an execution preview.
*)

}

Information about the resources that would be included in the actual runbook execution, if it were to be run.

type nonrec target_preview_list = target_preview list

type nonrec target_parameter_list = parameter_value list

type nonrec target_not_connected = {

message : string_ option;

}

The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Setting up 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

type nonrec target_locations_ur_l = string

type nonrec target_in_use_exception = {

message : string_ option;

}

You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

type nonrec target_count = int

type nonrec sub_type_count_limit_exceeded_exception = {

message : string_ option;

}

The sub-type count exceeded the limit for the inventory type.

type nonrec string_list = string_ list

type nonrec string_date_time = string

type nonrec string1to256 = string

type nonrec stream_url = string

type nonrec stop_type =

| CANCEL
| COMPLETE

type nonrec stop_automation_execution_result = unit

type nonrec automation_execution_id = string

type nonrec stop_automation_execution_request = {

type_ : stop_type option;
(*
The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.
*)
automation_execution_id : automation_execution_id;
(*
The execution ID of the Automation to stop.
*)

}

type nonrec invalid_automation_status_update_exception = {

message : string_ option;

}

The specified update status operation isn't valid.

type nonrec automation_execution_not_found_exception = {

message : string_ option;

}

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

type nonrec impact_type =

| UNDETERMINED
| NON_MUTATING
| MUTATING

type nonrec step_preview_map = (impact_type * integer) list

type nonrec automation_action_name = string

type nonrec long = int

type nonrec automation_execution_status =

| EXITED
| COMPLETED_WITH_FAILURE
| COMPLETED_WITH_SUCCESS
| CHANGE_CALENDAR_OVERRIDE_REJECTED
| CHANGE_CALENDAR_OVERRIDE_APPROVED
| PENDING_CHANGE_CALENDAR_OVERRIDE
| RUNBOOK_INPROGRESS
| SCHEDULED
| REJECTED
| APPROVED
| PENDING_APPROVAL
| FAILED
| CANCELLED
| CANCELLING
| TIMEDOUT
| SUCCESS
| WAITING
| INPROGRESS
| PENDING

type nonrec normal_string_map = (string_ * string_) list

type nonrec failure_details = {

details : automation_parameter_map option;
(*
Detailed information about the Automation step failure.
*)
failure_type : string_ option;
(*
The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.
*)
failure_stage : string_ option;
(*
The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.
*)

}

Information about an Automation failure.

type nonrec parent_step_details = {

iterator_value : string_ option;
(*
The current value of the specified iterator in the loop.
*)
iteration : integer option;
(*
The current repetition of the loop represented by an integer.
*)
action : automation_action_name option;
(*
The name of the automation action.
*)
step_name : string_ option;
(*
The name of the step.
*)
step_execution_id : string_ option;
(*
The unique ID of a step execution.
*)

}

A detailed status of the parent step.

type nonrec step_execution = {

parent_step_details : parent_step_details option;
(*
Information about the parent step.
*)
triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarms that were invoked by the automation.
*)
target_location : target_location option;
(*
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
*)
targets : targets option;
(*
The targets for the step execution.
*)
valid_next_steps : valid_next_step_list option;
(*
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.
*)
is_critical : boolean_ option;
(*
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
*)
next_step : string_ option;
(*
The next step after the step succeeds.
*)
is_end : boolean_ option;
(*
The flag which can be used to end automation no matter whether the step succeeds or fails.
*)
overridden_parameters : automation_parameter_map option;
(*
A user-specified list of parameters to override when running a step.
*)
step_execution_id : string_ option;
(*
The unique ID of a step execution.
*)
failure_details : failure_details option;
(*
Information about the Automation failure.
*)
failure_message : string_ option;
(*
If a step failed, this message explains why the execution failed.
*)
response : string_ option;
(*
A message associated with the response code for an execution.
*)
outputs : automation_parameter_map option;
(*
Returned values from the execution of the step.
*)
inputs : normal_string_map option;
(*
Fully-resolved values passed into the step before execution.
*)
response_code : string_ option;
(*
The response code returned by the execution of the step.
*)
step_status : automation_execution_status option;
(*
The execution status for this step.
*)
execution_end_time : date_time option;
(*
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.
*)
execution_start_time : date_time option;
(*
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.
*)
max_attempts : integer option;
(*
The maximum number of tries to run the action of the step. The default value is 1.
*)
on_failure : string_ option;
(*
The action to take if the step fails. The default value is Abort.
*)
timeout_seconds : long option;
(*
The timeout seconds of the step.
*)
action : automation_action_name option;
(*
The action this step performs. The action determines the behavior of the step.
*)
step_name : string_ option;
(*
The name of this execution step.
*)

}

Detailed information about an the execution state of an Automation step.

type nonrec step_execution_list = step_execution list

type nonrec step_execution_filter_value = string

type nonrec step_execution_filter_value_list = step_execution_filter_value list

type nonrec step_execution_filter_key =

| PARENT_STEP_ITERATOR_VALUE
| PARENT_STEP_ITERATION
| PARENT_STEP_EXECUTION_ID
| ACTION
| STEP_NAME
| STEP_EXECUTION_ID
| STEP_EXECUTION_STATUS
| START_TIME_AFTER
| START_TIME_BEFORE

type nonrec step_execution_filter = {

values : step_execution_filter_value_list;
(*
The values of the filter key.
*)
key : step_execution_filter_key;
(*
One or more keys to limit the results.
*)

}

A filter to limit the amount of step execution information returned by the call.

type nonrec step_execution_filter_list = step_execution_filter list

type nonrec status_details = string

type nonrec start_session_response = {

stream_url : stream_url option;
(*
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.{b region}.amazonaws.com/v1/data-channel/{b 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.
*)
token_value : token_value option;
(*
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.
*)
session_id : session_id option;
(*
The ID of the session.
*)

}

type nonrec session_target = string

type nonrec session_reason = string

type nonrec session_manager_parameter_value = string

type nonrec session_manager_parameter_value_list =
  session_manager_parameter_value list

type nonrec session_manager_parameter_name = string

type nonrec session_manager_parameters =
  (session_manager_parameter_name * session_manager_parameter_value_list) list

type nonrec start_session_request = {

parameters : session_manager_parameters option;
(*
The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see Create a Session Manager preferences document in the Amazon Web Services Systems Manager User Guide.
*)
reason : session_reason option;
(*
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.
*)
document_name : document_ar_n option;
(*
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.
*)
target : session_target;
(*
The managed node to connect to for the session.
*)

}

type nonrec execution_preview_id = string

type nonrec start_execution_preview_response = {

execution_preview_id : execution_preview_id option;
(*
The ID of the execution preview generated by the system.
*)

}

type nonrec automation_execution_inputs = {

target_locations_ur_l : target_locations_ur_l option;
(*
A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported.
*)
target_locations : target_locations option;
(*
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the Automation execution preview operation.
*)
target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
targets : targets option;
(*
Information about the resources that would be included in the actual runbook execution, if it were to be run. Both Targets and TargetMaps can't be specified together.
*)
target_parameter_name : automation_parameter_key option;
(*
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
*)
parameters : automation_parameter_map option;
(*
Information about parameters that can be specified for the preview operation.
*)

}

Information about the optional inputs that can be specified for an automation execution preview.

type nonrec execution_inputs =

| Automation of automation_execution_inputs
(*
Information about the optional inputs that can be specified for an automation execution preview.
*)

Information about the inputs for an execution preview.

type nonrec start_execution_preview_request = {

execution_inputs : execution_inputs option;
(*
Information about the inputs that can be specified for the preview operation.
*)
document_version : document_version option;
(*
The version of the Automation runbook to run. The default value is $DEFAULT.
*)
document_name : document_name;
(*
The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook.
*)

}

type nonrec start_change_request_execution_result = {

automation_execution_id : automation_execution_id option;
(*
The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)
*)

}

type nonrec change_request_name = string

type nonrec idempotency_token = string

type nonrec runbook = {

target_locations : target_locations option;
(*
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
*)
max_errors : max_errors option;
(*
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.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
target_maps : target_maps option;
(*
A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
targets : targets option;
(*
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
*)
target_parameter_name : automation_parameter_key option;
(*
The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.
*)
parameters : automation_parameter_map option;
(*
The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
*)
document_version : document_version option;
(*
The version of the Automation runbook used in a runbook workflow.
*)
document_name : document_ar_n;
(*
The name of the Automation runbook used in a runbook workflow.
*)

}

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.

type nonrec runbooks = runbook list

type nonrec change_details_value = string

type nonrec start_change_request_execution_request = {

change_details : change_details_value option;
(*
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.
*)
scheduled_end_time : date_time option;
(*
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.
*)
tags : tag_list option;
(*
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
The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.
*)
runbooks : runbooks;
(*
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.
*)
auto_approve : boolean_ option;
(*
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.
*)
client_token : idempotency_token option;
(*
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
*)
change_request_name : change_request_name option;
(*
The name of the change request associated with the runbook workflow to be run.
*)
parameters : automation_parameter_map option;
(*
A key-value map of parameters that match the declared parameters in the change template document.
*)
document_version : document_version option;
(*
The version of the change template document to run during the runbook workflow.
*)
document_name : document_ar_n;
(*
The name of the change template document to run during the runbook workflow.
*)
scheduled_time : date_time option;
(*
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.
*)

}

type nonrec invalid_automation_execution_parameters_exception = {

message : string_ option;

}

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.

type nonrec idempotent_parameter_mismatch = {

message : string_ option;

}

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.

type nonrec automation_execution_limit_exceeded_exception = {

message : string_ option;

}

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

type nonrec automation_definition_version_not_found_exception = {

message : string_ option;

}

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

type nonrec automation_definition_not_found_exception = {

message : string_ option;

}

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

type nonrec automation_definition_not_approved_exception = {

message : string_ option;

}

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

type nonrec start_automation_execution_result = {

automation_execution_id : automation_execution_id option;
(*
The unique ID of a newly scheduled automation execution.
*)

}

type nonrec execution_mode =

| Interactive
| Auto

type nonrec start_automation_execution_request = {

target_locations_ur_l : target_locations_ur_l option;
(*
Specify a publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported.
*)
alarm_configuration : alarm_configuration option;
(*
The CloudWatch alarm you want to apply to your automation.
*)
tags : tag_list option;
(*
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
The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartAutomationExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing automation configuration.
*)
target_locations : target_locations option;
(*
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 automations in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.
*)
max_errors : max_errors option;
(*
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.
If this parameter and the TargetLocation:TargetsMaxErrors parameter are both supplied, TargetLocation:TargetsMaxErrors takes precedence.
*)
max_concurrency : max_concurrency option;
(*
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.
If both this parameter and the TargetLocation:TargetsMaxConcurrency are supplied, TargetLocation:TargetsMaxConcurrency takes precedence.
*)
target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
targets : targets option;
(*
A key-value mapping to target resources. Required if you specify TargetParameterName.
If both this parameter and the TargetLocation:Targets parameter are supplied, TargetLocation:Targets takes precedence.
*)
target_parameter_name : automation_parameter_key option;
(*
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
*)
mode : execution_mode option;
(*
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
*)
client_token : idempotency_token option;
(*
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
*)
parameters : automation_parameter_map option;
(*
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
*)
document_version : document_version option;
(*
The version of the Automation runbook to use for this execution.
*)
document_name : document_ar_n;
(*
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 Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.
*)

}

type nonrec start_associations_once_result = unit

type nonrec association_id_list = association_id list

type nonrec start_associations_once_request = {

association_ids : association_id_list;
(*
The association IDs that you want to run immediately and only one time.
*)

}

type nonrec invalid_association = {

message : string_ option;

}

The association isn't valid or doesn't exist.

type nonrec access_request_id = string

type nonrec start_access_request_response = {

access_request_id : access_request_id option;
(*
The ID of the access request.
*)

}

type nonrec start_access_request_request = {

tags : tag_list option;
(*
Key-value pairs of metadata you want to assign to the access request.
*)
targets : targets;
(*
The node you are requesting access to.
*)
reason : string1to256;
(*
A brief description explaining why you are requesting access to the node.
*)

}

type nonrec service_quota_exceeded_exception = {

service_code : string_;
(*
The code for the Amazon Web Services service that owns the quota.
*)
quota_code : string_;
(*
The quota code recognized by the Amazon Web Services Service Quotas service.
*)
resource_type : string_ option;
(*
The resource type of the resource referenced in the failed request.
*)
resource_id : string_ option;
(*
The unique ID of the resource referenced in the failed request.
*)
message : string_;

}

The request exceeds the service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

type nonrec resource_not_found_exception = {

message : string_ option;

}

The specified parameter to be shared could not be found.

type nonrec access_denied_exception = {

message : string_;

}

The requester doesn't have permissions to perform the requested operation.

type nonrec standard_output_content = string

type nonrec standard_error_content = string

type nonrec source_type =

| AWS_SSM_MANAGEDINSTANCE
| AWS_IOT_THING
| AWS_EC2_INSTANCE

type nonrec source_id = string

type nonrec snapshot_id = string

type nonrec snapshot_download_url = string

type nonrec signal_type =

| REVOKE
| RESUME
| STOP_STEP
| START_STEP
| REJECT
| APPROVE

type nonrec shared_document_version = string

type nonrec compliance_summary_count = int

type nonrec severity_summary = {

unspecified_count : compliance_summary_count option;
(*
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.
*)
informational_count : compliance_summary_count option;
(*
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.
*)
low_count : compliance_summary_count option;
(*
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.
*)
medium_count : compliance_summary_count option;
(*
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.
*)
high_count : compliance_summary_count option;
(*
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.
*)
critical_count : compliance_summary_count option;
(*
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.
*)

}

The number of managed nodes found for each patch severity level defined in the request filter.

type nonrec session_token_type = string

type nonrec session_status =

| FAILED
| TERMINATING
| TERMINATED
| DISCONNECTED
| CONNECTING
| CONNECTED

type nonrec session_state =

| HISTORY
| ACTIVE

type nonrec session_owner = string

type nonrec session_max_results = int

type nonrec session_manager_s3_output_url = string

type nonrec session_manager_cloud_watch_output_url = string

type nonrec session_manager_output_url = {

cloud_watch_output_url : session_manager_cloud_watch_output_url option;
(*
Reserved for future use.
*)
s3_output_url : session_manager_s3_output_url option;
(*
Reserved for future use.
*)

}

Reserved for future use.

type nonrec session_details = string

type nonrec max_session_duration = string

type nonrec access_type =

| JUSTINTIME
| STANDARD

type nonrec session = {

access_type : access_type option;
(*
Standard access type is the default for Session Manager sessions. JustInTime is the access type for Just-in-time node access.
*)
max_session_duration : max_session_duration option;
(*
The maximum duration of a session before it terminates.
*)
output_url : session_manager_output_url option;
(*
Reserved for future use.
*)
details : session_details option;
(*
Reserved for future use.
*)
reason : session_reason option;
(*
The reason for connecting to the instance.
*)
owner : session_owner option;
(*
The ID of the Amazon Web Services user that started the session.
*)
document_name : document_name option;
(*
The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.
*)
end_date : date_time option;
(*
The date and time, in ISO-8601 Extended format, when the session was terminated.
*)
start_date : date_time option;
(*
The date and time, in ISO-8601 Extended format, when the session began.
*)
status : session_status option;
(*
The status of the session. For example, "Connected" or "Terminated".
*)
target : session_target option;
(*
The managed node that the Session Manager session connected to.
*)
session_id : session_id option;
(*
The ID of the session.
*)

}

Information about a Session Manager connection to a managed node.

type nonrec session_list = session list

type nonrec session_filter_value = string

type nonrec session_filter_key =

| ACCESS_TYPE
| SESSION_ID
| STATUS
| OWNER
| TARGET_ID
| INVOKED_BEFORE
| INVOKED_AFTER

type nonrec session_filter = {

value : session_filter_value;
(*
The filter value. Valid values for each filter key are as follows:
- InvokedAfter: Specify a timestamp to limit your results. For example, specify 2024-08-29T00:00:00Z to see sessions that started August 29, 2024, and later.
- InvokedBefore: Specify a timestamp to limit your results. For example, specify 2024-08-29T00:00:00Z to see sessions that started before August 29, 2024.
- 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.
*)
key : session_filter_key;
(*
The name of the filter.
*)

}

Describes a filter for Session Manager information.

type nonrec session_filter_list = session_filter list

type nonrec service_setting = {

status : string_ option;
(*
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.
*)
ar_n : string_ option;
(*
The ARN of the service setting.
*)
last_modified_user : string_ option;
(*
The ARN of the last modified user. This field is populated only if the setting value was overwritten.
*)
last_modified_date : date_time option;
(*
The last time the service setting was modified.
*)
setting_value : service_setting_value option;
(*
The value of the service setting.
*)
setting_id : service_setting_id option;
(*
The ID of the service setting.
*)

}

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.

type nonrec command_id = string

type nonrec instance_id_list = instance_id list

type nonrec command_status =

| CANCELLING
| TIMED_OUT
| FAILED
| CANCELLED
| SUCCESS
| IN_PROGRESS
| PENDING

type nonrec completed_count = int

type nonrec error_count = int

type nonrec delivery_timed_out_count = int

type nonrec command = {

triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarm that was invoked by the command.
*)
alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm applied to your command.
*)
timeout_seconds : timeout_seconds option;
(*
The TimeoutSeconds value specified for a command.
*)
cloud_watch_output_config : cloud_watch_output_config option;
(*
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
*)
notification_config : notification_config option;
(*
Configurations for sending notifications about command status changes.
*)
service_role : service_role option;
(*
The Identity and Access Management (IAM) service role that Run Command, a tool in Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
*)
delivery_timed_out_count : delivery_timed_out_count option;
(*
The number of targets for which the status is Delivery Timed Out.
*)
error_count : error_count option;
(*
The number of targets for which the status is Failed or Execution Timed Out.
*)
completed_count : completed_count option;
(*
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.
*)
target_count : target_count option;
(*
The number of targets for the command.
*)
max_errors : max_errors option;
(*
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 Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*)
max_concurrency : max_concurrency option;
(*
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 Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*)
output_s3_key_prefix : s3_key_prefix option;
(*
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
*)
output_s3_bucket_name : s3_bucket_name option;
(*
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
*)
output_s3_region : s3_region option;
(*
(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.
*)
status_details : status_details option;
(*
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.
*)
status : command_status option;
(*
The status of the command.
*)
requested_date_time : date_time option;
(*
The date and time the command was requested.
*)
targets : targets option;
(*
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.
*)
instance_ids : instance_id_list option;
(*
The managed node IDs against which this command was requested.
*)
parameters : parameters option;
(*
The parameter values to be inserted in the document when running the command.
*)
expires_after : date_time option;
(*
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.
*)
comment : comment option;
(*
User-specified information about the command, such as a brief description of what the command should do.
*)
document_version : document_version option;
(*
The Systems Manager document (SSM document) version.
*)
document_name : document_name option;
(*
The name of the document requested for execution.
*)
command_id : command_id option;
(*
A unique identifier for this command.
*)

}

Describes a command request.

type nonrec send_command_result = {

command : command option;
(*
The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.
*)

}

type nonrec send_command_request = {

alarm_configuration : alarm_configuration option;
(*
The CloudWatch alarm you want to apply to your command.
*)
cloud_watch_output_config : cloud_watch_output_config option;
(*
Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in Amazon Web Services Systems Manager.
*)
notification_config : notification_config option;
(*
Configurations for sending notifications.
*)
service_role_arn : service_role option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
max_concurrency : max_concurrency option;
(*
(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.
*)
output_s3_key_prefix : s3_key_prefix option;
(*
The directory structure within the S3 bucket where the responses should be stored.
*)
output_s3_bucket_name : s3_bucket_name option;
(*
The name of the S3 bucket where command execution responses should be stored.
*)
output_s3_region : s3_region option;
(*
(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.
*)
parameters : parameters option;
(*
The required and optional parameters specified in the document being run.
*)
comment : comment option;
(*
User-specified information about the command, such as a brief description of what the command should do.
*)
timeout_seconds : timeout_seconds option;
(*
If this time is reached and the command hasn't already started running, it won't run.
*)
document_hash_type : document_hash_type option;
(*
Sha256 or Sha1.
Sha1 hashes have been deprecated.
*)
document_hash : document_hash option;
(*
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
*)
document_version : document_version option;
(*
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"
*)
document_name : document_ar_n;
(*
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 Sharing 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.
*)
targets : targets option;
(*
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 Run commands at scale in the Amazon Web Services Systems Manager User Guide.
*)
instance_ids : instance_id_list option;
(*
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 Run commands at scale in the Amazon Web Services Systems Manager User Guide.
*)

}

type nonrec invalid_role = {

message : string_ option;

}

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 Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

type nonrec invalid_output_folder = unit

type nonrec invalid_notification_config = {

message : string_ option;

}

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.

type nonrec duplicate_instance_id = unit

type nonrec send_automation_signal_result = unit

type nonrec send_automation_signal_request = {

payload : automation_parameter_map option;
(*
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"
*)
signal_type : signal_type;
(*
The type of signal to send to an Automation execution.
*)
automation_execution_id : automation_execution_id;
(*
The unique identifier for an existing Automation execution that you want to send the signal to.
*)

}

type nonrec invalid_automation_signal_exception = {

message : string_ option;

}

The signal isn't valid for the current Automation execution.

type nonrec automation_step_not_found_exception = {

message : string_ option;

}

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

type nonrec scheduled_window_execution = {

execution_time : maintenance_window_string_date_time option;
(*
The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.
*)
name : maintenance_window_name option;
(*
The name of the maintenance window to be run.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window to be run.
*)

}

Information about a scheduled execution for a maintenance window.

type nonrec scheduled_window_execution_list = scheduled_window_execution list

type nonrec s3_output_url = {

output_url : url option;
(*
A URL for an S3 bucket where you want to store the results of this request.
*)

}

A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket where you want to store the results of this request.

type nonrec resume_session_response = {

stream_url : stream_url option;
(*
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.{b region}.amazonaws.com/v1/data-channel/{b 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.
*)
token_value : token_value option;
(*
An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.
*)
session_id : session_id option;
(*
The ID of the session.
*)

}

type nonrec resume_session_request = {

session_id : session_id;
(*
The ID of the disconnected session to resume.
*)

}

type nonrec result_attribute = {

type_name : inventory_item_type_name;
(*
Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.
*)

}

The inventory item result attribute.

type nonrec result_attribute_list = result_attribute list

type nonrec response_code = int

type nonrec resource_type_for_tagging =

| ASSOCIATION
| AUTOMATION
| OPSMETADATA
| OPS_ITEM
| PATCH_BASELINE
| PARAMETER
| MAINTENANCE_WINDOW
| MANAGED_INSTANCE
| DOCUMENT

type nonrec resource_type =

| EC2_INSTANCE
| MANAGED_INSTANCE

type nonrec resource_policy_parameter_names_list = string_ list

type nonrec resource_policy_not_found_exception = {

message : string_ option;

}

No policies with the specified policy ID and hash could be found.

type nonrec resource_policy_max_results = int

type nonrec resource_policy_limit_exceeded_exception = {

message : string_ option;
limit_type : string_ option;
limit : integer option;

}

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.

type nonrec resource_policy_invalid_parameter_exception = {

message : string_ option;
parameter_names : resource_policy_parameter_names_list option;

}

One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.

type nonrec resource_policy_conflict_exception = {

message : string_ option;

}

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.

type nonrec resource_limit_exceeded_exception = {

message : string_ option;

}

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.

type nonrec resource_in_use_exception = {

message : string_ option;

}

Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.

type nonrec resource_id = string

type nonrec resource_data_sync_state = string

type nonrec resource_data_sync_source_with_state = {

enable_all_ops_data_sources : resource_data_sync_enable_all_ops_data_sources option;
(*
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 Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.
*)
state : resource_data_sync_state option;
(*
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.
*)
include_future_regions : resource_data_sync_include_future_regions option;
(*
Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.
*)
source_regions : resource_data_sync_source_region_list option;
(*
The SyncSource Amazon Web Services Regions included in the resource data sync.
*)
aws_organizations_source : resource_data_sync_aws_organizations_source option;
(*
The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource type.
*)
source_type : resource_data_sync_source_type option;
(*
The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or singleAccountMultiRegions.
*)

}

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

type nonrec resource_data_sync_s3_region = string

type nonrec resource_data_sync_s3_prefix = string

type nonrec resource_data_sync_s3_format =

| JSON_SERDE

type nonrec resource_data_sync_s3_bucket_name = string

type nonrec resource_data_sync_awskms_key_ar_n = string

type nonrec resource_data_sync_destination_data_sharing_type = string

type nonrec resource_data_sync_destination_data_sharing = {

destination_data_sharing_type : resource_data_sync_destination_data_sharing_type option;
(*
The sharing data type. Only Organization is supported.
*)

}

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.

type nonrec resource_data_sync_s3_destination = {

destination_data_sharing : resource_data_sync_destination_data_sharing option;
(*
Enables destination data sharing. By default, this field is null.
*)
awskms_key_ar_n : resource_data_sync_awskms_key_ar_n option;
(*
The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
*)
region : resource_data_sync_s3_region;
(*
The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.
*)
sync_format : resource_data_sync_s3_format;
(*
A supported sync format. The following format is currently supported: JsonSerDe
*)
prefix : resource_data_sync_s3_prefix option;
(*
An Amazon S3 prefix for the bucket.
*)
bucket_name : resource_data_sync_s3_bucket_name;
(*
The name of the S3 bucket where the aggregated data is stored.
*)

}

Information about the target S3 bucket for the resource data sync.

type nonrec resource_data_sync_last_modified_time =
  Smaws_Lib.CoreTypes.Timestamp.t

type nonrec last_resource_data_sync_time = Smaws_Lib.CoreTypes.Timestamp.t

type nonrec last_successful_resource_data_sync_time =
  Smaws_Lib.CoreTypes.Timestamp.t

type nonrec last_resource_data_sync_status =

| INPROGRESS
| FAILED
| SUCCESSFUL

type nonrec resource_data_sync_created_time = Smaws_Lib.CoreTypes.Timestamp.t

type nonrec last_resource_data_sync_message = string

type nonrec resource_data_sync_item = {

last_sync_status_message : last_resource_data_sync_message option;
(*
The status message details reported by the last sync.
*)
sync_created_time : resource_data_sync_created_time option;
(*
The date and time the configuration was created (UTC).
*)
last_status : last_resource_data_sync_status option;
(*
The status reported by the last sync.
*)
sync_last_modified_time : resource_data_sync_last_modified_time option;
(*
The date and time the resource data sync was changed.
*)
last_successful_sync_time : last_successful_resource_data_sync_time option;
(*
The last time the sync operations returned a status of SUCCESSFUL (UTC).
*)
last_sync_time : last_resource_data_sync_time option;
(*
The last time the configuration attempted to sync (UTC).
*)
s3_destination : resource_data_sync_s3_destination option;
(*
Configuration information for the target S3 bucket.
*)
sync_source : resource_data_sync_source_with_state option;
(*
Information about the source where the data was synchronized.
*)
sync_type : resource_data_sync_type option;
(*
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.
*)
sync_name : resource_data_sync_name option;
(*
The name of the resource data sync.
*)

}

Information about a resource data sync configuration, including its current status and last successful sync.

type nonrec resource_data_sync_item_list = resource_data_sync_item list

type nonrec resource_data_sync_count_exceeded_exception = {

message : string_ option;

}

You have exceeded the allowed maximum sync configurations.

type nonrec resource_data_sync_already_exists_exception = {

sync_name : resource_data_sync_name option;

}

A sync configuration with the same name already exists.

type nonrec resource_count_by_status = string

type nonrec resource_count = int

type nonrec compliance_type_name = string

type nonrec compliance_resource_type = string

type nonrec compliance_resource_id = string

type nonrec compliance_status =

| NonCompliant
| Compliant

type nonrec compliance_severity =

| Unspecified
| Informational
| Low
| Medium
| High
| Critical

type nonrec compliance_execution_id = string

type nonrec compliance_execution_type = string

type nonrec compliance_execution_summary = {

execution_type : compliance_execution_type option;
(*
The type of execution. For example, Command is a valid execution type.
*)
execution_id : compliance_execution_id option;
(*
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.
*)
execution_time : date_time;
(*
The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
*)

}

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'

type nonrec compliant_summary = {

severity_summary : severity_summary option;
(*
A summary of the compliance severity by compliance type.
*)
compliant_count : compliance_summary_count option;
(*
The total number of resources that are compliant.
*)

}

A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.

type nonrec non_compliant_summary = {

severity_summary : severity_summary option;
(*
A summary of the non-compliance severity by compliance type
*)
non_compliant_count : compliance_summary_count option;
(*
The total number of compliance items that aren't compliant.
*)

}

A summary of resources that aren't compliant. The summary is organized according to resource type.

type nonrec resource_compliance_summary_item = {

non_compliant_summary : non_compliant_summary option;
(*
A list of items that aren't compliant for the resource.
*)
compliant_summary : compliant_summary option;
(*
A list of items that are compliant for the resource.
*)
execution_summary : compliance_execution_summary option;
(*
Information about the execution.
*)
overall_severity : compliance_severity option;
(*
The highest severity item found for the resource. The resource is compliant for this item.
*)
status : compliance_status option;
(*
The compliance status for the resource.
*)
resource_id : compliance_resource_id option;
(*
The resource ID.
*)
resource_type : compliance_resource_type option;
(*
The resource type.
*)
compliance_type : compliance_type_name option;
(*
The compliance type.
*)

}

Compliance summary information for a specific resource.

type nonrec resource_compliance_summary_item_list =
  resource_compliance_summary_item list

type nonrec resource_arn_string = string

type nonrec resolved_targets = {

truncated : boolean_ option;
(*
A boolean value indicating whether the resolved target list is truncated.
*)
parameter_values : target_parameter_list option;
(*
A list of parameter values sent to targets that resolved during the Automation execution.
*)

}

Information about targets that resolved during the Automation execution.

type nonrec reset_service_setting_result = {

service_setting : service_setting option;
(*
The current, effective service setting after calling the ResetServiceSetting API operation.
*)

}

The result body of the ResetServiceSetting API operation.

type nonrec reset_service_setting_request = {

setting_id : service_setting_id;
(*
The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.
- /ssm/appmanager/appmanager-enabled
- /ssm/automation/customer-script-log-destination
- /ssm/automation/customer-script-log-group-name
- /ssm/automation/enable-adaptive-concurrency
- /ssm/documents/console/public-sharing-permission
- /ssm/managed-instance/activation-tier
- /ssm/managed-instance/default-ec2-instance-management-role
- /ssm/opsinsights/opscenter
- /ssm/parameter-store/default-parameter-tier
- /ssm/parameter-store/high-throughput-enabled
*)

}

The request body of the ResetServiceSetting API operation.

type nonrec remove_tags_from_resource_result = unit

type nonrec key_list = tag_key list

type nonrec remove_tags_from_resource_request = {

tag_keys : key_list;
(*
Tag keys that you want to remove from the specified resource.
*)
resource_id : resource_id;
(*
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.
*)
resource_type : resource_type_for_tagging;
(*
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-{i ID_number} 
```
. For example, mi-1a2b3c4d5e6f.
*)

}

type nonrec invalid_resource_type = unit

type nonrec invalid_resource_id = unit

type nonrec remaining_count = int

type nonrec registrations_count = int

type nonrec registration_metadata_value = string

type nonrec registration_metadata_key = string

type nonrec registration_metadata_item = {

value : registration_metadata_value;
(*
Reserved for internal use.
*)
key : registration_metadata_key;
(*
Reserved for internal use.
*)

}

Reserved for internal use.

type nonrec registration_metadata_list = registration_metadata_item list

type nonrec registration_limit = int

type nonrec register_task_with_maintenance_window_result = {

window_task_id : maintenance_window_task_id option;
(*
The ID of the task in the maintenance window.
*)

}

type nonrec maintenance_window_task_type =

| Lambda
| StepFunctions
| Automation
| RunCommand

type nonrec client_token = string

type nonrec register_task_with_maintenance_window_request = {

alarm_configuration : alarm_configuration option;
(*
The CloudWatch alarm you want to apply to your maintenance window task.
*)
cutoff_behavior : maintenance_window_task_cutoff_behavior option;
(*
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.
*)
client_token : client_token option;
(*
User-provided idempotency token.
*)
description : maintenance_window_description option;
(*
An optional description for the task.
*)
name : maintenance_window_name option;
(*
An optional name for the task.
*)
logging_info : logging_info option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
priority : maintenance_window_task_priority option;
(*
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.
*)
task_invocation_parameters : maintenance_window_task_invocation_parameters option;
(*
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
*)
task_parameters : maintenance_window_task_parameters option;
(*
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.
*)
task_type : maintenance_window_task_type;
(*
The type of task being registered.
*)
service_role_arn : service_role option;
(*
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.
*)
task_arn : maintenance_window_task_arn;
(*
The ARN of the task to run.
*)
targets : targets option;
(*
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=,
```
Specify maintenance window targets using the following format:
```
Key=WindowTargetIds,Values=,
```
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window the task should be added to.
*)

}

type nonrec feature_not_available_exception = {

message : string_ option;

}

You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service isn't available.

type nonrec register_target_with_maintenance_window_result = {

window_target_id : maintenance_window_target_id option;
(*
The ID of the target definition in this maintenance window.
*)

}

type nonrec maintenance_window_resource_type =

| ResourceGroup
| Instance

type nonrec register_target_with_maintenance_window_request = {

client_token : client_token option;
(*
User-provided idempotency token.
*)
description : maintenance_window_description option;
(*
An optional description for the target.
*)
name : maintenance_window_name option;
(*
An optional name for the target.
*)
owner_information : owner_information option;
(*
User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.
*)
targets : targets;
(*
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=,,
```
Example 2: Use tag key-pairs applied to managed nodes
```
Key=tag:,Values=,
```
Example 3: Use tag-keys applied to managed nodes
```
Key=tag-key,Values=,
```
Example 4: Use resource group names
```
Key=resource-groups:Name,Values=
```
Example 5: Use filters for resource group types
```
Key=resource-groups:ResourceTypeFilters,Values=,
```
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.
*)
resource_type : maintenance_window_resource_type;
(*
The type of target being registered with the maintenance window.
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window the target should be registered with.
*)

}

type nonrec patch_group = string

type nonrec register_patch_baseline_for_patch_group_result = {

patch_group : patch_group option;
(*
The name of the patch group registered with the patch baseline.
*)
baseline_id : baseline_id option;
(*
The ID of the patch baseline the patch group was registered with.
*)

}

type nonrec register_patch_baseline_for_patch_group_request = {

patch_group : patch_group;
(*
The name of the patch group to be registered with the patch baseline.
*)
baseline_id : baseline_id;
(*
The ID of the patch baseline to register with the patch group.
*)

}

type nonrec already_exists_exception = {

message : string_ option;

}

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.

type nonrec register_default_patch_baseline_result = {

baseline_id : baseline_id option;
(*
The ID of the default patch baseline.
*)

}

type nonrec register_default_patch_baseline_request = {

baseline_id : baseline_id;
(*
The ID of the patch baseline that should be the default patch baseline.
*)

}

type nonrec region_list = region list

type nonrec reboot_option =

| NO_REBOOT
| REBOOT_IF_NEEDED

type nonrec policy_id = string

type nonrec policy_hash = string

type nonrec put_resource_policy_response = {

policy_hash : policy_hash option;
(*
ID of the current policy version.
*)
policy_id : policy_id option;
(*
The policy ID. To update a policy, you must specify PolicyId and PolicyHash.
*)

}

type nonrec policy = string

type nonrec put_resource_policy_request = {

policy_hash : policy_hash option;
(*
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_id : policy_id option;
(*
The policy ID.
*)
policy : policy;
(*
A policy you want to associate with a resource.
*)
resource_arn : resource_arn_string;
(*
Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
*)

}

type nonrec malformed_resource_policy_document_exception = {

message : string_ option;

}

The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.

type nonrec parameter_tier =

| INTELLIGENT_TIERING
| ADVANCED
| STANDARD

type nonrec put_parameter_result = {

tier : parameter_tier option;
(*
The tier assigned to the parameter.
*)
version : ps_parameter_version option;
(*
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.
*)

}

type nonrec parameter_description = string

type nonrec ps_parameter_value = string

type nonrec parameter_type =

| SECURE_STRING
| STRING_LIST
| STRING

type nonrec parameter_key_id = string

type nonrec allowed_pattern = string

type nonrec parameter_policies = string

type nonrec parameter_data_type = string

type nonrec put_parameter_request = {

data_type : parameter_data_type option;
(*
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 IDs.
*)
policies : parameter_policies option;
(*
One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in 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.
*)
tier : parameter_tier option;
(*
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 Managing 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.
*)
tags : tag_list option;
(*
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.
*)
allowed_pattern : allowed_pattern option;
(*
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+$
*)
overwrite : boolean_ option;
(*
Overwrite an existing parameter. The default value is false.
*)
key_id : parameter_key_id option;
(*
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.
*)
type_ : parameter_type option;
(*
The type of parameter that you want to create.
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.
*)
value : ps_parameter_value;
(*
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 values wrapped in double brackets {{}} or
```
\{\{ssm:{i parameter-name}\}\}
```
in a parameter value.
*)
description : parameter_description option;
(*
Information about the parameter that you want to add to the system. Optional but recommended.
Don't enter personally identifiable information in this field.
*)
name : ps_parameter_name;
(*
The fully qualified name of the parameter that you want to create or update.
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
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 reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: arn:aws:ssm:us-east-2:111122223333:parameter/.
*)

}

type nonrec policies_limit_exceeded_exception = {

message : string_ option;

}

You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.

type nonrec parameter_pattern_mismatch_exception = {

message : string_ option;
(*
The parameter name isn't valid.
*)

}

The parameter name isn't valid.

type nonrec parameter_max_version_limit_exceeded = {

message : string_ option;

}

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 {i parameter-name} by calling the PutParameter API with the overwrite flag. Version {i 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.

type nonrec parameter_limit_exceeded = {

message : string_ option;

}

You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more parameters and try again.

type nonrec parameter_already_exists = {

message : string_ option;

}

The parameter already exists. You can't create duplicate parameters.

type nonrec invalid_policy_type_exception = {

message : string_ option;

}

The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

type nonrec invalid_policy_attribute_exception = {

message : string_ option;

}

A policy attribute or its value is invalid.

type nonrec invalid_key_id = {

message : string_ option;

}

The query key ID isn't valid.

type nonrec invalid_allowed_pattern_exception = {

message : string_ option;
(*
The request doesn't meet the regular expression requirement.
*)

}

The request doesn't meet the regular expression requirement.

type nonrec incompatible_policy_exception = {

message : string_ option;

}

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.

type nonrec hierarchy_type_mismatch_exception = {

message : string_ option;
(*
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.
*)

}

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.

type nonrec hierarchy_level_limit_exceeded_exception = {

message : string_ option;
(*
A hierarchy can have a maximum of 15 levels. For more information, see About requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.
*)

}

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.

type nonrec put_inventory_message = string

type nonrec put_inventory_result = {

message : put_inventory_message option;
(*
Information about the request.
*)

}

type nonrec inventory_item_schema_version = string

type nonrec inventory_item_capture_time = string

type nonrec inventory_item_content_hash = string

type nonrec attribute_value = string

type nonrec attribute_name = string

type nonrec inventory_item_entry = (attribute_name * attribute_value) list

type nonrec inventory_item_entry_list = inventory_item_entry list

type nonrec inventory_item_content_context =
  (attribute_name * attribute_value) list

type nonrec inventory_item = {

context : inventory_item_content_context option;
(*
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.
*)
content : inventory_item_entry_list option;
(*
The inventory data of the inventory type.
*)
content_hash : inventory_item_content_hash option;
(*
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.
*)
capture_time : inventory_item_capture_time;
(*
The time the inventory information was collected.
*)
schema_version : inventory_item_schema_version;
(*
The schema version for the inventory item.
*)
type_name : inventory_item_type_name;
(*
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.
*)

}

Information collected from managed nodes based on your inventory policy document

type nonrec inventory_item_list = inventory_item list

type nonrec put_inventory_request = {

items : inventory_item_list;
(*
The inventory items that you want to add or update on managed nodes.
*)
instance_id : instance_id;
(*
An managed node ID where you want to add or update inventory items.
*)

}

type nonrec item_size_limit_exceeded_exception = {

message : string_ option;
type_name : inventory_item_type_name option;

}

The inventory item size has exceeded the size limit.

type nonrec item_content_mismatch_exception = {

message : string_ option;
type_name : inventory_item_type_name option;

}

The inventory item has invalid content.

type nonrec invalid_type_name_exception = {

message : string_ option;

}

The parameter type name isn't valid.

type nonrec invalid_item_content_exception = {

message : string_ option;
type_name : inventory_item_type_name option;

}

One or more content items isn't valid.

type nonrec invalid_inventory_item_context_exception = {

message : string_ option;

}

You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.

type nonrec custom_schema_count_limit_exceeded_exception = {

message : string_ option;

}

You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

type nonrec put_compliance_items_result = unit

type nonrec compliance_item_id = string

type nonrec compliance_item_title = string

type nonrec compliance_item_details = (attribute_name * attribute_value) list

type nonrec compliance_item_entry = {

details : compliance_item_details option;
(*
A "Key": "Value" tag combination for the compliance item.
*)
status : compliance_status;
(*
The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
*)
severity : compliance_severity;
(*
The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
*)
title : compliance_item_title option;
(*
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.
*)
id : compliance_item_id option;
(*
The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.
*)

}

Information about a compliance item.

type nonrec compliance_item_entry_list = compliance_item_entry list

type nonrec compliance_item_content_hash = string

type nonrec compliance_upload_type =

| Partial
| Complete

type nonrec put_compliance_items_request = {

upload_type : compliance_upload_type option;
(*
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.
*)
item_content_hash : compliance_item_content_hash option;
(*
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.
*)
items : compliance_item_entry_list;
(*
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.
*)
execution_summary : compliance_execution_summary;
(*
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'
*)
compliance_type : compliance_type_name;
(*
Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.
*)
resource_type : compliance_resource_type;
(*
Specify the type of resource. ManagedInstance is currently the only supported resource type.
*)
resource_id : compliance_resource_id;
(*
Specify an ID for this resource. For a managed node, this is the node ID.
*)

}

type nonrec compliance_type_count_limit_exceeded_exception = {

message : string_ option;

}

You specified too many custom compliance types. You can specify a maximum of 10 different types.

type nonrec progress_counters = {

timed_out_steps : integer option;
(*
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.
*)
cancelled_steps : integer option;
(*
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.
*)
failed_steps : integer option;
(*
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.
*)
success_steps : integer option;
(*
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.
*)
total_steps : integer option;
(*
The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.
*)

}

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

type nonrec product = string

type nonrec platform_version = string

type nonrec platform_name = string

type nonrec ping_status =

| INACTIVE
| CONNECTION_LOST
| ONLINE

type nonrec patch_version = string

type nonrec patch_vendor = string

type nonrec patch_unreported_not_applicable_count = int

type nonrec patch_title = string

type nonrec patch_deployment_status =

| ExplicitRejected
| ExplicitApproved
| PendingApproval
| Approved

type nonrec patch_status = {

approval_date : date_time option;
(*
The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).
*)
compliance_level : patch_compliance_level option;
(*
The compliance severity level for a patch.
*)
deployment_status : patch_deployment_status option;
(*
The approval status of a patch.
*)

}

Information about the approval status of a patch.

type nonrec patch_severity = string

type nonrec patch_set =

| Application
| Os

type nonrec patch_security_non_compliant_count = int

type nonrec patch_repository = string

type nonrec patch_release = string

type nonrec patch_property_entry = (attribute_name * attribute_value) list

type nonrec patch_property =

| PatchSeverity
| PatchPriority
| PatchMsrcSeverity
| PatchClassification
| PatchProductFamily
| Product

type nonrec patch_properties_list = patch_property_entry list

type nonrec patch_product_family = string

type nonrec patch_product = string

type nonrec patch_other_non_compliant_count = int

type nonrec patch_orchestrator_filter_value = string

type nonrec patch_orchestrator_filter_values =
  patch_orchestrator_filter_value list

type nonrec patch_orchestrator_filter_key = string

type nonrec patch_orchestrator_filter = {

values : patch_orchestrator_filter_values option;
(*
The value for the filter.
*)
key : patch_orchestrator_filter_key option;
(*
The key for the filter.
*)

}

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

type nonrec patch_orchestrator_filter_list = patch_orchestrator_filter list

type nonrec patch_operation_type =

| INSTALL
| SCAN

type nonrec patch_not_applicable_count = int

type nonrec patch_name = string

type nonrec patch_msrc_severity = string

type nonrec patch_msrc_number = string

type nonrec patch_missing_count = int

type nonrec patch_description = string

type nonrec patch_content_url = string

type nonrec patch_classification = string

type nonrec patch_kb_number = string

type nonrec patch_language = string

type nonrec patch_advisory_id = string

type nonrec patch_advisory_id_list = patch_advisory_id list

type nonrec patch_bugzilla_id = string

type nonrec patch_bugzilla_id_list = patch_bugzilla_id list

type nonrec patch_cve_id = string

type nonrec patch_cve_id_list = patch_cve_id list

type nonrec patch_epoch = int

type nonrec patch_arch = string

type nonrec patch = {

repository : patch_repository option;
(*
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.
*)
severity : patch_severity option;
(*
The severity level of the patch. For example, CRITICAL or MODERATE.
*)
arch : patch_arch option;
(*
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.
*)
release : patch_release option;
(*
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.
*)
version : patch_version option;
(*
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.
*)
epoch : patch_epoch option;
(*
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.
*)
name : patch_name option;
(*
The name of the patch. Applies to Linux-based managed nodes only.
*)
cve_ids : patch_cve_id_list option;
(*
The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, CVE-2011-3192. Applies to Linux-based managed nodes only.
*)
bugzilla_ids : patch_bugzilla_id_list option;
(*
The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based managed nodes only.
*)
advisory_ids : patch_advisory_id_list option;
(*
The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to Linux-based managed nodes only.
*)
language : patch_language option;
(*
The language of the patch if it's language-specific.
*)
msrc_number : patch_msrc_number option;
(*
The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, MS14-045. Applies to Windows patches only.
*)
kb_number : patch_kb_number option;
(*
The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.
*)
msrc_severity : patch_msrc_severity option;
(*
The severity of the patch, such as Critical, Important, or Moderate. Applies to Windows patches only.
*)
classification : patch_classification option;
(*
The classification of the patch. For example, SecurityUpdates, Updates, or CriticalUpdates.
*)
product : patch_product option;
(*
The specific product the patch is applicable for. For example, WindowsServer2016 or AmazonLinux2018.03.
*)
product_family : patch_product_family option;
(*
The product family the patch is applicable for. For example, Windows or Amazon Linux 2.
*)
vendor : patch_vendor option;
(*
The name of the vendor providing the patch.
*)
content_url : patch_content_url option;
(*
The URL where more information can be obtained about the patch.
*)
description : patch_description option;
(*
The description of the patch.
*)
title : patch_title option;
(*
The title of the patch.
*)
release_date : date_time option;
(*
The date the patch was released.
*)
id : patch_id option;
(*
The ID of the patch. Applies to Windows patches only.
This ID isn't the same as the Microsoft Knowledge Base ID.
*)

}

Represents metadata about a patch.

type nonrec patch_list = patch list

type nonrec patch_installed_rejected_count = int

type nonrec patch_installed_pending_reboot_count = int

type nonrec patch_installed_other_count = int

type nonrec patch_installed_count = int

type nonrec default_baseline = bool

type nonrec patch_baseline_identity = {

default_baseline : default_baseline option;
(*
Indicates 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.
*)
baseline_description : baseline_description option;
(*
The description of the patch baseline.
*)
operating_system : operating_system option;
(*
Defines the operating system the patch baseline applies to. The default value is WINDOWS.
*)
baseline_name : baseline_name option;
(*
The name of the patch baseline.
*)
baseline_id : baseline_id option;
(*
The ID of the patch baseline.
*)

}

Defines the basic information about a patch baseline.

type nonrec patch_group_patch_baseline_mapping = {

baseline_identity : patch_baseline_identity option;
(*
The patch baseline the patch group is registered with.
*)
patch_group : patch_group option;
(*
The name of the patch group registered with the patch baseline.
*)

}

The mapping between a patch group and the patch baseline the patch group is registered with.

type nonrec patch_group_patch_baseline_mapping_list =
  patch_group_patch_baseline_mapping list

type nonrec patch_group_list = patch_group list

type nonrec patch_failed_count = int

type nonrec patch_critical_non_compliant_count = int

type nonrec patch_compliance_max_results = int

type nonrec patch_compliance_data_state =

| AvailableSecurityUpdate
| Failed
| NotApplicable
| Missing
| InstalledRejected
| InstalledPendingReboot
| InstalledOther
| Installed

type nonrec patch_cve_ids = string

type nonrec patch_compliance_data = {

cve_ids : patch_cve_ids option;
(*
The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.
Currently, CVE ID values are reported only for patches with a status of Missing or Failed.
*)
installed_time : date_time;
(*
The date/time the patch was installed on the managed node. Not all operating systems provide this level of information.
*)
state : patch_compliance_data_state;
(*
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.
*)
severity : patch_severity;
(*
The severity of the patch such as Critical, Important, and Moderate.
*)
classification : patch_classification;
(*
The classification of the patch, such as SecurityUpdates, Updates, and CriticalUpdates.
*)
kb_id : patch_kb_number;
(*
The operating system-specific ID of the patch.
*)
title : patch_title;
(*
The title of the patch.
*)

}

Information about the state of a patch on a particular managed node as it relates to the patch baseline used to patch the node.

type nonrec patch_compliance_data_list = patch_compliance_data list

type nonrec patch_baseline_max_results = int

type nonrec patch_baseline_identity_list = patch_baseline_identity list

type nonrec patch_available_security_update_count = int

type nonrec parameters_filter_value = string

type nonrec parameters_filter_value_list = parameters_filter_value list

type nonrec parameters_filter_key =

| KEY_ID
| TYPE
| NAME

type nonrec parameters_filter = {

values : parameters_filter_value_list;
(*
The filter values.
*)
key : parameters_filter_key;
(*
The name of the filter.
*)

}

This data type is deprecated. Instead, use ParameterStringFilter.

type nonrec parameters_filter_list = parameters_filter list

type nonrec parameter_version_label_limit_exceeded = {

message : string_ option;

}

A parameter version can have a maximum of ten labels.

type nonrec parameter_string_query_option = string

type nonrec parameter_string_filter_value = string

type nonrec parameter_string_filter_value_list =
  parameter_string_filter_value list

type nonrec parameter_string_filter_key = string

type nonrec parameter_string_filter = {

values : parameter_string_filter_value_list option;
(*
The value you want to search for.
*)
option_ : parameter_string_query_option option;
(*
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.)
*)
key : parameter_string_filter_key;
(*
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.
*)

}

One or more filters. Use a filter to return a more specific list of results.

type nonrec parameter_string_filter_list = parameter_string_filter list

type nonrec parameter_inline_policy = {

policy_status : string_ option;
(*
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).
*)
policy_type : string_ option;
(*
The type of policy. Parameter Store, a tool in Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
*)
policy_text : string_ option;
(*
The JSON text of the policy.
*)

}

One or more policies assigned to a parameter.

type nonrec parameter_policy_list = parameter_inline_policy list

type nonrec parameter_name_list = ps_parameter_name list

type nonrec parameter_metadata = {

data_type : parameter_data_type option;
(*
The data type of the parameter, such as text or aws:ec2:image. The default is text.
*)
policies : parameter_policy_list option;
(*
A list of policies associated with a parameter.
*)
tier : parameter_tier option;
(*
The parameter tier.
*)
version : ps_parameter_version option;
(*
The parameter version.
*)
allowed_pattern : allowed_pattern option;
(*
A parameter name can include only the following letters and symbols.
a-zA-Z0-9_.-
*)
description : parameter_description option;
(*
Description of the parameter actions.
*)
last_modified_user : string_ option;
(*
Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
*)
last_modified_date : date_time option;
(*
Date the parameter was last changed or updated.
*)
key_id : parameter_key_id option;
(*
The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only.
*)
type_ : parameter_type option;
(*
The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.
*)
ar_n : string_ option;
(*
The Amazon Resource Name (ARN) of the parameter.
*)
name : ps_parameter_name option;
(*
The parameter name.
*)

}

Metadata includes information like the Amazon Resource Name (ARN) of the last user to update the parameter and the date and time the parameter was last used.

type nonrec parameter_metadata_list = parameter_metadata list

type nonrec ps_parameter_selector = string

type nonrec parameter = {

data_type : parameter_data_type option;
(*
The data type of the parameter, such as text or aws:ec2:image. The default is text.
*)
ar_n : string_ option;
(*
The Amazon Resource Name (ARN) of the parameter.
*)
last_modified_date : date_time option;
(*
Date the parameter was last changed or updated and the parameter version was created.
*)
source_result : string_ option;
(*
Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.
*)
selector : ps_parameter_selector option;
(*
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
*)
version : ps_parameter_version option;
(*
The parameter version.
*)
value : ps_parameter_value option;
(*
The parameter value.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
*)
type_ : parameter_type option;
(*
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.
*)
name : ps_parameter_name option;
(*
The name of the parameter.
*)

}

An Amazon Web Services Systems Manager parameter in Parameter Store.

type nonrec parameter_list = parameter list

type nonrec parameter_history = {

data_type : parameter_data_type option;
(*
The data type of the parameter, such as text or aws:ec2:image. The default is text.
*)
policies : parameter_policy_list option;
(*
Information about the policies assigned to a parameter.
Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.
*)
tier : parameter_tier option;
(*
The parameter tier.
*)
labels : parameter_label_list option;
(*
Labels assigned to the parameter version.
*)
version : ps_parameter_version option;
(*
The parameter version.
*)
allowed_pattern : allowed_pattern option;
(*
Parameter names can include the following letters and symbols.
a-zA-Z0-9_.-
*)
value : ps_parameter_value option;
(*
The parameter value.
*)
description : parameter_description option;
(*
Information about the parameter.
*)
last_modified_user : string_ option;
(*
Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
*)
last_modified_date : date_time option;
(*
Date the parameter was last changed or updated.
*)
key_id : parameter_key_id option;
(*
The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only
*)
type_ : parameter_type option;
(*
The type of parameter used.
*)
name : ps_parameter_name option;
(*
The name of the parameter.
*)

}

Information about parameter usage.

type nonrec parameter_history_list = parameter_history list

type nonrec output_source_type = string

type nonrec output_source_id = string

type nonrec output_source = {

output_source_type : output_source_type option;
(*
The type of source where the association execution details are stored, for example, Amazon S3.
*)
output_source_id : output_source_id option;
(*
The ID of the output source, for example the URL of an S3 bucket.
*)

}

Information about the source where the association execution details are stored.

type nonrec ops_data_type_name = string

type nonrec ops_result_attribute = {

type_name : ops_data_type_name;
(*
Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.
*)

}

The OpsItem data type to return.

type nonrec ops_result_attribute_list = ops_result_attribute list

type nonrec ops_metadata_resource_id = string

type nonrec ops_metadata = {

creation_date : date_time option;
(*
The date the OpsMetadata objects was created.
*)
last_modified_user : string_ option;
(*
The user name who last updated the OpsMetadata object.
*)
last_modified_date : date_time option;
(*
The date the OpsMetadata object was last updated.
*)
ops_metadata_arn : ops_metadata_arn option;
(*
The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
*)
resource_id : ops_metadata_resource_id option;
(*
The ID of the Application Manager application.
*)

}

Operational metadata for an application in Application Manager.

type nonrec ops_metadata_list = ops_metadata list

type nonrec ops_metadata_limit_exceeded_exception = {

message : string_ option;

}

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.

type nonrec ops_metadata_filter_value = string

type nonrec ops_metadata_filter_value_list = ops_metadata_filter_value list

type nonrec ops_metadata_filter_key = string

type nonrec ops_metadata_filter = {

values : ops_metadata_filter_value_list;
(*
A filter value.
*)
key : ops_metadata_filter_key;
(*
A filter key.
*)

}

A filter to limit the number of OpsMetadata objects displayed.

type nonrec ops_metadata_filter_list = ops_metadata_filter list

type nonrec ops_metadata_already_exists_exception = {

message : string_ option;

}

An OpsMetadata object already exists for the selected resource.

type nonrec ops_item_type = string

type nonrec ops_item_source = string

type nonrec ops_item_summary = {

planned_end_time : date_time option;
(*
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
*)
planned_start_time : date_time option;
(*
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
*)
actual_end_time : date_time option;
(*
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
*)
actual_start_time : date_time option;
(*
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
*)
ops_item_type : ops_item_type option;
(*
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.
*)
severity : ops_item_severity option;
(*
A list of OpsItems by severity.
*)
category : ops_item_category option;
(*
A list of OpsItems by category.
*)
operational_data : ops_item_operational_data option;
(*
Operational data is custom data that provides useful reference details about the OpsItem.
*)
title : ops_item_title option;
(*
A short heading that describes the nature of the OpsItem and the impacted resource.
*)
ops_item_id : ops_item_id option;
(*
The ID of the OpsItem.
*)
status : ops_item_status option;
(*
The OpsItem status.
*)
source : ops_item_source option;
(*
The impacted Amazon Web Services resource.
*)
priority : ops_item_priority option;
(*
The importance of this OpsItem in relation to other OpsItems in the system.
*)
last_modified_time : date_time option;
(*
The date and time the OpsItem was last updated.
*)
last_modified_by : string_ option;
(*
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
*)
created_time : date_time option;
(*
The date and time the OpsItem was created.
*)
created_by : string_ option;
(*
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
*)

}

A count of OpsItems.

type nonrec ops_item_summaries = ops_item_summary list

type nonrec ops_item_related_items_max_results = int

type nonrec ops_item_related_items_filter_key =

| RESOURCE_URI
| ASSOCIATION_ID
| RESOURCE_TYPE

type nonrec ops_item_related_items_filter_value = string

type nonrec ops_item_related_items_filter_values =
  ops_item_related_items_filter_value list

type nonrec ops_item_related_items_filter_operator =

| EQUAL

type nonrec ops_item_related_items_filter = {

operator : ops_item_related_items_filter_operator;
(*
The operator used by the filter call. The only supported operator is EQUAL.
*)
values : ops_item_related_items_filter_values;
(*
The values for the filter.
*)
key : ops_item_related_items_filter_key;
(*
The name of the filter key. Supported values include ResourceUri, ResourceType, or AssociationId.
*)

}

Describes a filter for a specific list of related-item resources.

type nonrec ops_item_related_items_filters = ops_item_related_items_filter list

type nonrec ops_item_related_item_association_id = string

type nonrec ops_item_related_item_association_resource_type = string

type nonrec ops_item_related_item_association_type = string

type nonrec ops_item_related_item_association_resource_uri = string

type nonrec ops_item_identity = {

arn : string_ option;
(*
The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
*)

}

Information about the user or resource that created an OpsItem event.

type nonrec ops_item_related_item_summary = {

last_modified_time : date_time option;
(*
The time the related-item association was last updated.
*)
last_modified_by : ops_item_identity option;
created_time : date_time option;
(*
The time the related-item association was created.
*)
created_by : ops_item_identity option;
resource_uri : ops_item_related_item_association_resource_uri option;
(*
The Amazon Resource Name (ARN) of the related-item resource.
*)
association_type : ops_item_related_item_association_type option;
(*
The association type.
*)
resource_type : ops_item_related_item_association_resource_type option;
(*
The resource type.
*)
association_id : ops_item_related_item_association_id option;
(*
The association ID.
*)
ops_item_id : ops_item_id option;
(*
The OpsItem ID.
*)

}

Summary information about related-item resources for an OpsItem.

type nonrec ops_item_related_item_summaries =
  ops_item_related_item_summary list

type nonrec ops_item_related_item_association_not_found_exception = {

message : string_ option;

}

The association wasn't found using the parameters you specified in the call. Verify the information and try again.

type nonrec ops_item_related_item_already_exists_exception = {

ops_item_id : ops_item_id option;
resource_uri : ops_item_related_item_association_resource_uri option;
message : string_ option;

}

The Amazon Resource Name (ARN) is already associated with the OpsItem.

type nonrec ops_item_max_results = int

type nonrec ops_item_filter_key =

| ACCOUNT_ID
| INSIGHT_TYPE
| CHANGE_REQUEST_TARGETS_RESOURCE_GROUP
| CHANGE_REQUEST_TEMPLATE
| CHANGE_REQUEST_APPROVER_NAME
| CHANGE_REQUEST_APPROVER_ARN
| CHANGE_REQUEST_REQUESTER_NAME
| CHANGE_REQUEST_REQUESTER_ARN
| ACCESS_REQUEST_TARGET_RESOURCE_ID
| ACCESS_REQUEST_IS_REPLICA
| ACCESS_REQUEST_SOURCE_REGION
| ACCESS_REQUEST_SOURCE_OPS_ITEM_ID
| ACCESS_REQUEST_SOURCE_ACCOUNT_ID
| ACCESS_REQUEST_APPROVER_ID
| ACCESS_REQUEST_APPROVER_ARN
| ACCESS_REQUEST_REQUESTER_ID
| ACCESS_REQUEST_REQUESTER_ARN
| OPSITEM_TYPE
| SEVERITY
| CATEGORY
| AUTOMATION_ID
| RESOURCE_ID
| OPERATIONAL_DATA_VALUE
| OPERATIONAL_DATA_KEY
| OPERATIONAL_DATA
| PLANNED_END_TIME
| PLANNED_START_TIME
| ACTUAL_END_TIME
| ACTUAL_START_TIME
| LAST_MODIFIED_TIME
| CREATED_TIME
| OPSITEM_ID
| TITLE
| PRIORITY
| SOURCE
| CREATED_BY
| STATUS

type nonrec ops_item_filter_value = string

type nonrec ops_item_filter_values = ops_item_filter_value list

type nonrec ops_item_filter_operator =

| LESS_THAN
| GREATER_THAN
| CONTAINS
| EQUAL

type nonrec ops_item_filter = {

operator : ops_item_filter_operator;
(*
The operator used by the filter call.
*)
values : ops_item_filter_values;
(*
The filter value.
*)
key : ops_item_filter_key;
(*
The name of the filter.
*)

}

Describes an OpsItem filter.

type nonrec ops_item_filters = ops_item_filter list

type nonrec ops_item_event_summary = {

created_time : date_time option;
(*
The date and time the OpsItem event was created.
*)
created_by : ops_item_identity option;
(*
Information about the user or resource that created the OpsItem event.
*)
detail : string_ option;
(*
Specific information about the OpsItem event.
*)
detail_type : string_ option;
(*
The type of information provided as a detail.
*)
source : string_ option;
(*
The source of the OpsItem event.
*)
event_id : string_ option;
(*
The ID of the OpsItem event.
*)
ops_item_id : string_ option;
(*
The ID of the OpsItem.
*)

}

Summary information about an OpsItem event or that associated an OpsItem with a related item.

type nonrec ops_item_event_summaries = ops_item_event_summary list

type nonrec ops_item_event_max_results = int

type nonrec ops_item_event_filter_key =

| OPSITEM_ID

type nonrec ops_item_event_filter_value = string

type nonrec ops_item_event_filter_values = ops_item_event_filter_value list

type nonrec ops_item_event_filter_operator =

| EQUAL

type nonrec ops_item_event_filter = {

operator : ops_item_event_filter_operator;
(*
The operator used by the filter call. Currently, the only supported value is Equal.
*)
values : ops_item_event_filter_values;
(*
The values for the filter, consisting of one or more OpsItem IDs.
*)
key : ops_item_event_filter_key;
(*
The name of the filter key. Currently, the only supported value is OpsItemId.
*)

}

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.

type nonrec ops_item_event_filters = ops_item_event_filter list

type nonrec ops_item_account_id = string

type nonrec ops_item = {

ops_item_arn : ops_item_arn option;
(*
The OpsItem Amazon Resource Name (ARN).
*)
planned_end_time : date_time option;
(*
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
*)
planned_start_time : date_time option;
(*
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
*)
actual_end_time : date_time option;
(*
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
*)
actual_start_time : date_time option;
(*
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
*)
severity : ops_item_severity option;
(*
The severity of the OpsItem. Severity options range from 1 to 4.
*)
category : ops_item_category option;
(*
An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
*)
operational_data : ops_item_operational_data option;
(*
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.
*)
source : ops_item_source option;
(*
The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
*)
title : ops_item_title option;
(*
A short heading that describes the nature of the OpsItem and the impacted resource.
*)
version : string_ option;
(*
The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
*)
ops_item_id : ops_item_id option;
(*
The ID of the OpsItem.
*)
status : ops_item_status option;
(*
The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
*)
related_ops_items : related_ops_items option;
(*
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.
*)
priority : ops_item_priority option;
(*
The importance of this OpsItem in relation to other OpsItems in the system.
*)
notifications : ops_item_notifications option;
(*
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.
*)
last_modified_time : date_time option;
(*
The date and time the OpsItem was last updated.
*)
last_modified_by : string_ option;
(*
The ARN of the Amazon Web Services account that last updated the OpsItem.
*)
description : ops_item_description option;
(*
The OpsItem description.
*)
created_time : date_time option;
(*
The date and time the OpsItem was created.
*)
ops_item_type : ops_item_type option;
(*
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.
*)
created_by : string_ option;
(*
The ARN of the Amazon Web Services account that created the OpsItem.
*)

}

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

type nonrec ops_filter_value = string

type nonrec ops_filter_value_list = ops_filter_value list

type nonrec ops_filter_operator_type =

| EXISTS
| GREATER_THAN
| LESS_THAN
| BEGIN_WITH
| NOT_EQUAL
| EQUAL

type nonrec ops_filter_key = string

type nonrec ops_filter = {

type_ : ops_filter_operator_type option;
(*
The type of filter.
*)
values : ops_filter_value_list;
(*
The filter value.
*)
key : ops_filter_key;
(*
The name of the filter.
*)

}

A filter for viewing OpsData summaries.

type nonrec ops_filter_list = ops_filter list

type nonrec ops_entity_id = string

type nonrec ops_entity_item_capture_time = string

type nonrec ops_entity_item_entry = (attribute_name * attribute_value) list

type nonrec ops_entity_item_entry_list = ops_entity_item_entry list

type nonrec ops_entity_item = {

content : ops_entity_item_entry_list option;
(*
The details of an OpsData summary.
*)
capture_time : ops_entity_item_capture_time option;
(*
The time the OpsData was captured.
*)

}

The OpsData summary.

type nonrec ops_entity_item_key = string

type nonrec ops_entity_item_map = (ops_entity_item_key * ops_entity_item) list

type nonrec ops_entity = {

data : ops_entity_item_map option;
(*
The data returned by the query.
*)
id : ops_entity_id option;
(*
The query ID.
*)

}

The result of the query.

type nonrec ops_entity_list = ops_entity list

type nonrec ops_data_attribute_name = string

type nonrec ops_aggregator_value = string

type nonrec ops_aggregator_value_key = string

type nonrec ops_aggregator_value_map =
  (ops_aggregator_value_key * ops_aggregator_value) list

type nonrec ops_aggregator_type = string

type ops_aggregator = {

aggregators : ops_aggregator_list option;
(*
A nested aggregator for viewing counts of OpsData.
*)
filters : ops_filter_list option;
(*
The aggregator filters.
*)
values : ops_aggregator_value_map option;
(*
The aggregator value.
*)
attribute_name : ops_data_attribute_name option;
(*
The name of an OpsData attribute on which to limit the count of OpsData.
*)
type_name : ops_data_type_name option;
(*
The data type name to use for viewing counts of OpsData.
*)
aggregator_type : ops_aggregator_type option;
(*
Either a Range or Count aggregator for limiting an OpsData summary.
*)

}

One or more aggregators for viewing counts of OpsData using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.

and ops_aggregator_list = ops_aggregator list

type nonrec node_type_name =

| INSTANCE

type nonrec agent_type = string

type nonrec agent_version = string

type nonrec computer_name = string

type nonrec instance_status = string

type nonrec ip_address = string

type nonrec managed_status =

| UNMANAGED
| MANAGED
| ALL

type nonrec instance_info = {

resource_type : resource_type option;
(*
The type of instance, either an EC2 instance or another supported machine type in a hybrid fleet.
*)
platform_version : platform_version option;
(*
The version of the OS platform running on your managed node.
*)
platform_name : platform_name option;
(*
The name of the operating system platform running on your managed node.
*)
platform_type : platform_type option;
(*
The operating system platform type of the managed node.
*)
managed_status : managed_status option;
(*
Indicates whether the node is managed by Systems Manager.
*)
ip_address : ip_address option;
(*
The IP address of the managed node.
*)
instance_status : instance_status option;
(*
The current status of the managed node.
*)
computer_name : computer_name option;
(*
The fully qualified host name of the managed node.
*)
agent_version : agent_version option;
(*
The version number of the agent installed on the node.
*)
agent_type : agent_type option;
(*
The type of agent installed on the node.
*)

}

Details about a specific managed node.

type nonrec node_type =

| Instance of instance_info
(*
Information about a specific managed node.
*)

Information about a managed node's type.

type nonrec node_summary = (attribute_name * attribute_value) list

type nonrec node_summary_list = node_summary list

type nonrec node_region = string

type nonrec node_account_id = string

type nonrec node_organizational_unit_id = string

type nonrec node_organizational_unit_path = string

type nonrec node_owner_info = {

organizational_unit_path : node_organizational_unit_path option;
(*
The path for the organizational unit (OU) that owns the managed node. The path for the OU is built using the IDs of the organization, root, and all OUs in the path down to and including the OU. For example:
o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/
*)
organizational_unit_id : node_organizational_unit_id option;
(*
The ID of the organization unit (OU) that the account is part of.
*)
account_id : node_account_id option;
(*
The ID of the Amazon Web Services account that owns the managed node.
*)

}

Information about ownership of a managed node.

type nonrec node_capture_time = Smaws_Lib.CoreTypes.Timestamp.t

type nonrec node_id = string

type nonrec node = {

node_type : node_type option;
(*
Information about the type of node.
*)
region : node_region option;
(*
The Amazon Web Services Region that a managed node was created in or assigned to.
*)
owner : node_owner_info option;
(*
Information about the ownership of the managed node.
*)
id : node_id option;
(*
The ID of the managed node.
*)
capture_time : node_capture_time option;
(*
The UTC timestamp for when the managed node data was last captured.
*)

}

Details about an individual managed node.

type nonrec node_list = node list

type nonrec node_filter_value = string

type nonrec node_filter_value_list = node_filter_value list

type nonrec node_filter_operator_type =

| BEGIN_WITH
| NOT_EQUAL
| EQUAL

type nonrec node_filter_key =

| ACCOUNT_ID
| REGION
| ORGANIZATIONAL_UNIT_PATH
| ORGANIZATIONAL_UNIT_ID
| RESOURCE_TYPE
| PLATFORM_VERSION
| PLATFORM_TYPE
| PLATFORM_NAME
| MANAGED_STATUS
| IP_ADDRESS
| INSTANCE_STATUS
| INSTANCE_ID
| COMPUTER_NAME
| AGENT_VERSION
| AGENT_TYPE

type nonrec node_filter = {

type_ : node_filter_operator_type option;
(*
The type of filter operator.
*)
values : node_filter_value_list;
(*
A filter value supported by the specified key. For example, for the key PlatformType, supported values include Linux and Windows.
*)
key : node_filter_key;
(*
The name of the filter.
*)

}

The filters for the operation.

type nonrec node_filter_list = node_filter list

type nonrec node_attribute_name =

| RESOURCE_TYPE
| REGION
| PLATFORM_VERSION
| PLATFORM_TYPE
| PLATFORM_NAME
| AGENT_VERSION

type nonrec node_aggregator_type =

| COUNT

type node_aggregator = {

aggregators : node_aggregator_list option;
(*
Information about aggregators used to refine a node summary.
*)
attribute_name : node_attribute_name;
(*
The name of a node attribute on which to limit the count of nodes.
*)
type_name : node_type_name;
(*
The data type name to use for viewing counts of nodes. Currently, only Instance is supported.
*)
aggregator_type : node_aggregator_type;
(*
The aggregator type for limiting a node summary. Currently, only Count is supported.
*)

}

One or more aggregators for viewing counts of nodes using different dimensions.

and node_aggregator_list = node_aggregator list

type nonrec next_token = string

type nonrec modify_document_permission_response = unit

type nonrec document_permission_type =

| SHARE

type nonrec account_id = string

type nonrec account_id_list = account_id list

type nonrec modify_document_permission_request = {

shared_document_version : shared_document_version option;
(*
(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.
*)
account_ids_to_remove : account_id_list option;
(*
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. You must specify a value for this parameter or the AccountIdsToAdd parameter.
*)
account_ids_to_add : account_id_list option;
(*
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. You must specify a value for this parameter or the AccountIdsToRemove parameter.
*)
permission_type : document_permission_type;
(*
The permission type for the document. The permission type can be Share.
*)
name : document_name;
(*
The name of the document that you want to share.
*)

}

type nonrec invalid_permission_type = {

message : string_ option;

}

The permission type isn't supported. Share is the only supported permission type.

type nonrec document_permission_limit = {

message : string_ option;

}

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.

type nonrec document_limit_exceeded = {

message : string_ option;

}

You can have at most 500 active SSM documents.

type nonrec max_results_ec2_compatible = int

type nonrec max_results = int

type nonrec maintenance_window_identity_for_target = {

name : maintenance_window_name option;
(*
The name of the maintenance window.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window.
*)

}

The maintenance window to which the specified target belongs.

type nonrec maintenance_windows_for_target_list =
  maintenance_window_identity_for_target list

type nonrec maintenance_window_task_target_id = string

type nonrec maintenance_window_task_parameters_list =
  maintenance_window_task_parameters list

type nonrec maintenance_window_task = {

alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm applied to your maintenance window task.
*)
cutoff_behavior : maintenance_window_task_cutoff_behavior option;
(*
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
*)
description : maintenance_window_description option;
(*
A description of the task.
*)
name : maintenance_window_name option;
(*
The task name.
*)
max_errors : max_errors option;
(*
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.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
service_role_arn : service_role option;
(*
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.
*)
logging_info : logging_info option;
(*
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.
*)
priority : maintenance_window_task_priority option;
(*
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.
*)
task_parameters : maintenance_window_task_parameters option;
(*
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.
*)
targets : targets option;
(*
The targets (either managed nodes or tags). Managed nodes are specified using
```
Key=instanceids,Values=,
```
. Tags are specified using
```
Key=,Values=
```
.
*)
type_ : maintenance_window_task_type option;
(*
The type of task.
*)
task_arn : maintenance_window_task_arn option;
(*
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.
*)
window_task_id : maintenance_window_task_id option;
(*
The task ID.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window where the task is registered.
*)

}

Information about a task defined for a maintenance window.

type nonrec maintenance_window_task_list = maintenance_window_task list

type nonrec maintenance_window_target = {

description : maintenance_window_description option;
(*
A description for the target.
*)
name : maintenance_window_name option;
(*
The name for the maintenance window target.
*)
owner_information : owner_information option;
(*
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.
*)
targets : targets option;
(*
The targets, either managed nodes or tags.
Specify managed nodes using the following format:
```
Key=instanceids,Values=,
```
Tags are specified using the following format:
```
Key=,Values=
```
.
*)
resource_type : maintenance_window_resource_type option;
(*
The type of target that is being registered with the maintenance window.
*)
window_target_id : maintenance_window_target_id option;
(*
The ID of the target.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window to register the target with.
*)

}

The target registered with the maintenance window.

type nonrec maintenance_window_target_list = maintenance_window_target list

type nonrec maintenance_window_search_max_results = int

type nonrec maintenance_window_max_results = int

type nonrec maintenance_window_identity = {

next_execution_time : maintenance_window_string_date_time option;
(*
The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
*)
start_date : maintenance_window_string_date_time option;
(*
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
*)
end_date : maintenance_window_string_date_time option;
(*
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
*)
schedule_offset : maintenance_window_offset option;
(*
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
*)
schedule_timezone : maintenance_window_timezone option;
(*
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
*)
schedule : maintenance_window_schedule option;
(*
The schedule of the maintenance window in the form of a cron or rate expression.
*)
cutoff : maintenance_window_cutoff option;
(*
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
*)
duration : maintenance_window_duration_hours option;
(*
The duration of the maintenance window in hours.
*)
enabled : maintenance_window_enabled option;
(*
Indicates whether the maintenance window is enabled.
*)
description : maintenance_window_description option;
(*
A description of the maintenance window.
*)
name : maintenance_window_name option;
(*
The name of the maintenance window.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window.
*)

}

Information about the maintenance window.

type nonrec maintenance_window_identity_list = maintenance_window_identity list

type nonrec maintenance_window_filter_value = string

type nonrec maintenance_window_filter_values =
  maintenance_window_filter_value list

type nonrec maintenance_window_filter_key = string

type nonrec maintenance_window_filter = {

values : maintenance_window_filter_values option;
(*
The filter values.
*)
key : maintenance_window_filter_key option;
(*
The name of the filter.
*)

}

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

type nonrec maintenance_window_filter_list = maintenance_window_filter list

type nonrec maintenance_window_execution_task_invocation_parameters = string

type nonrec maintenance_window_execution_id = string

type nonrec maintenance_window_execution_task_id = string

type nonrec maintenance_window_execution_task_invocation_id = string

type nonrec maintenance_window_execution_task_execution_id = string

type nonrec maintenance_window_execution_status =

| SkippedOverlapping
| Cancelled
| Cancelling
| TimedOut
| Failed
| Success
| InProgress
| Pending

type nonrec maintenance_window_execution_status_details = string

type nonrec maintenance_window_execution_task_invocation_identity = {

window_target_id : maintenance_window_task_target_id option;
(*
The ID of the target definition in this maintenance window the invocation was performed for.
*)
owner_information : owner_information option;
(*
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.
*)
end_time : date_time option;
(*
The time the invocation finished.
*)
start_time : date_time option;
(*
The time the invocation started.
*)
status_details : maintenance_window_execution_status_details option;
(*
The details explaining the status of the task invocation. Not available for all status values.
*)
status : maintenance_window_execution_status option;
(*
The status of the task invocation.
*)
parameters : maintenance_window_execution_task_invocation_parameters option;
(*
The parameters that were provided for the invocation when it was run.
*)
task_type : maintenance_window_task_type option;
(*
The task type.
*)
execution_id : maintenance_window_execution_task_execution_id option;
(*
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.
*)
invocation_id : maintenance_window_execution_task_invocation_id option;
(*
The ID of the task invocation.
*)
task_execution_id : maintenance_window_execution_task_id option;
(*
The ID of the specific task execution in the maintenance window execution.
*)
window_execution_id : maintenance_window_execution_id option;
(*
The ID of the maintenance window execution that ran the task.
*)

}

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.

type nonrec maintenance_window_execution_task_invocation_identity_list =
  maintenance_window_execution_task_invocation_identity list

type nonrec maintenance_window_execution_task_identity = {

triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarm that was invoked by the maintenance window task.
*)
alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm applied to your maintenance window task.
*)
task_type : maintenance_window_task_type option;
(*
The type of task that ran.
*)
task_arn : maintenance_window_task_arn option;
(*
The Amazon Resource Name (ARN) of the task that ran.
*)
end_time : date_time option;
(*
The time the task execution finished.
*)
start_time : date_time option;
(*
The time the task execution started.
*)
status_details : maintenance_window_execution_status_details option;
(*
The details explaining the status of the task execution. Not available for all status values.
*)
status : maintenance_window_execution_status option;
(*
The status of the task execution.
*)
task_execution_id : maintenance_window_execution_task_id option;
(*
The ID of the specific task execution in the maintenance window execution.
*)
window_execution_id : maintenance_window_execution_id option;
(*
The ID of the maintenance window execution that ran the task.
*)

}

Information about a task execution performed as part of a maintenance window execution.

type nonrec maintenance_window_execution_task_identity_list =
  maintenance_window_execution_task_identity list

type nonrec maintenance_window_execution_task_id_list =
  maintenance_window_execution_task_id list

type nonrec maintenance_window_execution = {

end_time : date_time option;
(*
The time the execution finished.
*)
start_time : date_time option;
(*
The time the execution started.
*)
status_details : maintenance_window_execution_status_details option;
(*
The details explaining the status. Not available for all status values.
*)
status : maintenance_window_execution_status option;
(*
The status of the execution.
*)
window_execution_id : maintenance_window_execution_id option;
(*
The ID of the maintenance window execution.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window.
*)

}

Describes the information about an execution of a maintenance window.

type nonrec maintenance_window_execution_list =
  maintenance_window_execution list

type nonrec list_tags_for_resource_result = {

tag_list : tag_list option;
(*
A list of tags.
*)

}

type nonrec list_tags_for_resource_request = {

resource_id : resource_id;
(*
The resource ID for which you want to see a list of tags.
*)
resource_type : resource_type_for_tagging;
(*
Returns a list of tags for a specific resource type.
*)

}

type nonrec list_resource_data_sync_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
resource_data_sync_items : resource_data_sync_item_list option;
(*
A list of your current resource data sync configurations and their statuses.
*)

}

type nonrec list_resource_data_sync_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
sync_type : resource_data_sync_type option;
(*
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.
*)

}

type nonrec invalid_next_token = {

message : string_ option;

}

The specified token isn't valid.

type nonrec list_resource_compliance_summaries_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
resource_compliance_summary_items : resource_compliance_summary_item_list option;
(*
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.
*)

}

type nonrec compliance_string_filter_key = string

type nonrec compliance_filter_value = string

type nonrec compliance_string_filter_value_list = compliance_filter_value list

type nonrec compliance_query_operator_type =

| GreaterThan
| LessThan
| BeginWith
| NotEqual
| Equal

type nonrec compliance_string_filter = {

type_ : compliance_query_operator_type option;
(*
The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.
*)
values : compliance_string_filter_value_list option;
(*
The value for which to search.
*)
key : compliance_string_filter_key option;
(*
The name of the filter.
*)

}

One or more filters. Use a filter to return a more specific list of results.

type nonrec compliance_string_filter_list = compliance_string_filter list

type nonrec list_resource_compliance_summaries_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
filters : compliance_string_filter_list option;
(*
One or more filters. Use a filter to return a more specific list of results.
*)

}

type nonrec invalid_filter = {

message : string_ option;

}

The filter name isn't valid. Verify that you entered the correct name and try again.

type nonrec list_ops_metadata_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
ops_metadata_list : ops_metadata_list option;
(*
Returns a list of OpsMetadata objects.
*)

}

type nonrec list_ops_metadata_max_results = int

type nonrec list_ops_metadata_request = {

next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : list_ops_metadata_max_results option;
(*
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.
*)
filters : ops_metadata_filter_list option;
(*
One or more filters to limit the number of OpsMetadata objects returned by the call.
*)

}

type nonrec list_ops_item_related_items_response = {

summaries : ops_item_related_item_summaries option;
(*
A list of related-item resources for the specified OpsItem.
*)
next_token : string_ option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)

}

type nonrec list_ops_item_related_items_request = {

next_token : string_ option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : ops_item_related_items_max_results option;
(*
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.
*)
filters : ops_item_related_items_filters option;
(*
One or more OpsItem filters. Use a filter to return a more specific list of results.
*)
ops_item_id : ops_item_id option;
(*
The ID of the OpsItem for which you want to list all related-item resources.
*)

}

type nonrec list_ops_item_events_response = {

summaries : ops_item_event_summaries option;
(*
A list of event information for the specified OpsItems.
*)
next_token : string_ option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)

}

type nonrec list_ops_item_events_request = {

next_token : string_ option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : ops_item_event_max_results option;
(*
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.
*)
filters : ops_item_event_filters option;
(*
One or more OpsItem filters. Use a filter to return a more specific list of results.
*)

}

type nonrec list_nodes_summary_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
summary : node_summary_list option;
(*
A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system.
*)

}

type nonrec list_nodes_summary_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results.
*)
aggregators : node_aggregator_list;
(*
Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system.
*)
filters : node_filter_list option;
(*
One or more filters. Use a filter to generate a summary that matches your specified filter criteria.
*)
sync_name : resource_data_sync_name option;
(*
The name of the Amazon Web Services managed resource data sync to retrieve information about.
For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode.
For single account/single-Region configurations, the parameter is not required.
*)

}

type nonrec invalid_aggregator_exception = {

message : string_ option;

}

The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported.

type nonrec list_nodes_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
nodes : node_list option;
(*
A list of managed nodes that match the specified filter criteria.
*)

}

type nonrec list_nodes_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
filters : node_filter_list option;
(*
One or more filters. Use a filter to return a more specific list of managed nodes.
*)
sync_name : resource_data_sync_name option;
(*
The name of the Amazon Web Services managed resource data sync to retrieve information about.
For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is AWS-QuickSetup-ManagedNode.
For single account/single-Region configurations, the parameter is not required.
*)

}

type nonrec list_inventory_entries_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
entries : inventory_item_entry_list option;
(*
A list of inventory items on the managed nodes.
*)
capture_time : inventory_item_capture_time option;
(*
The time that inventory information was collected for the managed nodes.
*)
schema_version : inventory_item_schema_version option;
(*
The inventory schema version used by the managed nodes.
*)
instance_id : instance_id option;
(*
The managed node ID targeted by the request to query inventory information.
*)
type_name : inventory_item_type_name option;
(*
The type of inventory item returned by the request.
*)

}

type nonrec inventory_filter_key = string

type nonrec inventory_filter_value = string

type nonrec inventory_filter_value_list = inventory_filter_value list

type nonrec inventory_query_operator_type =

| EXISTS
| GREATER_THAN
| LESS_THAN
| BEGIN_WITH
| NOT_EQUAL
| EQUAL

type nonrec inventory_filter = {

type_ : inventory_query_operator_type option;
(*
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.
*)
values : inventory_filter_value_list;
(*
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.
*)
key : inventory_filter_key;
(*
The name of the filter key.
*)

}

One or more filters. Use a filter to return a more specific list of results.

type nonrec inventory_filter_list = inventory_filter list

type nonrec list_inventory_entries_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
filters : inventory_filter_list option;
(*
One or more filters. Use a filter to return a more specific list of results.
*)
type_name : inventory_item_type_name;
(*
The type of inventory item for which you want information.
*)
instance_id : instance_id;
(*
The managed node ID for which you want inventory information.
*)

}

type nonrec document_identifier = {

author : document_author option;
(*
The user in your organization who created the document.
*)
review_status : review_status option;
(*
The current status of a document review.
*)
requires : document_requires_list option;
(*
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
*)
tags : tag_list option;
(*
The tags, or metadata, that have been applied to the document.
*)
target_type : target_type option;
(*
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.
*)
document_format : document_format option;
(*
The document format, either JSON or YAML.
*)
schema_version : document_schema_version option;
(*
The schema version.
*)
document_type : document_type option;
(*
The document type.
*)
document_version : document_version option;
(*
The document version.
*)
platform_types : platform_type_list option;
(*
The operating system platform.
*)
version_name : document_version_name option;
(*
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
*)
owner : document_owner option;
(*
The Amazon Web Services user that created the document.
*)
display_name : document_display_name option;
(*
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.
*)
created_date : date_time option;
(*
The date the SSM document was created.
*)
name : document_ar_n option;
(*
The name of the SSM document.
*)

}

Describes the name of a SSM document.

type nonrec document_identifier_list = document_identifier list

type nonrec list_documents_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
document_identifiers : document_identifier_list option;
(*
The names of the SSM documents.
*)

}

type nonrec document_filter_key =

| DocumentType
| PlatformTypes
| Owner
| Name

type nonrec document_filter_value = string

type nonrec document_filter = {

value : document_filter_value;
(*
The value of the filter.
*)
key : document_filter_key;
(*
The name of the filter.
*)

}

This data type is deprecated. Instead, use DocumentKeyValuesFilter.

type nonrec document_filter_list = document_filter list

type nonrec document_key_values_filter_key = string

type nonrec document_key_values_filter_value = string

type nonrec document_key_values_filter_values =
  document_key_values_filter_value list

type nonrec document_key_values_filter = {

values : document_key_values_filter_values option;
(*
The value for the filter key.
*)
key : document_key_values_filter_key option;
(*
The name of the filter key.
*)

}

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

type nonrec document_key_values_filter_list = document_key_values_filter list

type nonrec list_documents_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
filters : document_key_values_filter_list option;
(*
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
*)
document_filter_list : document_filter_list option;
(*
This data type is deprecated. Instead, use Filters.
*)

}

type nonrec invalid_filter_key = unit

type nonrec document_version_info = {

review_status : review_status option;
(*
The current status of the approval review for the latest version of the document.
*)
status_information : document_status_information option;
(*
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."
*)
status : document_status option;
(*
The status of the SSM document, such as Creating, Active, Failed, and Deleting.
*)
document_format : document_format option;
(*
The document format, either JSON or YAML.
*)
is_default_version : boolean_ option;
(*
An identifier for the default version of the document.
*)
created_date : date_time option;
(*
The date the document was created.
*)
version_name : document_version_name option;
(*
The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
*)
document_version : document_version option;
(*
The document version.
*)
display_name : document_display_name option;
(*
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.
*)
name : document_name option;
(*
The document name.
*)

}

Version information about the document.

type nonrec document_version_list = document_version_info list

type nonrec list_document_versions_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
document_versions : document_version_list option;
(*
The document versions.
*)

}

type nonrec list_document_versions_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
name : document_ar_n;
(*
The name of the document. You can specify an Amazon Resource Name (ARN).
*)

}

type nonrec document_reviewer_response_source = {

reviewer : reviewer option;
(*
The user in your organization assigned to review a document request.
*)
comment : document_review_comment_list option;
(*
The comment entered by a reviewer as part of their document review response.
*)
review_status : review_status option;
(*
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.
*)
updated_time : date_time option;
(*
The date and time that a reviewer last updated a response to a document review request.
*)
create_time : date_time option;
(*
The date and time that a reviewer entered a response to a document review request.
*)

}

Information about a reviewer's response to a document review request.

type nonrec document_reviewer_response_list =
  document_reviewer_response_source list

type nonrec document_metadata_response_info = {

reviewer_response : document_reviewer_response_list option;
(*
Details about a reviewer's response to a document review request.
*)

}

Details about the response to a document review request.

type nonrec list_document_metadata_history_response = {

next_token : next_token option;
(*
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.
*)
metadata : document_metadata_response_info option;
(*
Information about the response to the change template approval request.
*)
author : document_author option;
(*
The user ID of the person in the organization who requested the review of the change template.
*)
document_version : document_version option;
(*
The version of the change template.
*)
name : document_name option;
(*
The name of the change template.
*)

}

type nonrec document_metadata_enum =

| DocumentReviews

type nonrec list_document_metadata_history_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
metadata : document_metadata_enum;
(*
The type of data for which details are being requested. Currently, the only supported value is DocumentReviews.
*)
document_version : document_version option;
(*
The version of the change template.
*)
name : document_name;
(*
The name of the change template.
*)

}

type nonrec compliance_summary_item = {

non_compliant_summary : non_compliant_summary option;
(*
A list of NON_COMPLIANT items for the specified compliance type.
*)
compliant_summary : compliant_summary option;
(*
A list of COMPLIANT items for the specified compliance type.
*)
compliance_type : compliance_type_name option;
(*
The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.
*)

}

A summary of compliance information by compliance type.

type nonrec compliance_summary_item_list = compliance_summary_item list

type nonrec list_compliance_summaries_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
compliance_summary_items : compliance_summary_item_list option;
(*
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.
*)

}

type nonrec list_compliance_summaries_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
filters : compliance_string_filter_list option;
(*
One or more compliance or inventory filters. Use a filter to return a more specific list of results.
*)

}

type nonrec compliance_item = {

details : compliance_item_details option;
(*
A "Key": "Value" tag combination for the compliance item.
*)
execution_summary : compliance_execution_summary option;
(*
A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.
*)
severity : compliance_severity option;
(*
The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
*)
status : compliance_status option;
(*
The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).
*)
title : compliance_item_title option;
(*
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.
*)
id : compliance_item_id option;
(*
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.
*)
resource_id : compliance_resource_id option;
(*
An ID for the resource. For a managed node, this is the node ID.
*)
resource_type : compliance_resource_type option;
(*
The type of resource. ManagedInstance is currently the only supported resource type.
*)
compliance_type : compliance_type_name option;
(*
The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.
*)

}

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.

type nonrec compliance_item_list = compliance_item list

type nonrec list_compliance_items_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
compliance_items : compliance_item_list option;
(*
A list of compliance information for the specified resource ID.
*)

}

type nonrec compliance_resource_id_list = compliance_resource_id list

type nonrec compliance_resource_type_list = compliance_resource_type list

type nonrec list_compliance_items_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
resource_types : compliance_resource_type_list option;
(*
The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.
*)
resource_ids : compliance_resource_id_list option;
(*
The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.
*)
filters : compliance_string_filter_list option;
(*
One or more compliance filters. Use a filter to return a more specific list of results.
*)

}

type nonrec command_list = command list

type nonrec list_commands_result = {

next_token : next_token option;
(*
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
*)
commands : command_list option;
(*
(Optional) The list of commands requested by the user.
*)

}

type nonrec command_max_results = int

type nonrec command_filter_key =

| DOCUMENT_NAME
| EXECUTION_STAGE
| STATUS
| INVOKED_BEFORE
| INVOKED_AFTER

type nonrec command_filter_value = string

type nonrec command_filter = {

value : command_filter_value;
(*
The filter value. Valid values for each filter key are as follows:
- InvokedAfter: Specify a timestamp to limit your results. For example, specify 2024-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 2024-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.
*)
key : command_filter_key;
(*
The name of the filter.
The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
*)

}

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.

type nonrec command_filter_list = command_filter list

type nonrec list_commands_request = {

filters : command_filter_list option;
(*
(Optional) One or more filters. Use a filter to return a more specific list of results.
*)
next_token : next_token option;
(*
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : command_max_results option;
(*
(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.
*)
instance_id : instance_id option;
(*
(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.
*)
command_id : command_id option;
(*
(Optional) If provided, lists only the specified command.
*)

}

type nonrec invalid_command_id = unit

type nonrec instance_tag_name = string

type nonrec command_invocation_status =

| CANCELLING
| FAILED
| TIMED_OUT
| CANCELLED
| SUCCESS
| DELAYED
| IN_PROGRESS
| PENDING

type nonrec invocation_trace_output = string

type nonrec command_plugin_name = string

type nonrec command_plugin_status =

| FAILED
| CANCELLED
| TIMED_OUT
| SUCCESS
| IN_PROGRESS
| PENDING

type nonrec command_plugin_output = string

type nonrec command_plugin = {

output_s3_key_prefix : s3_key_prefix option;
(*
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:
amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript
amzn-s3-demo-bucket is the name of the S3 bucket;
my-prefix is the name of the S3 prefix;
i-02573cafcfEXAMPLE is the managed node ID;
awsrunShellScript is the name of the plugin.
*)
output_s3_bucket_name : s3_bucket_name option;
(*
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:
amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript
amzn-s3-demo-bucket is the name of the S3 bucket;
my-prefix is the name of the S3 prefix;
i-02573cafcfEXAMPLE is the managed node ID;
awsrunShellScript is the name of the plugin.
*)
output_s3_region : s3_region option;
(*
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.
*)
standard_error_url : url option;
(*
The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.
*)
standard_output_url : url option;
(*
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.
*)
output : command_plugin_output option;
(*
Output of the plugin execution.
*)
response_finish_date_time : date_time option;
(*
The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.
*)
response_start_date_time : date_time option;
(*
The time the plugin started running.
*)
response_code : response_code option;
(*
A numeric response code generated after running the plugin.
*)
status_details : status_details option;
(*
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.
*)
status : command_plugin_status option;
(*
The status of this plugin. You can run a document with multiple plugins.
*)
name : command_plugin_name option;
(*
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.
*)

}

Describes plugin details.

type nonrec command_plugin_list = command_plugin list

type nonrec command_invocation = {

cloud_watch_output_config : cloud_watch_output_config option;
(*
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
*)
notification_config : notification_config option;
(*
Configurations for sending notifications about command status changes on a per managed node basis.
*)
service_role : service_role option;
(*
The Identity and Access Management (IAM) service role that Run Command, a tool in Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.
*)
command_plugins : command_plugin_list option;
(*
Plugins processed by the command.
*)
standard_error_url : url option;
(*
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.
*)
standard_output_url : url option;
(*
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.
*)
trace_output : invocation_trace_output option;
(*
Gets the trace output sent by the agent.
*)
status_details : status_details option;
(*
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.
*)
status : command_invocation_status option;
(*
Whether or not the invocation succeeded, failed, or is pending.
*)
requested_date_time : date_time option;
(*
The time and date the request was sent to this managed node.
*)
document_version : document_version option;
(*
The Systems Manager document (SSM document) version.
*)
document_name : document_name option;
(*
The document name that was requested for execution.
*)
comment : comment option;
(*
User-specified information about the command, such as a brief description of what the command should do.
*)
instance_name : instance_tag_name option;
(*
The fully qualified host name of the managed node.
*)
instance_id : instance_id option;
(*
The managed node ID in which this invocation was requested.
*)
command_id : command_id option;
(*
The command against which this invocation was requested.
*)

}

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.

type nonrec command_invocation_list = command_invocation list

type nonrec list_command_invocations_result = {

next_token : next_token option;
(*
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
*)
command_invocations : command_invocation_list option;
(*
(Optional) A list of all invocations.
*)

}

type nonrec list_command_invocations_request = {

details : boolean_ option;
(*
(Optional) If set this returns the response of the command executions and any command output. The default value is false.
*)
filters : command_filter_list option;
(*
(Optional) One or more filters. Use a filter to return a more specific list of results.
*)
next_token : next_token option;
(*
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : command_max_results option;
(*
(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.
*)
instance_id : instance_id option;
(*
(Optional) The command execution details for a specific managed node ID.
*)
command_id : command_id option;
(*
(Optional) The invocations for a specific command ID.
*)

}

type nonrec association = {

target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
duration : duration option;
(*
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
*)
schedule_offset : schedule_offset option;
(*
Number of days to wait after the scheduled day to run an association.
*)
association_name : association_name option;
(*
The association name.
*)
schedule_expression : schedule_expression option;
(*
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
*)
overview : association_overview option;
(*
Information about the association.
*)
last_execution_date : date_time option;
(*
The date on which the association was last run.
*)
targets : targets option;
(*
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 *.
*)
document_version : document_version option;
(*
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.
*)
association_version : association_version option;
(*
The association version.
*)
association_id : association_id option;
(*
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.
*)
instance_id : instance_id option;
(*
The managed node ID.
*)
name : document_ar_n option;
(*
The name of the SSM document.
*)

}

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

type nonrec association_list = association list

type nonrec list_associations_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
associations : association_list option;
(*
The associations.
*)

}

type nonrec association_filter_key =

| ResourceGroupName
| AssociationName
| LastExecutedAfter
| LastExecutedBefore
| Status
| AssociationId
| Name
| InstanceId

type nonrec association_filter_value = string

type nonrec association_filter = {

value : association_filter_value;
(*
The filter value.
*)
key : association_filter_key;
(*
The name of the filter.
InstanceId has been deprecated.
*)

}

Describes a filter.

type nonrec association_filter_list = association_filter list

type nonrec list_associations_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
association_filter_list : association_filter_list option;
(*
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.
*)

}

type nonrec association_version_info = {

target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
duration : duration option;
(*
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
*)
schedule_offset : schedule_offset option;
(*
Number of days to wait after the scheduled day to run an association.
*)
target_locations : target_locations option;
(*
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.
*)
calendar_names : calendar_name_or_arn_list option;
(*
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 in the Amazon Web Services Systems Manager User Guide.
*)
apply_only_at_cron_interval : apply_only_at_cron_interval option;
(*
By default, when you create 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.
*)
sync_compliance : association_sync_compliance option;
(*
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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
*)
compliance_severity : association_compliance_severity option;
(*
The severity level that is assigned to the association.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
association_name : association_name option;
(*
The name specified for the association version when the association version was created.
*)
output_location : instance_association_output_location option;
(*
The location in Amazon S3 specified for the association when the association version was created.
*)
schedule_expression : schedule_expression option;
(*
The cron or rate schedule specified for the association when the association version was created.
*)
targets : targets option;
(*
The targets specified for the association when the association version was created.
*)
parameters : parameters option;
(*
Parameters specified when the association version was created.
*)
document_version : document_version option;
(*
The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
*)
name : document_ar_n option;
(*
The name specified when the association was created.
*)
created_date : date_time option;
(*
The date the association version was created.
*)
association_version : association_version option;
(*
The association version.
*)
association_id : association_id option;
(*
The ID created by the system when the association was created.
*)

}

Information about the association version.

type nonrec association_version_list = association_version_info list

type nonrec list_association_versions_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
association_versions : association_version_list option;
(*
Information about all versions of the association for the specified association ID.
*)

}

type nonrec list_association_versions_request = {

next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : max_results option;
(*
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.
*)
association_id : association_id;
(*
The association ID for which you want to view all versions.
*)

}

type nonrec label_parameter_version_result = {

parameter_version : ps_parameter_version option;
(*
The version of the parameter that has been labeled.
*)
invalid_labels : parameter_label_list option;
(*
The label doesn't meet the requirements. For information about parameter label requirements, see Working with parameter labels in the Amazon Web Services Systems Manager User Guide.
*)

}

type nonrec label_parameter_version_request = {

labels : parameter_label_list;
(*
One or more labels to attach to the specified parameter version.
*)
parameter_version : ps_parameter_version option;
(*
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.
*)
name : ps_parameter_name;
(*
The parameter name on which you want to attach one or more labels.
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
*)

}

type nonrec key_name = string

type nonrec is_sub_type_schema = bool

type nonrec invocation_does_not_exist = unit

type nonrec inventory_type_display_name = string

type nonrec inventory_schema_delete_option =

| DELETE_SCHEMA
| DISABLE_SCHEMA

type nonrec inventory_result_item = {

content : inventory_item_entry_list;
(*
Contains all the inventory data of the item type. Results include attribute names and values.
*)
content_hash : inventory_item_content_hash option;
(*
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.
*)
capture_time : inventory_item_capture_time option;
(*
The time inventory item data was captured.
*)
schema_version : inventory_item_schema_version;
(*
The schema version for the inventory result item/
*)
type_name : inventory_item_type_name;
(*
The name of the inventory result item type.
*)

}

The inventory result item.

type nonrec inventory_result_item_key = string

type nonrec inventory_result_item_map =
  (inventory_result_item_key * inventory_result_item) list

type nonrec inventory_result_entity_id = string

type nonrec inventory_result_entity = {

data : inventory_result_item_map option;
(*
The data section in the inventory result entity JSON.
*)
id : inventory_result_entity_id option;
(*
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.
*)

}

Inventory query results.

type nonrec inventory_result_entity_list = inventory_result_entity list

type nonrec inventory_item_type_name_filter = string

type nonrec inventory_item_attribute_name = string

type nonrec inventory_attribute_data_type =

| NUMBER
| STRING

type nonrec inventory_item_attribute = {

data_type : inventory_attribute_data_type;
(*
The data type of the inventory item attribute.
*)
name : inventory_item_attribute_name;
(*
Name of the inventory item attribute.
*)

}

Attributes are the entries within the inventory item content. It contains name and value.

type nonrec inventory_item_attribute_list = inventory_item_attribute list

type nonrec inventory_item_schema = {

display_name : inventory_type_display_name option;
(*
The alias name of the inventory type. The alias name is used for display purposes.
*)
attributes : inventory_item_attribute_list;
(*
The schema attributes for inventory. This contains data type and attribute name.
*)
version : inventory_item_schema_version option;
(*
The schema version for the inventory item.
*)
type_name : inventory_item_type_name;
(*
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.
*)

}

The inventory item schema definition. Users can use this to compose inventory query filters.

type nonrec inventory_item_schema_result_list = inventory_item_schema list

type nonrec inventory_group_name = string

type nonrec inventory_group = {

filters : inventory_filter_list;
(*
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.
*)
name : inventory_group_name;
(*
The name of the group.
*)

}

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.

type nonrec inventory_group_list = inventory_group list

type nonrec inventory_deletion_start_time = Smaws_Lib.CoreTypes.Timestamp.t

type nonrec inventory_deletion_status =

| COMPLETE
| IN_PROGRESS

type nonrec inventory_deletion_last_status_message = string

type nonrec inventory_deletion_summary_item = {

remaining_count : remaining_count option;
(*
The remaining number of items to delete.
*)
count : resource_count option;
(*
A count of the number of deleted items.
*)
version : inventory_item_schema_version option;
(*
The inventory type version.
*)

}

Either a count, remaining count, or a version number in a delete inventory summary.

type nonrec inventory_deletion_summary_items =
  inventory_deletion_summary_item list

type nonrec inventory_deletion_summary = {

summary_items : inventory_deletion_summary_items option;
(*
A list of counts and versions for deleted items.
*)
remaining_count : remaining_count option;
(*
Remaining number of items to delete.
*)
total_count : total_count option;
(*
The total number of items to delete. This count doesn't change during the delete operation.
*)

}

Information about the delete operation.

type nonrec inventory_deletion_last_status_update_time =
  Smaws_Lib.CoreTypes.Timestamp.t

type nonrec inventory_deletion_status_item = {

last_status_update_time : inventory_deletion_last_status_update_time option;
(*
The UTC timestamp of when the last status report.
*)
deletion_summary : inventory_deletion_summary option;
(*
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.
*)
last_status_message : inventory_deletion_last_status_message option;
(*
Information about the status.
*)
last_status : inventory_deletion_status option;
(*
The status of the operation. Possible values are InProgress and Complete.
*)
deletion_start_time : inventory_deletion_start_time option;
(*
The UTC timestamp when the delete operation started.
*)
type_name : inventory_item_type_name option;
(*
The name of the inventory data type.
*)
deletion_id : uui_d option;
(*
The deletion ID returned by the DeleteInventory operation.
*)

}

Status information returned by the DeleteInventory operation.

type nonrec inventory_deletions_list = inventory_deletion_status_item list

type nonrec inventory_aggregator_expression = string

type inventory_aggregator = {

groups : inventory_group_list option;
(*
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.
*)
aggregators : inventory_aggregator_list option;
(*
Nested aggregators to further refine aggregation for an inventory type.
*)
expression : inventory_aggregator_expression option;
(*
The inventory type and attribute name for aggregation.
*)

}

Specifies the inventory type and attribute for the aggregation execution.

and inventory_aggregator_list = inventory_aggregator list

type nonrec invalid_tag = {

message : string_ option;

}

The specified tag key or value isn't valid.

type nonrec invalid_result_attribute_exception = {

message : string_ option;

}

The specified inventory item result attribute isn't valid.

type nonrec invalid_plugin_name = unit

type nonrec invalid_option_exception = {

message : string_ option;

}

The delete inventory option specified isn't valid. Verify the option and try again.

type nonrec invalid_inventory_request_exception = {

message : string_ option;

}

The request isn't valid.

type nonrec invalid_inventory_group_exception = {

message : string_ option;

}

The specified inventory group isn't valid.

type nonrec invalid_instance_property_filter_value = {

message : string_ option;

}

The specified filter value isn't valid.

type nonrec invalid_instance_information_filter_value = {

message : string_ option;

}

The specified filter value isn't valid.

type nonrec invalid_filter_value = {

message : string_ option;

}

The filter value isn't valid. Verify the value and try again.

type nonrec invalid_filter_option = {

message : string_ option;
(*
The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
*)

}

The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

type nonrec invalid_document_type = {

message : string_ option;

}

The SSM document type isn't valid. Valid document types are described in the DocumentType property.

type nonrec invalid_deletion_id_exception = {

message : string_ option;

}

The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.

type nonrec invalid_delete_inventory_parameters_exception = {

message : string_ option;

}

One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.

type nonrec invalid_activation_id = {

message : string_ option;

}

The activation ID isn't valid. Verify that you entered the correct ActivationId or ActivationCode and try again.

type nonrec invalid_activation = {

message : string_ option;

}

The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.

type nonrec instances_count = int

type nonrec instance_type = string

type nonrec instance_state = string

type nonrec instance_role = string

type nonrec instance_property_string_filter_key = string

type nonrec instance_property_filter_value = string

type nonrec instance_property_filter_value_set =
  instance_property_filter_value list

type nonrec instance_property_filter_operator =

| GREATER_THAN
| LESS_THAN
| BEGIN_WITH
| NOT_EQUAL
| EQUAL

type nonrec instance_property_string_filter = {

operator : instance_property_filter_operator option;
(*
The operator used by the filter call.
*)
values : instance_property_filter_value_set;
(*
The filter key name to describe your managed nodes.
*)
key : instance_property_string_filter_key;
(*
The filter key name to describe your managed nodes.
*)

}

The filters to describe or get information about your managed nodes.

type nonrec instance_property_string_filter_list =
  instance_property_string_filter list

type nonrec instance_property_filter_key =

| ASSOCIATION_STATUS
| RESOURCE_TYPE
| IAM_ROLE
| ACTIVATION_IDS
| DOCUMENT_NAME
| PLATFORM_TYPES
| PING_STATUS
| AGENT_VERSION
| INSTANCE_IDS

type nonrec instance_property_filter = {

value_set : instance_property_filter_value_set;
(*
The filter values.
*)
key : instance_property_filter_key;
(*
The name of the filter.
*)

}

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.

type nonrec instance_property_filter_list = instance_property_filter list

type nonrec instance_name = string

type nonrec architecture = string

type nonrec activation_id = string

type nonrec instance_association_status_aggregated_count =
  (status_name * instance_count) list

type nonrec instance_aggregated_association_overview = {

instance_association_status_aggregated_count : instance_association_status_aggregated_count option;
(*
The number of associations for the managed nodes.
*)
detailed_status : status_name option;
(*
Detailed status information about the aggregated associations.
*)

}

Status information about the aggregated associations.

type nonrec instance_property = {

source_type : source_type option;
(*
The type of the source resource.
*)
source_id : source_id option;
(*
The ID of the source resource.
*)
association_overview : instance_aggregated_association_overview option;
last_successful_association_execution_date : date_time option;
(*
The last date the association was successfully run.
*)
last_association_execution_date : date_time option;
(*
The date the association was last run.
*)
association_status : status_name option;
(*
The status of the State Manager association applied to the managed node.
*)
computer_name : computer_name option;
(*
The fully qualified host name of the managed node.
*)
resource_type : string_ option;
(*
The type of managed node.
*)
registration_date : date_time option;
(*
The date the node was registered with Systems Manager.
*)
iam_role : iam_role option;
(*
The IAM role used in the hybrid activation to register the node with Systems Manager.
*)
activation_id : activation_id option;
(*
The activation ID created by Systems Manager when the server or virtual machine (VM) was registered
*)
platform_version : platform_version option;
(*
The version of the OS platform running on your managed node.
*)
platform_name : platform_name option;
(*
The name of the operating system platform running on your managed node.
*)
platform_type : platform_type option;
(*
The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2.
*)
agent_version : version option;
(*
The version of SSM Agent running on your managed node.
*)
last_ping_date_time : date_time option;
(*
The date and time when the SSM Agent last pinged the Systems Manager service.
*)
ping_status : ping_status option;
(*
Connection status of the SSM Agent on the managed node.
*)
launch_time : date_time option;
(*
The timestamp for when the node was launched.
*)
ip_address : ip_address option;
(*
The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.
*)
architecture : architecture option;
(*
The CPU architecture of the node. For example, x86_64.
*)
instance_state : instance_state option;
(*
The current state of the node.
*)
key_name : key_name option;
(*
The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.
*)
instance_role : instance_role option;
(*
The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.
*)
instance_type : instance_type option;
(*
The instance type of the managed node. For example, t3.large.
*)
instance_id : instance_id option;
(*
The ID of the managed node.
*)
name : instance_name option;
(*
The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.
*)

}

An object containing various properties of a managed node.

type nonrec instance_properties = instance_property list

type nonrec install_override_list = string

type nonrec instance_patch_state = {

other_non_compliant_count : patch_other_non_compliant_count option;
(*
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.
*)
security_non_compliant_count : patch_security_non_compliant_count option;
(*
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.
*)
critical_non_compliant_count : patch_critical_non_compliant_count option;
(*
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.
*)
reboot_option : reboot_option option;
(*
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.
*)
last_no_reboot_install_operation_time : date_time option;
(*
The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.
*)
operation : patch_operation_type;
(*
The type of patching operation that was performed: or
- SCAN assesses the patch compliance state.
- INSTALL installs missing patches.
*)
operation_end_time : date_time;
(*
The time the most recent patching operation completed on the managed node.
*)
operation_start_time : date_time;
(*
The time the most recent patching operation was started on the managed node.
*)
available_security_update_count : patch_available_security_update_count option;
(*
The number of security-related patches that are available but not approved because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the specified auto-approval period was over.
Applies to Windows Server managed nodes only.
*)
not_applicable_count : patch_not_applicable_count option;
(*
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.
*)
unreported_not_applicable_count : patch_unreported_not_applicable_count option;
(*
The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.
*)
failed_count : patch_failed_count option;
(*
The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
*)
missing_count : patch_missing_count option;
(*
The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.
*)
installed_rejected_count : patch_installed_rejected_count option;
(*
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).
*)
installed_pending_reboot_count : patch_installed_pending_reboot_count option;
(*
The number of patches installed by Patch Manager since the last time the managed node was rebooted.
*)
installed_other_count : patch_installed_other_count option;
(*
The number of patches not specified in the patch baseline that are installed on the managed node.
*)
installed_count : patch_installed_count option;
(*
The number of patches from the patch baseline that are installed on the managed node.
*)
owner_information : owner_information option;
(*
Placeholder information. This field will always be empty in the current release of the service.
*)
install_override_list : install_override_list option;
(*
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 SSM Command document for patching: AWS-RunPatchBaseline in the Amazon Web Services Systems Manager User Guide.
*)
snapshot_id : snapshot_id option;
(*
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
*)
baseline_id : baseline_id;
(*
The ID of the patch baseline used to patch the managed node.
*)
patch_group : patch_group;
(*
The name of the patch group the managed node belongs to.
*)
instance_id : instance_id;
(*
The ID of the managed node the high-level patch compliance information was collected for.
*)

}

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.

type nonrec instance_patch_states_list = instance_patch_state list

type nonrec instance_patch_state_operator_type =

| GREATER_THAN
| LESS_THAN
| NOT_EQUAL
| EQUAL

type nonrec instance_patch_state_list = instance_patch_state list

type nonrec instance_patch_state_filter_value = string

type nonrec instance_patch_state_filter_values =
  instance_patch_state_filter_value list

type nonrec instance_patch_state_filter_key = string

type nonrec instance_patch_state_filter = {

type_ : instance_patch_state_operator_type;
(*
The type of comparison that should be performed for the value.
*)
values : instance_patch_state_filter_values;
(*
The value for the filter. Must be an integer greater than or equal to 0.
*)
key : instance_patch_state_filter_key;
(*
The key for the filter. Supported values include the following:
- InstalledCount
- InstalledOtherCount
- InstalledPendingRebootCount
- InstalledRejectedCount
- MissingCount
- FailedCount
- UnreportedNotApplicableCount
- NotApplicableCount
*)

}

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

type nonrec instance_patch_state_filter_list = instance_patch_state_filter list

type nonrec instance_information_string_filter_key = string

type nonrec instance_information_filter_value = string

type nonrec instance_information_filter_value_set =
  instance_information_filter_value list

type nonrec instance_information_string_filter = {

values : instance_information_filter_value_set;
(*
The filter values.
*)
key : instance_information_string_filter_key;
(*
The filter key name to describe your managed nodes.
Valid filter key values: ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds | PingStatus | PlatformType | 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.
*)

}

The filters to describe or get information about your managed nodes.

type nonrec instance_information_string_filter_list =
  instance_information_string_filter list

type nonrec instance_information = {

source_type : source_type option;
(*
The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.
*)
source_id : source_id option;
(*
The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.
*)
association_overview : instance_aggregated_association_overview option;
(*
Information about the association.
*)
last_successful_association_execution_date : date_time option;
(*
The last date the association was successfully run.
*)
last_association_execution_date : date_time option;
(*
The date the association was last run.
*)
association_status : status_name option;
(*
The status of the association.
*)
computer_name : computer_name option;
(*
The fully qualified host name of the managed node.
*)
ip_address : ip_address option;
(*
The IP address of the managed node.
*)
name : string_ option;
(*
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 How to install SSM Agent on hybrid Linux nodes and How to install SSM Agent on hybrid Windows Server nodes. 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.
*)
resource_type : resource_type option;
(*
The type of instance. Instances are either EC2 instances or managed instances.
*)
registration_date : date_time option;
(*
The date the server or VM was registered with Amazon Web Services as a managed node.
*)
iam_role : iam_role option;
(*
The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.
This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged 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.
*)
activation_id : activation_id option;
(*
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
*)
platform_version : string_ option;
(*
The version of the OS platform running on your managed node.
*)
platform_name : string_ option;
(*
The name of the operating system platform running on your managed node.
*)
platform_type : platform_type option;
(*
The operating system platform type.
*)
is_latest_version : boolean_ option;
(*
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.
*)
agent_version : version option;
(*
The version of SSM Agent running on your Linux managed node.
*)
last_ping_date_time : date_time option;
(*
The date and time when the agent last pinged the Systems Manager service.
*)
ping_status : ping_status option;
(*
Connection status of SSM Agent.
The status Inactive has been deprecated and is no longer in use.
*)
instance_id : instance_id option;
(*
The managed node ID.
*)

}

Describes a filter for a specific list of managed nodes.

type nonrec instance_information_list = instance_information list

type nonrec instance_information_filter_key =

| ASSOCIATION_STATUS
| RESOURCE_TYPE
| IAM_ROLE
| ACTIVATION_IDS
| PLATFORM_TYPES
| PING_STATUS
| AGENT_VERSION
| INSTANCE_IDS

type nonrec instance_information_filter = {

value_set : instance_information_filter_value_set;
(*
The filter values.
*)
key : instance_information_filter_key;
(*
The name of the filter.
*)

}

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.

type nonrec instance_information_filter_list = instance_information_filter list

type nonrec instance_association_execution_summary = string

type nonrec agent_error_code = string

type nonrec instance_association_output_url = {

s3_output_url : s3_output_url option;
(*
The URL of S3 bucket where you want to store the results of this request.
*)

}

The URL of S3 bucket where you want to store the results of this request.

type nonrec instance_association_status_info = {

association_name : association_name option;
(*
The name of the association applied to the managed node.
*)
output_url : instance_association_output_url option;
(*
A URL for an S3 bucket where you want to store the results of this request.
*)
error_code : agent_error_code option;
(*
An error code returned by the request to create the association.
*)
execution_summary : instance_association_execution_summary option;
(*
Summary information about association execution.
*)
detailed_status : status_name option;
(*
Detailed status information about the association.
*)
status : status_name option;
(*
Status information about the association.
*)
execution_date : date_time option;
(*
The date the association ran.
*)
instance_id : instance_id option;
(*
The managed node ID where the association was created.
*)
association_version : association_version option;
(*
The version of the association applied to the managed node.
*)
document_version : document_version option;
(*
The association document versions.
*)
name : document_ar_n option;
(*
The name of the association.
*)
association_id : association_id option;
(*
The association ID.
*)

}

Status information about the association.

type nonrec instance_association_status_infos =
  instance_association_status_info list

type nonrec instance_association = {

association_version : association_version option;
(*
Version information for the association on the managed node.
*)
content : document_content option;
(*
The content of the association document for the managed nodes.
*)
instance_id : instance_id option;
(*
The managed node ID.
*)
association_id : association_id option;
(*
The association ID.
*)

}

One or more association documents on the managed node.

type nonrec instance_association_list = instance_association list

type nonrec iso8601_string = string

type nonrec get_service_setting_result = {

service_setting : service_setting option;
(*
The query result of the current service setting.
*)

}

The query result body of the GetServiceSetting API operation.

type nonrec get_service_setting_request = {

setting_id : service_setting_id;
(*
The ID of the service setting to get. The setting ID can be one of the following.
- /ssm/appmanager/appmanager-enabled
- /ssm/automation/customer-script-log-destination
- /ssm/automation/customer-script-log-group-name
- /ssm/automation/enable-adaptive-concurrency
- /ssm/documents/console/public-sharing-permission
- /ssm/managed-instance/activation-tier
- /ssm/managed-instance/default-ec2-instance-management-role
- /ssm/opsinsights/opscenter
- /ssm/parameter-store/default-parameter-tier
- /ssm/parameter-store/high-throughput-enabled
*)

}

The request body of the GetServiceSetting API operation.

type nonrec get_resource_policies_response_entry = {

policy : policy option;
(*
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).
*)
policy_hash : policy_hash option;
(*
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_id : policy_id option;
(*
A policy ID.
*)

}

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

type nonrec get_resource_policies_response_entries =
  get_resource_policies_response_entry list

type nonrec get_resource_policies_response = {

policies : get_resource_policies_response_entries option;
(*
An array of the Policy object.
*)
next_token : string_ option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)

}

type nonrec get_resource_policies_request = {

max_results : resource_policy_max_results option;
(*
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.
*)
next_token : string_ option;
(*
A token to start the list. Use this token to get the next set of results.
*)
resource_arn : resource_arn_string;
(*
Amazon Resource Name (ARN) of the resource to which the policies are attached.
*)

}

type nonrec get_patch_baseline_result = {

available_security_updates_compliance_status : patch_compliance_status option;
(*
Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. This preference is specified when the CreatePatchBaseline or UpdatePatchBaseline commands are run.
Applies to Windows Server managed nodes only.
*)
sources : patch_source_list option;
(*
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
*)
description : baseline_description option;
(*
A description of the patch baseline.
*)
modified_date : date_time option;
(*
The date the patch baseline was last modified.
*)
created_date : date_time option;
(*
The date the patch baseline was created.
*)
patch_groups : patch_group_list option;
(*
Patch groups included in the patch baseline.
*)
rejected_patches_action : patch_action option;
(*
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.
*)
rejected_patches : patch_id_list option;
(*
A list of explicitly rejected patches for the baseline.
*)
approved_patches_enable_non_security : boolean_ option;
(*
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.
*)
approved_patches_compliance_level : patch_compliance_level option;
(*
Returns the specified compliance severity level for approved patches in the patch baseline.
*)
approved_patches : patch_id_list option;
(*
A list of explicitly approved patches for the baseline.
*)
approval_rules : patch_rule_group option;
(*
A set of rules used to include patches in the baseline.
*)
global_filters : patch_filter_group option;
(*
A set of global filters used to exclude patches from the baseline.
*)
operating_system : operating_system option;
(*
Returns the operating system specified for the patch baseline.
*)
name : baseline_name option;
(*
The name of the patch baseline.
*)
baseline_id : baseline_id option;
(*
The ID of the retrieved patch baseline.
*)

}

type nonrec get_patch_baseline_request = {

baseline_id : baseline_id;
(*
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.
*)

}

type nonrec get_patch_baseline_for_patch_group_result = {

operating_system : operating_system option;
(*
The operating system rule specified for patch groups using the patch baseline.
*)
patch_group : patch_group option;
(*
The name of the patch group.
*)
baseline_id : baseline_id option;
(*
The ID of the patch baseline that should be used for the patch group.
*)

}

type nonrec get_patch_baseline_for_patch_group_request = {

operating_system : operating_system option;
(*
Returns the operating system rule specified for patch groups using the patch baseline.
*)
patch_group : patch_group;
(*
The name of the patch group whose patch baseline should be retrieved.
*)

}

type nonrec get_parameters_result = {

invalid_parameters : parameter_name_list option;
(*
A list of parameters that aren't formatted correctly or don't run during an execution.
*)
parameters : parameter_list option;
(*
A list of details for a parameter.
*)

}

type nonrec get_parameters_request = {

with_decryption : boolean_ option;
(*
Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
*)
names : parameter_name_list;
(*
The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.
To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".
The results for GetParameters requests are listed in alphabetical order in query responses.
For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*)

}

type nonrec get_parameters_by_path_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
parameters : parameter_list option;
(*
A list of parameters found in the specified hierarchy.
*)

}

type nonrec get_parameters_by_path_max_results = int

type nonrec get_parameters_by_path_request = {

next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : get_parameters_by_path_max_results option;
(*
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.
*)
with_decryption : boolean_ option;
(*
Retrieve all parameters in a hierarchy with their value decrypted.
*)
parameter_filters : parameter_string_filter_list option;
(*
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.
*)
recursive : boolean_ option;
(*
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.
*)
path : ps_parameter_name;
(*
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
*)

}

type nonrec get_parameter_result = {

parameter : parameter option;
(*
Information about a parameter.
*)

}

type nonrec get_parameter_request = {

with_decryption : boolean_ option;
(*
Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
*)
name : ps_parameter_name;
(*
The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.
To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".
For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*)

}

type nonrec get_parameter_history_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
parameters : parameter_history_list option;
(*
A list of parameters returned by the request.
*)

}

type nonrec get_parameter_history_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
with_decryption : boolean_ option;
(*
Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.
*)
name : ps_parameter_name;
(*
The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.
*)

}

type nonrec get_ops_summary_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
entities : ops_entity_list option;
(*
The list of aggregated details and filtered OpsData.
*)

}

type nonrec get_ops_summary_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
result_attributes : ops_result_attribute_list option;
(*
The OpsData data type to return.
*)
aggregators : ops_aggregator_list option;
(*
Optional aggregators that return counts of OpsData based on one or more expressions.
*)
filters : ops_filter_list option;
(*
Optional filters used to scope down the returned OpsData.
*)
sync_name : resource_data_sync_name option;
(*
Specify the name of a resource data sync to get.
*)

}

type nonrec get_ops_metadata_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
metadata : metadata_map option;
(*
OpsMetadata for an Application Manager application.
*)
resource_id : ops_metadata_resource_id option;
(*
The resource ID of the Application Manager application.
*)

}

type nonrec get_ops_metadata_max_results = int

type nonrec get_ops_metadata_request = {

next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : get_ops_metadata_max_results option;
(*
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.
*)
ops_metadata_arn : ops_metadata_arn;
(*
The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
*)

}

type nonrec get_ops_item_response = {

ops_item : ops_item option;
(*
The OpsItem.
*)

}

type nonrec get_ops_item_request = {

ops_item_arn : ops_item_arn option;
(*
The OpsItem Amazon Resource Name (ARN).
*)
ops_item_id : ops_item_id;
(*
The ID of the OpsItem that you want to get.
*)

}

type nonrec get_maintenance_window_task_result = {

alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm you applied to your maintenance window task.
*)
cutoff_behavior : maintenance_window_task_cutoff_behavior option;
(*
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.
*)
description : maintenance_window_description option;
(*
The retrieved task description.
*)
name : maintenance_window_name option;
(*
The retrieved task name.
*)
logging_info : logging_info option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
priority : maintenance_window_task_priority option;
(*
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.
*)
task_invocation_parameters : maintenance_window_task_invocation_parameters option;
(*
The parameters to pass to the task when it runs.
*)
task_parameters : maintenance_window_task_parameters option;
(*
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.
*)
task_type : maintenance_window_task_type option;
(*
The type of task to run.
*)
service_role_arn : service_role option;
(*
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.
*)
task_arn : maintenance_window_task_arn option;
(*
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.
*)
targets : targets option;
(*
The targets where the task should run.
*)
window_task_id : maintenance_window_task_id option;
(*
The retrieved maintenance window task ID.
*)
window_id : maintenance_window_id option;
(*
The retrieved maintenance window ID.
*)

}

type nonrec get_maintenance_window_task_request = {

window_task_id : maintenance_window_task_id;
(*
The maintenance window task ID to retrieve.
*)
window_id : maintenance_window_id;
(*
The maintenance window ID that includes the task to retrieve.
*)

}

type nonrec get_maintenance_window_result = {

modified_date : date_time option;
(*
The date the maintenance window was last modified.
*)
created_date : date_time option;
(*
The date the maintenance window was created.
*)
enabled : maintenance_window_enabled option;
(*
Indicates whether the maintenance window is enabled.
*)
allow_unassociated_targets : maintenance_window_allow_unassociated_targets option;
(*
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
*)
cutoff : maintenance_window_cutoff option;
(*
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
*)
duration : maintenance_window_duration_hours option;
(*
The duration of the maintenance window in hours.
*)
next_execution_time : maintenance_window_string_date_time option;
(*
The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
*)
schedule_offset : maintenance_window_offset option;
(*
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
*)
schedule_timezone : maintenance_window_timezone option;
(*
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.
*)
schedule : maintenance_window_schedule option;
(*
The schedule of the maintenance window in the form of a cron or rate expression.
*)
end_date : maintenance_window_string_date_time option;
(*
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.
*)
start_date : maintenance_window_string_date_time option;
(*
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.
*)
description : maintenance_window_description option;
(*
The description of the maintenance window.
*)
name : maintenance_window_name option;
(*
The name of the maintenance window.
*)
window_id : maintenance_window_id option;
(*
The ID of the created maintenance window.
*)

}

type nonrec get_maintenance_window_request = {

window_id : maintenance_window_id;
(*
The ID of the maintenance window for which you want to retrieve information.
*)

}

type nonrec get_maintenance_window_execution_task_result = {

triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarms that were invoked by the maintenance window task.
*)
alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm you applied to your maintenance window task.
*)
end_time : date_time option;
(*
The time the task execution completed.
*)
start_time : date_time option;
(*
The time the task execution started.
*)
status_details : maintenance_window_execution_status_details option;
(*
The details explaining the status. Not available for all status values.
*)
status : maintenance_window_execution_status option;
(*
The status of the task.
*)
max_errors : max_errors option;
(*
The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
*)
max_concurrency : max_concurrency option;
(*
The defined maximum number of task executions that could be run in parallel.
*)
priority : maintenance_window_task_priority option;
(*
The priority of the task.
*)
task_parameters : maintenance_window_task_parameters_list option;
(*
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
*)
type_ : maintenance_window_task_type option;
(*
The type of task that was run.
*)
service_role : service_role option;
(*
The role that was assumed when running the task.
*)
task_arn : maintenance_window_task_arn option;
(*
The Amazon Resource Name (ARN) of the task that ran.
*)
task_execution_id : maintenance_window_execution_task_id option;
(*
The ID of the specific task execution in the maintenance window task that was retrieved.
*)
window_execution_id : maintenance_window_execution_id option;
(*
The ID of the maintenance window execution that includes the task.
*)

}

type nonrec get_maintenance_window_execution_task_request = {

task_id : maintenance_window_execution_task_id;
(*
The ID of the specific task execution in the maintenance window task that should be retrieved.
*)
window_execution_id : maintenance_window_execution_id;
(*
The ID of the maintenance window execution that includes the task.
*)

}

type nonrec get_maintenance_window_execution_task_invocation_result = {

window_target_id : maintenance_window_task_target_id option;
(*
The maintenance window target ID.
*)
owner_information : owner_information option;
(*
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.
*)
end_time : date_time option;
(*
The time that the task finished running on the target.
*)
start_time : date_time option;
(*
The time that the task started running on the target.
*)
status_details : maintenance_window_execution_status_details option;
(*
The details explaining the status. Details are only available for certain status values.
*)
status : maintenance_window_execution_status option;
(*
The task status for an invocation.
*)
parameters : maintenance_window_execution_task_invocation_parameters option;
(*
The parameters used at the time that the task ran.
*)
task_type : maintenance_window_task_type option;
(*
Retrieves the task type for a maintenance window.
*)
execution_id : maintenance_window_execution_task_execution_id option;
(*
The execution ID.
*)
invocation_id : maintenance_window_execution_task_invocation_id option;
(*
The invocation ID.
*)
task_execution_id : maintenance_window_execution_task_id option;
(*
The task execution ID.
*)
window_execution_id : maintenance_window_execution_id option;
(*
The maintenance window execution ID.
*)

}

type nonrec get_maintenance_window_execution_task_invocation_request = {

invocation_id : maintenance_window_execution_task_invocation_id;
(*
The invocation ID to retrieve.
*)
task_id : maintenance_window_execution_task_id;
(*
The ID of the specific task in the maintenance window task that should be retrieved.
*)
window_execution_id : maintenance_window_execution_id;
(*
The ID of the maintenance window execution for which the task is a part.
*)

}

type nonrec get_maintenance_window_execution_result = {

end_time : date_time option;
(*
The time the maintenance window finished running.
*)
start_time : date_time option;
(*
The time the maintenance window started running.
*)
status_details : maintenance_window_execution_status_details option;
(*
The details explaining the status. Not available for all status values.
*)
status : maintenance_window_execution_status option;
(*
The status of the maintenance window execution.
*)
task_ids : maintenance_window_execution_task_id_list option;
(*
The ID of the task executions from the maintenance window execution.
*)
window_execution_id : maintenance_window_execution_id option;
(*
The ID of the maintenance window execution.
*)

}

type nonrec get_maintenance_window_execution_request = {

window_execution_id : maintenance_window_execution_id;
(*
The ID of the maintenance window execution that includes the task.
*)

}

type nonrec get_inventory_schema_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
schemas : inventory_item_schema_result_list option;
(*
Inventory schemas returned by the request.
*)

}

type nonrec get_inventory_schema_max_results = int

type nonrec aggregator_schema_only = bool

type nonrec get_inventory_schema_request = {

sub_type : is_sub_type_schema option;
(*
Returns the sub-type schema for a specified inventory type.
*)
aggregator : aggregator_schema_only option;
(*
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.
*)
max_results : get_inventory_schema_max_results option;
(*
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.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
type_name : inventory_item_type_name_filter option;
(*
The type of inventory item to return.
*)

}

type nonrec get_inventory_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
entities : inventory_result_entity_list option;
(*
Collection of inventory entities such as a collection of managed node inventory.
*)

}

type nonrec get_inventory_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
result_attributes : result_attribute_list option;
(*
The list of inventory item types to return.
*)
aggregators : inventory_aggregator_list option;
(*
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.
*)
filters : inventory_filter_list option;
(*
One or more filters. Use a filter to return a more specific list of results.
*)

}

type nonrec execution_preview_status =

| FAILED
| SUCCESS
| IN_PROGRESS
| PENDING

type nonrec automation_execution_preview = {

total_accounts : integer option;
(*
Information about the Amazon Web Services accounts that were included in the execution preview.
*)
target_previews : target_preview_list option;
(*
Information that provides a preview of what the impact of running the specified Automation runbook would be.
*)
regions : region_list option;
(*
Information about the Amazon Web Services Regions targeted by the execution preview.
*)
step_previews : step_preview_map option;
(*
Information about the type of impact a runbook step would have on a resource.
- Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.
- Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.
- Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.
*)

}

Information about the results of the execution preview.

type nonrec execution_preview =

| Automation of automation_execution_preview
(*
Information about the changes that would be made if an Automation workflow were run.
*)

Information about the changes that would be made if an execution were run.

type nonrec get_execution_preview_response = {

execution_preview : execution_preview option;
status_message : string_ option;
(*
Supplemental information about the current status of the execution preview.
*)
status : execution_preview_status option;
(*
The current status of the execution preview operation.
*)
ended_at : date_time option;
(*
A UTC timestamp indicating when the execution preview operation ended.
*)
execution_preview_id : execution_preview_id option;
(*
The generated ID for the existing execution preview.
*)

}

type nonrec get_execution_preview_request = {

execution_preview_id : execution_preview_id;
(*
The ID of the existing execution preview.
*)

}

type nonrec content_length = int

type nonrec attachment_hash = string

type nonrec attachment_hash_type =

| SHA256

type nonrec attachment_url = string

type nonrec attachment_content = {

url : attachment_url option;
(*
The URL location of the attachment content.
*)
hash_type : attachment_hash_type option;
(*
The hash algorithm used to calculate the hash value.
*)
hash : attachment_hash option;
(*
The cryptographic hash value of the document content.
*)
size : content_length option;
(*
The size of an attachment in bytes.
*)
name : attachment_name option;
(*
The name of an attachment.
*)

}

A structure that includes attributes that describe a document attachment.

type nonrec attachment_content_list = attachment_content list

type nonrec get_document_result = {

review_status : review_status option;
(*
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.
*)
attachments_content : attachment_content_list option;
(*
A description of the document attachments, including names, locations, sizes, and so on.
*)
requires : document_requires_list option;
(*
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
*)
document_format : document_format option;
(*
The document format, either JSON or YAML.
*)
document_type : document_type option;
(*
The document type.
*)
content : document_content option;
(*
The contents of the SSM document.
*)
status_information : document_status_information option;
(*
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."
*)
status : document_status option;
(*
The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.
*)
document_version : document_version option;
(*
The document version.
*)
version_name : document_version_name option;
(*
The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
*)
display_name : document_display_name option;
(*
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.
*)
created_date : date_time option;
(*
The date the SSM document was created.
*)
name : document_ar_n option;
(*
The name of the SSM document.
*)

}

type nonrec get_document_request = {

document_format : document_format option;
(*
Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.
*)
document_version : document_version option;
(*
The document version for which you want information.
*)
version_name : document_version_name option;
(*
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can't be changed.
*)
name : document_ar_n;
(*
The name of the SSM document.
*)

}

type nonrec get_deployable_patch_snapshot_for_instance_result = {

product : product option;
(*
Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot.
*)
snapshot_download_url : snapshot_download_url option;
(*
A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.
*)
snapshot_id : snapshot_id option;
(*
The user-defined snapshot ID.
*)
instance_id : instance_id option;
(*
The managed node ID.
*)

}

type nonrec baseline_override = {

available_security_updates_compliance_status : patch_compliance_status option;
(*
Indicates whether managed nodes for which there are available security-related patches that have not been approved by the baseline are being defined as COMPLIANT or NON_COMPLIANT. This option is specified when the CreatePatchBaseline or UpdatePatchBaseline commands are run.
Applies to Windows Server managed nodes only.
*)
sources : patch_source_list option;
(*
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
*)
approved_patches_enable_non_security : boolean_ option;
(*
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.
*)
rejected_patches_action : patch_action option;
(*
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.
*)
rejected_patches : patch_id_list option;
(*
A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
*)
approved_patches_compliance_level : patch_compliance_level option;
(*
Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.
*)
approved_patches : patch_id_list option;
(*
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
*)
approval_rules : patch_rule_group option;
global_filters : patch_filter_group option;
operating_system : operating_system option;
(*
The operating system rule used by the patch baseline override.
*)

}

Defines the basic information about a patch baseline override.

type nonrec get_deployable_patch_snapshot_for_instance_request = {

baseline_override : baseline_override option;
(*
Defines the basic information about a patch baseline override.
*)
snapshot_id : snapshot_id;
(*
The snapshot ID provided by the user when running AWS-RunPatchBaseline.
*)
instance_id : instance_id;
(*
The ID of the managed node for which the appropriate patch snapshot should be retrieved.
*)

}

type nonrec get_default_patch_baseline_result = {

operating_system : operating_system option;
(*
The operating system for the returned patch baseline.
*)
baseline_id : baseline_id option;
(*
The ID of the default patch baseline.
*)

}

type nonrec get_default_patch_baseline_request = {

operating_system : operating_system option;
(*
Returns the default patch baseline for the specified operating system.
*)

}

type nonrec connection_status =

| NOT_CONNECTED
| CONNECTED

type nonrec get_connection_status_response = {

status : connection_status option;
(*
The status of the connection to the managed node.
*)
target : session_target option;
(*
The ID of the managed node to check connection status.
*)

}

type nonrec get_connection_status_request = {

target : session_target;
(*
The managed node ID.
*)

}

type nonrec get_command_invocation_result = {

cloud_watch_output_config : cloud_watch_output_config option;
(*
Amazon CloudWatch Logs information where Systems Manager sent the command output.
*)
standard_error_url : url option;
(*
The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
*)
standard_error_content : standard_error_content option;
(*
The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
*)
standard_output_url : url option;
(*
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.
*)
standard_output_content : standard_output_content option;
(*
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.
*)
status_details : status_details option;
(*
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.
*)
status : command_invocation_status option;
(*
The status of this invocation plugin. This status can be different than StatusDetails.
*)
execution_end_date_time : string_date_time option;
(*
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.
*)
execution_elapsed_time : string_date_time option;
(*
Duration since ExecutionStartDateTime.
*)
execution_start_date_time : string_date_time option;
(*
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.
*)
response_code : response_code option;
(*
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.
*)
plugin_name : command_plugin_name option;
(*
The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.
*)
document_version : document_version option;
(*
The Systems Manager document (SSM document) version used in the request.
*)
document_name : document_name option;
(*
The name of the document that was run. For example, AWS-RunShellScript.
*)
comment : comment option;
(*
The comment text for the command.
*)
instance_id : instance_id option;
(*
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.
*)
command_id : command_id option;
(*
The parent command ID of the invocation plugin.
*)

}

type nonrec get_command_invocation_request = {

plugin_name : command_plugin_name option;
(*
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.
*)
instance_id : instance_id;
(*
(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.
*)
command_id : command_id;
(*
(Required) The parent command ID of the invocation plugin.
*)

}

type nonrec calendar_state =

| CLOSED
| OPEN

type nonrec get_calendar_state_response = {

next_transition_time : iso8601_string option;
(*
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.
*)
at_time : iso8601_string option;
(*
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.
*)
state : calendar_state option;
(*
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.
*)

}

type nonrec get_calendar_state_request = {

at_time : iso8601_string option;
(*
(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.
*)
calendar_names : calendar_name_or_arn_list;
(*
The names of Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.
*)

}

type nonrec automation_subtype =

| AccessRequest
| ChangeRequest

type nonrec automation_execution = {

variables : automation_parameter_map option;
(*
Variables defined for the automation.
*)
change_request_name : change_request_name option;
(*
The name of the Change Manager change request.
*)
association_id : string_ option;
(*
The ID of a State Manager association used in the Automation operation.
*)
ops_item_id : string_ option;
(*
The ID of an OpsItem that is created to represent a Change Manager change request.
*)
runbooks : runbooks option;
(*
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.
*)
scheduled_time : date_time option;
(*
The date and time the Automation operation is scheduled to start.
*)
automation_subtype : automation_subtype option;
(*
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
*)
target_locations_ur_l : target_locations_ur_l option;
(*
A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported
*)
triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarm that was invoked by the automation.
*)
alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm applied to your automation.
*)
progress_counters : progress_counters option;
(*
An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
*)
target_locations : target_locations option;
(*
The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
*)
target : string_ option;
(*
The target of the execution.
*)
max_errors : max_errors option;
(*
The MaxErrors value specified by the user when the execution started.
*)
max_concurrency : max_concurrency option;
(*
The MaxConcurrency value specified by the user when the execution started.
*)
resolved_targets : resolved_targets option;
(*
A list of resolved targets in the rate control execution.
*)
target_maps : target_maps option;
(*
The specified key-value mapping of document parameters to target resources.
*)
targets : targets option;
(*
The specified targets.
*)
target_parameter_name : automation_parameter_key option;
(*
The parameter name.
*)
current_action : string_ option;
(*
The action of the step that is currently running.
*)
current_step_name : string_ option;
(*
The name of the step that is currently running.
*)
executed_by : string_ option;
(*
The Amazon Resource Name (ARN) of the user who ran the automation.
*)
parent_automation_execution_id : automation_execution_id option;
(*
The AutomationExecutionId of the parent automation.
*)
mode : execution_mode option;
(*
The automation execution mode.
*)
failure_message : string_ option;
(*
A message describing why an execution has failed, if the status is set to Failed.
*)
outputs : automation_parameter_map option;
(*
The list of execution outputs as defined in the Automation runbook.
*)
parameters : automation_parameter_map option;
(*
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
*)
step_executions_truncated : boolean_ option;
(*
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.
*)
step_executions : step_execution_list option;
(*
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.
*)
automation_execution_status : automation_execution_status option;
(*
The execution status of the Automation.
*)
execution_end_time : date_time option;
(*
The time the execution finished.
*)
execution_start_time : date_time option;
(*
The time the execution started.
*)
document_version : document_version option;
(*
The version of the document to use during execution.
*)
document_name : document_name option;
(*
The name of the Automation runbook used during the execution.
*)
automation_execution_id : automation_execution_id option;
(*
The execution ID.
*)

}

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

type nonrec get_automation_execution_result = {

automation_execution : automation_execution option;
(*
Detailed information about the current state of an automation execution.
*)

}

type nonrec get_automation_execution_request = {

automation_execution_id : automation_execution_id;
(*
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.
*)

}

type nonrec access_key_id_type = string

type nonrec access_key_secret_type = string

type nonrec credentials = {

expiration_time : date_time;
(*
The datetime on which the current credentials expire.
*)
session_token : session_token_type;
(*
The token that users must pass to the service API to use the temporary credentials.
*)
secret_access_key : access_key_secret_type;
(*
The secret access key that can be used to sign requests.
*)
access_key_id : access_key_id_type;
(*
The access key ID that identifies the temporary security credentials.
*)

}

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

type nonrec access_request_status =

| PENDING
| EXPIRED
| REVOKED
| REJECTED
| APPROVED

type nonrec get_access_token_response = {

access_request_status : access_request_status option;
(*
The status of the access request.
*)
credentials : credentials option;
(*
The temporary security credentials which can be used to start just-in-time node access sessions.
*)

}

type nonrec get_access_token_request = {

access_request_id : access_request_id;
(*
The ID of a just-in-time node access request.
*)

}

type nonrec fault =

| Unknown
| Server
| Client

type nonrec create_association_batch_request_entry = {

alarm_configuration : alarm_configuration option;
target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
duration : duration option;
(*
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration parameter applies only when both these conditions are true:
- The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
- The command specifies the
```
 {{:https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociationBatchRequestEntry.html#systemsmanager-Type-CreateAssociationBatchRequestEntry-ApplyOnlyAtCronInterval}ApplyOnlyAtCronInterval} 
```
  parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.
*)
schedule_offset : schedule_offset option;
(*
Number of days to wait after the scheduled day to run an association.
*)
target_locations : target_locations option;
(*
Use this action to create an association in multiple Regions and multiple accounts.
*)
calendar_names : calendar_name_or_arn_list option;
(*
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 in the Amazon Web Services Systems Manager User Guide.
*)
apply_only_at_cron_interval : apply_only_at_cron_interval option;
(*
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 and when target changes are detected. Specify true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you specified.
For more information, see Understanding when associations are applied to resources and >About target updates with Automation runbooks in the Amazon Web Services Systems Manager User Guide.
This parameter isn't supported for rate expressions.
*)
sync_compliance : association_sync_compliance option;
(*
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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.
By default, all associations use AUTO mode.
*)
compliance_severity : association_compliance_severity option;
(*
The severity level to assign to the association.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
association_name : association_name option;
(*
Specify a descriptive name for the association.
*)
output_location : instance_association_output_location option;
(*
An S3 bucket where you want to store the results of this request.
*)
schedule_expression : schedule_expression option;
(*
A cron expression that specifies a schedule when the association runs.
*)
targets : targets option;
(*
The managed nodes targeted by the request.
*)
document_version : document_version option;
(*
The document version.
*)
automation_target_parameter_name : automation_target_parameter_name option;
(*
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 tool in Amazon Web Services Systems Manager.
*)
parameters : parameters option;
(*
A description of the parameters for a document.
*)
instance_id : instance_id option;
(*
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.
*)
name : document_ar_n;
(*
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:{i region}:{i account-id}:document/{i 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.
*)

}

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

type nonrec batch_error_message = string

type nonrec failed_create_association = {

fault : fault option;
(*
The source of the failure.
*)
message : batch_error_message option;
(*
A description of the failure.
*)
entry : create_association_batch_request_entry option;
(*
The association.
*)

}

Describes a failed association.

type nonrec failed_create_association_list = failed_create_association list

type nonrec expiration_date = Smaws_Lib.CoreTypes.Timestamp.t

type nonrec effective_patch = {

patch_status : patch_status option;
(*
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.
*)
patch : patch option;
(*
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.
*)

}

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.

type nonrec effective_patch_list = effective_patch list

type nonrec effective_instance_association_max_results = int

type nonrec dry_run = bool

type nonrec document_permission_max_results = int

type nonrec document_already_exists = {

message : string_ option;

}

The specified document already exists.

type nonrec disassociate_ops_item_related_item_response = unit

type nonrec disassociate_ops_item_related_item_request = {

association_id : ops_item_related_item_association_id;
(*
The ID of the association for which you want to delete an association between the OpsItem and a related item.
*)
ops_item_id : ops_item_id;
(*
The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.
*)

}

type nonrec describe_sessions_response = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
sessions : session_list option;
(*
A list of sessions meeting the request parameters.
*)

}

type nonrec describe_sessions_request = {

filters : session_filter_list option;
(*
One or more filters to limit the type of sessions returned by the request.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : session_max_results option;
(*
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.
*)
state : session_state;
(*
The session status to retrieve a list of sessions for. For example, "Active".
*)

}

type nonrec describe_patch_properties_result = {

next_token : next_token option;
(*
The token for the next set of items to return. (You use this token in the next call.)
*)
properties : patch_properties_list option;
(*
A list of the properties for patches matching the filter request parameters.
*)

}

type nonrec describe_patch_properties_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
patch_set : patch_set option;
(*
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.
*)
property : patch_property;
(*
The patch property for which you want to view patch details.
*)
operating_system : operating_system;
(*
The operating system type for which to list patches.
*)

}

type nonrec describe_patch_groups_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
mappings : patch_group_patch_baseline_mapping_list option;
(*
Each entry in the array contains:
- PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)
- PatchBaselineIdentity: A PatchBaselineIdentity element.
*)

}

type nonrec describe_patch_groups_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
filters : patch_orchestrator_filter_list option;
(*
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
*)
max_results : patch_baseline_max_results option;
(*
The maximum number of patch groups to return (per page).
*)

}

type nonrec describe_patch_group_state_result = {

instances_with_available_security_updates : integer option;
(*
The number of managed nodes for which security-related patches are available but not approved because because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the specified auto-approval period was over.
Applies to Windows Server managed nodes only.
*)
instances_with_other_non_compliant_patches : instances_count option;
(*
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.
*)
instances_with_security_non_compliant_patches : instances_count option;
(*
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.
*)
instances_with_critical_non_compliant_patches : instances_count option;
(*
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.
*)
instances_with_unreported_not_applicable_patches : integer option;
(*
The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.
*)
instances_with_not_applicable_patches : integer option;
(*
The number of managed nodes with patches that aren't applicable.
*)
instances_with_failed_patches : integer option;
(*
The number of managed nodes with patches from the patch baseline that failed to install.
*)
instances_with_missing_patches : integer option;
(*
The number of managed nodes with missing patches from the patch baseline.
*)
instances_with_installed_rejected_patches : instances_count option;
(*
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).
*)
instances_with_installed_pending_reboot_patches : instances_count option;
(*
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.
*)
instances_with_installed_other_patches : integer option;
(*
The number of managed nodes with patches installed that aren't defined in the patch baseline.
*)
instances_with_installed_patches : integer option;
(*
The number of managed nodes with installed patches.
*)
instances : integer option;
(*
The number of managed nodes in the patch group.
*)

}

type nonrec describe_patch_group_state_request = {

patch_group : patch_group;
(*
The name of the patch group whose patch snapshot should be retrieved.
*)

}

type nonrec describe_patch_baselines_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
baseline_identities : patch_baseline_identity_list option;
(*
An array of PatchBaselineIdentity elements.
*)

}

type nonrec describe_patch_baselines_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : patch_baseline_max_results option;
(*
The maximum number of patch baselines to return (per page).
*)
filters : patch_orchestrator_filter_list option;
(*
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
*)

}

type nonrec describe_parameters_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items.
*)
parameters : parameter_metadata_list option;
(*
Parameters returned by the request.
*)

}

type nonrec describe_parameters_request = {

shared : boolean_ option;
(*
Lists parameters that are shared with you.
By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
parameter_filters : parameter_string_filter_list option;
(*
Filters to limit the request results.
*)
filters : parameters_filter_list option;
(*
This data type is deprecated. Instead, use ParameterFilters.
*)

}

type nonrec describe_ops_items_response = {

ops_item_summaries : ops_item_summaries option;
(*
A list of OpsItems.
*)
next_token : string_ option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)

}

type nonrec describe_ops_items_request = {

next_token : string_ option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : ops_item_max_results option;
(*
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.
*)
ops_item_filters : ops_item_filters option;
(*
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"}
*)

}

type nonrec describe_maintenance_windows_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
window_identities : maintenance_window_identity_list option;
(*
Information about the maintenance windows.
*)

}

type nonrec describe_maintenance_windows_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_max_results option;
(*
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.
*)
filters : maintenance_window_filter_list option;
(*
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.
*)

}

type nonrec describe_maintenance_windows_for_target_result = {

next_token : next_token option;
(*
The token for the next set of items to return. (You use this token in the next call.)
*)
window_identities : maintenance_windows_for_target_list option;
(*
Information about the maintenance window targets and tasks a managed node is associated with.
*)

}

type nonrec describe_maintenance_windows_for_target_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_search_max_results option;
(*
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.
*)
resource_type : maintenance_window_resource_type;
(*
The type of resource you want to retrieve information about. For example, INSTANCE.
*)
targets : targets;
(*
The managed node ID or key-value pair to retrieve information about.
*)

}

type nonrec describe_maintenance_window_tasks_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
tasks : maintenance_window_task_list option;
(*
Information about the tasks in the maintenance window.
*)

}

type nonrec describe_maintenance_window_tasks_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_max_results option;
(*
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.
*)
filters : maintenance_window_filter_list option;
(*
Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window whose tasks should be retrieved.
*)

}

type nonrec describe_maintenance_window_targets_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
targets : maintenance_window_target_list option;
(*
Information about the targets in the maintenance window.
*)

}

type nonrec describe_maintenance_window_targets_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_max_results option;
(*
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.
*)
filters : maintenance_window_filter_list option;
(*
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.
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window whose targets should be retrieved.
*)

}

type nonrec describe_maintenance_window_schedule_result = {

next_token : next_token option;
(*
The token for the next set of items to return. (You use this token in the next call.)
*)
scheduled_window_executions : scheduled_window_execution_list option;
(*
Information about maintenance window executions scheduled for the specified time range.
*)

}

type nonrec describe_maintenance_window_schedule_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_search_max_results option;
(*
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.
*)
filters : patch_orchestrator_filter_list option;
(*
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.
*)
resource_type : maintenance_window_resource_type option;
(*
The type of resource you want to retrieve information about. For example, INSTANCE.
*)
targets : targets option;
(*
The managed node ID or key-value pair to retrieve information about.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window to retrieve information about.
*)

}

type nonrec describe_maintenance_window_executions_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
window_executions : maintenance_window_execution_list option;
(*
Information about the maintenance window executions.
*)

}

type nonrec describe_maintenance_window_executions_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_max_results option;
(*
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.
*)
filters : maintenance_window_filter_list option;
(*
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 2024-11-04T05:00:00Z.
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window whose executions should be retrieved.
*)

}

type nonrec describe_maintenance_window_execution_tasks_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
window_execution_task_identities : maintenance_window_execution_task_identity_list option;
(*
Information about the task executions.
*)

}

type nonrec describe_maintenance_window_execution_tasks_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_max_results option;
(*
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.
*)
filters : maintenance_window_filter_list option;
(*
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.
*)
window_execution_id : maintenance_window_execution_id;
(*
The ID of the maintenance window execution whose task executions should be retrieved.
*)

}

type nonrec describe_maintenance_window_execution_task_invocations_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
window_execution_task_invocation_identities : maintenance_window_execution_task_invocation_identity_list option;
(*
Information about the task invocation results per invocation.
*)

}

type nonrec describe_maintenance_window_execution_task_invocations_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : maintenance_window_max_results option;
(*
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.
*)
filters : maintenance_window_filter_list option;
(*
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.
*)
task_id : maintenance_window_execution_task_id;
(*
The ID of the specific task in the maintenance window task that should be retrieved.
*)
window_execution_id : maintenance_window_execution_id;
(*
The ID of the maintenance window execution the task is part of.
*)

}

type nonrec describe_inventory_deletions_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
inventory_deletions : inventory_deletions_list option;
(*
A list of status items for deleted inventory.
*)

}

type nonrec describe_inventory_deletions_request = {

max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
deletion_id : uui_d option;
(*
Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory operation.
*)

}

type nonrec describe_instance_properties_result = {

next_token : next_token option;
(*
The token for the next set of properties to return. Use this token to get the next set of results.
*)
instance_properties : instance_properties option;
(*
Properties for the managed instances.
*)

}

type nonrec describe_instance_properties_max_results = int

type nonrec describe_instance_properties_request = {

next_token : next_token option;
(*
The token provided by a previous request to use to return the next set of properties.
*)
max_results : describe_instance_properties_max_results option;
(*
The maximum number of items to return for the call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
*)
filters_with_operator : instance_property_string_filter_list option;
(*
The request filters to use with the operator.
*)
instance_property_filter_list : instance_property_filter_list option;
(*
An array of instance property filters.
*)

}

type nonrec describe_instance_patches_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
patches : patch_compliance_data_list option;
(*
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)
*)

}

type nonrec describe_instance_patches_request = {

max_results : patch_compliance_max_results option;
(*
The maximum number of patches to return (per page).
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
filters : patch_orchestrator_filter_list option;
(*
Each element in the array is a structure containing a key-value pair.
Supported keys for DescribeInstancePatchesinclude 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 Patch compliance state values in the Amazon Web Services Systems Manager User Guide.
*)
instance_id : instance_id;
(*
The ID of the managed node whose patch state information should be retrieved.
*)

}

type nonrec describe_instance_patch_states_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
instance_patch_states : instance_patch_state_list option;
(*
The high-level patch state for the requested managed nodes.
*)

}

type nonrec describe_instance_patch_states_request = {

max_results : patch_compliance_max_results option;
(*
The maximum number of managed nodes to return (per page).
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
instance_ids : instance_id_list;
(*
The ID of the managed node for which patch state information should be retrieved.
*)

}

type nonrec describe_instance_patch_states_for_patch_group_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
instance_patch_states : instance_patch_states_list option;
(*
The high-level patch state for the requested managed nodes.
*)

}

type nonrec describe_instance_patch_states_for_patch_group_request = {

max_results : patch_compliance_max_results option;
(*
The maximum number of patches to return (per page).
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
filters : instance_patch_state_filter_list option;
(*
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")
*)
patch_group : patch_group;
(*
The name of the patch group for which the patch state information should be retrieved.
*)

}

type nonrec describe_instance_information_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
instance_information_list : instance_information_list option;
(*
The managed node information list.
*)

}

type nonrec describe_instance_information_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results_ec2_compatible option;
(*
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.
*)
filters : instance_information_string_filter_list option;
(*
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.
*)
instance_information_filter_list : instance_information_filter_list option;
(*
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.
*)

}

type nonrec describe_instance_associations_status_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
instance_association_status_infos : instance_association_status_infos option;
(*
Status information about the association.
*)

}

type nonrec describe_instance_associations_status_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
instance_id : instance_id;
(*
The managed node IDs for which you want association status information.
*)

}

type nonrec describe_effective_patches_for_patch_baseline_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
effective_patches : effective_patch_list option;
(*
An array of patches and patch status.
*)

}

type nonrec describe_effective_patches_for_patch_baseline_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : patch_baseline_max_results option;
(*
The maximum number of patches to return (per page).
*)
baseline_id : baseline_id;
(*
The ID of the patch baseline to retrieve the effective patches for.
*)

}

type nonrec describe_effective_instance_associations_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
associations : instance_association_list option;
(*
The associations for the requested managed node.
*)

}

type nonrec describe_effective_instance_associations_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : effective_instance_association_max_results option;
(*
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.
*)
instance_id : instance_id;
(*
The managed node ID for which you want to view all associations.
*)

}

type nonrec describe_document_result = {

document : document_description option;
(*
Information about the SSM document.
*)

}

type nonrec describe_document_request = {

version_name : document_version_name option;
(*
An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
*)
document_version : document_version option;
(*
The document version for which you want information. Can be a specific version or the default version.
*)
name : document_ar_n;
(*
The name of the SSM document.
If you're calling a shared SSM document from a different Amazon Web Services account, Name is the full Amazon Resource Name (ARN) of the document.
*)

}

type nonrec account_sharing_info = {

shared_document_version : shared_document_version option;
(*
The version of the current document shared with the account.
*)
account_id : account_id option;
(*
The Amazon Web Services account ID where the current document is shared.
*)

}

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

type nonrec account_sharing_info_list = account_sharing_info list

type nonrec describe_document_permission_response = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
account_sharing_info_list : account_sharing_info_list option;
(*
A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.
*)
account_ids : account_id_list option;
(*
The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account number or all.
*)

}

type nonrec describe_document_permission_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : document_permission_max_results option;
(*
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.
*)
permission_type : document_permission_type;
(*
The permission type for the document. The permission type can be Share.
*)
name : document_name;
(*
The name of the document for which you are the owner.
*)

}

type nonrec describe_available_patches_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
patches : patch_list option;
(*
An array of patches. Each entry in the array is a patch structure.
*)

}

type nonrec describe_available_patches_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : patch_baseline_max_results option;
(*
The maximum number of patches to return (per page).
*)
filters : patch_orchestrator_filter_list option;
(*
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
*)

}

type nonrec describe_automation_step_executions_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
step_executions : step_execution_list option;
(*
A list of details about the current state of all steps that make up an execution.
*)

}

type nonrec describe_automation_step_executions_request = {

reverse_order : boolean_ option;
(*
Indicates whether to list step executions in reverse order by start time. The default value is 'false'.
*)
max_results : max_results option;
(*
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.
*)
next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
filters : step_execution_filter_list option;
(*
One or more filters to limit the number of step executions returned by the request.
*)
automation_execution_id : automation_execution_id;
(*
The Automation execution ID for which you want step execution descriptions.
*)

}

type nonrec automation_type =

| Local
| CrossAccount

type nonrec automation_execution_metadata = {

change_request_name : change_request_name option;
(*
The name of the Change Manager change request.
*)
association_id : string_ option;
(*
The ID of a State Manager association used in the Automation operation.
*)
ops_item_id : string_ option;
(*
The ID of an OpsItem that is created to represent a Change Manager change request.
*)
runbooks : runbooks option;
(*
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.
*)
scheduled_time : date_time option;
(*
The date and time the Automation operation is scheduled to start.
*)
automation_subtype : automation_subtype option;
(*
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
*)
target_locations_ur_l : target_locations_ur_l option;
(*
A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported
*)
triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarm that was invoked by the automation.
*)
alarm_configuration : alarm_configuration option;
(*
The details for the CloudWatch alarm applied to your automation.
*)
automation_type : automation_type option;
(*
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 automations in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.
*)
target : string_ option;
(*
The list of execution outputs as defined in the Automation runbook.
*)
max_errors : max_errors option;
(*
The MaxErrors value specified by the user when starting the automation.
*)
max_concurrency : max_concurrency option;
(*
The MaxConcurrency value specified by the user when starting the automation.
*)
resolved_targets : resolved_targets option;
(*
A list of targets that resolved during the execution.
*)
target_maps : target_maps option;
(*
The specified key-value mapping of document parameters to target resources.
*)
targets : targets option;
(*
The targets defined by the user when starting the automation.
*)
target_parameter_name : automation_parameter_key option;
(*
The list of execution outputs as defined in the Automation runbook.
*)
failure_message : string_ option;
(*
The list of execution outputs as defined in the Automation runbook.
*)
current_action : string_ option;
(*
The action of the step that is currently running.
*)
current_step_name : string_ option;
(*
The name of the step that is currently running.
*)
parent_automation_execution_id : automation_execution_id option;
(*
The execution ID of the parent automation.
*)
mode : execution_mode option;
(*
The Automation execution mode.
*)
outputs : automation_parameter_map option;
(*
The list of execution outputs as defined in the Automation runbook.
*)
log_file : string_ option;
(*
An S3 bucket where execution information is stored.
*)
executed_by : string_ option;
(*
The IAM role ARN of the user who ran the automation.
*)
execution_end_time : date_time option;
(*
The time the execution finished. This isn't populated if the execution is still in progress.
*)
execution_start_time : date_time option;
(*
The time the execution started.
*)
automation_execution_status : automation_execution_status option;
(*
The status of the execution.
*)
document_version : document_version option;
(*
The document version used during the execution.
*)
document_name : document_name option;
(*
The name of the Automation runbook used during execution.
*)
automation_execution_id : automation_execution_id option;
(*
The execution ID.
*)

}

Details about a specific Automation execution.

type nonrec automation_execution_metadata_list =
  automation_execution_metadata list

type nonrec describe_automation_executions_result = {

next_token : next_token option;
(*
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*)
automation_execution_metadata_list : automation_execution_metadata_list option;
(*
The list of details about each automation execution which has occurred which matches the filter specification, if any.
*)

}

type nonrec automation_execution_filter_key =

| OPS_ITEM_ID
| AUTOMATION_SUBTYPE
| TARGET_RESOURCE_GROUP
| TAG_KEY
| AUTOMATION_TYPE
| START_TIME_AFTER
| START_TIME_BEFORE
| CURRENT_ACTION
| PARENT_EXECUTION_ID
| EXECUTION_ID
| EXECUTION_STATUS
| DOCUMENT_NAME_PREFIX

type nonrec automation_execution_filter_value = string

type nonrec automation_execution_filter_value_list =
  automation_execution_filter_value list

type nonrec automation_execution_filter = {

values : automation_execution_filter_value_list;
(*
The values used to limit the execution information associated with the filter's key.
*)
key : automation_execution_filter_key;
(*
One or more keys to limit the results.
*)

}

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

type nonrec automation_execution_filter_list = automation_execution_filter list

type nonrec describe_automation_executions_request = {

next_token : next_token option;
(*
The token for the next set of items to return. (You received this token from a previous call.)
*)
max_results : max_results option;
(*
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.
*)
filters : automation_execution_filter_list option;
(*
Filters used to limit the scope of executions that are requested.
*)

}

type nonrec describe_association_result = {

association_description : association_description option;
(*
Information about the association.
*)

}

type nonrec describe_association_request = {

association_version : association_version option;
(*
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.
*)
association_id : association_id option;
(*
The association ID for which you want information.
*)
instance_id : instance_id option;
(*
The managed node ID.
*)
name : document_ar_n option;
(*
The name of the SSM document.
*)

}

type nonrec association_execution_id = string

type nonrec association_execution = {

triggered_alarms : alarm_state_information_list option;
(*
The CloudWatch alarms that were invoked by the association.
*)
alarm_configuration : alarm_configuration option;
resource_count_by_status : resource_count_by_status option;
(*
An aggregate status of the resources in the execution based on the status type.
*)
last_execution_date : date_time option;
(*
The date of the last execution.
*)
created_time : date_time option;
(*
The time the execution started.
*)
detailed_status : status_name option;
(*
Detailed status information about the execution.
*)
status : status_name option;
(*
The status of the association execution.
*)
execution_id : association_execution_id option;
(*
The execution ID for the association.
*)
association_version : association_version option;
(*
The association version.
*)
association_id : association_id option;
(*
The association ID.
*)

}

Includes information about the specified association.

type nonrec association_executions_list = association_execution list

type nonrec describe_association_executions_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
association_executions : association_executions_list option;
(*
A list of the executions for the specified association ID.
*)

}

type nonrec association_execution_filter_key =

| CreatedTime
| Status
| ExecutionId

type nonrec association_execution_filter_value = string

type nonrec association_filter_operator_type =

| GreaterThan
| LessThan
| Equal

type nonrec association_execution_filter = {

type_ : association_filter_operator_type;
(*
The filter type specified in the request.
*)
value : association_execution_filter_value;
(*
The value specified for the key.
*)
key : association_execution_filter_key;
(*
The key value used in the request.
*)

}

Filters used in the request.

type nonrec association_execution_filter_list =
  association_execution_filter list

type nonrec describe_association_executions_request = {

next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : max_results option;
(*
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.
*)
filters : association_execution_filter_list option;
(*
Filters for the request. You can specify the following filters and values.
ExecutionId (EQUAL)
Status (EQUAL)
CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
*)
association_id : association_id;
(*
The association ID for which you want to view execution history details.
*)

}

type nonrec association_resource_id = string

type nonrec association_resource_type = string

type nonrec association_execution_target = {

output_source : output_source option;
(*
The location where the association details are saved.
*)
last_execution_date : date_time option;
(*
The date of the last execution.
*)
detailed_status : status_name option;
(*
Detailed information about the execution status.
*)
status : status_name option;
(*
The association execution status.
*)
resource_type : association_resource_type option;
(*
The resource type, for example, EC2.
*)
resource_id : association_resource_id option;
(*
The resource ID, for example, the managed node ID where the association ran.
*)
execution_id : association_execution_id option;
(*
The execution ID.
*)
association_version : association_version option;
(*
The association version.
*)
association_id : association_id option;
(*
The association ID.
*)

}

Includes information about the specified association execution.

type nonrec association_execution_targets_list =
  association_execution_target list

type nonrec describe_association_execution_targets_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
association_execution_targets : association_execution_targets_list option;
(*
Information about the execution.
*)

}

type nonrec association_execution_targets_filter_key =

| ResourceType
| ResourceId
| Status

type nonrec association_execution_targets_filter_value = string

type nonrec association_execution_targets_filter = {

value : association_execution_targets_filter_value;
(*
The value specified for the key.
*)
key : association_execution_targets_filter_key;
(*
The key value used in the request.
*)

}

Filters for the association execution.

type nonrec association_execution_targets_filter_list =
  association_execution_targets_filter list

type nonrec describe_association_execution_targets_request = {

next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : max_results option;
(*
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.
*)
filters : association_execution_targets_filter_list option;
(*
Filters for the request. You can specify the following filters and values.
Status (EQUAL)
ResourceId (EQUAL)
ResourceType (EQUAL)
*)
execution_id : association_execution_id;
(*
The execution ID for which you want to view details.
*)
association_id : association_id;
(*
The association ID that includes the execution for which you want to view details.
*)

}

type nonrec association_execution_does_not_exist = {

message : string_ option;

}

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

type nonrec activation_description = string

type nonrec default_instance_name = string

type nonrec created_date = Smaws_Lib.CoreTypes.Timestamp.t

type nonrec activation = {

tags : tag_list option;
(*
Tags assigned to the activation.
*)
created_date : created_date option;
(*
The date the activation was created.
*)
expired : boolean_ option;
(*
Whether or not the activation is expired.
*)
expiration_date : expiration_date option;
(*
The date when this activation can no longer be used to register managed nodes.
*)
registrations_count : registrations_count option;
(*
The number of managed nodes already registered with this activation.
*)
registration_limit : registration_limit option;
(*
The maximum number of managed nodes that can be registered using this activation.
*)
iam_role : iam_role option;
(*
The Identity and Access Management (IAM) role to assign to the managed node.
*)
default_instance_name : default_instance_name option;
(*
A name for the managed node when it is created.
*)
description : activation_description option;
(*
A user defined description of the activation.
*)
activation_id : activation_id option;
(*
The ID created by Systems Manager when you submitted the activation.
*)

}

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.

type nonrec activation_list = activation list

type nonrec describe_activations_result = {

next_token : next_token option;
(*
The token for the next set of items to return. Use this token to get the next set of results.
*)
activation_list : activation_list option;
(*
A list of activations for your Amazon Web Services account.
*)

}

type nonrec describe_activations_filter_keys =

| IAM_ROLE
| DEFAULT_INSTANCE_NAME
| ACTIVATION_IDS

type nonrec describe_activations_filter = {

filter_values : string_list option;
(*
The filter values.
*)
filter_key : describe_activations_filter_keys option;
(*
The name of the filter.
*)

}

Filter for the DescribeActivation API.

type nonrec describe_activations_filter_list = describe_activations_filter list

type nonrec describe_activations_request = {

next_token : next_token option;
(*
A token to start the list. Use this token to get the next set of results.
*)
max_results : max_results option;
(*
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.
*)
filters : describe_activations_filter_list option;
(*
A filter to view information about your activations.
*)

}

type nonrec deregister_task_from_maintenance_window_result = {

window_task_id : maintenance_window_task_id option;
(*
The ID of the task removed from the maintenance window.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window the task was removed from.
*)

}

type nonrec deregister_task_from_maintenance_window_request = {

window_task_id : maintenance_window_task_id;
(*
The ID of the task to remove from the maintenance window.
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window the task should be removed from.
*)

}

type nonrec deregister_target_from_maintenance_window_result = {

window_target_id : maintenance_window_target_id option;
(*
The ID of the removed target definition.
*)
window_id : maintenance_window_id option;
(*
The ID of the maintenance window the target was removed from.
*)

}

type nonrec deregister_target_from_maintenance_window_request = {

safe : boolean_ option;
(*
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.
*)
window_target_id : maintenance_window_target_id;
(*
The ID of the target definition to remove.
*)
window_id : maintenance_window_id;
(*
The ID of the maintenance window the target should be removed from.
*)

}

type nonrec deregister_patch_baseline_for_patch_group_result = {

patch_group : patch_group option;
(*
The name of the patch group deregistered from the patch baseline.
*)
baseline_id : baseline_id option;
(*
The ID of the patch baseline the patch group was deregistered from.
*)

}

type nonrec deregister_patch_baseline_for_patch_group_request = {

patch_group : patch_group;
(*
The name of the patch group that should be deregistered from the patch baseline.
*)
baseline_id : baseline_id;
(*
The ID of the patch baseline to deregister the patch group from.
*)

}

type nonrec deregister_managed_instance_result = unit

type nonrec deregister_managed_instance_request = {

instance_id : managed_instance_id;
(*
The ID assigned to the managed node when you registered it using the activation process.
*)

}

type nonrec delete_resource_policy_response = unit

type nonrec delete_resource_policy_request = {

policy_hash : policy_hash;
(*
ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.
*)
policy_id : policy_id;
(*
The policy ID.
*)
resource_arn : resource_arn_string;
(*
Amazon Resource Name (ARN) of the resource to which the policies are attached.
*)

}

type nonrec delete_resource_data_sync_result = unit

type nonrec delete_resource_data_sync_request = {

sync_type : resource_data_sync_type option;
(*
Specify the type of resource data sync to delete.
*)
sync_name : resource_data_sync_name;
(*
The name of the configuration to delete.
*)

}

type nonrec delete_patch_baseline_result = {

baseline_id : baseline_id option;
(*
The ID of the deleted patch baseline.
*)

}

type nonrec delete_patch_baseline_request = {

baseline_id : baseline_id;
(*
The ID of the patch baseline to delete.
*)

}

type nonrec delete_parameters_result = {

invalid_parameters : parameter_name_list option;
(*
The names of parameters that weren't deleted because the parameters aren't valid.
*)
deleted_parameters : parameter_name_list option;
(*
The names of the deleted parameters.
*)

}

type nonrec delete_parameters_request = {

names : parameter_name_list;
(*
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.
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
*)

}

type nonrec delete_parameter_result = unit

type nonrec delete_parameter_request = {

name : ps_parameter_name;
(*
The name of the parameter to delete.
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
*)

}

type nonrec delete_ops_metadata_result = unit

type nonrec delete_ops_metadata_request = {

ops_metadata_arn : ops_metadata_arn;
(*
The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.
*)

}

type nonrec delete_ops_item_response = unit

type nonrec delete_ops_item_request = {

ops_item_id : ops_item_id;
(*
The ID of the OpsItem that you want to delete.
*)

}

type nonrec delete_maintenance_window_result = {

window_id : maintenance_window_id option;
(*
The ID of the deleted maintenance window.
*)

}

type nonrec delete_maintenance_window_request = {

window_id : maintenance_window_id;
(*
The ID of the maintenance window to delete.
*)

}

type nonrec delete_inventory_result = {

deletion_summary : inventory_deletion_summary option;
(*
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.
*)
type_name : inventory_item_type_name option;
(*
The name of the inventory data type specified in the request.
*)
deletion_id : uui_d option;
(*
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.
*)

}

type nonrec delete_inventory_request = {

client_token : uui_d option;
(*
User-provided idempotency token.
*)
dry_run : dry_run option;
(*
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.
*)
schema_delete_option : inventory_schema_delete_option option;
(*
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.
*)
type_name : inventory_item_type_name;
(*
The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.
*)

}

type nonrec delete_document_result = unit

type nonrec delete_document_request = {

force : boolean_ option;
(*
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.
*)
version_name : document_version_name option;
(*
The version name of the document that you want to delete. If not provided, all versions of the document are deleted.
*)
document_version : document_version option;
(*
The version of the document that you want to delete. If not provided, all versions of the document are deleted.
*)
name : document_name;
(*
The name of the document.
*)

}

type nonrec associated_instances = unit

type nonrec delete_association_result = unit

type nonrec delete_association_request = {

association_id : association_id option;
(*
The association ID that you want to delete.
*)
instance_id : instance_id option;
(*
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.
*)
name : document_ar_n option;
(*
The name of the SSM document.
*)

}

type nonrec delete_activation_result = unit

type nonrec delete_activation_request = {

activation_id : activation_id;
(*
The ID of the activation that you want to delete.
*)

}

type nonrec create_resource_data_sync_result = unit

type nonrec create_resource_data_sync_request = {

sync_source : resource_data_sync_source option;
(*
Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.
*)
sync_type : resource_data_sync_type option;
(*
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.
*)
s3_destination : resource_data_sync_s3_destination option;
(*
Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.
*)
sync_name : resource_data_sync_name;
(*
A name for the configuration.
*)

}

type nonrec create_patch_baseline_result = {

baseline_id : baseline_id option;
(*
The ID of the created patch baseline.
*)

}

type nonrec create_patch_baseline_request = {

tags : tag_list option;
(*
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.
*)
client_token : client_token option;
(*
User-provided idempotency token.
*)
available_security_updates_compliance_status : patch_compliance_status option;
(*
Indicates the status you want to assign to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.
Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.
Supported for Windows Server managed nodes only.
*)
sources : patch_source_list option;
(*
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
*)
description : baseline_description option;
(*
A description of the patch baseline.
*)
rejected_patches_action : patch_action option;
(*
The action for Patch Manager to take on patches included in the RejectedPackages list.
ALLOW_AS_DEPENDENCY Linux and macOS: 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 INSTALLED_OTHER. This is the default action if no option is specified.
Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.
BLOCK All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED.
*)
rejected_patches : patch_id_list option;
(*
A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
*)
approved_patches_enable_non_security : boolean_ option;
(*
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.
*)
approved_patches_compliance_level : patch_compliance_level option;
(*
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.
*)
approved_patches : patch_id_list option;
(*
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
*)
approval_rules : patch_rule_group option;
(*
A set of rules used to include patches in the baseline.
*)
global_filters : patch_filter_group option;
(*
A set of global filters used to include patches in the baseline.
The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.
*)
name : baseline_name;
(*
The name of the patch baseline.
*)
operating_system : operating_system option;
(*
Defines the operating system the patch baseline applies to. The default value is WINDOWS.
*)

}

type nonrec create_ops_metadata_result = {

ops_metadata_arn : ops_metadata_arn option;
(*
The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.
*)

}

type nonrec create_ops_metadata_request = {

tags : tag_list option;
(*
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
*)
metadata : metadata_map option;
(*
Metadata for a new Application Manager application.
*)
resource_id : ops_metadata_resource_id;
(*
A resource ID for a new Application Manager application.
*)

}

type nonrec create_ops_item_response = {

ops_item_arn : ops_item_arn option;
(*
The OpsItem Amazon Resource Name (ARN).
*)
ops_item_id : string_ option;
(*
The ID of the OpsItem.
*)

}

type nonrec create_ops_item_request = {

account_id : ops_item_account_id option;
(*
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.
*)
planned_end_time : date_time option;
(*
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
*)
planned_start_time : date_time option;
(*
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
*)
actual_end_time : date_time option;
(*
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
*)
actual_start_time : date_time option;
(*
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
*)
severity : ops_item_severity option;
(*
Specify a severity to assign to an OpsItem.
*)
category : ops_item_category option;
(*
Specify a category to assign to an OpsItem.
*)
tags : tag_list option;
(*
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.
*)
title : ops_item_title;
(*
A short heading that describes the nature of the OpsItem and the impacted resource.
*)
source : ops_item_source;
(*
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.
*)
related_ops_items : related_ops_items option;
(*
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.
*)
priority : ops_item_priority option;
(*
The importance of this OpsItem in relation to other OpsItems in the system.
*)
notifications : ops_item_notifications option;
(*
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
*)
operational_data : ops_item_operational_data option;
(*
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 Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.
*)
ops_item_type : ops_item_type option;
(*
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.
*)
description : ops_item_description;
(*
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.
*)

}

type nonrec create_maintenance_window_result = {

window_id : maintenance_window_id option;
(*
The ID of the created maintenance window.
*)

}

type nonrec create_maintenance_window_request = {

tags : tag_list option;
(*
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.
*)
client_token : client_token option;
(*
User-provided idempotency token.
*)
allow_unassociated_targets : maintenance_window_allow_unassociated_targets;
(*
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.
*)
cutoff : maintenance_window_cutoff;
(*
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
*)
duration : maintenance_window_duration_hours;
(*
The duration of the maintenance window in hours.
*)
schedule_offset : maintenance_window_offset option;
(*
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.
*)
schedule_timezone : maintenance_window_timezone option;
(*
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.
*)
schedule : maintenance_window_schedule;
(*
The schedule of the maintenance window in the form of a cron or rate expression.
*)
end_date : maintenance_window_string_date_time option;
(*
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.
*)
start_date : maintenance_window_string_date_time option;
(*
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.
When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.
*)
description : maintenance_window_description option;
(*
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
*)
name : maintenance_window_name;
(*
The name of the maintenance window.
*)

}

type nonrec create_document_result = {

document_description : document_description option;
(*
Information about the SSM document.
*)

}

type nonrec create_document_request = {

tags : tag_list option;
(*
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.
*)
target_type : target_type option;
(*
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.
*)
document_format : document_format option;
(*
Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
*)
document_type : document_type option;
(*
The type of document to create.
The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.
*)
version_name : document_version_name option;
(*
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.
*)
display_name : document_display_name option;
(*
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.
*)
name : document_name;
(*
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
- AWSEC2
- AWSConfigRemediation
- AWSSupport
*)
attachments : attachments_source_list option;
(*
A list of key-value pairs that describe attachments to a version of a document.
*)
requires : document_requires_list option;
(*
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.
*)
content : document_content;
(*
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.
*)

}

type nonrec create_association_result = {

association_description : association_description option;
(*
Information about the association.
*)

}

type nonrec create_association_request = {

alarm_configuration : alarm_configuration option;
tags : tag_list option;
(*
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.
*)
target_maps : target_maps option;
(*
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
*)
duration : duration option;
(*
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration parameter applies only when both these conditions are true:
- The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
- The command specifies the
```
 {{:https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html#systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval}ApplyOnlyAtCronInterval} 
```
  parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.
*)
schedule_offset : schedule_offset option;
(*
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.
*)
target_locations : target_locations option;
(*
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.
*)
calendar_names : calendar_name_or_arn_list option;
(*
The names of 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 in the Amazon Web Services Systems Manager User Guide.
*)
apply_only_at_cron_interval : apply_only_at_cron_interval option;
(*
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 and when target changes are detected. Specify true for ApplyOnlyAtCronIntervalif you want the association to run only according to the schedule you specified.
For more information, see Understanding when associations are applied to resources and >About target updates with Automation runbooks in the Amazon Web Services Systems Manager User Guide.
This parameter isn't supported for rate expressions.
*)
sync_compliance : association_sync_compliance option;
(*
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.
*)
compliance_severity : association_compliance_severity option;
(*
The severity level to assign to the association.
*)
max_concurrency : max_concurrency option;
(*
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.
*)
max_errors : max_errors option;
(*
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.
*)
automation_target_parameter_name : automation_target_parameter_name option;
(*
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 tool in Amazon Web Services Systems Manager.
*)
association_name : association_name option;
(*
Specify a descriptive name for the association.
*)
output_location : instance_association_output_location option;
(*
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
*)
schedule_expression : schedule_expression option;
(*
A cron expression when the association will be applied to the targets.
*)
targets : targets option;
(*
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 Understanding targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.
*)
parameters : parameters option;
(*
The parameters for the runtime configuration of the document.
*)
instance_id : instance_id option;
(*
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.
*)
document_version : document_version option;
(*
The document version you want to associate with the targets. 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.
*)
name : document_ar_n;
(*
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:{i partition}:ssm:{i region}:{i account-id}:document/{i 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.
*)

}

type nonrec association_description_list = association_description list

type nonrec create_association_batch_result = {

failed : failed_create_association_list option;
(*
Information about the associations that failed.
*)
successful : association_description_list option;
(*
Information about the associations that succeeded.
*)

}

type nonrec create_association_batch_request_entries =
  create_association_batch_request_entry list

type nonrec create_association_batch_request = {

entries : create_association_batch_request_entries;
(*
One or more associations.
*)

}

type nonrec association_limit_exceeded = unit

type nonrec association_already_exists = unit

type nonrec activation_code = string

type nonrec create_activation_result = {

activation_code : activation_code option;
(*
The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
*)
activation_id : activation_id option;
(*
The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
*)

}

type nonrec create_activation_request = {

registration_metadata : registration_metadata_list option;
(*
Reserved for internal use.
*)
tags : tag_list option;
(*
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.
*)
expiration_date : expiration_date option;
(*
The date by which this activation request should expire, in timestamp format, such as "2024-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.
*)
registration_limit : registration_limit option;
(*
Specify the maximum number of managed nodes you want to register. The default value is 1.
*)
iam_role : iam_role;
(*
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 the IAM service role required for Systems Manager in a hybrid and multicloud environments 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.
*)
default_instance_name : default_instance_name option;
(*
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.
*)
description : activation_description option;
(*
A user-defined description of the resource that you want to register with Systems Manager.
Don't enter personally identifiable information in this field.
*)

}

type nonrec cancel_maintenance_window_execution_result = {

window_execution_id : maintenance_window_execution_id option;
(*
The ID of the maintenance window execution that has been stopped.
*)

}

type nonrec cancel_maintenance_window_execution_request = {

window_execution_id : maintenance_window_execution_id;
(*
The ID of the maintenance window execution to stop.
*)

}

type nonrec cancel_command_result = unit

type nonrec cancel_command_request = {

instance_ids : instance_id_list option;
(*
(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.
*)
command_id : command_id;
(*
The ID of the command you want to cancel.
*)

}

type nonrec associate_ops_item_related_item_response = {

association_id : ops_item_related_item_association_id option;
(*
The association ID.
*)

}

type nonrec associate_ops_item_related_item_request = {

resource_uri : ops_item_related_item_association_resource_uri;
(*
The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.
*)
resource_type : ops_item_related_item_association_resource_type;
(*
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.
*)
association_type : ops_item_related_item_association_type;
(*
The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.
*)
ops_item_id : ops_item_id;
(*
The ID of the OpsItem to which you want to associate a resource as a related item.
*)

}

type nonrec add_tags_to_resource_result = unit

type nonrec add_tags_to_resource_request = {

tags : tag_list;
(*
One or more tags. The value parameter is required.
Don't enter personally identifiable information in this field.
*)
resource_id : resource_id;
(*
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-{i ID_number} 
```
. For example, mi-1a2b3c4d5e6f.
*)
resource_type : resource_type_for_tagging;
(*
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-{i ID_number} 
```
. For example, mi-1a2b3c4d5e6f.
*)

}