Ssm

add_tags_to_resource(resource_id, resource_type, tags)
add_tags_to_resource(resource_id, resource_type, tags, params::Dict{String,<:Any})

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 50 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.

Arguments

• resource_id: The resource ID you want to tag. Use the ID of the resource. Here are some examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-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 action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
• resource_type: Specifies the type of resource you are tagging. The ManagedInstance type for this API action is for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
• tags: One or more tags. The value parameter is required. Do not enter personally identifiable information in this field.

associate_ops_item_related_item(association_type, ops_item_id, resource_type, resource_uri)
associate_ops_item_related_item(association_type, ops_item_id, resource_type, resource_uri, params::Dict{String,<:Any})

Associates a related resource to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager is a capability of AWS Systems Manager.

Arguments

• 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: The ID of the OpsItem to which you want to associate a resource as a related item.
• 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. Incident Manager is a capability of AWS Systems Manager. AWS::SSM::Document: a Systems Manager (SSM) document.
• resource_uri: The Amazon Resource Name (ARN) of the AWS resource that you want to associate with the OpsItem.

cancel_command(command_id)
cancel_command(command_id, params::Dict{String,<:Any})

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

Arguments

• command_id: The ID of the command you want to cancel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "InstanceIds": (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

cancel_maintenance_window_execution(window_execution_id)
cancel_maintenance_window_execution(window_execution_id, params::Dict{String,<:Any})

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)

Arguments

• window_execution_id: The ID of the maintenance window execution to stop.

create_activation(iam_role)
create_activation(iam_role, params::Dict{String,<:Any})

Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide. On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.

Arguments

• iam_role: The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DefaultInstanceName": The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources. Do not enter personally identifiable information in this field.
• "Description": A user-defined description of the resource that you want to register with Systems Manager. Do not enter personally identifiable information in this field.
• "ExpirationDate": The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.
• "RegistrationLimit": Specify the maximum number of managed instances you want to register. The default value is 1 instance.
• "Tags": 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 name/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 and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

create_association(name)
create_association(name, params::Dict{String,<:Any})

A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.

Arguments

• name: The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-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 AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:partition:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ApplyOnlyAtCronInterval": By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
• "AssociationName": Specify a descriptive name for the association.
• "AutomationTargetParameterName": Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
• "CalendarNames": The names or Amazon Resource Names (ARNs) of the Systems Manager 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 AWS Systems Manager Change Calendar.
• "ComplianceSeverity": The severity level to assign to the association.
• "DocumentVersion": The document version you want to associate with the target(s). Can be a specific version or the default version.
• "InstanceId": The instance ID. InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
• "MaxConcurrency": 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
• "MaxErrors": The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set 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.
• "OutputLocation": An S3 bucket where you want to store the output details of the request.
• "Parameters": The parameters for the runtime configuration of the document.
• "ScheduleExpression": A cron expression when the association will be applied to the target(s).
• "SyncCompliance": 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action. By default, all associations use AUTO mode.
• "TargetLocations": A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
• "Targets": The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

create_association_batch(entries)
create_association_batch(entries, params::Dict{String,<:Any})

Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

Arguments

• entries: One or more associations.

create_document(content, name)
create_document(content, name, params::Dict{String,<:Any})

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

Arguments

• content: The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command. For examples, see the following topics in the AWS Systems Manager User Guide. Create an SSM document (AWS API) Create an SSM document (AWS CLI) Create an SSM document (API)
• name: A name for the Systems Manager document. You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: aws- amazon amzn

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Attachments": A list of key and value pairs that describe attachments to a version of a document.
• "DisplayName": An optional field where you can specify a friendly name for the Systems Manager document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument action.
• "DocumentFormat": Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
• "DocumentType": The type of document to create.
• "Requires": A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
• "Tags": 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 name/value pairs: Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing SSM document, use the AddTagsToResource action.
• "TargetType": 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 AWS resource and property types reference in the AWS CloudFormation User Guide.
• "VersionName": An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

create_maintenance_window(allow_unassociated_targets, cutoff, duration, name, schedule)
create_maintenance_window(allow_unassociated_targets, cutoff, duration, name, schedule, params::Dict{String,<:Any})

Creates a new maintenance window. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Arguments

• allow_unassociated_targets: Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window. If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.
• cutoff: The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
• duration: The duration of the maintenance window in hours.
• name: The name of the maintenance window.
• schedule: The schedule of the maintenance window in the form of a cron or rate expression.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": User-provided idempotency token.
• "Description": An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
• "EndDate": 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.
• "ScheduleOffset": 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.
• "ScheduleTimezone": 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.
• "StartDate": 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.
• "Tags": 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 name/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 action.

create_ops_item(description, source, title)
create_ops_item(description, source, title, params::Dict{String,<:Any})

Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Arguments

• description: Information about the OpsItem.
• 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.
• title: A short heading that describes the nature of the OpsItem and the impacted resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ActualEndTime": The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
• "ActualStartTime": The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
• "Category": Specify a category to assign to an OpsItem.
• "Notifications": The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
• "OperationalData": 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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action). 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 AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
• "OpsItemType": The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.
• "PlannedEndTime": The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
• "PlannedStartTime": The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
• "Priority": The importance of this OpsItem in relation to other OpsItems in the system.
• "RelatedOpsItems": 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.
• "Severity": Specify a severity to assign to an OpsItem.
• "Tags": Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide. Tags use a key-value pair. For example: Key=Department,Value=Finance To add tags to an existing OpsItem, use the AddTagsToResource action.

create_ops_metadata(resource_id)
create_ops_metadata(resource_id, params::Dict{String,<:Any})

If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.

Arguments

• resource_id: A resource ID for a new Application Manager application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Metadata": Metadata for a new Application Manager application.
• "Tags": 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 AWS Region. In this case, you could specify the following key-value pairs: Key=Environment,Value=Production Key=Region,Value=us-east-2

create_patch_baseline(name)
create_patch_baseline(name, params::Dict{String,<:Any})

Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Arguments

• name: The name of the patch baseline.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ApprovalRules": A set of rules used to include patches in the baseline.
• "ApprovedPatches": A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
• "ApprovedPatchesComplianceLevel": Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED.
• "ApprovedPatchesEnableNonSecurity": Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
• "ClientToken": User-provided idempotency token.
• "Description": A description of the patch baseline.
• "GlobalFilters": A set of global filters used to include patches in the baseline.
• "OperatingSystem": Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
• "RejectedPatches": A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
• "RejectedPatchesAction": The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOWASDEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
• "Sources": Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.
• "Tags": 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 name/value pairs: Key=PatchSeverity,Value=Critical Key=OS,Value=Windows To add tags to an existing patch baseline, use the AddTagsToResource action.

create_resource_data_sync(sync_name)
create_resource_data_sync(sync_name, params::Dict{String,<:Any})

A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide. You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization by using AWS Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager User Guide. A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

Arguments

• sync_name: A name for the configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "S3Destination": Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.
• "SyncSource": Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.
• "SyncType": 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 AWS accounts and Regions, as listed in AWS Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

delete_activation(activation_id)
delete_activation(activation_id, params::Dict{String,<:Any})

Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

Arguments

• activation_id: The ID of the activation that you want to delete.

delete_association()
delete_association(params::Dict{String,<:Any})

Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AssociationId": The association ID that you want to delete.
• "InstanceId": The ID of the instance.
• "Name": The name of the Systems Manager document.

delete_document(name)
delete_document(name, params::Dict{String,<:Any})

Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Arguments

• name: The name of the document.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DocumentVersion": The version of the document that you want to delete. If not provided, all versions of the document are deleted.
• "Force": 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 AWS Identity and Access Management (IAM) policy.
• "VersionName": The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

delete_inventory(type_name)
delete_inventory(type_name, params::Dict{String,<:Any})

Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": User-provided idempotency token.
• "DryRun": 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.
• "SchemaDeleteOption": 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 action 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.

delete_maintenance_window(window_id)
delete_maintenance_window(window_id, params::Dict{String,<:Any})

Deletes a maintenance window.

Arguments

• window_id: The ID of the maintenance window to delete.

delete_ops_metadata(ops_metadata_arn)
delete_ops_metadata(ops_metadata_arn, params::Dict{String,<:Any})

Delete OpsMetadata related to an application.

Arguments

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

delete_parameter(name)
delete_parameter(name, params::Dict{String,<:Any})

Delete a parameter from the system.

Arguments

• name: The name of the parameter to delete.

delete_parameters(names)
delete_parameters(names, params::Dict{String,<:Any})

Delete a list of parameters.

Arguments

• names: The names of the parameters to delete.

delete_patch_baseline(baseline_id)
delete_patch_baseline(baseline_id, params::Dict{String,<:Any})

Deletes a patch baseline.

Arguments

• baseline_id: The ID of the patch baseline to delete.

delete_resource_data_sync(sync_name)
delete_resource_data_sync(sync_name, params::Dict{String,<:Any})

Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.

Arguments

• sync_name: The name of the configuration to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "SyncType": Specify the type of resource data sync to delete.

deregister_managed_instance(instance_id)
deregister_managed_instance(instance_id, params::Dict{String,<:Any})

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

Arguments

• instance_id: The ID assigned to the managed instance when you registered it using the activation process.

deregister_patch_baseline_for_patch_group(baseline_id, patch_group)
deregister_patch_baseline_for_patch_group(baseline_id, patch_group, params::Dict{String,<:Any})

Removes a patch group from a patch baseline.

Arguments

• baseline_id: The ID of the patch baseline to deregister the patch group from.
• patch_group: The name of the patch group that should be deregistered from the patch baseline.

deregister_target_from_maintenance_window(window_id, window_target_id)
deregister_target_from_maintenance_window(window_id, window_target_id, params::Dict{String,<:Any})

Removes a target from a maintenance window.

Arguments

• window_id: The ID of the maintenance window the target should be removed from.
• window_target_id: The ID of the target definition to remove.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Safe": The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the maintenance window.

deregister_task_from_maintenance_window(window_id, window_task_id)
deregister_task_from_maintenance_window(window_id, window_task_id, params::Dict{String,<:Any})

Removes a task from a maintenance window.

Arguments

• window_id: The ID of the maintenance window the task should be removed from.
• window_task_id: The ID of the task to remove from the maintenance window.

describe_activations()
describe_activations(params::Dict{String,<:Any})

Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": A filter to view information about your activations.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

describe_association()
describe_association(params::Dict{String,<:Any})

Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AssociationId": The association ID for which you want information.
• "AssociationVersion": 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 an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.
• "InstanceId": The instance ID.
• "Name": The name of the Systems Manager document.

describe_association_execution_targets(association_id, execution_id)
describe_association_execution_targets(association_id, execution_id, params::Dict{String,<:Any})

Use this API action to view information about a specific execution of a specific association.

Arguments

• association_id: The association ID that includes the execution for which you want to view details.
• execution_id: The execution ID for which you want to view details.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Filters for the request. You can specify the following filters and values. Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL)
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

describe_association_executions(association_id)
describe_association_executions(association_id, params::Dict{String,<:Any})

Use this API action to view all executions for a specific association ID.

Arguments

• association_id: The association ID for which you want to view execution history details.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Filters for the request. You can specify the following filters and values. ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATERTHAN, LESSTHAN)
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

describe_automation_executions()
describe_automation_executions(params::Dict{String,<:Any})

Provides details about all active and terminated Automation executions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Filters used to limit the scope of executions that are requested.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_automation_step_executions(automation_execution_id)
describe_automation_step_executions(automation_execution_id, params::Dict{String,<:Any})

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

Arguments

• automation_execution_id: The Automation execution ID for which you want step execution descriptions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more filters to limit the number of step executions returned by the request.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "ReverseOrder": Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

describe_available_patches()
describe_available_patches(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Filters used to scope down the returned patches.
• "MaxResults": The maximum number of patches to return (per page).
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_document(name)
describe_document(name, params::Dict{String,<:Any})

Describes the specified Systems Manager document.

Arguments

• name: The name of the Systems Manager document.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DocumentVersion": The document version for which you want information. Can be a specific version or the default version.
• "VersionName": An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

describe_document_permission(name, permission_type)
describe_document_permission(name, permission_type, params::Dict{String,<:Any})

Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).

Arguments

• name: The name of the document for which you are the owner.
• permission_type: The permission type for the document. The permission type can be Share.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_effective_instance_associations(instance_id)
describe_effective_instance_associations(instance_id, params::Dict{String,<:Any})

All associations for the instance(s).

Arguments

• instance_id: The instance ID for which you want to view all associations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_effective_patches_for_patch_baseline(baseline_id)
describe_effective_patches_for_patch_baseline(baseline_id, params::Dict{String,<:Any})

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.

Arguments

• baseline_id: The ID of the patch baseline to retrieve the effective patches for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of patches to return (per page).
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_instance_associations_status(instance_id)
describe_instance_associations_status(instance_id, params::Dict{String,<:Any})

The status of the associations for the instance(s).

Arguments

• instance_id: The instance IDs for which you want association status information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_instance_information()
describe_instance_information(params::Dict{String,<:Any})

Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more filters. Use a filter to return a more specific list of instances. You can filter based on tags applied to EC2 instances. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated.
• "InstanceInformationFilterList": 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 instance information by filtering based on tags applied to managed instances. Attempting to use InstanceInformationFilterList and Filters leads to an exception error.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_instance_patch_states(instance_ids)
describe_instance_patch_states(instance_ids, params::Dict{String,<:Any})

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

Arguments

• instance_ids: The ID of the instance whose patch state information should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of instances to return (per page).
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_instance_patch_states_for_patch_group(patch_group)
describe_instance_patch_states_for_patch_group(patch_group, params::Dict{String,<:Any})

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

Arguments

• patch_group: The name of the patch group for which the patch state information should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": 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")
• "MaxResults": The maximum number of patches to return (per page).
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_instance_patches(instance_id)
describe_instance_patches(instance_id, params::Dict{String,<:Any})

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

Arguments

• instance_id: The ID of the instance whose patch state information should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": An array of structures. Each entry in the array is a structure containing a Key, Value combination. Valid values for Key are Classification | KBId | Severity | State.
• "MaxResults": The maximum number of patches to return (per page).
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_inventory_deletions()
describe_inventory_deletions(params::Dict{String,<:Any})

Describes a specific delete inventory operation.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeletionId": Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

describe_maintenance_window_execution_task_invocations(task_id, window_execution_id)
describe_maintenance_window_execution_task_invocations(task_id, window_execution_id, params::Dict{String,<:Any})

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

Arguments

• task_id: The ID of the specific task in the maintenance window task that should be retrieved.
• window_execution_id: The ID of the maintenance window execution the task is part of.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, INPROGRESS, SUCCESS, FAILED, TIMEDOUT, CANCELLING, and CANCELLED.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_maintenance_window_execution_tasks(window_execution_id)
describe_maintenance_window_execution_tasks(window_execution_id, params::Dict{String,<:Any})

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

Arguments

• window_execution_id: The ID of the maintenance window execution whose task executions should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, INPROGRESS, SUCCESS, FAILED, TIMEDOUT, CANCELLING, and CANCELLED.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_maintenance_window_executions(window_id)
describe_maintenance_window_executions(window_id, params::Dict{String,<:Any})

Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

Arguments

• window_id: The ID of the maintenance window whose executions should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string is between 1 and 256 characters) The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_maintenance_window_schedule()
describe_maintenance_window_schedule(params::Dict{String,<:Any})

Retrieves information about upcoming executions of a maintenance window.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "ResourceType": The type of resource you want to retrieve information about. For example, "INSTANCE".
• "Targets": The instance ID or key/value pair to retrieve information about.
• "WindowId": The ID of the maintenance window to retrieve information about.

describe_maintenance_window_targets(window_id)
describe_maintenance_window_targets(window_id, params::Dict{String,<:Any})

Lists the targets registered with the maintenance window.

Arguments

• window_id: The ID of the maintenance window whose targets should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_maintenance_window_tasks(window_id)
describe_maintenance_window_tasks(window_id, params::Dict{String,<:Any})

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

Arguments

• window_id: The ID of the maintenance window whose tasks should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_maintenance_windows()
describe_maintenance_windows(params::Dict{String,<:Any})

Retrieves the maintenance windows in an AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_maintenance_windows_for_target(resource_type, targets)
describe_maintenance_windows_for_target(resource_type, targets, params::Dict{String,<:Any})

Retrieves information about the maintenance window targets or tasks that an instance is associated with.

Arguments

• resource_type: The type of resource you want to retrieve information about. For example, "INSTANCE".
• targets: The instance ID or key/value pair to retrieve information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_ops_items()
describe_ops_items(params::Dict{String,<:Any})

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.
• "OpsItemFilters": 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: 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 *If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"keyname","value":"avalue"}

describe_parameters()
describe_parameters(params::Dict{String,<:Any})

Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": This data type is deprecated. Instead, use ParameterFilters.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "ParameterFilters": Filters to limit the request results.

describe_patch_baselines()
describe_patch_baselines(params::Dict{String,<:Any})

Lists the patch baselines in your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": Each element in the array is a structure containing: Key: (string, "NAME_PREFIX" or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255 characters)
• "MaxResults": The maximum number of patch baselines to return (per page).
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_patch_group_state(patch_group)
describe_patch_group_state(patch_group, params::Dict{String,<:Any})

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

Arguments

• patch_group: The name of the patch group whose patch snapshot should be retrieved.

describe_patch_groups()
describe_patch_groups(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more filters. Use a filter to return a more specific list of results. For DescribePatchGroups,valid filter keys include the following: NAMEPREFIX: The name of the patch group. Wildcards (*) are accepted. OPERATINGSYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequestOperatingSystem in CreatePatchBaseline. Examples: –filters Key=NAMEPREFIX,Values=MyPatchGroup* –filters Key=OPERATINGSYSTEM,Values=AMAZONLINUX2
• "MaxResults": The maximum number of patch groups to return (per page).
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

describe_patch_properties(operating_system, property)
describe_patch_properties(operating_system, property, params::Dict{String,<:Any})

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines. The following section lists the properties that can be used in filters for each major operating system type: AMAZONLINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY AMAZONLINUX2 Valid properties: PRODUCT, CLASSIFICATION, SEVERITY CENTOS Valid properties: PRODUCT, CLASSIFICATION, SEVERITY DEBIAN Valid properties: PRODUCT, PRIORITY MACOS Valid properties: PRODUCT, CLASSIFICATION ORACLELINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY REDHATENTERPRISELINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY SUSE Valid properties: PRODUCT, CLASSIFICATION, SEVERITY UBUNTU Valid properties: PRODUCT, PRIORITY WINDOWS Valid properties: PRODUCT, PRODUCTFAMILY, CLASSIFICATION, MSRCSEVERITY

Arguments

• operating_system: The operating system type for which to list patches.
• property: The patch property for which you want to view patch details.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "PatchSet": Indicates whether to list patches for the Windows operating system or for Microsoft applications. Not applicable for the Linux or macOS operating systems.

describe_sessions(state)
describe_sessions(state, params::Dict{String,<:Any})

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

Arguments

• state: The session status to retrieve a list of sessions for. For example, "Active".

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more filters to limit the type of sessions returned by the request.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

disassociate_ops_item_related_item(association_id, ops_item_id)
disassociate_ops_item_related_item(association_id, ops_item_id, params::Dict{String,<:Any})

Deletes the association between an OpsItem and a related resource. For example, this API action can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of AWS Systems Manager.

Arguments

• association_id: The ID of the association for which you want to delete an association between the OpsItem and a related resource.
• ops_item_id: The ID of the OpsItem for which you want to delete an association between the OpsItem and a related resource.

get_automation_execution(automation_execution_id)
get_automation_execution(automation_execution_id, params::Dict{String,<:Any})

Get detailed information about a particular Automation execution.

Arguments

• 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 document is initiated.

get_calendar_state(calendar_names)
get_calendar_state(calendar_names, params::Dict{String,<:Any})

Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, GetCalendarState returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, GetCalendarState assumes the current time. Change Calendar entries have two possible states: OPEN or CLOSED. If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED. For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.

Arguments

• calendar_names: The names or Amazon Resource Names (ARNs) of the Systems Manager documents that represent the calendar entries for which you want to get the state.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AtTime": (Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you do not add AtTime, the current time is assumed.

get_command_invocation(command_id, instance_id)
get_command_invocation(command_id, instance_id, params::Dict{String,<:Any})

Returns detailed information about command execution for an invocation or plugin. GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific instance, use ListCommandInvocations. To get the command execution status across instances, use ListCommands.

Arguments

• command_id: (Required) The parent command ID of the invocation plugin.
• instance_id: (Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for AWS Systems Manager.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "PluginName": The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details. Plugin names are also referred to as step names in Systems Manager documents. For example, aws:RunShellScript is a plugin. To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

get_connection_status(target)
get_connection_status(target, params::Dict{String,<:Any})

Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.

Arguments

• target: The ID of the instance.

get_default_patch_baseline()
get_default_patch_baseline(params::Dict{String,<:Any})

Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "OperatingSystem": Returns the default patch baseline for the specified operating system.

get_deployable_patch_snapshot_for_instance(instance_id, snapshot_id)
get_deployable_patch_snapshot_for_instance(instance_id, snapshot_id, params::Dict{String,<:Any})

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.

Arguments

• instance_id: The ID of the instance for which the appropriate patch snapshot should be retrieved.
• snapshot_id: The user-defined snapshot ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "BaselineOverride": Defines the basic information about a patch baseline override.

get_document(name)
get_document(name, params::Dict{String,<:Any})

Gets the contents of the specified Systems Manager document.

Arguments

• name: The name of the Systems Manager document.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DocumentFormat": Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.
• "DocumentVersion": The document version for which you want information.
• "VersionName": An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

get_inventory()
get_inventory(params::Dict{String,<:Any})

Query inventory information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Aggregators": 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 instances exist in your inventoried fleet.
• "Filters": One or more filters. Use a filter to return a more specific list of results.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "ResultAttributes": The list of inventory item types to return.

get_inventory_schema()
get_inventory_schema(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Aggregator": 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.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "SubType": Returns the sub-type schema for a specified inventory type.
• "TypeName": The type of inventory item to return.

get_maintenance_window(window_id)
get_maintenance_window(window_id, params::Dict{String,<:Any})

Retrieves a maintenance window.

Arguments

• window_id: The ID of the maintenance window for which you want to retrieve information.

get_maintenance_window_execution(window_execution_id)
get_maintenance_window_execution(window_execution_id, params::Dict{String,<:Any})

Retrieves details about a specific a maintenance window execution.

Arguments

• window_execution_id: The ID of the maintenance window execution that includes the task.

get_maintenance_window_execution_task(task_id, window_execution_id)
get_maintenance_window_execution_task(task_id, window_execution_id, params::Dict{String,<:Any})

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

Arguments

• task_id: The ID of the specific task execution in the maintenance window task that should be retrieved.
• window_execution_id: The ID of the maintenance window execution that includes the task.

get_maintenance_window_execution_task_invocation(invocation_id, task_id, window_execution_id)
get_maintenance_window_execution_task_invocation(invocation_id, task_id, window_execution_id, params::Dict{String,<:Any})

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

Arguments

• invocation_id: The invocation ID to retrieve.
• task_id: The ID of the specific task in the maintenance window task that should be retrieved.
• window_execution_id: The ID of the maintenance window execution for which the task is a part.

get_maintenance_window_task(window_id, window_task_id)
get_maintenance_window_task(window_id, window_task_id, params::Dict{String,<:Any})

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

Arguments

• window_id: The maintenance window ID that includes the task to retrieve.
• window_task_id: The maintenance window task ID to retrieve.

get_ops_item(ops_item_id)
get_ops_item(ops_item_id, params::Dict{String,<:Any})

Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Arguments

• ops_item_id: The ID of the OpsItem that you want to get.

get_ops_metadata(ops_metadata_arn)
get_ops_metadata(ops_metadata_arn, params::Dict{String,<:Any})

View operational metadata related to an application in Application Manager.

Arguments

• ops_metadata_arn: The Amazon Resource Name (ARN) of an OpsMetadata Object to view.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

get_ops_summary()
get_ops_summary(params::Dict{String,<:Any})

View a summary of OpsItems based on specified filters and aggregators.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Aggregators": Optional aggregators that return counts of OpsItems based on one or more expressions.
• "Filters": Optional filters used to scope down the returned OpsItems.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.
• "ResultAttributes": The OpsItem data type to return.
• "SyncName": Specify the name of a resource data sync to get.

get_parameter(name)
get_parameter(name, params::Dict{String,<:Any})

Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.

Arguments

• name: The name of the parameter you want to query.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "WithDecryption": Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

get_parameter_history(name)
get_parameter_history(name, params::Dict{String,<:Any})

Retrieves the history of all changes to a parameter.

Arguments

• name: The name of the parameter for which you want to review history.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "WithDecryption": Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

get_parameters(names)
get_parameters(names, params::Dict{String,<:Any})

Get details of a parameter. Don't confuse this API action with the GetParameter API action.

Arguments

• names: Names of the parameters for which you want to query information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "WithDecryption": Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

get_parameters_by_path(path)
get_parameters_by_path(path, params::Dict{String,<:Any})

Retrieve information about one or more parameters in a specific hierarchy. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Arguments

• path: The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot 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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.
• "ParameterFilters": Filters to limit the request results. For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType. The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.
• "Recursive": 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 action recursively for /a and view /a/b.
• "WithDecryption": Retrieve all parameters in a hierarchy with their value decrypted.

get_patch_baseline(baseline_id)
get_patch_baseline(baseline_id, params::Dict{String,<:Any})

Retrieves information about a patch baseline.

Arguments

• baseline_id: The ID of the patch baseline to retrieve.

get_patch_baseline_for_patch_group(patch_group)
get_patch_baseline_for_patch_group(patch_group, params::Dict{String,<:Any})

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

Arguments

• patch_group: The name of the patch group whose patch baseline should be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "OperatingSystem": Returns he operating system rule specified for patch groups using the patch baseline.

get_service_setting(setting_id)
get_service_setting(setting_id, params::Dict{String,<:Any})

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS 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. AWS 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 action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Query the current service setting for the account.

Arguments

• setting_id: The ID of the service setting to get. The setting ID can be /ssm/automation/customer-script-log-destination, /ssm/automation/customer-script-log-group-name, /ssm/parameter-store/default-parameter-tier, /ssm/parameter-store/high-throughput-enabled, or /ssm/managed-instance/activation-tier.

label_parameter_version(labels, name)
label_parameter_version(labels, name, params::Dict{String,<:Any})

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions. A version of a parameter can have a maximum of 10 labels. You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2. You can move a label from one version of a parameter to another. You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter. If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter. A label can have a maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_). Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.

Arguments

• labels: One or more labels to attach to the specified parameter version.
• name: The parameter name on which you want to attach one or more labels.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ParameterVersion": 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.

list_association_versions(association_id)
list_association_versions(association_id, params::Dict{String,<:Any})

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

Arguments

• association_id: The association ID for which you want to view all versions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

list_associations()
list_associations(params::Dict{String,<:Any})

Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AssociationFilterList": 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 instance that are part of the Target Attributes ResourceGroup or Tags are not returned.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

list_command_invocations()
list_command_invocations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "CommandId": (Optional) The invocations for a specific command ID.
• "Details": (Optional) If set this returns the response of the command executions and any command output. The default value is 'false'.
• "Filters": (Optional) One or more filters. Use a filter to return a more specific list of results.
• "InstanceId": (Optional) The command execution details for a specific instance ID.
• "MaxResults": (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.
• "NextToken": (Optional) The token for the next set of items to return. (You received this token from a previous call.)

list_commands()
list_commands(params::Dict{String,<:Any})

Lists the commands requested by users of the AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "CommandId": (Optional) If provided, lists only the specified command.
• "Filters": (Optional) One or more filters. Use a filter to return a more specific list of results.
• "InstanceId": (Optional) Lists commands issued against this instance ID. You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command has not reached the instance yet.
• "MaxResults": (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.
• "NextToken": (Optional) The token for the next set of items to return. (You received this token from a previous call.)

list_compliance_items()
list_compliance_items(params::Dict{String,<:Any})

For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more compliance filters. Use a filter to return a more specific list of results.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.
• "ResourceIds": The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.
• "ResourceTypes": The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

list_compliance_summaries()
list_compliance_summaries(params::Dict{String,<:Any})

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more compliance or inventory filters. Use a filter to return a more specific list of results.
• "MaxResults": 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.
• "NextToken": A token to start the list. Use this token to get the next set of results.

list_document_metadata_history(metadata, name)
list_document_metadata_history(metadata, name, params::Dict{String,<:Any})

Information about approval reviews for a version of an SSM document.

Arguments

• metadata: The type of data for which details are being requested. Currently, the only supported value is DocumentReviews.
• name: The name of the document.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DocumentVersion": The version of the document.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

list_document_versions(name)
list_document_versions(name, params::Dict{String,<:Any})

List all versions for a document.

Arguments

• name: The name of the document. You can specify an Amazon Resource Name (ARN).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

list_documents()
list_documents(params::Dict{String,<:Any})

Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DocumentFilterList": This data type is deprecated. Instead, use Filters.
• "Filters": 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 action only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

list_inventory_entries(instance_id, type_name)
list_inventory_entries(instance_id, type_name, params::Dict{String,<:Any})

A list of inventory items returned by the request.

Arguments

• instance_id: The instance ID for which you want inventory information.
• type_name: The type of inventory item for which you want information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more filters. Use a filter to return a more specific list of results.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)

list_ops_item_events()
list_ops_item_events(params::Dict{String,<:Any})

Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more OpsItem filters. Use a filter to return a more specific list of results.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

list_ops_item_related_items()
list_ops_item_related_items(params::Dict{String,<:Any})

Lists all related-item resources associated with an OpsItem.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more OpsItem filters. Use a filter to return a more specific list of results.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": The token for the next set of items to return. (You received this token from a previous call.)
• "OpsItemId": The ID of the OpsItem for which you want to list all related-item resources.

list_ops_metadata()
list_ops_metadata(params::Dict{String,<:Any})

Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more filters to limit the number of OpsMetadata objects returned by the call.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

list_resource_compliance_summaries()
list_resource_compliance_summaries(params::Dict{String,<:Any})

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Filters": One or more filters. Use a filter to return a more specific list of results.
• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.

list_resource_data_sync()
list_resource_data_sync(params::Dict{String,<:Any})

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• "NextToken": A token to start the list. Use this token to get the next set of results.
• "SyncType": 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 AWS Organizations or from multiple AWS Regions.

list_tags_for_resource(resource_id, resource_type)
list_tags_for_resource(resource_id, resource_type, params::Dict{String,<:Any})

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

Arguments

• resource_id: The resource ID for which you want to see a list of tags.
• resource_type: Returns a list of tags for a specific resource type.

modify_document_permission(name, permission_type)
modify_document_permission(name, permission_type, params::Dict{String,<:Any})

Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Arguments

• name: The name of the document that you want to share.
• permission_type: The permission type for the document. The permission type can be Share.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AccountIdsToAdd": The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
• "AccountIdsToRemove": The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
• "SharedDocumentVersion": (Optional) The version of the document to share. If it's not specified, the system choose the Default version to share.

put_compliance_items(compliance_type, execution_summary, items, resource_id, resource_type)
put_compliance_items(compliance_type, execution_summary, items, resource_id, resource_type, params::Dict{String,<:Any})

Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following: ExecutionId: The execution ID when the patch, association, or custom compliance item was applied. ExecutionType: Specify patch, association, or Custom:string. ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance. Id: The patch, association, or custom compliance ID. Title: A title. Status: The status of the compliance item. For example, approved for patches, or Failed for associations. Severity: A patch severity. For example, critical. DocumentName: A SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document version number. For example, 4. Classification: A patch classification. For example, security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch severity. For example, Critical. PatchState: A patch state. For example, InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

Arguments

• compliance_type: Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.
• 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'.
• items: 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.
• resource_id: Specify an ID for this resource. For a managed instance, this is the instance ID.
• resource_type: Specify the type of resource. ManagedInstance is currently the only supported resource type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ItemContentHash": MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.
• "UploadType": 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.

put_inventory(instance_id, items)
put_inventory(instance_id, items, params::Dict{String,<:Any})

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

Arguments

• instance_id: An instance ID where you want to add or update inventory items.
• items: The inventory items that you want to add or update on instances.

put_parameter(name, value)
put_parameter(name, value, params::Dict{String,<:Any})

Add a parameter to the system.

Arguments

• name: The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13 Naming Constraints: Parameter names are case sensitive. A parameter name must be unique within an AWS 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 AWS Systems Manager User Guide. The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName
• 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 {{}} or {{ssm:parameter-name}} in a parameter value.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AllowedPattern": 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+
• "DataType": The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs. The following data type values are supported. text aws:ec2:image When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.
• "Description": Information about the parameter that you want to add to the system. Optional but recommended. Do not enter personally identifiable information in this field.
• "KeyId": The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. 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 AWS account. To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key. To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
• "Overwrite": Overwrite an existing parameter. The default value is 'false'.
• "Policies": One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store 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 does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter. ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours. NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not 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 has not 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.
• "Tags": 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 name/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 action.
• "Tier": 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 AWS 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 AWS account. Advanced parameters incur a charge. For more information, see Standard and advanced parameter tiers in the AWS 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 do not 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 AWS account in the current Region. For more information about configuring the default tier option, see Specifying a default parameter tier in the AWS Systems Manager User Guide.
• "Type": The type of parameter that you want to add to the system. SecureString is not currently supported for AWS 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 is not required when updating a parameter. You must specify a parameter type when creating a parameter.

register_default_patch_baseline(baseline_id)
register_default_patch_baseline(baseline_id, params::Dict{String,<:Any})

Defines the default patch baseline for the relevant operating system. To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

Arguments

• baseline_id: The ID of the patch baseline that should be the default patch baseline.

register_patch_baseline_for_patch_group(baseline_id, patch_group)
register_patch_baseline_for_patch_group(baseline_id, patch_group, params::Dict{String,<:Any})

Registers a patch baseline for a patch group.

Arguments

• baseline_id: The ID of the patch baseline to register the patch group with.
• patch_group: The name of the patch group that should be registered with the patch baseline.

register_target_with_maintenance_window(resource_type, targets, window_id)
register_target_with_maintenance_window(resource_type, targets, window_id, params::Dict{String,<:Any})

Registers a target with a maintenance window.

Arguments

• resource_type: The type of target being registered with the maintenance window.
• targets: The targets to register with the maintenance window. In other words, the instances 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 instance IDs, resource group names, or tags that have been applied to instances. Example 1: Specify instance IDs Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 Example 2: Use tag key-pairs applied to instances Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2 Example 3: Use tag-keys applied to instances Key=tag-key,Values=my-tag-key-1,my-tag-key-2 Example 4: Use resource group names Key=resource-groups:Name,Values=resource-group-name Example 5: Use filters for resource group types Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2 For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the AWS Systems Manager User Guide.
• window_id: The ID of the maintenance window the target should be registered with.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": User-provided idempotency token.
• "Description": An optional description for the target.
• "Name": An optional name for the target.
• "OwnerInformation": User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

register_task_with_maintenance_window(task_arn, task_type, window_id)
register_task_with_maintenance_window(task_arn, task_type, window_id, params::Dict{String,<:Any})

Adds a new task to a maintenance window.

Arguments

• task_arn: The ARN of the task to run.
• task_type: The type of task being registered.
• window_id: The ID of the maintenance window the task should be added to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": User-provided idempotency token.
• "Description": An optional description for the task.
• "LoggingInfo": A structure containing information about an S3 bucket to write instance-level logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
• "MaxConcurrency": The maximum number of targets this task can be run for in parallel. For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
• "MaxErrors": The maximum number of errors allowed before this task stops being scheduled. For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
• "Name": An optional name for the task.
• "Priority": 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.
• "ServiceRoleArn": The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. For more information, see the following topics in the in the AWS Systems Manager User Guide: Using service-linked roles for Systems Manager Should I use a service-linked role or a custom service role to run maintenance window tasks?
• "Targets": The targets (either instances 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, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide. Specify instances using the following format: Key=InstanceIds,Values=<instance-id-1>,<instance-id-2> Specify maintenance window targets using the following format: Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
• "TaskInvocationParameters": The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
• "TaskParameters": 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.

remove_tags_from_resource(resource_id, resource_type, tag_keys)
remove_tags_from_resource(resource_id, resource_type, tag_keys, params::Dict{String,<:Any})

Removes tag keys from the specified resource.

Arguments

• resource_id: The ID of the resource from which you want to remove tags. For example: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-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 action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
• resource_type: The type of resource from which you want to remove a tag. The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
• tag_keys: Tag keys that you want to remove from the specified resource.

reset_service_setting(setting_id)
reset_service_setting(setting_id, params::Dict{String,<:Any})

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS 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. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting. Reset the service setting for the account to the default value as provisioned by the AWS service team.

Arguments

• setting_id: The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be /ssm/automation/customer-script-log-destination, /ssm/automation/customer-script-log-group-name, /ssm/parameter-store/default-parameter-tier, /ssm/parameter-store/high-throughput-enabled, or /ssm/managed-instance/activation-tier. For example, arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enable d.

resume_session(session_id)
resume_session(session_id, params::Dict{String,<:Any})

Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.

Arguments

• session_id: The ID of the disconnected session to resume.

send_automation_signal(automation_execution_id, signal_type)
send_automation_signal(automation_execution_id, signal_type, params::Dict{String,<:Any})

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

Arguments

• automation_execution_id: The unique identifier for an existing Automation execution that you want to send the signal to.
• signal_type: The type of signal to send to an Automation execution.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Payload": 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"

send_command(document_name)
send_command(document_name, params::Dict{String,<:Any})

Runs commands on one or more managed instances.

Arguments

• document_name: The name of the Systems Manager document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the AWS Systems Manager User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "CloudWatchOutputConfig": Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
• "Comment": User-specified information about the command, such as a brief description of what the command should do.
• "DocumentHash": The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
• "DocumentHashType": Sha256 or Sha1. Sha1 hashes have been deprecated.
• "DocumentVersion": 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 AWS 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"
• "InstanceIds": The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs. To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once. For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.
• "MaxConcurrency": (Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the AWS Systems Manager User Guide.
• "MaxErrors": 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 AWS Systems Manager User Guide.
• "NotificationConfig": Configurations for sending notifications.
• "OutputS3BucketName": The name of the S3 bucket where command execution responses should be stored.
• "OutputS3KeyPrefix": The directory structure within the S3 bucket where the responses should be stored.
• "OutputS3Region": (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
• "Parameters": The required and optional parameters specified in the document being run.
• "ServiceRoleArn": The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
• "Targets": An array of search criteria that targets instances 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 instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once. To send a command to a smaller number of instances, you can use the InstanceIds option instead. For more information about how to use targets, see Sending commands to a fleet in the AWS Systems Manager User Guide.
• "TimeoutSeconds": If this time is reached and the command has not already started running, it will not run.

start_associations_once(association_ids)
start_associations_once(association_ids, params::Dict{String,<:Any})

Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.

Arguments

• association_ids: The association IDs that you want to run immediately and only one time.

start_automation_execution(document_name)
start_automation_execution(document_name, params::Dict{String,<:Any})

Initiates execution of an Automation document.

Arguments

• document_name: The name of the Systems Manager document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the AWS Systems Manager User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientToken": User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
• "DocumentVersion": The version of the Automation document to use for this execution.
• "MaxConcurrency": The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
• "MaxErrors": 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.
• "Mode": The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
• "Parameters": A key-value map of execution parameters, which match the declared parameters in the Automation document.
• "Tags": 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 name/value pairs: Key=environment,Value=test Key=OS,Value=Windows To add tags to an existing patch baseline, use the AddTagsToResource action.
• "TargetLocations": A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.
• "TargetMaps": A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
• "TargetParameterName": The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
• "Targets": A key-value mapping to target resources. Required if you specify TargetParameterName.

start_change_request_execution(document_name, runbooks)
start_change_request_execution(document_name, runbooks, params::Dict{String,<:Any})

Creates a change request for Change Manager. The runbooks (Automation documents) specified in the change request run only after all required approvals for the change request have been received.

Arguments

• document_name: The name of the change template document to run during the runbook workflow.
• runbooks: Information about the Automation runbooks (Automation documents) 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ChangeDetails": 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.
• "ChangeRequestName": The name of the change request associated with the runbook workflow to be run.
• "ClientToken": The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
• "DocumentVersion": The version of the change template document to run during the runbook workflow.
• "Parameters": A key-value map of parameters that match the declared parameters in the change template document.
• "ScheduledEndTime": 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.
• "ScheduledTime": 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.
• "Tags": 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 AWS Region. In this case, you could specify the following key-value pairs: Key=Environment,Value=Production Key=Region,Value=us-east-2

start_session(target)
start_session(target, params::Dict{String,<:Any})

Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide. AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.

Arguments

• target: The instance to connect to for the session.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DocumentName": The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.
• "Parameters": Reserved for future use.

stop_automation_execution(automation_execution_id)
stop_automation_execution(automation_execution_id, params::Dict{String,<:Any})

Stop an Automation that is currently running.

Arguments

• automation_execution_id: The execution ID of the Automation to stop.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Type": The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.

terminate_session(session_id)
terminate_session(session_id, params::Dict{String,<:Any})

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.

Arguments

• session_id: The ID of the session to terminate.

unlabel_parameter_version(labels, name, parameter_version)
unlabel_parameter_version(labels, name, parameter_version, params::Dict{String,<:Any})

Remove a label or labels from a parameter.

Arguments

• labels: One or more labels to delete from the specified parameter version.
• name: The parameter name of which you want to delete one or more labels.
• parameter_version: The specific version of the parameter which you want to delete one or more labels from. If it is not present, the call will fail.

update_association(association_id)
update_association(association_id, params::Dict{String,<:Any})

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <userarn> is not authorized to perform: ssm:DescribeAssociation on resource: <resourcearn> When you update an association, the association immediately runs against the specified targets.

Arguments

• association_id: The ID of the association you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ApplyOnlyAtCronInterval": By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter is not supported for rate expressions. Also, if you specified this option when you created the association, you can reset it. 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.
• "AssociationName": The name of the association that you want to update.
• "AssociationVersion": This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify LATEST, or omit this parameter.
• "AutomationTargetParameterName": Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
• "CalendarNames": The names or Amazon Resource Names (ARNs) of the Systems Manager 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 AWS Systems Manager Change Calendar.
• "ComplianceSeverity": The severity level to assign to the association.
• "DocumentVersion": The document version you want update for the association.
• "MaxConcurrency": 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
• "MaxErrors": The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set 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.
• "Name": The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. You can specify AWS-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 AWS accounts, you must specify the complete SSM document ARN, in the following format: arn:aws:ssm:region:account-id:document/document-name For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For AWS-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.
• "OutputLocation": An S3 bucket where you want to store the results of this request.
• "Parameters": The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
• "ScheduleExpression": The cron expression used to schedule the association that you want to update.
• "SyncCompliance": 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action. By default, all associations use AUTO mode.
• "TargetLocations": A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
• "Targets": The targets of the association.

update_association_status(association_status, instance_id, name)
update_association_status(association_status, instance_id, name, params::Dict{String,<:Any})

Updates the status of the Systems Manager document associated with the specified instance.

Arguments

• association_status: The association status.
• instance_id: The ID of the instance.
• name: The name of the Systems Manager document.

update_document(content, name)
update_document(content, name, params::Dict{String,<:Any})

Updates one or more values for an SSM document.

Arguments

• content: A valid JSON or YAML string.
• name: The name of the Systems Manager document that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Attachments": A list of key and value pairs that describe attachments to a version of a document.
• "DisplayName": The friendly name of the Systems Manager document that you want to update. This value can differ for each version of the document. If you do not specify a value for this parameter in your request, the existing value is applied to the new document version.
• "DocumentFormat": Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
• "DocumentVersion": 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.
• "TargetType": Specify a new target type for the document.
• "VersionName": An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

update_document_default_version(document_version, name)
update_document_default_version(document_version, name, params::Dict{String,<:Any})

Set the default version of a document.

Arguments

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

update_document_metadata(document_reviews, name)
update_document_metadata(document_reviews, name, params::Dict{String,<:Any})

Updates information related to approval reviews for a specific version of a document.

Arguments

• document_reviews: The document review details to update.
• name: The name of the document for which a version is to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DocumentVersion": The version of a document to update.

update_maintenance_window(window_id)
update_maintenance_window(window_id, params::Dict{String,<:Any})

Updates an existing maintenance window. Only specified parameters are modified. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Arguments

• window_id: The ID of the maintenance window to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AllowUnassociatedTargets": Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
• "Cutoff": The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
• "Description": An optional description for the update request.
• "Duration": The duration of the maintenance window in hours.
• "Enabled": Whether the maintenance window is enabled.
• "EndDate": 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.
• "Name": The name of the maintenance window.
• "Replace": If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
• "Schedule": The schedule of the maintenance window in the form of a cron or rate expression.
• "ScheduleOffset": 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.
• "ScheduleTimezone": 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.
• "StartDate": 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.

update_maintenance_window_target(window_id, window_target_id)
update_maintenance_window_target(window_id, window_target_id, params::Dict{String,<:Any})

Modifies the target of an existing maintenance window. You can change the following: Name Description Owner IDs for an ID target Tags for a Tag target From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target. If a parameter is null, then the corresponding field is not modified.

Arguments

• window_id: The maintenance window ID with which to modify the target.
• window_target_id: The target ID to modify.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": An optional description for the update.
• "Name": A name for the update.
• "OwnerInformation": User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.
• "Replace": If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
• "Targets": The targets to add or replace.

update_maintenance_window_task(window_id, window_task_id)
update_maintenance_window_task(window_id, window_task_id, params::Dict{String,<:Any})

Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide. If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field is not modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null. When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not 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.

Arguments

• window_id: The maintenance window ID that contains the task to modify.
• window_task_id: The task ID to modify.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Description": The new task description to specify.
• "LoggingInfo": The new logging location in Amazon S3 to specify. LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
• "MaxConcurrency": The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel. For maintenance window tasks without a target specified, you cannot 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 does not affect the running of your task and can be ignored.
• "MaxErrors": The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled. For maintenance window tasks without a target specified, you cannot 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 does not affect the running of your task and can be ignored.
• "Name": The new task name to specify.
• "Priority": The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
• "Replace": If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
• "ServiceRoleArn": The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. For more information, see the following topics in the in the AWS Systems Manager User Guide: Using service-linked roles for Systems Manager Should I use a service-linked role or a custom service role to run maintenance window tasks?
• "Targets": The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID1,instanceID2. Tags are specified using Key=tagname,Values=tagvalue. 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, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
• "TaskArn": The task ARN to modify.
• "TaskInvocationParameters": 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 do not 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.
• "TaskParameters": 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

update_managed_instance_role(iam_role, instance_id)
update_managed_instance_role(iam_role, instance_id, params::Dict{String,<:Any})

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

Arguments

• iam_role: The IAM role you want to assign or change.
• instance_id: The ID of the managed instance where you want to update the role.

update_ops_item(ops_item_id)
update_ops_item(ops_item_id, params::Dict{String,<:Any})

Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Arguments

• ops_item_id: The ID of the OpsItem.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ActualEndTime": The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
• "ActualStartTime": The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
• "Category": Specify a new category for an OpsItem.
• "Description": Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
• "Notifications": The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
• "OperationalData": 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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action). 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 AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
• "OperationalDataToDelete": Keys that you want to remove from the OperationalData map.
• "PlannedEndTime": The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
• "PlannedStartTime": The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
• "Priority": The importance of this OpsItem in relation to other OpsItems in the system.
• "RelatedOpsItems": 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.
• "Severity": Specify a new severity for an OpsItem.
• "Status": The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.
• "Title": A short heading that describes the nature of the OpsItem and the impacted resource.

update_ops_metadata(ops_metadata_arn)
update_ops_metadata(ops_metadata_arn, params::Dict{String,<:Any})

Systems Manager calls this API action when you edit OpsMetadata in Application Manager.

Arguments

• ops_metadata_arn: The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "KeysToDelete": The metadata keys to delete from the OpsMetadata object.
• "MetadataToUpdate": Metadata to add to an OpsMetadata object.

update_patch_baseline(baseline_id)
update_patch_baseline(baseline_id, params::Dict{String,<:Any})

Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Arguments

• baseline_id: The ID of the patch baseline to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ApprovalRules": A set of rules used to include patches in the baseline.
• "ApprovedPatches": A list of explicitly approved patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
• "ApprovedPatchesComplianceLevel": Assigns a new compliance severity level to an existing patch baseline.
• "ApprovedPatchesEnableNonSecurity": Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.
• "Description": A description of the patch baseline.
• "GlobalFilters": A set of global filters used to include patches in the baseline.
• "Name": The name of the patch baseline.
• "RejectedPatches": A list of explicitly rejected patches for the baseline. For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.
• "RejectedPatchesAction": The action for Patch Manager to take on patches included in the RejectedPackages list. ALLOWASDEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified. BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.
• "Replace": If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.
• "Sources": Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

update_resource_data_sync(sync_name, sync_source, sync_type)
update_resource_data_sync(sync_name, sync_source, sync_type, params::Dict{String,<:Any})

Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one. This API action only supports a resource data sync that was created with a SyncFromSource SyncType.

Arguments

• sync_name: The name of the resource data sync you want to update.
• sync_source: Specify information about the data sources to synchronize.
• sync_type: The type of resource data sync. The supported SyncType is SyncFromSource.

update_service_setting(setting_id, setting_value)
update_service_setting(setting_id, setting_value, params::Dict{String,<:Any})

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS 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. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team. Update the service setting for the account.

Arguments

• setting_id: The Amazon Resource Name (ARN) of the service setting to reset. For example, arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enable d. The setting ID can be one of the following. /ssm/automation/customer-script-log-destination /ssm/automation/customer-script-log-group-name /ssm/parameter-store/default-parameter-tier /ssm/parameter-store/high-throughput-enabled /ssm/managed-instance/activation-tier
• setting_value: The new value to specify for the service setting. For the /ssm/parameter-store/default-parameter-tier setting ID, the setting value can be one of the following. Standard Advanced Intelligent-Tiering For the /ssm/parameter-store/high-throughput-enabled, and /ssm/managed-instance/activation-tier setting IDs, the setting value can be true or false. For the /ssm/automation/customer-script-log-destination setting ID, the setting value can be CloudWatch. For the /ssm/automation/customer-script-log-group-name setting ID, the setting value can be the name of a CloudWatch Logs log group.