NAME

Paws::SSM - Perl Interface to AWS Amazon Simple Systems Manager (SSM)

SYNOPSIS

  use Paws;
  my $obj = Paws->service('SSM');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Systems Manager

AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.

This reference is intended to be used with the AWS Systems Manager User Guide (https://docs.aws.amazon.com/systems-manager/latest/userguide/).

To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html) in the AWS Systems Manager User Guide.

Related resources

For information about how to use a Query API, see Making API requests (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/making-api-requests.html).
For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/).
For information about AWS AppConfig, a capability of Systems Manager, see the AWS AppConfig User Guide (https://docs.aws.amazon.com/appconfig/latest/userguide/) and the AWS AppConfig API Reference (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/).
For information about AWS Incident Manager, a capability of Systems Manager, see the AWS Incident Manager User Guide (https://docs.aws.amazon.com/incident-manager/latest/userguide/) and the AWS Incident Manager API Reference (https://docs.aws.amazon.com/incident-manager/latest/APIReference/).

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06>

METHODS

Each argument is described in detail in: Paws::SSM::AddTagsToResource

Returns: a Paws::SSM::AddTagsToResourceResult instance

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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the Amazon EC2 User Guide.

AssociateOpsItemRelatedItem

AssociationType => Str
OpsItemId => Str
ResourceType => Str
ResourceUri => Str

Each argument is described in detail in: Paws::SSM::AssociateOpsItemRelatedItem

Returns: a Paws::SSM::AssociateOpsItemRelatedItemResponse instance

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.

CancelCommand

CommandId => Str
[InstanceIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SSM::CancelCommand

Returns: a Paws::SSM::CancelCommandResult instance

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

CancelMaintenanceWindowExecution

WindowExecutionId => Str

Each argument is described in detail in: Paws::SSM::CancelMaintenanceWindowExecution

Returns: a Paws::SSM::CancelMaintenanceWindowExecutionResult instance

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

CreateActivation

IamRole => Str
[DefaultInstanceName => Str]
[Description => Str]
[ExpirationDate => Str]
[RegistrationLimit => Int]
[Tags => ArrayRef[Paws::SSM::Tag]]

Each argument is described in detail in: Paws::SSM::CreateActivation

Returns: a Paws::SSM::CreateActivationResult instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) 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.

CreateAssociation

Name => Str
[ApplyOnlyAtCronInterval => Bool]
[AssociationName => Str]
[AutomationTargetParameterName => Str]
[CalendarNames => ArrayRef[Str|Undef]]
[ComplianceSeverity => Str]
[DocumentVersion => Str]
[InstanceId => Str]
[MaxConcurrency => Str]
[MaxErrors => Str]
[OutputLocation => Paws::SSM::InstanceAssociationOutputLocation]
[Parameters => Paws::SSM::Parameters]
[ScheduleExpression => Str]
[SyncCompliance => Str]
[TargetLocations => ArrayRef[Paws::SSM::TargetLocation]]
[Targets => ArrayRef[Paws::SSM::Target]]

Each argument is described in detail in: Paws::SSM::CreateAssociation

Returns: a Paws::SSM::CreateAssociationResult instance

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.

CreateAssociationBatch

Entries => ArrayRef[Paws::SSM::CreateAssociationBatchRequestEntry]

Each argument is described in detail in: Paws::SSM::CreateAssociationBatch

Returns: a Paws::SSM::CreateAssociationBatchResult instance

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.

CreateDocument

Content => Str
Name => Str
[Attachments => ArrayRef[Paws::SSM::AttachmentsSource]]
[DisplayName => Str]
[DocumentFormat => Str]
[DocumentType => Str]
[Requires => ArrayRef[Paws::SSM::DocumentRequires]]
[Tags => ArrayRef[Paws::SSM::Tag]]
[TargetType => Str]
[VersionName => Str]

Each argument is described in detail in: Paws::SSM::CreateDocument

Returns: a Paws::SSM::CreateDocumentResult instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html) in the AWS Systems Manager User Guide.

CreateMaintenanceWindow

AllowUnassociatedTargets => Bool
Cutoff => Int
Duration => Int
Name => Str
Schedule => Str
[ClientToken => Str]
[Description => Str]
[EndDate => Str]
[ScheduleOffset => Int]
[ScheduleTimezone => Str]
[StartDate => Str]
[Tags => ArrayRef[Paws::SSM::Tag]]

Each argument is described in detail in: Paws::SSM::CreateMaintenanceWindow

Returns: a Paws::SSM::CreateMaintenanceWindowResult instance

Creates a new maintenance window.

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

CreateOpsItem

Description => Str
Source => Str
Title => Str
[ActualEndTime => Str]
[ActualStartTime => Str]
[Category => Str]
[Notifications => ArrayRef[Paws::SSM::OpsItemNotification]]
[OperationalData => Paws::SSM::OpsItemOperationalData]
[OpsItemType => Str]
[PlannedEndTime => Str]
[PlannedStartTime => Str]
[Priority => Int]
[RelatedOpsItems => ArrayRef[Paws::SSM::RelatedOpsItem]]
[Severity => Str]
[Tags => ArrayRef[Paws::SSM::Tag]]

Each argument is described in detail in: Paws::SSM::CreateOpsItem

Returns: a Paws::SSM::CreateOpsItemResponse instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

CreateOpsMetadata

ResourceId => Str
[Metadata => Paws::SSM::MetadataMap]
[Tags => ArrayRef[Paws::SSM::Tag]]

Each argument is described in detail in: Paws::SSM::CreateOpsMetadata

Returns: a Paws::SSM::CreateOpsMetadataResult instance

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.

CreatePatchBaseline

Name => Str
[ApprovalRules => Paws::SSM::PatchRuleGroup]
[ApprovedPatches => ArrayRef[Str|Undef]]
[ApprovedPatchesComplianceLevel => Str]
[ApprovedPatchesEnableNonSecurity => Bool]
[ClientToken => Str]
[Description => Str]
[GlobalFilters => Paws::SSM::PatchFilterGroup]
[OperatingSystem => Str]
[RejectedPatches => ArrayRef[Str|Undef]]
[RejectedPatchesAction => Str]
[Sources => ArrayRef[Paws::SSM::PatchSource]]
[Tags => ArrayRef[Paws::SSM::Tag]]

Each argument is described in detail in: Paws::SSM::CreatePatchBaseline

Returns: a Paws::SSM::CreatePatchBaselineResult instance

Creates a patch baseline.

For information about valid key and value pairs in "PatchFilters" for each supported operating system type, see PatchFilter (http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html).

CreateResourceDataSync

SyncName => Str
[S3Destination => Paws::SSM::ResourceDataSyncS3Destination]
[SyncSource => Paws::SSM::ResourceDataSyncSource]
[SyncType => Str]

Each argument is described in detail in: Paws::SSM::CreateResourceDataSync

Returns: a Paws::SSM::CreateResourceDataSyncResult instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html) 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) 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.

DeleteActivation

ActivationId => Str

Each argument is described in detail in: Paws::SSM::DeleteActivation

Returns: a Paws::SSM::DeleteActivationResult instance

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.

DeleteAssociation

[AssociationId => Str]
[InstanceId => Str]
[Name => Str]

Each argument is described in detail in: Paws::SSM::DeleteAssociation

Returns: a Paws::SSM::DeleteAssociationResult instance

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.

DeleteDocument

Name => Str
[DocumentVersion => Str]
[Force => Bool]
[VersionName => Str]

Each argument is described in detail in: Paws::SSM::DeleteDocument

Returns: a Paws::SSM::DeleteDocumentResult instance

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.

DeleteInventory

TypeName => Str
[ClientToken => Str]
[DryRun => Bool]
[SchemaDeleteOption => Str]

Each argument is described in detail in: Paws::SSM::DeleteInventory

Returns: a Paws::SSM::DeleteInventoryResult instance

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

DeleteMaintenanceWindow

WindowId => Str

Each argument is described in detail in: Paws::SSM::DeleteMaintenanceWindow

Returns: a Paws::SSM::DeleteMaintenanceWindowResult instance

Deletes a maintenance window.

DeleteOpsMetadata

OpsMetadataArn => Str

Each argument is described in detail in: Paws::SSM::DeleteOpsMetadata

Returns: a Paws::SSM::DeleteOpsMetadataResult instance

Delete OpsMetadata related to an application.

DeleteParameter

Name => Str

Each argument is described in detail in: Paws::SSM::DeleteParameter

Returns: a Paws::SSM::DeleteParameterResult instance

Delete a parameter from the system.

DeleteParameters

Names => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SSM::DeleteParameters

Returns: a Paws::SSM::DeleteParametersResult instance

Delete a list of parameters.

DeletePatchBaseline

BaselineId => Str

Each argument is described in detail in: Paws::SSM::DeletePatchBaseline

Returns: a Paws::SSM::DeletePatchBaselineResult instance

Deletes a patch baseline.

DeleteResourceDataSync

SyncName => Str
[SyncType => Str]

Each argument is described in detail in: Paws::SSM::DeleteResourceDataSync

Returns: a Paws::SSM::DeleteResourceDataSyncResult instance

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.

DeregisterManagedInstance

InstanceId => Str

Each argument is described in detail in: Paws::SSM::DeregisterManagedInstance

Returns: a Paws::SSM::DeregisterManagedInstanceResult instance

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.

DeregisterPatchBaselineForPatchGroup

BaselineId => Str
PatchGroup => Str

Each argument is described in detail in: Paws::SSM::DeregisterPatchBaselineForPatchGroup

Returns: a Paws::SSM::DeregisterPatchBaselineForPatchGroupResult instance

Removes a patch group from a patch baseline.

DeregisterTargetFromMaintenanceWindow

WindowId => Str
WindowTargetId => Str
[Safe => Bool]

Each argument is described in detail in: Paws::SSM::DeregisterTargetFromMaintenanceWindow

Returns: a Paws::SSM::DeregisterTargetFromMaintenanceWindowResult instance

Removes a target from a maintenance window.

DeregisterTaskFromMaintenanceWindow

WindowId => Str
WindowTaskId => Str

Each argument is described in detail in: Paws::SSM::DeregisterTaskFromMaintenanceWindow

Returns: a Paws::SSM::DeregisterTaskFromMaintenanceWindowResult instance

Removes a task from a maintenance window.

DescribeActivations

[Filters => ArrayRef[Paws::SSM::DescribeActivationsFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeActivations

Returns: a Paws::SSM::DescribeActivationsResult instance

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.

DescribeAssociation

[AssociationId => Str]
[AssociationVersion => Str]
[InstanceId => Str]
[Name => Str]

Each argument is described in detail in: Paws::SSM::DescribeAssociation

Returns: a Paws::SSM::DescribeAssociationResult instance

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.

DescribeAssociationExecutions

AssociationId => Str
[Filters => ArrayRef[Paws::SSM::AssociationExecutionFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeAssociationExecutions

Returns: a Paws::SSM::DescribeAssociationExecutionsResult instance

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

DescribeAssociationExecutionTargets

AssociationId => Str
ExecutionId => Str
[Filters => ArrayRef[Paws::SSM::AssociationExecutionTargetsFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeAssociationExecutionTargets

Returns: a Paws::SSM::DescribeAssociationExecutionTargetsResult instance

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

DescribeAutomationExecutions

[Filters => ArrayRef[Paws::SSM::AutomationExecutionFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeAutomationExecutions

Returns: a Paws::SSM::DescribeAutomationExecutionsResult instance

Provides details about all active and terminated Automation executions.

DescribeAutomationStepExecutions

AutomationExecutionId => Str
[Filters => ArrayRef[Paws::SSM::StepExecutionFilter]]
[MaxResults => Int]
[NextToken => Str]
[ReverseOrder => Bool]

Each argument is described in detail in: Paws::SSM::DescribeAutomationStepExecutions

Returns: a Paws::SSM::DescribeAutomationStepExecutionsResult instance

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

DescribeAvailablePatches

[Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeAvailablePatches

Returns: a Paws::SSM::DescribeAvailablePatchesResult instance

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

DescribeDocument

Name => Str
[DocumentVersion => Str]
[VersionName => Str]

Each argument is described in detail in: Paws::SSM::DescribeDocument

Returns: a Paws::SSM::DescribeDocumentResult instance

Describes the specified Systems Manager document.

DescribeDocumentPermission

Name => Str
PermissionType => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeDocumentPermission

Returns: a Paws::SSM::DescribeDocumentPermissionResponse instance

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

DescribeEffectiveInstanceAssociations

InstanceId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeEffectiveInstanceAssociations

Returns: a Paws::SSM::DescribeEffectiveInstanceAssociationsResult instance

All associations for the instance(s).

DescribeEffectivePatchesForPatchBaseline

BaselineId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeEffectivePatchesForPatchBaseline

Returns: a Paws::SSM::DescribeEffectivePatchesForPatchBaselineResult instance

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.

DescribeInstanceAssociationsStatus

InstanceId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeInstanceAssociationsStatus

Returns: a Paws::SSM::DescribeInstanceAssociationsStatusResult instance

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

DescribeInstanceInformation

[Filters => ArrayRef[Paws::SSM::InstanceInformationStringFilter]]
[InstanceInformationFilterList => ArrayRef[Paws::SSM::InstanceInformationFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeInstanceInformation

Returns: a Paws::SSM::DescribeInstanceInformationResult instance

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.

DescribeInstancePatches

InstanceId => Str
[Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeInstancePatches

Returns: a Paws::SSM::DescribeInstancePatchesResult instance

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

DescribeInstancePatchStates

InstanceIds => ArrayRef[Str|Undef]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeInstancePatchStates

Returns: a Paws::SSM::DescribeInstancePatchStatesResult instance

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

DescribeInstancePatchStatesForPatchGroup

PatchGroup => Str
[Filters => ArrayRef[Paws::SSM::InstancePatchStateFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeInstancePatchStatesForPatchGroup

Returns: a Paws::SSM::DescribeInstancePatchStatesForPatchGroupResult instance

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

DescribeInventoryDeletions

[DeletionId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeInventoryDeletions

Returns: a Paws::SSM::DescribeInventoryDeletionsResult instance

Describes a specific delete inventory operation.

DescribeMaintenanceWindowExecutions

WindowId => Str
[Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindowExecutions

Returns: a Paws::SSM::DescribeMaintenanceWindowExecutionsResult instance

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.

DescribeMaintenanceWindowExecutionTaskInvocations

TaskId => Str
WindowExecutionId => Str
[Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindowExecutionTaskInvocations

Returns: a Paws::SSM::DescribeMaintenanceWindowExecutionTaskInvocationsResult instance

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

DescribeMaintenanceWindowExecutionTasks

WindowExecutionId => Str
[Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindowExecutionTasks

Returns: a Paws::SSM::DescribeMaintenanceWindowExecutionTasksResult instance

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

DescribeMaintenanceWindows

[Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindows

Returns: a Paws::SSM::DescribeMaintenanceWindowsResult instance

Retrieves the maintenance windows in an AWS account.

DescribeMaintenanceWindowSchedule

[Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter]]
[MaxResults => Int]
[NextToken => Str]
[ResourceType => Str]
[Targets => ArrayRef[Paws::SSM::Target]]
[WindowId => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindowSchedule

Returns: a Paws::SSM::DescribeMaintenanceWindowScheduleResult instance

Retrieves information about upcoming executions of a maintenance window.

DescribeMaintenanceWindowsForTarget

ResourceType => Str
Targets => ArrayRef[Paws::SSM::Target]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindowsForTarget

Returns: a Paws::SSM::DescribeMaintenanceWindowsForTargetResult instance

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

DescribeMaintenanceWindowTargets

WindowId => Str
[Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindowTargets

Returns: a Paws::SSM::DescribeMaintenanceWindowTargetsResult instance

Lists the targets registered with the maintenance window.

DescribeMaintenanceWindowTasks

WindowId => Str
[Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeMaintenanceWindowTasks

Returns: a Paws::SSM::DescribeMaintenanceWindowTasksResult instance

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.

DescribeOpsItems

[MaxResults => Int]
[NextToken => Str]
[OpsItemFilters => ArrayRef[Paws::SSM::OpsItemFilter]]

Each argument is described in detail in: Paws::SSM::DescribeOpsItems

Returns: a Paws::SSM::DescribeOpsItemsResponse instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide.

DescribeParameters

[Filters => ArrayRef[Paws::SSM::ParametersFilter]]
[MaxResults => Int]
[NextToken => Str]
[ParameterFilters => ArrayRef[Paws::SSM::ParameterStringFilter]]

Each argument is described in detail in: Paws::SSM::DescribeParameters

Returns: a Paws::SSM::DescribeParametersResult instance

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.

DescribePatchBaselines

[Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribePatchBaselines

Returns: a Paws::SSM::DescribePatchBaselinesResult instance

Lists the patch baselines in your AWS account.

DescribePatchGroups

[Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribePatchGroups

Returns: a Paws::SSM::DescribePatchGroupsResult instance

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

DescribePatchGroupState

PatchGroup => Str

Each argument is described in detail in: Paws::SSM::DescribePatchGroupState

Returns: a Paws::SSM::DescribePatchGroupStateResult instance

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

DescribePatchProperties

OperatingSystem => Str
Property => Str
[MaxResults => Int]
[NextToken => Str]
[PatchSet => Str]

Each argument is described in detail in: Paws::SSM::DescribePatchProperties

Returns: a Paws::SSM::DescribePatchPropertiesResult instance

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:

AMAZON_LINUX: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
AMAZON_LINUX_2: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
CENTOS: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
DEBIAN: Valid properties: PRODUCT, PRIORITY
MACOS: Valid properties: PRODUCT, CLASSIFICATION
ORACLE_LINUX: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
REDHAT_ENTERPRISE_LINUX: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
SUSE: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
UBUNTU: Valid properties: PRODUCT, PRIORITY
WINDOWS: Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY

DescribeSessions

State => Str
[Filters => ArrayRef[Paws::SSM::SessionFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::DescribeSessions

Returns: a Paws::SSM::DescribeSessionsResponse instance

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

DisassociateOpsItemRelatedItem

AssociationId => Str
OpsItemId => Str

Each argument is described in detail in: Paws::SSM::DisassociateOpsItemRelatedItem

Returns: a Paws::SSM::DisassociateOpsItemRelatedItemResponse instance

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.

GetAutomationExecution

AutomationExecutionId => Str

Each argument is described in detail in: Paws::SSM::GetAutomationExecution

Returns: a Paws::SSM::GetAutomationExecutionResult instance

Get detailed information about a particular Automation execution.

GetCalendarState

CalendarNames => ArrayRef[Str|Undef]
[AtTime => Str]

Each argument is described in detail in: Paws::SSM::GetCalendarState

Returns: a Paws::SSM::GetCalendarStateResponse instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) in the AWS Systems Manager User Guide.

GetCommandInvocation

CommandId => Str
InstanceId => Str
[PluginName => Str]

Each argument is described in detail in: Paws::SSM::GetCommandInvocation

Returns: a Paws::SSM::GetCommandInvocationResult instance

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.

GetConnectionStatus

Target => Str

Each argument is described in detail in: Paws::SSM::GetConnectionStatus

Returns: a Paws::SSM::GetConnectionStatusResponse instance

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

GetDefaultPatchBaseline

[OperatingSystem => Str]

Each argument is described in detail in: Paws::SSM::GetDefaultPatchBaseline

Returns: a Paws::SSM::GetDefaultPatchBaselineResult instance

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.

GetDeployablePatchSnapshotForInstance

InstanceId => Str
SnapshotId => Str
[BaselineOverride => Paws::SSM::BaselineOverride]

Each argument is described in detail in: Paws::SSM::GetDeployablePatchSnapshotForInstance

Returns: a Paws::SSM::GetDeployablePatchSnapshotForInstanceResult instance

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

GetDocument

Name => Str
[DocumentFormat => Str]
[DocumentVersion => Str]
[VersionName => Str]

Each argument is described in detail in: Paws::SSM::GetDocument

Returns: a Paws::SSM::GetDocumentResult instance

Gets the contents of the specified Systems Manager document.

GetInventory

[Aggregators => ArrayRef[Paws::SSM::InventoryAggregator]]
[Filters => ArrayRef[Paws::SSM::InventoryFilter]]
[MaxResults => Int]
[NextToken => Str]
[ResultAttributes => ArrayRef[Paws::SSM::ResultAttribute]]

Each argument is described in detail in: Paws::SSM::GetInventory

Returns: a Paws::SSM::GetInventoryResult instance

Query inventory information.

GetInventorySchema

[Aggregator => Bool]
[MaxResults => Int]
[NextToken => Str]
[SubType => Bool]
[TypeName => Str]

Each argument is described in detail in: Paws::SSM::GetInventorySchema

Returns: a Paws::SSM::GetInventorySchemaResult instance

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

GetMaintenanceWindow

WindowId => Str

Each argument is described in detail in: Paws::SSM::GetMaintenanceWindow

Returns: a Paws::SSM::GetMaintenanceWindowResult instance

Retrieves a maintenance window.

GetMaintenanceWindowExecution

WindowExecutionId => Str

Each argument is described in detail in: Paws::SSM::GetMaintenanceWindowExecution

Returns: a Paws::SSM::GetMaintenanceWindowExecutionResult instance

Retrieves details about a specific a maintenance window execution.

GetMaintenanceWindowExecutionTask

TaskId => Str
WindowExecutionId => Str

Each argument is described in detail in: Paws::SSM::GetMaintenanceWindowExecutionTask

Returns: a Paws::SSM::GetMaintenanceWindowExecutionTaskResult instance

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

GetMaintenanceWindowExecutionTaskInvocation

InvocationId => Str
TaskId => Str
WindowExecutionId => Str

Each argument is described in detail in: Paws::SSM::GetMaintenanceWindowExecutionTaskInvocation

Returns: a Paws::SSM::GetMaintenanceWindowExecutionTaskInvocationResult instance

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

GetMaintenanceWindowTask

WindowId => Str
WindowTaskId => Str

Each argument is described in detail in: Paws::SSM::GetMaintenanceWindowTask

Returns: a Paws::SSM::GetMaintenanceWindowTaskResult instance

Lists the tasks in a maintenance window.

GetOpsItem

OpsItemId => Str

Each argument is described in detail in: Paws::SSM::GetOpsItem

Returns: a Paws::SSM::GetOpsItemResponse instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide.

GetOpsMetadata

OpsMetadataArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::GetOpsMetadata

Returns: a Paws::SSM::GetOpsMetadataResult instance

View operational metadata related to an application in Application Manager.

GetOpsSummary

[Aggregators => ArrayRef[Paws::SSM::OpsAggregator]]
[Filters => ArrayRef[Paws::SSM::OpsFilter]]
[MaxResults => Int]
[NextToken => Str]
[ResultAttributes => ArrayRef[Paws::SSM::OpsResultAttribute]]
[SyncName => Str]

Each argument is described in detail in: Paws::SSM::GetOpsSummary

Returns: a Paws::SSM::GetOpsSummaryResult instance

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

GetParameter

Name => Str
[WithDecryption => Bool]

Each argument is described in detail in: Paws::SSM::GetParameter

Returns: a Paws::SSM::GetParameterResult instance

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

GetParameterHistory

Name => Str
[MaxResults => Int]
[NextToken => Str]
[WithDecryption => Bool]

Each argument is described in detail in: Paws::SSM::GetParameterHistory

Returns: a Paws::SSM::GetParameterHistoryResult instance

Retrieves the history of all changes to a parameter.

GetParameters

Names => ArrayRef[Str|Undef]
[WithDecryption => Bool]

Each argument is described in detail in: Paws::SSM::GetParameters

Returns: a Paws::SSM::GetParametersResult instance

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

GetParametersByPath

Path => Str
[MaxResults => Int]
[NextToken => Str]
[ParameterFilters => ArrayRef[Paws::SSM::ParameterStringFilter]]
[Recursive => Bool]
[WithDecryption => Bool]

Each argument is described in detail in: Paws::SSM::GetParametersByPath

Returns: a Paws::SSM::GetParametersByPathResult instance

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

GetPatchBaseline

BaselineId => Str

Each argument is described in detail in: Paws::SSM::GetPatchBaseline

Returns: a Paws::SSM::GetPatchBaselineResult instance

Retrieves information about a patch baseline.

GetPatchBaselineForPatchGroup

PatchGroup => Str
[OperatingSystem => Str]

Each argument is described in detail in: Paws::SSM::GetPatchBaselineForPatchGroup

Returns: a Paws::SSM::GetPatchBaselineForPatchGroupResult instance

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

GetServiceSetting

SettingId => Str

Each argument is described in detail in: Paws::SSM::GetServiceSetting

Returns: a Paws::SSM::GetServiceSettingResult instance

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

LabelParameterVersion

Labels => ArrayRef[Str|Undef]
Name => Str
[ParameterVersion => Int]

Each argument is described in detail in: Paws::SSM::LabelParameterVersion

Returns: a Paws::SSM::LabelParameterVersionResult instance

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.

ListAssociations

[AssociationFilterList => ArrayRef[Paws::SSM::AssociationFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListAssociations

Returns: a Paws::SSM::ListAssociationsResult instance

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.

ListAssociationVersions

AssociationId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListAssociationVersions

Returns: a Paws::SSM::ListAssociationVersionsResult instance

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

ListCommandInvocations

[CommandId => Str]
[Details => Bool]
[Filters => ArrayRef[Paws::SSM::CommandFilter]]
[InstanceId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListCommandInvocations

Returns: a Paws::SSM::ListCommandInvocationsResult instance

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.

ListCommands

[CommandId => Str]
[Filters => ArrayRef[Paws::SSM::CommandFilter]]
[InstanceId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListCommands

Returns: a Paws::SSM::ListCommandsResult instance

Lists the commands requested by users of the AWS account.

ListComplianceItems

[Filters => ArrayRef[Paws::SSM::ComplianceStringFilter]]
[MaxResults => Int]
[NextToken => Str]
[ResourceIds => ArrayRef[Str|Undef]]
[ResourceTypes => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::SSM::ListComplianceItems

Returns: a Paws::SSM::ListComplianceItemsResult instance

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.

ListComplianceSummaries

[Filters => ArrayRef[Paws::SSM::ComplianceStringFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListComplianceSummaries

Returns: a Paws::SSM::ListComplianceSummariesResult instance

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

ListDocumentMetadataHistory

Metadata => Str
Name => Str
[DocumentVersion => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListDocumentMetadataHistory

Returns: a Paws::SSM::ListDocumentMetadataHistoryResponse instance

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

ListDocuments

[DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter]]
[Filters => ArrayRef[Paws::SSM::DocumentKeyValuesFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListDocuments

Returns: a Paws::SSM::ListDocumentsResult instance

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.

ListDocumentVersions

Name => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListDocumentVersions

Returns: a Paws::SSM::ListDocumentVersionsResult instance

List all versions for a document.

ListInventoryEntries

InstanceId => Str
TypeName => Str
[Filters => ArrayRef[Paws::SSM::InventoryFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListInventoryEntries

Returns: a Paws::SSM::ListInventoryEntriesResult instance

A list of inventory items returned by the request.

ListOpsItemEvents

[Filters => ArrayRef[Paws::SSM::OpsItemEventFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListOpsItemEvents

Returns: a Paws::SSM::ListOpsItemEventsResponse instance

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.

ListOpsItemRelatedItems

[Filters => ArrayRef[Paws::SSM::OpsItemRelatedItemsFilter]]
[MaxResults => Int]
[NextToken => Str]
[OpsItemId => Str]

Each argument is described in detail in: Paws::SSM::ListOpsItemRelatedItems

Returns: a Paws::SSM::ListOpsItemRelatedItemsResponse instance

Lists all related-item resources associated with an OpsItem.

ListOpsMetadata

[Filters => ArrayRef[Paws::SSM::OpsMetadataFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListOpsMetadata

Returns: a Paws::SSM::ListOpsMetadataResult instance

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

ListResourceComplianceSummaries

[Filters => ArrayRef[Paws::SSM::ComplianceStringFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::SSM::ListResourceComplianceSummaries

Returns: a Paws::SSM::ListResourceComplianceSummariesResult instance

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

ListResourceDataSync

[MaxResults => Int]
[NextToken => Str]
[SyncType => Str]

Each argument is described in detail in: Paws::SSM::ListResourceDataSync

Returns: a Paws::SSM::ListResourceDataSyncResult instance

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

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

ListTagsForResource

ResourceId => Str
ResourceType => Str

Each argument is described in detail in: Paws::SSM::ListTagsForResource

Returns: a Paws::SSM::ListTagsForResourceResult instance

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

ModifyDocumentPermission

Name => Str
PermissionType => Str
[AccountIdsToAdd => ArrayRef[Str|Undef]]
[AccountIdsToRemove => ArrayRef[Str|Undef]]
[SharedDocumentVersion => Str]

Each argument is described in detail in: Paws::SSM::ModifyDocumentPermission

Returns: a Paws::SSM::ModifyDocumentPermissionResponse instance

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.

PutComplianceItems

ComplianceType => Str
ExecutionSummary => Paws::SSM::ComplianceExecutionSummary
Items => ArrayRef[Paws::SSM::ComplianceItemEntry]
ResourceId => Str
ResourceType => Str
[ItemContentHash => Str]
[UploadType => Str]

Each argument is described in detail in: Paws::SSM::PutComplianceItems

Returns: a Paws::SSM::PutComplianceItemsResult instance

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'

PutInventory

InstanceId => Str
Items => ArrayRef[Paws::SSM::InventoryItem]

Each argument is described in detail in: Paws::SSM::PutInventory

Returns: a Paws::SSM::PutInventoryResult instance

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.

PutParameter

Name => Str
Value => Str
[AllowedPattern => Str]
[DataType => Str]
[Description => Str]
[KeyId => Str]
[Overwrite => Bool]
[Policies => Str]
[Tags => ArrayRef[Paws::SSM::Tag]]
[Tier => Str]
[Type => Str]

Each argument is described in detail in: Paws::SSM::PutParameter

Returns: a Paws::SSM::PutParameterResult instance

Add a parameter to the system.

RegisterDefaultPatchBaseline

BaselineId => Str

Each argument is described in detail in: Paws::SSM::RegisterDefaultPatchBaseline

Returns: a Paws::SSM::RegisterDefaultPatchBaselineResult instance

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

RegisterPatchBaselineForPatchGroup

BaselineId => Str
PatchGroup => Str

Each argument is described in detail in: Paws::SSM::RegisterPatchBaselineForPatchGroup

Returns: a Paws::SSM::RegisterPatchBaselineForPatchGroupResult instance

Registers a patch baseline for a patch group.

RegisterTargetWithMaintenanceWindow

ResourceType => Str
Targets => ArrayRef[Paws::SSM::Target]
WindowId => Str
[ClientToken => Str]
[Description => Str]
[Name => Str]
[OwnerInformation => Str]

Each argument is described in detail in: Paws::SSM::RegisterTargetWithMaintenanceWindow

Returns: a Paws::SSM::RegisterTargetWithMaintenanceWindowResult instance

Registers a target with a maintenance window.

RegisterTaskWithMaintenanceWindow

TaskArn => Str
TaskType => Str
WindowId => Str
[ClientToken => Str]
[Description => Str]
[LoggingInfo => Paws::SSM::LoggingInfo]
[MaxConcurrency => Str]
[MaxErrors => Str]
[Name => Str]
[Priority => Int]
[ServiceRoleArn => Str]
[Targets => ArrayRef[Paws::SSM::Target]]
[TaskInvocationParameters => Paws::SSM::MaintenanceWindowTaskInvocationParameters]
[TaskParameters => Paws::SSM::MaintenanceWindowTaskParameters]

Each argument is described in detail in: Paws::SSM::RegisterTaskWithMaintenanceWindow

Returns: a Paws::SSM::RegisterTaskWithMaintenanceWindowResult instance

Adds a new task to a maintenance window.

RemoveTagsFromResource

ResourceId => Str
ResourceType => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SSM::RemoveTagsFromResource

Returns: a Paws::SSM::RemoveTagsFromResourceResult instance

Removes tag keys from the specified resource.

ResetServiceSetting

SettingId => Str

Each argument is described in detail in: Paws::SSM::ResetServiceSetting

Returns: a Paws::SSM::ResetServiceSettingResult instance

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.

ResumeSession

SessionId => Str

Each argument is described in detail in: Paws::SSM::ResumeSession

Returns: a Paws::SSM::ResumeSessionResponse instance

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.

SendAutomationSignal

AutomationExecutionId => Str
SignalType => Str
[Payload => Paws::SSM::AutomationParameterMap]

Each argument is described in detail in: Paws::SSM::SendAutomationSignal

Returns: a Paws::SSM::SendAutomationSignalResult instance

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

SendCommand

DocumentName => Str
[CloudWatchOutputConfig => Paws::SSM::CloudWatchOutputConfig]
[Comment => Str]
[DocumentHash => Str]
[DocumentHashType => Str]
[DocumentVersion => Str]
[InstanceIds => ArrayRef[Str|Undef]]
[MaxConcurrency => Str]
[MaxErrors => Str]
[NotificationConfig => Paws::SSM::NotificationConfig]
[OutputS3BucketName => Str]
[OutputS3KeyPrefix => Str]
[OutputS3Region => Str]
[Parameters => Paws::SSM::Parameters]
[ServiceRoleArn => Str]
[Targets => ArrayRef[Paws::SSM::Target]]
[TimeoutSeconds => Int]

Each argument is described in detail in: Paws::SSM::SendCommand

Returns: a Paws::SSM::SendCommandResult instance

Runs commands on one or more managed instances.

StartAssociationsOnce

AssociationIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::SSM::StartAssociationsOnce

Returns: a Paws::SSM::StartAssociationsOnceResult instance

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

StartAutomationExecution

DocumentName => Str
[ClientToken => Str]
[DocumentVersion => Str]
[MaxConcurrency => Str]
[MaxErrors => Str]
[Mode => Str]
[Parameters => Paws::SSM::AutomationParameterMap]
[Tags => ArrayRef[Paws::SSM::Tag]]
[TargetLocations => ArrayRef[Paws::SSM::TargetLocation]]
[TargetMaps => ArrayRef[Paws::SSM::TargetMap]]
[TargetParameterName => Str]
[Targets => ArrayRef[Paws::SSM::Target]]

Each argument is described in detail in: Paws::SSM::StartAutomationExecution

Returns: a Paws::SSM::StartAutomationExecutionResult instance

Initiates execution of an Automation document.

StartChangeRequestExecution

DocumentName => Str
Runbooks => ArrayRef[Paws::SSM::Runbook]
[ChangeDetails => Str]
[ChangeRequestName => Str]
[ClientToken => Str]
[DocumentVersion => Str]
[Parameters => Paws::SSM::AutomationParameterMap]
[ScheduledEndTime => Str]
[ScheduledTime => Str]
[Tags => ArrayRef[Paws::SSM::Tag]]

Each argument is described in detail in: Paws::SSM::StartChangeRequestExecution

Returns: a Paws::SSM::StartChangeRequestExecutionResult instance

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.

StartSession

Target => Str
[DocumentName => Str]
[Parameters => Paws::SSM::SessionManagerParameters]

Each argument is described in detail in: Paws::SSM::StartSession

Returns: a Paws::SSM::StartSessionResponse instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) 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.

StopAutomationExecution

AutomationExecutionId => Str
[Type => Str]

Each argument is described in detail in: Paws::SSM::StopAutomationExecution

Returns: a Paws::SSM::StopAutomationExecutionResult instance

Stop an Automation that is currently running.

TerminateSession

SessionId => Str

Each argument is described in detail in: Paws::SSM::TerminateSession

Returns: a Paws::SSM::TerminateSessionResponse instance

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.

UnlabelParameterVersion

Labels => ArrayRef[Str|Undef]
Name => Str
ParameterVersion => Int

Each argument is described in detail in: Paws::SSM::UnlabelParameterVersion

Returns: a Paws::SSM::UnlabelParameterVersionResult instance

Remove a label or labels from a parameter.

UpdateAssociation

AssociationId => Str
[ApplyOnlyAtCronInterval => Bool]
[AssociationName => Str]
[AssociationVersion => Str]
[AutomationTargetParameterName => Str]
[CalendarNames => ArrayRef[Str|Undef]]
[ComplianceSeverity => Str]
[DocumentVersion => Str]
[MaxConcurrency => Str]
[MaxErrors => Str]
[Name => Str]
[OutputLocation => Paws::SSM::InstanceAssociationOutputLocation]
[Parameters => Paws::SSM::Parameters]
[ScheduleExpression => Str]
[SyncCompliance => Str]
[TargetLocations => ArrayRef[Paws::SSM::TargetLocation]]
[Targets => ArrayRef[Paws::SSM::Target]]

Each argument is described in detail in: Paws::SSM::UpdateAssociation

Returns: a Paws::SSM::UpdateAssociationResult instance

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: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>"

When you update an association, the association immediately runs against the specified targets.

UpdateAssociationStatus

AssociationStatus => Paws::SSM::AssociationStatus
InstanceId => Str
Name => Str

Each argument is described in detail in: Paws::SSM::UpdateAssociationStatus

Returns: a Paws::SSM::UpdateAssociationStatusResult instance

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

UpdateDocument

Content => Str
Name => Str
[Attachments => ArrayRef[Paws::SSM::AttachmentsSource]]
[DisplayName => Str]
[DocumentFormat => Str]
[DocumentVersion => Str]
[TargetType => Str]
[VersionName => Str]

Each argument is described in detail in: Paws::SSM::UpdateDocument

Returns: a Paws::SSM::UpdateDocumentResult instance

Updates one or more values for an SSM document.

UpdateDocumentDefaultVersion

DocumentVersion => Str
Name => Str

Each argument is described in detail in: Paws::SSM::UpdateDocumentDefaultVersion

Returns: a Paws::SSM::UpdateDocumentDefaultVersionResult instance

Set the default version of a document.

UpdateDocumentMetadata

DocumentReviews => Paws::SSM::DocumentReviews
Name => Str
[DocumentVersion => Str]

Each argument is described in detail in: Paws::SSM::UpdateDocumentMetadata

Returns: a Paws::SSM::UpdateDocumentMetadataResponse instance

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

UpdateMaintenanceWindow

WindowId => Str
[AllowUnassociatedTargets => Bool]
[Cutoff => Int]
[Description => Str]
[Duration => Int]
[Enabled => Bool]
[EndDate => Str]
[Name => Str]
[Replace => Bool]
[Schedule => Str]
[ScheduleOffset => Int]
[ScheduleTimezone => Str]
[StartDate => Str]

Each argument is described in detail in: Paws::SSM::UpdateMaintenanceWindow

Returns: a Paws::SSM::UpdateMaintenanceWindowResult instance

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

UpdateMaintenanceWindowTarget

WindowId => Str
WindowTargetId => Str
[Description => Str]
[Name => Str]
[OwnerInformation => Str]
[Replace => Bool]
[Targets => ArrayRef[Paws::SSM::Target]]

Each argument is described in detail in: Paws::SSM::UpdateMaintenanceWindowTarget

Returns: a Paws::SSM::UpdateMaintenanceWindowTargetResult instance

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.

UpdateMaintenanceWindowTask

WindowId => Str
WindowTaskId => Str
[Description => Str]
[LoggingInfo => Paws::SSM::LoggingInfo]
[MaxConcurrency => Str]
[MaxErrors => Str]
[Name => Str]
[Priority => Int]
[Replace => Bool]
[ServiceRoleArn => Str]
[Targets => ArrayRef[Paws::SSM::Target]]
[TaskArn => Str]
[TaskInvocationParameters => Paws::SSM::MaintenanceWindowTaskInvocationParameters]
[TaskParameters => Paws::SSM::MaintenanceWindowTaskParameters]

Each argument is described in detail in: Paws::SSM::UpdateMaintenanceWindowTask

Returns: a Paws::SSM::UpdateMaintenanceWindowTaskResult instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) 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.

UpdateManagedInstanceRole

IamRole => Str
InstanceId => Str

Each argument is described in detail in: Paws::SSM::UpdateManagedInstanceRole

Returns: a Paws::SSM::UpdateManagedInstanceRoleResult instance

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.

UpdateOpsItem

OpsItemId => Str
[ActualEndTime => Str]
[ActualStartTime => Str]
[Category => Str]
[Description => Str]
[Notifications => ArrayRef[Paws::SSM::OpsItemNotification]]
[OperationalData => Paws::SSM::OpsItemOperationalData]
[OperationalDataToDelete => ArrayRef[Str|Undef]]
[PlannedEndTime => Str]
[PlannedStartTime => Str]
[Priority => Int]
[RelatedOpsItems => ArrayRef[Paws::SSM::RelatedOpsItem]]
[Severity => Str]
[Status => Str]
[Title => Str]

Each argument is described in detail in: Paws::SSM::UpdateOpsItem

Returns: a Paws::SSM::UpdateOpsItemResponse instance

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide.

UpdateOpsMetadata

OpsMetadataArn => Str
[KeysToDelete => ArrayRef[Str|Undef]]
[MetadataToUpdate => Paws::SSM::MetadataMap]

Each argument is described in detail in: Paws::SSM::UpdateOpsMetadata

Returns: a Paws::SSM::UpdateOpsMetadataResult instance

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

UpdatePatchBaseline

BaselineId => Str
[ApprovalRules => Paws::SSM::PatchRuleGroup]
[ApprovedPatches => ArrayRef[Str|Undef]]
[ApprovedPatchesComplianceLevel => Str]
[ApprovedPatchesEnableNonSecurity => Bool]
[Description => Str]
[GlobalFilters => Paws::SSM::PatchFilterGroup]
[Name => Str]
[RejectedPatches => ArrayRef[Str|Undef]]
[RejectedPatchesAction => Str]
[Replace => Bool]
[Sources => ArrayRef[Paws::SSM::PatchSource]]

Each argument is described in detail in: Paws::SSM::UpdatePatchBaseline

Returns: a Paws::SSM::UpdatePatchBaselineResult instance

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

UpdateResourceDataSync

SyncName => Str
SyncSource => Paws::SSM::ResourceDataSyncSource
SyncType => Str

Each argument is described in detail in: Paws::SSM::UpdateResourceDataSync

Returns: a Paws::SSM::UpdateResourceDataSyncResult instance

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

UpdateServiceSetting

SettingId => Str
SettingValue => Str

Each argument is described in detail in: Paws::SSM::UpdateServiceSetting

Returns: a Paws::SSM::UpdateServiceSettingResult instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results