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

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 lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.

This reference is intended to be used with the Amazon EC2 Systems Manager User Guide.

To get started, verify prerequisites and configure managed instances. For more information, see Systems Manager Prerequisites.

For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.

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 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 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 Systems Manager in Hybrid Environments.

CreateAssociation(Name => Str, [AssociationName => 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 Systems Manager document with the specified
instances or targets.

When you associate a 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 Systems Manager document with the specified
instances or targets.

When you associate a 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 a Systems Manager document.

After you create a 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, Description => 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], ApprovedPatchesComplianceLevel => Str, ClientToken => Str, Description => Str, GlobalFilters => Paws::SSM::PatchFilterGroup, OperatingSystem => Str, RejectedPatches => ArrayRef[Str|Undef]])

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

Returns: a Paws::SSM::CreatePatchBaselineResult instance

Creates a patch baseline.

CreateResourceDataSync(S3Destination => Paws::SSM::ResourceDataSyncS3Destination, SyncName => Str)

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

Returns: a Paws::SSM::CreateResourceDataSyncResult instance

Creates a resource data sync configuration to a single bucket in Amazon
S3. This is an asynchronous operation that returns immediately. After a
successful initial sync is completed, the system continuously syncs
data to the Amazon S3 bucket. To check the status of the sync, use the
ListResourceDataSync operation.

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. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.

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)

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.

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.

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. This API is used to delete parameters by
using the Amazon EC2 console.

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)

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 inventory data on managed instances are no longer
synced with the target Amazon S3 bucket. Deleting a sync configuration
does not delete data in the target Amazon S3 bucket.

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
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, [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

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, AssociationVersion => 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 Systems Manager 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 Systems Manager 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 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 (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. 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. 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. 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 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, 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.

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

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-RunPatchBaseline 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 Systems Manager 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, 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 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.

GetMaintenanceWindowExecutionTaskInvocation(InvocationId => Str, TaskId => Str, WindowExecutionId => Str)

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

Returns: a Paws::SSM::GetMaintenanceWindowExecutionTaskInvocationResult instance

Retrieves a task invocation. A task invocation is a specific task
executing on a specific target. Maintenance Windows report status for
all invocations.

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.

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.

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 details of a parameter.

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 parameters in a specific hierarchy. For more information, see
Working with Systems Manager Parameters.

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.

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

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

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.

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

Describes one or more of your Systems Manager 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.

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

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

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

PutComplianceItems(ComplianceType => Str, ExecutionSummary => Paws::SSM::ComplianceExecutionSummary, Items => ArrayRef[Paws::SSM::ComplianceItemEntry], ResourceId => Str, ResourceType => Str, [ItemContentHash => 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.

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

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, [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 managed instances.

StartAutomationExecution(DocumentName => Str, [ClientToken => 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, [AssociationName => Str, AssociationVersion => Str, DocumentVersion => Str, Name => 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::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.

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, [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, Description => Str, Duration => Int, Enabled => Bool, Name => Str, Replace => Bool, 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.

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't change
the target type, but you can change the following:

The target from being an ID target to a Tag target, or a Tag target to an ID target.

IDs for an ID target.

Tags for a Tag target.

Owner.

Name.

Description.

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:

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

Service role ARN.

Task parameters.

Task priority.

Task MaxConcurrency and MaxErrors.

Log location.

If a parameter is null, then the corresponding field is not modified. Also, 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.

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], ApprovedPatchesComplianceLevel => Str, 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