• NAME
• SYNOPSIS
• DESCRIPTION
• METHODS
  • AddTagsToResource(ResourceId => Str, ResourceType => Str, Tags => ArrayRef[Paws::SSM::Tag])
  • CancelCommand(CommandId => Str, [InstanceIds => ArrayRef[Str|Undef]])
  • CreateActivation(IamRole => Str, [DefaultInstanceName => Str, Description => Str, ExpirationDate => Str, RegistrationLimit => Int])
  • CreateAssociation(Name => Str, [DocumentVersion => Str, InstanceId => Str, OutputLocation => Paws::SSM::InstanceAssociationOutputLocation, Parameters => Paws::SSM::Parameters, ScheduleExpression => Str, Targets => ArrayRef[Paws::SSM::Target]])
  • CreateAssociationBatch(Entries => ArrayRef[Paws::SSM::CreateAssociationBatchRequestEntry])
  • CreateDocument(Content => Str, Name => Str, [DocumentType => Str])
  • CreateMaintenanceWindow(AllowUnassociatedTargets => Bool, Cutoff => Int, Duration => Int, Name => Str, Schedule => Str, [ClientToken => Str])
  • CreatePatchBaseline(Name => Str, [ApprovalRules => Paws::SSM::PatchRuleGroup, ApprovedPatches => ArrayRef[Str|Undef], ClientToken => Str, Description => Str, GlobalFilters => Paws::SSM::PatchFilterGroup, RejectedPatches => ArrayRef[Str|Undef]])
  • DeleteActivation(ActivationId => Str)
  • DeleteAssociation([AssociationId => Str, InstanceId => Str, Name => Str])
  • DeleteDocument(Name => Str)
  • DeleteMaintenanceWindow(WindowId => Str)
  • DeleteParameter(Name => Str)
  • DeletePatchBaseline(BaselineId => Str)
  • DeregisterManagedInstance(InstanceId => Str)
  • DeregisterPatchBaselineForPatchGroup(BaselineId => Str, PatchGroup => Str)
  • DeregisterTargetFromMaintenanceWindow(WindowId => Str, WindowTargetId => Str)
  • DeregisterTaskFromMaintenanceWindow(WindowId => Str, WindowTaskId => Str)
  • DescribeActivations([Filters => ArrayRef[Paws::SSM::DescribeActivationsFilter], MaxResults => Int, NextToken => Str])
  • DescribeAssociation([AssociationId => Str, InstanceId => Str, Name => Str])
  • DescribeAutomationExecutions([Filters => ArrayRef[Paws::SSM::AutomationExecutionFilter], MaxResults => Int, NextToken => Str])
  • DescribeAvailablePatches([Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter], MaxResults => Int, NextToken => Str])
  • DescribeDocument(Name => Str, [DocumentVersion => Str])
  • DescribeDocumentPermission(Name => Str, PermissionType => Str)
  • DescribeEffectiveInstanceAssociations(InstanceId => Str, [MaxResults => Int, NextToken => Str])
  • DescribeEffectivePatchesForPatchBaseline(BaselineId => Str, [MaxResults => Int, NextToken => Str])
  • DescribeInstanceAssociationsStatus(InstanceId => Str, [MaxResults => Int, NextToken => Str])
  • DescribeInstanceInformation([Filters => ArrayRef[Paws::SSM::InstanceInformationStringFilter], InstanceInformationFilterList => ArrayRef[Paws::SSM::InstanceInformationFilter], MaxResults => Int, NextToken => Str])
  • DescribeInstancePatches(InstanceId => Str, [Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter], MaxResults => Int, NextToken => Str])
  • DescribeInstancePatchStates(InstanceIds => ArrayRef[Str|Undef], [MaxResults => Int, NextToken => Str])
  • DescribeInstancePatchStatesForPatchGroup(PatchGroup => Str, [Filters => ArrayRef[Paws::SSM::InstancePatchStateFilter], MaxResults => Int, NextToken => Str])
  • DescribeMaintenanceWindowExecutions(WindowId => Str, [Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter], MaxResults => Int, NextToken => Str])
  • DescribeMaintenanceWindowExecutionTaskInvocations(TaskId => Str, WindowExecutionId => Str, [Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter], MaxResults => Int, NextToken => Str])
  • DescribeMaintenanceWindowExecutionTasks(WindowExecutionId => Str, [Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter], MaxResults => Int, NextToken => Str])
  • DescribeMaintenanceWindows([Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter], MaxResults => Int, NextToken => Str])
  • DescribeMaintenanceWindowTargets(WindowId => Str, [Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter], MaxResults => Int, NextToken => Str])
  • DescribeMaintenanceWindowTasks(WindowId => Str, [Filters => ArrayRef[Paws::SSM::MaintenanceWindowFilter], MaxResults => Int, NextToken => Str])
  • DescribeParameters([Filters => ArrayRef[Paws::SSM::ParametersFilter], MaxResults => Int, NextToken => Str])
  • DescribePatchBaselines([Filters => ArrayRef[Paws::SSM::PatchOrchestratorFilter], MaxResults => Int, NextToken => Str])
  • DescribePatchGroups([MaxResults => Int, NextToken => Str])
  • DescribePatchGroupState(PatchGroup => Str)
  • GetAutomationExecution(AutomationExecutionId => Str)
  • GetCommandInvocation(CommandId => Str, InstanceId => Str, [PluginName => Str])
  • GetDefaultPatchBaseline()
  • GetDeployablePatchSnapshotForInstance(InstanceId => Str, SnapshotId => Str)
  • GetDocument(Name => Str, [DocumentVersion => Str])
  • GetInventory([Filters => ArrayRef[Paws::SSM::InventoryFilter], MaxResults => Int, NextToken => Str, ResultAttributes => ArrayRef[Paws::SSM::ResultAttribute]])
  • GetInventorySchema([MaxResults => Int, NextToken => Str, TypeName => Str])
  • GetMaintenanceWindow(WindowId => Str)
  • GetMaintenanceWindowExecution(WindowExecutionId => Str)
  • GetMaintenanceWindowExecutionTask(TaskId => Str, WindowExecutionId => Str)
  • GetParameterHistory(Name => Str, [MaxResults => Int, NextToken => Str, WithDecryption => Bool])
  • GetParameters(Names => ArrayRef[Str|Undef], [WithDecryption => Bool])
  • GetPatchBaseline(BaselineId => Str)
  • GetPatchBaselineForPatchGroup(PatchGroup => Str)
  • ListAssociations([AssociationFilterList => ArrayRef[Paws::SSM::AssociationFilter], MaxResults => Int, NextToken => Str])
  • ListCommandInvocations([CommandId => Str, Details => Bool, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])
  • ListCommands([CommandId => Str, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])
  • ListDocuments([DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter], MaxResults => Int, NextToken => Str])
  • ListDocumentVersions(Name => Str, [MaxResults => Int, NextToken => Str])
  • ListInventoryEntries(InstanceId => Str, TypeName => Str, [Filters => ArrayRef[Paws::SSM::InventoryFilter], MaxResults => Int, NextToken => Str])
  • ListTagsForResource(ResourceId => Str, ResourceType => Str)
  • ModifyDocumentPermission(Name => Str, PermissionType => Str, [AccountIdsToAdd => ArrayRef[Str|Undef], AccountIdsToRemove => ArrayRef[Str|Undef]])
  • PutInventory(InstanceId => Str, Items => ArrayRef[Paws::SSM::InventoryItem])
  • PutParameter(Name => Str, Type => Str, Value => Str, [Description => Str, KeyId => Str, Overwrite => Bool])
  • RegisterDefaultPatchBaseline(BaselineId => Str)
  • RegisterPatchBaselineForPatchGroup(BaselineId => Str, PatchGroup => Str)
  • RegisterTargetWithMaintenanceWindow(ResourceType => Str, Targets => ArrayRef[Paws::SSM::Target], WindowId => Str, [ClientToken => Str, OwnerInformation => Str])
  • RegisterTaskWithMaintenanceWindow(MaxConcurrency => Str, MaxErrors => Str, ServiceRoleArn => Str, Targets => ArrayRef[Paws::SSM::Target], TaskArn => Str, TaskType => Str, WindowId => Str, [ClientToken => Str, LoggingInfo => Paws::SSM::LoggingInfo, Priority => Int, TaskParameters => Paws::SSM::MaintenanceWindowTaskParameters])
  • RemoveTagsFromResource(ResourceId => Str, ResourceType => Str, TagKeys => ArrayRef[Str|Undef])
  • SendCommand(DocumentName => Str, [Comment => Str, DocumentHash => Str, DocumentHashType => 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])
  • StartAutomationExecution(DocumentName => Str, [DocumentVersion => Str, Parameters => Paws::SSM::AutomationParameterMap])
  • StopAutomationExecution(AutomationExecutionId => Str)
  • UpdateAssociation(AssociationId => Str, [DocumentVersion => Str, OutputLocation => Paws::SSM::InstanceAssociationOutputLocation, Parameters => Paws::SSM::Parameters, ScheduleExpression => Str])
  • UpdateAssociationStatus(AssociationStatus => Paws::SSM::AssociationStatus, InstanceId => Str, Name => Str)
  • UpdateDocument(Content => Str, Name => Str, [DocumentVersion => Str])
  • UpdateDocumentDefaultVersion(DocumentVersion => Str, Name => Str)
  • UpdateMaintenanceWindow(WindowId => Str, [AllowUnassociatedTargets => Bool, Cutoff => Int, Duration => Int, Enabled => Bool, Name => Str, Schedule => Str])
  • UpdateManagedInstanceRole(IamRole => Str, InstanceId => Str)
  • UpdatePatchBaseline(BaselineId => Str, [ApprovalRules => Paws::SSM::PatchRuleGroup, ApprovedPatches => ArrayRef[Str|Undef], Description => Str, GlobalFilters => Paws::SSM::PatchFilterGroup, Name => Str, RejectedPatches => ArrayRef[Str|Undef]])
• PAGINATORS
  • ListAllAssociations(sub { },[AssociationFilterList => ArrayRef[Paws::SSM::AssociationFilter], MaxResults => Int, NextToken => Str])
  • ListAllAssociations([AssociationFilterList => ArrayRef[Paws::SSM::AssociationFilter], MaxResults => Int, NextToken => Str])
  • ListAllCommandInvocations(sub { },[CommandId => Str, Details => Bool, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])
  • ListAllCommandInvocations([CommandId => Str, Details => Bool, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])
  • ListAllCommands(sub { },[CommandId => Str, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])
  • ListAllCommands([CommandId => Str, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])
  • ListAllDocuments(sub { },[DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter], MaxResults => Int, NextToken => Str])
  • ListAllDocuments([DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter], MaxResults => Int, NextToken => Str])
• SEE ALSO
• BUGS and CONTRIBUTIONS

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

Amazon EC2 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 works with managed instances: Amazon EC2 instances and servers or virtual machines (VMs) in your on-premises environment that are configured for Systems Manager.

This references is intended to be used with the EC2 Systems Manager User Guide (Linux) (Windows).

To get started, verify prerequisites and configure managed instances (Linux) (Windows).

METHODS

AddTagsToResource(ResourceId => Str, ResourceType => Str, Tags => ArrayRef[Paws::SSM::Tag])

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 assign to your managed instances. Tags enable you
to categorize your managed instances 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 10 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 Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

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.

CreateActivation(IamRole => Str, [DefaultInstanceName => Str, Description => Str, ExpirationDate => Str, RegistrationLimit => Int])

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

Returns: a Paws::SSM::CreateActivationResult instance

  Registers your on-premises server or virtual machine with Amazon EC2 so
that you can manage these resources using Run Command. An on-premises
server or virtual machine that has been registered with EC2 is called a
managed instance. For more information about activations, see Setting
Up Managed Instances (Linux) or Setting Up Managed Instances (Windows)
in the Amazon EC2 User Guide.

CreateAssociation(Name => Str, [DocumentVersion => Str, InstanceId => Str, OutputLocation => Paws::SSM::InstanceAssociationOutputLocation, Parameters => Paws::SSM::Parameters, ScheduleExpression => Str, Targets => ArrayRef[Paws::SSM::Target]])

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

Returns: a Paws::SSM::CreateAssociationResult instance

  Associates the specified SSM document with the specified instances or
targets.

When you associate an SSM document with one or more instances using instance IDs or tags, the 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 throws the AssociationAlreadyExists exception.

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 SSM document with the specified instances or
targets.

When you associate an SSM document with one or more instances using instance IDs or tags, the 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 throws the AssociationAlreadyExists exception.

CreateDocument(Content => Str, Name => Str, [DocumentType => Str])

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

Returns: a Paws::SSM::CreateDocumentResult instance

  Creates an SSM document.

After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.

CreateMaintenanceWindow(AllowUnassociatedTargets => Bool, Cutoff => Int, Duration => Int, Name => Str, Schedule => Str, [ClientToken => Str])

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

Returns: a Paws::SSM::CreateMaintenanceWindowResult instance

  Creates a new Maintenance Window.

CreatePatchBaseline(Name => Str, [ApprovalRules => Paws::SSM::PatchRuleGroup, ApprovedPatches => ArrayRef[Str|Undef], ClientToken => Str, Description => Str, GlobalFilters => Paws::SSM::PatchFilterGroup, RejectedPatches => ArrayRef[Str|Undef]])

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

Returns: a Paws::SSM::CreatePatchBaselineResult instance

  Creates a patch baseline.

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 SSM document from the specified instance.

When you disassociate an SSM 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)

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

Returns: a Paws::SSM::DeleteDocumentResult instance

  Deletes the SSM document and all instance associations to the document.

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

DeleteMaintenanceWindow(WindowId => Str)

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

Returns: a Paws::SSM::DeleteMaintenanceWindowResult instance

  Deletes a Maintenance Window.

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.

DeletePatchBaseline(BaselineId => Str)

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

Returns: a Paws::SSM::DeletePatchBaselineResult instance

  Deletes a patch baseline.

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
donE<rsquo>t plan to use Run Command on the server, we suggest
uninstalling the 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)

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

  Details about the activation, including: the date and time the
activation was created, the expiration date, the IAM role assigned to
the instances in the activation, and the number of instances activated
by this registration.

DescribeAssociation([AssociationId => Str, InstanceId => Str, Name => Str])

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

Returns: a Paws::SSM::DescribeAssociationResult instance

  Describes the associations for the specified SSM document or instance.

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.

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 that could possibly be included in a patch baseline.

DescribeDocument(Name => Str, [DocumentVersion => Str])

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

Returns: a Paws::SSM::DescribeDocumentResult instance

  Describes the specified SSM document.

DescribeDocumentPermission(Name => Str, PermissionType => Str)

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

Returns: a Paws::SSM::DescribeDocumentPermissionResponse instance

  Describes the permissions for an SSM document. If you created the
document, you are the owner. If a document is shared, it can either be
shared privately (by specifying a userE<rsquo>s AWS account ID) or
publicly (I<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.

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. You can use this to get
information about instances like the operating system platform, the SSM
agent version (Linux), status etc. 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.

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.

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 (meaning, 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 executed 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
executed.

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.

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.

DescribeParameters([Filters => ArrayRef[Paws::SSM::ParametersFilter], MaxResults => Int, NextToken => Str])

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

Returns: a Paws::SSM::DescribeParametersResult instance

  Get information about a parameter.

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

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.

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.

GetDefaultPatchBaseline()

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

Returns: a Paws::SSM::GetDefaultPatchBaselineResult instance

  Retrieves the default patch baseline.

GetDeployablePatchSnapshotForInstance(InstanceId => Str, SnapshotId => Str)

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-ApplyPatchBaseline Systems
Manager document.

GetDocument(Name => Str, [DocumentVersion => Str])

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

Returns: a Paws::SSM::GetDocumentResult instance

  Gets the contents of the specified SSM document.

GetInventory([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([MaxResults => Int, NextToken => Str, 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 task executed as part of 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 executed as part of a
Maintenance Window execution.

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

  Query a list of all parameters used by the AWS account.

GetParameters(Names => ArrayRef[Str|Undef], [WithDecryption => Bool])

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

Returns: a Paws::SSM::GetParametersResult instance

  Get a list of parameters used by the AWS account.E<gt>

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)

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.

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

  Lists the associations for the specified SSM document or instance.

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

ListDocuments([DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter], MaxResults => Int, NextToken => Str])

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

Returns: a Paws::SSM::ListDocumentsResult instance

  Describes one or more of your SSM documents.

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.

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

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

Returns: a Paws::SSM::ModifyDocumentPermissionResponse instance

  Share a 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 I<All> as the account ID.

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, Type => Str, Value => Str, [Description => Str, KeyId => Str, Overwrite => Bool])

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

Returns: a Paws::SSM::PutParameterResult instance

  Add one or more paramaters 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.

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, 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(MaxConcurrency => Str, MaxErrors => Str, ServiceRoleArn => Str, Targets => ArrayRef[Paws::SSM::Target], TaskArn => Str, TaskType => Str, WindowId => Str, [ClientToken => Str, LoggingInfo => Paws::SSM::LoggingInfo, Priority => Int, 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 all tags from the specified resource.

SendCommand(DocumentName => Str, [Comment => Str, DocumentHash => Str, DocumentHashType => 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

  Executes commands on one or more remote instances.

StartAutomationExecution(DocumentName => Str, [DocumentVersion => Str, Parameters => Paws::SSM::AutomationParameterMap])

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

Returns: a Paws::SSM::StartAutomationExecutionResult instance

  Initiates execution of an Automation document.

StopAutomationExecution(AutomationExecutionId => Str)

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

Returns: a Paws::SSM::StopAutomationExecutionResult instance

  Stop an Automation that is currently executing.

UpdateAssociation(AssociationId => Str, [DocumentVersion => Str, OutputLocation => Paws::SSM::InstanceAssociationOutputLocation, Parameters => Paws::SSM::Parameters, ScheduleExpression => Str])

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

Returns: a Paws::SSM::UpdateAssociationResult instance

  Updates an association. You can only update the document version,
schedule, parameters, and Amazon S3 output of an association.

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 SSM document associated with the specified
instance.

UpdateDocument(Content => Str, Name => Str, [DocumentVersion => Str])

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

Returns: a Paws::SSM::UpdateDocumentResult instance

  The document you want to update.

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.

UpdateMaintenanceWindow(WindowId => Str, [AllowUnassociatedTargets => Bool, Cutoff => Int, Duration => Int, Enabled => Bool, Name => Str, Schedule => 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.

UpdateManagedInstanceRole(IamRole => Str, InstanceId => Str)

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

Returns: a Paws::SSM::UpdateManagedInstanceRoleResult instance

  Assigns or changes an Amazon Identity and Access Management (IAM) role
to the managed instance.

UpdatePatchBaseline(BaselineId => Str, [ApprovalRules => Paws::SSM::PatchRuleGroup, ApprovedPatches => ArrayRef[Str|Undef], Description => Str, GlobalFilters => Paws::SSM::PatchFilterGroup, Name => Str, RejectedPatches => ArrayRef[Str|Undef]])

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.

PAGINATORS

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

ListAllAssociations(sub { },[AssociationFilterList => ArrayRef[Paws::SSM::AssociationFilter], MaxResults => Int, NextToken => Str])

ListAllAssociations([AssociationFilterList => ArrayRef[Paws::SSM::AssociationFilter], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Associations, passing the object as the first parameter, and the string 'Associations' as the second parameter 

If not, it will return a a Paws::SSM::ListAssociationsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllCommandInvocations(sub { },[CommandId => Str, Details => Bool, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])

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

If passed a sub as first parameter, it will call the sub for each element found in :

 - CommandInvocations, passing the object as the first parameter, and the string 'CommandInvocations' as the second parameter 

If not, it will return a a Paws::SSM::ListCommandInvocationsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllCommands(sub { },[CommandId => Str, Filters => ArrayRef[Paws::SSM::CommandFilter], InstanceId => Str, MaxResults => Int, NextToken => Str])

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

If passed a sub as first parameter, it will call the sub for each element found in :

 - Commands, passing the object as the first parameter, and the string 'Commands' as the second parameter 

If not, it will return a a Paws::SSM::ListCommandsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDocuments(sub { },[DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter], MaxResults => Int, NextToken => Str])

ListAllDocuments([DocumentFilterList => ArrayRef[Paws::SSM::DocumentFilter], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - DocumentIdentifiers, passing the object as the first parameter, and the string 'DocumentIdentifiers' as the second parameter 

If not, it will return a a Paws::SSM::ListDocumentsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

                    cpanm Paws::SSM

                    perl -MCPAN -e shell
                    install Paws::SSM